Refactor main Richards and Transport model files
Description
During the JOSS paper review, it was noted that some source files have bad variable naming conventions and are thus difficult to read.
The files implementing the Richards and Transport models are historically grown and do not match our general coding guidelines. Many of the variable naming conventions stem from PDELab implementations and are difficult to read if one has not seen other PDELab code before. Additionally, the files for Richards still use tab indentation as opposed to spaces, which are now used almost exclusively throughout the DORiE code.
Files in question:
- https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/blob/master/dune/dorie/model/richards/richards.cc
- https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/blob/master/dune/dorie/model/richards/richards.hh
- https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/blob/master/dune/dorie/model/transport/transport.cc
- https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/blob/master/dune/dorie/model/transport/transport.hh
Proposal
Reformat files above using the clang-format
tool, with specifications given in !203 (merged). Note: A downside of re-formatting the files will be that git blame
becomes much less useful. But I guess we can afford that at this point?
Update variable names to be more readable. Examples/proposals:
-
gfs
->grid_func_space
-
gv
->grid_view
-
u
->solution
(a particularly bad one) -
cc
->constraints
-
slop
->local_op_space
-
go0
->grid_op_0
How to test the implementation?
Nothing new to test.
Related issues
- Original proposal
- #180 (closed): C++ style guide