Skip to content
Snippets Groups Projects
Commit 7012fdcd authored by David Seus's avatar David Seus
Browse files

explain function.py

parent 88767050
Branches
No related tags found
No related merge requests found
......@@ -19,10 +19,23 @@ which gets called by the `main()` of each usecase (more precisely by
## `boundary_and_interface.py`
## `solutionFile.py`
This file defines a class `SolutionFile(dolfin.XDMFFile)` around the `dolfin`
`XDMFFile` class and sets some parameters for the files in which the solution
gets saved.
## `domainSubstructuring.py`
This file defines various subdomains and their subdomain substructurings to be
used in the simulation. A lengthy explanation on how to define your own substructurings is given in the file itself.
Most likely, you will learn how to to this by looking at the examples given in the file.
## `functions.py`
This file defines data functions like relative permeabilities and pc-S relationships along with methods `generate_relative_permeability_dicts` and
`generate_Spc_dicts` to generate dictionaries of callables that get passed to
the simulation class.
This was done in an attempt to tidy the usecases and have a central place in which to define data functions.
New relative permeabilites and pc-S relationships must be specified here and
the corresponding generator functions
`generate_relative_permeability_dicts` and `generate_Spc_dicts` need to be adjusted accordingly.
## `helpers.py`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment