Skip to content
Snippets Groups Projects
Commit 8414e6bd authored by Christoph Lehmann's avatar Christoph Lehmann Committed by Tom Fischer
Browse files

[Doc] updated project file docu start page

parent 36d1234d
No related branches found
No related tags found
No related merge requests found
......@@ -16,7 +16,7 @@ different prefixes, namely:
<tt>&lt;type&gt;</tt> tag in the input file.<br>
Example: \ref ogs_file_param__linear_solver
and \ref ogs_file_param__parameter__Constant (<tt>&lt;type&gt;Constant&lt;/type&gt;</tt>)
vs. \ref ogs_file_param__parameter__MeshProperty (<tt>&lt;type&gt;MeshProperty&lt;/type&gt;</tt>)
vs. \ref ogs_file_param__parameter__MeshNode (<tt>&lt;type&gt;MeshNode&lt;/type&gt;</tt>)
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
......@@ -48,15 +48,14 @@ prefix:
<tt>process_variables.process_variable.boundary_conditions.boundary_condition.geometry</tt>.
2. Cases that distinguish types do not translate to XML tags either.
They enclose a set of configuration settings that can be used at that specific point.<br>
Example: There is a \ref ogs_file_param__initial_condition__MeshProperty "MeshProperty"
initial condition, which has a
\ref ogs_file_param__initial_condition__MeshProperty__field_name "field_name" tag.
I.e., if you select the MeshProperty IC, you can (or must) specify the XML tag
with the path <tt>process_variables.process_variable.initial_condition.field_name</tt>
in the project file.<br>
The MeshProperty IC can be selected by setting the
\ref ogs_file_param__initial_condition__type "process_variables.process_variable.initial_condition.type" tag to
<tt>MeshProperty</tt>.
Example: There is a \ref ogs_file_param__parameter__MeshNode "MeshNode"
initial condition, which has a \ref
ogs_file_param__parameter__MeshNode__field_name "field_name" tag. I.e., if you
configure the MeshNode parameter, you can (or must) specify the XML tag with the
path <tt>parameters.parameter.field_name</tt> in the project file.<br> A
MeshNode parameter can be defined by setting the \ref
ogs_file_param__parameter__type "parameters.parameter.type" tag to
<tt>MeshNode</tt>.
# Further Information
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment