Draft: PNM regularization
What this MR does / why does DuMux need it:
This MR implements conductivity regularization for pore-network models by using the theta interface in problem files. This allows to switch very easily between the old implementation and the new one that utilizes regularization.
Main changes are:
- Generalization of flux law by introducing theta variable that indicates the state, i.e. invaded or not
- New InvasionState class that uses this new theta variable
Notes for the reviewer
Before you request a review from someone, make sure to revise the following points:
-
does the new code follow the style guide? -
do the test pipelines pass? (see guide on how to run pipelines for a merge request) -
is the code you changed and/or the new code you wrote covered in the test suite? (if not, extend the existing tests or write new ones) -
does your change affect public interfaces or behavior, or, does it introduce a new feature? If so, document the change in CHANGELOG.md
. -
is the list of the header includes complete? ("include what you use") -
all files have to end with a \n
character. Make sure there is no\ No newline at end of file
comment in "Changes" of this MR. -
(if not applicable remove) are newly introduced or modified physical values/functions backed up with a scientific reference (including doi) in the docs? -
(if not applicable remove) if the examples are modified, is the documentation regenerated (using generate_example_docs.py
)
Edited by Martin Schneider