Feature/gridformat writer
What this MR does / why does DuMux need it:
Adds gridformat as git submodule and a wrapper around its generic readers/writers in order to provide I/O from/to various grid file formats.
TODO:
-
Discuss class and file names. The current choice was made s.t. the include is #include <dumux/io/gridwriter.hh>
, since it's generic over the formats... -
Support discontinuous output. Could be achieved by adding a separate template argument and perform a similar mechanism as currently done for the lagrange wrapper (i.e. add one more wrapper layer around the stored grid...). EDIT: will be done in a separate MR. -
Add support for vol-var output as in VTKOutputModule
. I suggest to derive from this writer and expose an additionalsetVolVarField
function, because for vol var output we need more things (e.g.GridVariables
,X
, etc...). By adding it as additional derived class we can keep simple output "simpler". EDIT: will be done in a separate MR.
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
)