From 39fb40cefcdb4549db803769b3cb089b4249d023 Mon Sep 17 00:00:00 2001 From: termi-official Date: Mon, 15 Jan 2024 22:18:54 +0100 Subject: [PATCH 1/3] Sprinkle sprinkle little documenter... --- docs/src/literate-howto/postprocessing.jl | 6 ++++++ docs/src/literate-tutorials/heat_equation.jl | 2 ++ src/Dofs/DofHandler.jl | 3 +++ 3 files changed, 11 insertions(+) diff --git a/docs/src/literate-howto/postprocessing.jl b/docs/src/literate-howto/postprocessing.jl index 79586f0640..3918794e87 100644 --- a/docs/src/literate-howto/postprocessing.jl +++ b/docs/src/literate-howto/postprocessing.jl @@ -129,6 +129,12 @@ Plots.plot(getindex.(points,1), u_points, xlabel="x (coordinate)", ylabel="u (te Plots.plot(getindex.(points,1), getindex.(q_points,1), xlabel="x (coordinate)", ylabel="q_x (flux in x-direction)", label=nothing) # *Figure 4*: ``x``-component of the flux along the cut line from *Figure 2*. +#md # ## What next? +#md # For more complicated visualization workflows we recomment either using our visualization tool [FerriteViz.jl](https://github.com/Ferrite-FEM/FerriteViz.jl) +#md # or users should export the solution into vtk files and use e.g. [ParaView](https://www.paraview.org/), [Mayavi](https://docs.enthought.com/mayavi/mayavi/), ... . +#md # It should be noted that the ordering of the DofHandler and the numbering of the nodes does not match, hence we cannot directly use solution +#md # vectors to assign colors to discretizations. + #md # ## [Plain program](@id postprocessing-plain-program) #md # #md # Here follows a version of the program without any comments. diff --git a/docs/src/literate-tutorials/heat_equation.jl b/docs/src/literate-tutorials/heat_equation.jl index 4a82dac7b7..0b5a2169d5 100644 --- a/docs/src/literate-tutorials/heat_equation.jl +++ b/docs/src/literate-tutorials/heat_equation.jl @@ -66,6 +66,8 @@ cellvalues = CellValues(qr, ip); # our interpolation `ip` defined above. # Lastly we `close!` the `DofHandler`, it is now that the dofs are distributed # for all the elements. +#md # !!! note +#md # The dof numbering does not follow the node numbering of the grid. dh = DofHandler(grid) add!(dh, :u, ip) close!(dh); diff --git a/src/Dofs/DofHandler.jl b/src/Dofs/DofHandler.jl index c72828fbb1..57a4c5dae5 100644 --- a/src/Dofs/DofHandler.jl +++ b/src/Dofs/DofHandler.jl @@ -127,6 +127,9 @@ add!(dh, :u, ip_u) add!(dh, :p, ip_p) close!(dh) ``` + +!!! note + The dof numbering does not follow the node numbering of the associated grid. """ function DofHandler(grid::G) where {dim, G <: AbstractGrid{dim}} ncells = getncells(grid) From 446f639d524bb2ef4d2bd797da7be033565979f4 Mon Sep 17 00:00:00 2001 From: Dennis Ogiermann Date: Mon, 15 Jan 2024 22:39:42 +0100 Subject: [PATCH 2/3] Update docs/src/literate-howto/postprocessing.jl MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Maximilian Köhler --- docs/src/literate-howto/postprocessing.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/literate-howto/postprocessing.jl b/docs/src/literate-howto/postprocessing.jl index 3918794e87..ff9dba1846 100644 --- a/docs/src/literate-howto/postprocessing.jl +++ b/docs/src/literate-howto/postprocessing.jl @@ -130,7 +130,7 @@ Plots.plot(getindex.(points,1), getindex.(q_points,1), xlabel="x (coordinate)", # *Figure 4*: ``x``-component of the flux along the cut line from *Figure 2*. #md # ## What next? -#md # For more complicated visualization workflows we recomment either using our visualization tool [FerriteViz.jl](https://github.com/Ferrite-FEM/FerriteViz.jl) +#md # For more complicated visualization workflows we recommend either using our visualization tool [FerriteViz.jl](https://github.com/Ferrite-FEM/FerriteViz.jl) #md # or users should export the solution into vtk files and use e.g. [ParaView](https://www.paraview.org/), [Mayavi](https://docs.enthought.com/mayavi/mayavi/), ... . #md # It should be noted that the ordering of the DofHandler and the numbering of the nodes does not match, hence we cannot directly use solution #md # vectors to assign colors to discretizations. From fdbf66232e5e5a49b83d343dc600afc48deca4d8 Mon Sep 17 00:00:00 2001 From: termi-official Date: Tue, 16 Jan 2024 13:46:20 +0100 Subject: [PATCH 3/3] Remove note. --- docs/src/literate-tutorials/heat_equation.jl | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/src/literate-tutorials/heat_equation.jl b/docs/src/literate-tutorials/heat_equation.jl index 0b5a2169d5..7f5fedd2ef 100644 --- a/docs/src/literate-tutorials/heat_equation.jl +++ b/docs/src/literate-tutorials/heat_equation.jl @@ -66,8 +66,7 @@ cellvalues = CellValues(qr, ip); # our interpolation `ip` defined above. # Lastly we `close!` the `DofHandler`, it is now that the dofs are distributed # for all the elements. -#md # !!! note -#md # The dof numbering does not follow the node numbering of the grid. +# Please note that the dof numbering does not follow the node numbering of the grid. dh = DofHandler(grid) add!(dh, :u, ip) close!(dh);