Skip to content

feature/flux-documentation-forchheimer

Leon Keim requested to merge feature/flux-documentation-forchheimer into master

What this MR does / why does DuMux need it:

Description of the Forchheimer fluxes is now in forchheimerslaw.hh . Should be more visible there. Most of the description is taken from the forchheimervelocity.hh . At the End there should be a description for every flux in Dumux. "Related to #1149 (closed)"

Notes for the reviewer

Is this the way as intended? The question is also, if the Forchheimer law should be mentioned in the description of 1p model etc? Currently there is only one test for 1p, but it seems like it should work for every Darcy velocity. Should I add a link to this description in every model with a Darcy velocity? Maybe another Issue would be to make new tests for Forchheimers law.

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?
Edited by Timo Koch

Merge request reports