Commit b935e645 authored by Lukas Riedel's avatar Lukas Riedel

Introduce new category [grid.mapping] to common config parameters

* rename `grid.mappingFile` to `grid.mapping.file`.
* rename `grid.mappingFileDataset` to `grid.mapping.volume`.
* remove `grid.globalIndex`. Same functionality is provided by setting
    `grid.mapping.volume` to an integer index.
* add keys for boundary mapping datasets.
parent d541b01c
......@@ -76,28 +76,72 @@ adding an empty line, make text **bold** or ``monospaced``.
<values> int </values>
<suggestion> 0 </suggestion>
</parameter>
</category>
<parameter name="mappingFile">
<definition> The H5 file containing the mapping from cell to medium index.
Specify the dataset inside the file with the next key. Leave empty or
set to ``None`` for a global homogeneous medium. In this case,
``grid.globalIndex`` has to be specified.
<category name="grid.mapping">
<parameter name="file">
<definition> The H5 file containing all mapping datasets.
Leave empty or set to ``None`` for global mappings.
</definition>
<values> path </values>
<comment> This category is only used for 'rectangular' grids </comment>
</parameter>
<parameter name="mappingFileDataset">
<definition> The H5 dataset inside ``grid.mappingFile`` containing the
mapping from cell to medium index.
<parameter name="volume">
<definition> The H5 dataset containing the
mapping from cell to medium index. May specify a global index for the
entire volume if its value can be parsed as ``int``.
</definition>
<values> path </values>
<values> path or int </values>
</parameter>
<parameter name="globalIndex">
<definition> The medium index to use for all grid cells, if
``mappingFile`` is unset or ``None``.
<parameter name="boundaryLower">
<definition> The H5 dataset mapping the lower boundary faces to
boundary condition indices. May specify a global index for the
boundary if its value can be parsed as ``int``.
</definition>
<values> int </values>
<values> path or int </values>
</parameter>
<parameter name="boundaryUpper">
<definition> The H5 dataset mapping the upper boundary faces to
boundary condition indices. May specify a global index for the
boundary if its value can be parsed as ``int``.
</definition>
<values> path or int </values>
</parameter>
<parameter name="boundaryLeft">
<definition> The H5 dataset mapping the left boundary faces to
boundary condition indices. May specify a global index for the
boundary if its value can be parsed as ``int``.
</definition>
<values> path or int </values>
</parameter>
<parameter name="boundaryRight">
<definition> The H5 dataset mapping the right boundary faces to
boundary condition indices. May specify a global index for the
boundary if its value can be parsed as ``int``.
</definition>
<values> path or int </values>
</parameter>
<parameter name="boundaryFront">
<definition> The H5 dataset mapping the front boundary faces to
boundary condition indices (3D only). May specify a global index for
the boundary if its value can be parsed as ``int``.
</definition>
<values> path or int </values>
<comment> Only in 3D </comment>
</parameter>
<parameter name="boundaryBack">
<definition> The H5 dataset mapping the back boundary faces to
boundary condition indices (3D only). May specify a global index for
the boundary if its value can be parsed as ``int``.
</definition>
<values> path or int </values>
</parameter>
</category>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment