Timo Koch authored 2 years ago and Dennis Gläser committed 2 years ago

* Copy the docs of the models to the model's group page so we see the equations immediately
* Introduce high-level groups to add some structure
* Improve some names/descriptions

Remove todo and warning lists from the generated html docs. Move bibliography
to the end. Select new headings for overview and models.

Melanie Lipp authored 2 years ago and Timo Koch committed 2 years ago

[doc][doxygen] Change module nomenclature from FaceCenteredStaggeredDiamondDiscretization to DiamondDiscretization.

[doc][doxygen] Introduce group FreeFlowPorousMediumCoupling in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/multidomain/boundary/freeflowporousmedium.

[doc][doxygen] Introduce group FreeFlowPoreNetworkCoupling in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/multidomain/boundary/freeflowporenetwork.

[doc][doxygen] Introduce group SSTModel in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/freeflow/rans/twoeq/sst.

[doc][doxygen] Introduce group FaceCenteredStaggeredDiscretization in modules.txt. This group has been used already before, although it did not exist. Additionally, use it more consistently throughout the folder dumux/discretization/facecentered.

Yue Wang authored 3 years ago and Timo Koch committed 3 years ago

Manual inputs are provided via a human-readable json file which is
under version control. The parameters.txt file is now completely
auto-generated and shouldn't be manually edited. All edits
happen to the json file. This makes sure formatting and data
are separated properly and git changes are minimal.

Change input parameter group name from SpatialParameters to SpatialParams as SpatialParams already exists while SpatialParameters would be lonely.