OGS
|
The OGS input file parameters are documented in the page hierarchy rooted here. A project file has the ending .prj
and is a valid XML document. To check proper formatting you can use xmllint
, see usage instructions in the documentation.
Depending on the type of the parameters the corresponding page titles have different prefixes, namely:
<type>
tag in the input file.<type>Constant</type>
) vs. [case] MeshNode (<type>MeshNode</type>
)The input file parameters are documented within a tree structure (cf. the navigation tree on the left). This structure resembles the XML document tree of the input files, however, there are some small differences (see below).
Currently two different input files are documented: The project file (prj) and the geometry file (gml). All other cases on the top level do not represent separate input files but rather are shortcuts to certain project file sections, which are provided only in order to keep the documentation tree flat, they have no other special meaning.
A path in the documentation tree corresponds to a path in the prj or gml input file, e.g., [tag] boundary_condition corresponds to the path process_variables.process_variable.boundary_conditions.boundary_condition
in the project file (here parent and child tags are separated by a dot).
Note: The top level XML tags (i.e., <OpenGeoSysProject>
and <OpenGeoSysGLI>
) have been omitted in the entire documentation for the sake of brevity.
There are two exceptions to this rule, both related to the [case] prefix:
process_variables.process_variable.boundary_conditions.boundary_condition.geometry
.parameters.parameter.field_name
in the project file.MeshNode
.Used in no end-to-end test cases.