Improved in-line help comments; output MPI cell values to HDF5 only when saving mesh to HDF5; removed timing data

This commit is contained in:
Josh Bowden
2023-12-14 10:27:05 +01:00
parent e16cd9a3b3
commit 55dc80725f
5 changed files with 28 additions and 18 deletions

View File

@@ -212,7 +212,7 @@ public:
/**
* Constructor - sets private data values and dos not initialise the shared memory area.
*
* N.B. These objects need a matching <variable ...> and <paramater ...> in the Damaris XML file
* N.B. These objects need a matching <variable ...> and <paramater ...> entries in the Damaris XML file
*
* Two usages:
* Example XML definition:
@@ -293,7 +293,7 @@ public:
* by specifying the values for the variables parameters .
* i.e. makes the data() pointer available and sets the size of the memory block it points to.
*
* N.B. These objects need a matching <variable ...> and <paramater ...> in the Damaris XML file
* N.B. These objects need a matching <variable ...> and <paramater ...> entries in the Damaris XML file
*
* Example use:
* Example XML definition:

View File

@@ -35,11 +35,11 @@
to get the references into the vertex array and element (aka cell) types for
the sub-partition. This allows the full set of vertices to be reused for
visualisation of the various sub-partitions, at the expense of copying all
the vertices. Typically a user is interested in the interiorBoarder elements
the vertices. Typically a user is interested in the interiorBorder elements
which make use of the bulk (~80%) of the vertices. This saves having to
renumber the indexes to the vertices for the sub-partitions. The vertex data
can be retrieved as seperate x, y and z arrays, or as a single array of
structures, or as a single structure of arrays based
array of structures, or as single structure of arrays based array.
Example:
@@ -480,11 +480,11 @@ public:
ConnectivityVertexOrder whichOrder,
long max_size = 0) {
if (max_size < ncorners_) {
// assert(max_size >= ncorners_);
OPM_THROW(
std::runtime_error,
"Opm::GridDataOutput::writeConnectivity( T* connectivity_inout ) " +
" Input objects size (" + std::to_string(max_size) +
"Opm::GridDataOutput::writeConnectivity( T* connectivity_inout,... ) " +
" Input max_size value (" + std::to_string(max_size) +
") is not sufficient to fit the ncorners_ values (" +
std::to_string(ncorners_) + ")");
}
@@ -622,7 +622,7 @@ public:
OPM_THROW(std::runtime_error,
"Opm::GridDataOutput::writeOffsetsCells( VectType& "
"offsets_inout ) " +
" Input objects check_size (" + std::to_string(check_size) +
" Input objects size (" + std::to_string(offsets_inout.size()) +
") is not sufficient to fit the ncells_ values (" +
std::to_string(ncells_) + ")");
}

View File

@@ -55,7 +55,7 @@ std::string initDamarisXmlFile()
<variable name="PRESSURE" layout="zonal_layout_usmesh" type="scalar" visualizable="true" mesh="us_mesh" unit="_PRESSURE_UNIT_" centering="zonal" select-file="GLOBAL_CELL_INDEX" store="_MYSTORE_OR_EMPTY_REGEX_" script="_MAKE_AVAILABLE_IN_PYTHON_" />
_MORE_VARIABLES_REGEX_
<variable name="MPI_RANK" layout="zonal_layout_usmesh_integer" type="scalar" visualizable="true" mesh="us_mesh" unit="rank" centering="zonal" store="_MYSTORE_OR_EMPTY_REGEX_" time-varying="false" select-file="GLOBAL_CELL_INDEX" script="_MAKE_AVAILABLE_IN_PYTHON_" comment="The MPI rank of each cell"/>
<variable name="MPI_RANK" layout="zonal_layout_usmesh_integer" type="scalar" visualizable="true" mesh="us_mesh" unit="rank" centering="zonal" store="_MYSTORE_MESH_OR_EMPTY_REGEX_" time-varying="false" select-file="GLOBAL_CELL_INDEX" script="_MAKE_AVAILABLE_IN_PYTHON_" comment="The MPI rank of each cell"/>
<variable name="KRNSW_GO" layout="zonal_layout_usmesh" type="scalar" visualizable="true" mesh="#" unit="" centering="zonal" time-varying="true" select-file="GLOBAL_CELL_INDEX" store="#" script="#" />
<variable name="KRNSW_OW" layout="zonal_layout_usmesh" type="scalar" visualizable="true" mesh="#" unit="" centering="zonal" time-varying="true" select-file="GLOBAL_CELL_INDEX" store="#" script="#" />