Document model solver loop and time step adaptation schemes in user manual
The following discussion from !181 (merged) should be addressed:
-
@sospinar started a discussion: (+1 comment)
We should probably document the time step scheme algorithm(s) in the user manual.
How about using a uml diagram?
This would be a sketch of a possible diagram. @lriedel Do you know how to add a box on the way back of the while loop?
Description
We need to document the (slightly different) solver routines of the Richards and transport models in the user manual. @sospinar suggested using a UML diagram with the PlantUML extension of Sphinx.
Proposal
-
Add
sphinxcontrib-plantuml
to therequirements.txt
of the user docs. -
Add
'sphinxcontrib.plantuml'
to the Sphinx extensions in theconf.py
. -
Document the time step schemes:
- Richards model: Explain allowed Newton iterations and relation to time step.
- Transport model: Explain solution check first implemented in !181 (merged).
Finalize proposal for loop visualization here
How to test the implementation?
Nothing to test.