Update documentation for test setup simplification and Coefficient VTK post-processing - #57
Merged
Merged
Conversation
…+ support for exporting a Coefficient in VTK output
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the documentation to reflect the recent SLOTH additions: simplified test
setup aliases/factories (
using namespace SlothND,set(Periodic)SpatialDiscretization,setBoundaryConditions,setCoupling<N>), auxiliary variables set afterProblemconstruction, and
CoefficientVTK post-processing.New page
Documentation/User/Aliases/index.md— new reference page forusing namespace SlothND:what's available from
Sloth1D/Sloth2D/Sloth3Dalone (FECollection,VARS,VAR,PST,SPA,SPAS,BCS,PB_MPI,PB_CALPHAD,PB_PROPERTY), the PDE aliases(
TransientOPE/TransientPB/SteadyOPE/SteadyPB, already included, no extra namespaceneeded), and a practical cheat sheet for the factory functions.
Updated pages
SpatialDiscretization/Meshing/index.md— documentsset(Periodic)SpatialDiscretizationfor building
Nspatial discretizations sharing a mesh.SpatialDiscretization/BoundaryConditions/index.md— documentssetBoundaryConditions;also documents space-/time-variable Dirichlet boundary conditions via a
Glossary::DirichletCoefficient(previously undocumented, already supported in code).MultiPhysicsCouplingScheme/Couplings/index.md— documentssetCoupling<N>for couplingNidentical Problems.MultiPhysicsCouplingScheme/Problems/PDEs/index.md— documentsset_auxvariables(setafter construction instead of through the constructor) and
set_vtk_coefficients.PostProcessing/index.md— new "Post-processing Coefficients in VTK output" section.Started/HowTo/Simple/index.md— points to the new Aliases page;