#include <SiloFile.hpp>

Public Member Functions
	SiloFile ()
	Default Constructor.

virtual	~SiloFile ()
	Destructor.

void	makeSiloDirectories ()
	function to setup directories where silo files will be written

void	initialize (int const numGroups=1)
	Initializes silo for input/output. More...

void	finish ()
	finishes/closes up the silo interface

int	groupRank (int const i) const
	obtain the group number of the calling processor, indexed from zero. More...

void	waitForBatonWrite (int const domainNumber, int const cycleNum, integer const eventCounter, bool const isRestart)
	Wait for the Baton when writing using PMPIO. More...

void	waitForBaton (int const domainNumber, string const &restartFileName)
	Wait for the Baton when reading using PMPIO. More...

void	handOffBaton ()
	Hand off the Baton when done writing to file.

void	makeSubDirectory (string const &subdir, string const &rootdir)
	Make a subdirectory within the silo file. More...

void	writeMeshObject (string const &meshName, const localIndex nnodes, real64 coords[3], const globalIndex globalNodeNum, char const const ghostNodeName, char const const ghostZoneName, int const numShapes, int const shapecnt, const localIndex const const meshConnectivity, const globalIndex const const globalElementNum, int const const shapetype, int const *const shapesize, int const cycleNumber, real64 const problemTime)
	Write out a single silo mesh object. More...

void	writePolygonMeshObject (const string &meshName, const localIndex nnodes, real64 coords[3], const globalIndex dummy1, const int numRegions, const int shapecnt, const localIndex const const meshConnectivity, const globalIndex const const globalElementNum, const int const const dummy2, const int const shapetype, const int *const shapesize, const int cycleNumber, const real64 problemTime, const int lnodelist)

void	writeDomainPartition (DomainPartition const &domain, int const cycleNum, real64 const problemTime, bool const isRestart)
	write a domain parititon out to silo file More...

void	writeElementMesh (ElementRegionBase const &elementRegion, NodeManager const &nodeManager, string const &meshName, const localIndex nnodes, real64 coords[3], globalIndex const const globalNodeNum, char const *const ghostNodeFlag, int const cycleNumber, real64 const problemTime, bool &writeArbitraryPolygon)

void	writeMeshLevel (MeshLevel const &meshLevel, int const cycleNum, real64 const problemTime, bool const isRestart)
	write a mesh level out to the silo file More...

void	writePointMesh (string const &meshName, const localIndex numPoints, real64 *coords[3], int const cycleNumber, real64 const problemTime)

void	writeBeamMesh (string const &meshName, const localIndex nnodes, real64 *coords[3], const localIndex_array &node1, const localIndex_array &node2, int const cycleNumber, real64 const problemTime)
	write a beam mesh to silo file More...

void	writeBeamMesh (string const &meshName, const localIndex nnodes, real64 *coords[3], integer_array &nodelist, int const cycleNumber, real64 const problemTime)

void	writeMaterialMapsFullStorage (ElementRegionBase const &elementRegion, string const &meshName, string_array const &regionMaterialList, int const cycleNumber, real64 const problemTime)

void	writeGroupSilo (dataRepository::Group const &group, string const &siloDirName, string const &meshname, int const centering, int const cycleNum, real64 const problemTime, bool const isRestart, const localIndex_array &mask)

void	writeElementRegionSilo (ElementRegionBase const &elemRegion, string const &siloDirName, string const &meshName, int const cycleNum, real64 const problemTime, bool const isRestart)

template<typename OUTPUTTYPE >
void	writeWrappersToSilo (string const &meshname, const dataRepository::Group::wrapperMap &wrappers, int const centering, int const cycleNum, real64 const problemTime, bool const isRestart, string const &multiRoot, const localIndex_array &mask)

template<typename OUTTYPE , typename TYPE >
void	writeDataField (string const &meshName, string const &fieldName, arrayView1d< TYPE const > const &field, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot)

template<typename OUTTYPE , typename TYPE , int USD>
void	writeDataField (string const &meshName, string const &fieldName, arrayView2d< TYPE const, USD > const &field, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot)

template<typename OUTTYPE , typename TYPE , int USD>
void	writeDataField (string const &meshName, string const &fieldName, arrayView3d< TYPE const, USD > const &field, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot)

template<typename OUTTYPE , typename TYPE , int NDIM, int USD>
void	writeDataField (string const &meshName, string const &fieldName, ArrayView< TYPE const, NDIM, USD > const &field, int const siloTensorRank, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot)

template<typename OUTTYPE , typename TYPE >
void	writeMaterialDataField (string const &meshName, string const &fieldName, array1d< array1d< arrayView2d< TYPE const > > > const &field, ElementRegionBase const &elemRegion, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot, string_array const &materialNames)

template<typename OUTTYPE , typename TYPE >
void	writeMaterialDataField2d (string const &meshName, string const &fieldName, ElementRegionBase const &elemRegion, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot, string_array const &materialNames)

template<typename OUTTYPE , typename TYPE >
void	writeMaterialDataField3d (string const &meshName, string const &fieldName, ElementRegionBase const &elemRegion, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot, string_array const &materialNames)

template<typename OUTTYPE , typename TYPE >
void	writeMaterialDataField4d (string const &meshName, string const &fieldName, ElementRegionBase const &elemRegion, int const centering, int const cycleNumber, real64 const problemTime, string const &multiRoot, string_array const &materialNames)

void	writeMaterialVarDefinition (string const &subDir, string const &matDir, localIndex const matIndex, string const &fieldName)

void	writeStressVarDefinition (string const &MatDir)

void	writeVectorVarDefinition (string const &fieldName, string const &subDirectory)

int	getMeshType (string const &meshName) const

template<typename CBF >
void	writeMultiXXXX (const DBObjectType type, CBF DBPutMultiCB, int const centering, string const name, int const cycleNumber, string const &multiRoot, const DBoptlist *optlist=nullptr)

void	clearEmptiesFromMultiObjects (int const cycleNum)

void	setNumGroups (int const numGroups)
	Sets the number of individual Silo files to generate. More...

void	setPlotLevel (int const plotLevel)
	Sets the plot level option. More...

void	setWriteEdgeMesh (int const val)
	Sets the edge mesh output option. More...

void	setWriteFaceMesh (int const val)
	Sets the face mesh output option. More...

void	setWriteCellElementMesh (int const val)
	Sets the cell element mesh output option. More...

void	setWriteFaceElementMesh (int const val)
	Sets the face element mesh output option. More...

void	setPlotFileRoot (string const &fileRoot)
	Sets root of the filename that will be read/written. More...

void	setOutputDirectory (string const &path)
	Sets the top-level output directory, under which Silo's output dir is nested. More...

void	setOnlyPlotSpecifiedFieldNamesFlag (integer const onlyPlotSpecifiedFieldNames)
	Set the flag to decide whether we only plot the fields specified by fieldNames, or if we also plot fields based on plotLevel. More...

void	setFieldNames (arrayView1d< string const > const &fieldNames)
	Set the names of the fields to output. More...

Detailed Description

This class serves as a wrapper to isolate the code from the specifics of SILO output/input. Its members contain all the necessary information for reading/writing a group of SILO files.

Definition at line 55 of file SiloFile.hpp.

Member Function Documentation

◆ clearEmptiesFromMultiObjects()

void geos::SiloFile::clearEmptiesFromMultiObjects ( int const cycleNum )

function to clear any empty multi-objects

Parameters

cycleNum When we write our multimesh and multivar objects, we do it assuming that there is a non-empty multimesh or multivar object on each domain. This is incorrect, so we must modify the rootfile to remove empty references to the multivar or multimesh objects and replace their path with "EMPTY"

◆ getMeshType()

int geos::SiloFile::getMeshType ( string const & meshName ) const

find the silo mesh type that we are attempting to reference

Parameters

meshName the name of the mesh object we are attaching data to

Returns: integer that results from a call to DBInqMeshtype()

◆ groupRank()

int geos::SiloFile::groupRank ( int const i ) const

obtain the group number of the calling processor, indexed from zero.

Parameters

i	rank of calling processor in the MPI communicator

Returns: group number of the calling processor, indexed from zero

◆ initialize()

void geos::SiloFile::initialize ( int const numGroups = 1 )

Initializes silo for input/output.

Parameters

numGroups number of individual Silo files to generate

◆ makeSubDirectory()

void geos::SiloFile::makeSubDirectory	(	string const &	subdir,
		string const &	rootdir
	)

inline

Make a subdirectory within the silo file.

Parameters

subdir	the new directory name
rootdir	the root directory path

Definition at line 122 of file SiloFile.hpp.

◆ setFieldNames()

void geos::SiloFile::setFieldNames ( arrayView1d< string const > const & fieldNames )

inline

Set the names of the fields to output.

Parameters

[in] fieldNames the fields to output

Definition at line 678 of file SiloFile.hpp.

◆ setNumGroups()

void geos::SiloFile::setNumGroups ( int const numGroups )

inline

Sets the number of individual Silo files to generate.

Parameters

numGroups number of individual Silo files to generate

Definition at line 597 of file SiloFile.hpp.

◆ setOnlyPlotSpecifiedFieldNamesFlag()

void geos::SiloFile::setOnlyPlotSpecifiedFieldNamesFlag ( integer const onlyPlotSpecifiedFieldNames )

inline

Set the flag to decide whether we only plot the fields specified by fieldNames, or if we also plot fields based on plotLevel.

Parameters

[in] onlyPlotSpecifiedFieldNames the flag

Definition at line 669 of file SiloFile.hpp.

◆ setOutputDirectory()

void geos::SiloFile::setOutputDirectory ( string const & path )

inline

Sets the top-level output directory, under which Silo's output dir is nested.

Parameters

path	output directory path

Definition at line 660 of file SiloFile.hpp.

◆ setPlotFileRoot()

void geos::SiloFile::setPlotFileRoot ( string const & fileRoot )

inline

Sets root of the filename that will be read/written.

Parameters

fileRoot root of the filename

Definition at line 651 of file SiloFile.hpp.

◆ setPlotLevel()

void geos::SiloFile::setPlotLevel ( int const plotLevel )

inline

Sets the plot level option.

Parameters

plotLevel the plot level desired value

Definition at line 606 of file SiloFile.hpp.

◆ setWriteCellElementMesh()

void geos::SiloFile::setWriteCellElementMesh ( int const val )

inline

Sets the cell element mesh output option.

Parameters

val	if 1 the cell element mesh is written to a Silo file

Definition at line 633 of file SiloFile.hpp.

◆ setWriteEdgeMesh()

void geos::SiloFile::setWriteEdgeMesh ( int const val )

inline

Sets the edge mesh output option.

Parameters

val	if 1, the edge mesh is written to a Silo file

Definition at line 615 of file SiloFile.hpp.

◆ setWriteFaceElementMesh()

void geos::SiloFile::setWriteFaceElementMesh ( int const val )

inline

Sets the face element mesh output option.

Parameters

val	if 1 the face element mesh is written to a Silo file

Definition at line 642 of file SiloFile.hpp.

◆ setWriteFaceMesh()

void geos::SiloFile::setWriteFaceMesh ( int const val )

inline

Sets the face mesh output option.

Parameters

val	if 1, the face mesh is written to a Silo file

Definition at line 624 of file SiloFile.hpp.

◆ waitForBaton()

void geos::SiloFile::waitForBaton	(	int const	domainNumber,
		string const &	restartFileName
	)

Wait for the Baton when reading using PMPIO.

Parameters

domainNumber	domain partition number
restartFileName	base of the restart file to open

◆ waitForBatonWrite()

void geos::SiloFile::waitForBatonWrite	(	int const	domainNumber,
		int const	cycleNum,
		integer const	eventCounter,
		bool const	isRestart
	)

Wait for the Baton when writing using PMPIO.

Parameters

domainNumber	domain partition number
cycleNum	cycle number of simulation
eventCounter	Counter to indicate the event number during the current timestep.
isRestart	whether or not we are writing a restart file

This function requests the write baton from silo PMPIO. The involves determining the file names, and opening the file for write.

◆ writeBeamMesh() [1/2]

void geos::SiloFile::writeBeamMesh	(	string const &	meshName,
		const localIndex	nnodes,
		real64 *	coords[3],
		const localIndex_array &	node1,
		const localIndex_array &	node2,
		int const	cycleNumber,
		real64 const	problemTime
	)

write a beam mesh to silo file

Parameters

meshName	name of the mesh to write
nnodes	number of nodes
coords	array[3] of pointers to x, y, and z.
node1	array of the first node for each element
node2	array of the second node for each element
cycleNumber	current cycle number
problemTime	current problem time

◆ writeBeamMesh() [2/2]

void geos::SiloFile::writeBeamMesh	(	string const &	meshName,
		const localIndex	nnodes,
		real64 *	coords[3],
		integer_array &	nodelist,
		int const	cycleNumber,
		real64 const	problemTime
	)

Parameters

meshName	name of the mesh to write
nnodes	number of nodes
coords	array[3] of pointers to x, y, and z.
nodelist	nodal connectivity array
cycleNumber	current cycle number
problemTime	current problem time

◆ writeDataField() [1/4]

template<typename OUTTYPE , typename TYPE >

void geos::SiloFile::writeDataField	(	string const &	meshName,
		string const &	fieldName,
		arrayView1d< TYPE const > const &	field,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot
	)

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
field	field data
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries

◆ writeDataField() [2/4]

template<typename OUTTYPE , typename TYPE , int USD>

void geos::SiloFile::writeDataField	(	string const &	meshName,
		string const &	fieldName,
		arrayView2d< TYPE const, USD > const &	field,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot
	)

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
field	field data
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries

◆ writeDataField() [3/4]

template<typename OUTTYPE , typename TYPE , int USD>

void geos::SiloFile::writeDataField	(	string const &	meshName,
		string const &	fieldName,
		arrayView3d< TYPE const, USD > const &	field,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot
	)

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
field	field data
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries

◆ writeDataField() [4/4]

template<typename OUTTYPE , typename TYPE , int NDIM, int USD>

void geos::SiloFile::writeDataField	(	string const &	meshName,
		string const &	fieldName,
		ArrayView< TYPE const, NDIM, USD > const &	field,
		int const	siloTensorRank,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot
	)

Todo:: Verify: documentation missing / incomplete

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
field	field data
siloTensorRank	**** UNUSED IN THE IMPLEMENTATION ****
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries

◆ writeDomainPartition()

void geos::SiloFile::writeDomainPartition	(	DomainPartition const &	domain,
		int const	cycleNum,
		real64 const	problemTime,
		bool const	isRestart
	)

write a domain parititon out to silo file

Parameters

domain	the domain partition to write
cycleNum	the current cycle number
problemTime	the current problem time
isRestart	whether or not we want to write restart only data

◆ writeElementMesh()

void geos::SiloFile::writeElementMesh	(	ElementRegionBase const &	elementRegion,
		NodeManager const &	nodeManager,
		string const &	meshName,
		const localIndex	nnodes,
		real64 *	coords[3],
		globalIndex const *const	globalNodeNum,
		char const *const	ghostNodeFlag,
		int const	cycleNumber,
		real64 const	problemTime,
		bool &	writeArbitraryPolygon
	)

Todo:: Verify: documentation missing / incomplete.

Parameters

elementRegion	the element region that holds the data to be written to the silo file
nodeManager	the NodeManager containing the nodes of the domain to be output
meshName	name of the mesh to write
nnodes	number of nodes
coords	array[3] of pointers to x, y, and z.
globalNodeNum	array to the global node numbers. This might be redundant as there is a field for this.
ghostNodeFlag
cycleNumber	the current cycle number
problemTime	the current problem time
writeArbitraryPolygon

◆ writeElementRegionSilo()

void geos::SiloFile::writeElementRegionSilo	(	ElementRegionBase const &	elemRegion,
		string const &	siloDirName,
		string const &	meshName,
		int const	cycleNum,
		real64 const	problemTime,
		bool const	isRestart
	)

Parameters

elemRegion	the element region that holds the data to be written to the silo file
siloDirName	the name of the silo directory to put this data into (i.e. nodalFields, elemFields)
meshName	the name of the mesh attach this write to
cycleNum	current cycle number
problemTime	current problem time
isRestart	write restart only data

◆ writeGroupSilo()

void geos::SiloFile::writeGroupSilo	(	dataRepository::Group const &	group,
		string const &	siloDirName,
		string const &	meshname,
		int const	centering,
		int const	cycleNum,
		real64 const	problemTime,
		bool const	isRestart,
		const localIndex_array &	mask
	)

Parameters

group	the group that holds the data to be written to the silo file
siloDirName	the name of the silo directory to put this data into (i.e. nodalFields, elemFields)
meshname	the name of the mesh attach this write to
centering	the centering of the data (e.g. DB_ZONECENT)
cycleNum	current cycle number
problemTime	current problem time
isRestart	write restart only data
mask	indices to write out to the silo file

◆ writeMaterialDataField()

template<typename OUTTYPE , typename TYPE >

void geos::SiloFile::writeMaterialDataField	(	string const &	meshName,
		string const &	fieldName,
		array1d< array1d< arrayView2d< TYPE const > > > const &	field,
		ElementRegionBase const &	elemRegion,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot,
		string_array const &	materialNames
	)

Todo:: Verify: documentation missing / incomplete

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
field	field data
elemRegion	the element region that holds the data to be written to the silo file
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries
materialNames	material names

◆ writeMaterialDataField2d()

template<typename OUTTYPE , typename TYPE >

void geos::SiloFile::writeMaterialDataField2d	(	string const &	meshName,
		string const &	fieldName,
		ElementRegionBase const &	elemRegion,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot,
		string_array const &	materialNames
	)

Todo:: Verify: documentation missing / incomplete

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
elemRegion	the element region that holds the data to be written to the silo file
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries
materialNames	material names

◆ writeMaterialDataField3d()

template<typename OUTTYPE , typename TYPE >

void geos::SiloFile::writeMaterialDataField3d	(	string const &	meshName,
		string const &	fieldName,
		ElementRegionBase const &	elemRegion,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot,
		string_array const &	materialNames
	)

Todo:: Verify: documentation missing / incomplete

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
elemRegion	the element region that holds the data to be written to the silo file
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries
materialNames	material names

◆ writeMaterialDataField4d()

template<typename OUTTYPE , typename TYPE >

void geos::SiloFile::writeMaterialDataField4d	(	string const &	meshName,
		string const &	fieldName,
		ElementRegionBase const &	elemRegion,
		int const	centering,
		int const	cycleNumber,
		real64 const	problemTime,
		string const &	multiRoot,
		string_array const &	materialNames
	)

Todo:: Verify: documentation missing / incomplete

Parameters

meshName	the name of the mesh attach this write to
fieldName	name of the field to write
elemRegion	the element region that holds the data to be written to the silo file
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNumber	the current cycle number
problemTime	the current problem time
multiRoot	location to write the multivar entries
materialNames	material names

◆ writeMaterialMapsFullStorage()

void geos::SiloFile::writeMaterialMapsFullStorage	(	ElementRegionBase const &	elementRegion,
		string const &	meshName,
		string_array const &	regionMaterialList,
		int const	cycleNumber,
		real64 const	problemTime
	)

Parameters

elementRegion	the element region that holds the data to be written to the silo file
meshName	name of the mesh to write
regionMaterialList	region material list
cycleNumber	current cycle number
problemTime	current problem time

◆ writeMaterialVarDefinition()

void geos::SiloFile::writeMaterialVarDefinition	(	string const &	subDir,
		string const &	matDir,
		localIndex const	matIndex,
		string const &	fieldName
	)

Todo:: Verify: documentation missing / incomplete

Parameters

subDir
matDir
matIndex
fieldName

◆ writeMeshLevel()

void geos::SiloFile::writeMeshLevel	(	MeshLevel const &	meshLevel,
		int const	cycleNum,
		real64 const	problemTime,
		bool const	isRestart
	)

write a mesh level out to the silo file

Parameters

meshLevel	the meshLevel to write out
cycleNum	the current cycle number
problemTime	the current problem time
isRestart	whether or not we want to write restart only data

◆ writeMeshObject()

void geos::SiloFile::writeMeshObject	(	string const &	meshName,
		const localIndex	nnodes,
		real64 *	coords[3],
		const globalIndex *	globalNodeNum,
		char const *const	ghostNodeName,
		char const *const	ghostZoneName,
		int const	numShapes,
		int const *	shapecnt,
		const localIndex const const	meshConnectivity,
		const globalIndex const const	globalElementNum,
		int const *const	shapetype,
		int const *const	shapesize,
		int const	cycleNumber,
		real64 const	problemTime
	)

Write out a single silo mesh object.

Parameters

meshName	name of the mesh in the silo db
nnodes	number of nodes
coords	array[3] of pointers to x, y, and z.
globalNodeNum	array to the global node numbers. This might be redundant as there is a field for this.
ghostNodeName	Character array for whether or not a node is a ghost. ( 0 = local, 1 = ghost )
ghostZoneName	Character array for whether or not a zone is a ghost. ( 0 = local, 1 = ghost )
numShapes	number of element zone type (i.e. number of zone types with different topology)
shapecnt	pointer to array that contains the number of zones per shape type
meshConnectivity	pointer to array that contains the zone to element map for each zone type
globalElementNum	pointer to array of global zone numbers for each shape type
shapetype	pointer to array containing the shape types
shapesize	pointer to array containing the number of nodes in each zone in the shape types
cycleNumber	the current cycle number
problemTime	the current problem time

This function takes in the the required data to call a silo::DBPutUcdMesh() and a DBPutZonelist2, and calls those functions to create a silo mesh object. In addition the MultiVar is written in the root file.

◆ writeMultiXXXX()

template<typename CBF >

void geos::SiloFile::writeMultiXXXX	(	const DBObjectType	type,
		CBF	DBPutMultiCB,
		int const	centering,
		string const	name,
		int const	cycleNumber,
		string const &	multiRoot,
		const DBoptlist *	optlist = `nullptr`
	)

write out a multi mesh or multivar object assocaited with a mesh or var object.

Parameters

type	the object type (DB_UCDVAR, ...)
DBPutMultiCB	a callback function for the placement of the multi object. ( DBPutMultivar, DBPutMultimesh...)
centering	the centering of the data (DB_NODECENT, DB_ZONECENT, ...)
name	the name of the multivar
cycleNumber	the current cycle number
multiRoot	the location in the silo file to put hte multiXXXX
optlist	the option list assocaited with the multiXXXX

◆ writePointMesh()

void geos::SiloFile::writePointMesh	(	string const &	meshName,
		const localIndex	numPoints,
		real64 *	coords[3],
		int const	cycleNumber,
		real64 const	problemTime
	)

Parameters

meshName	name of the mesh to write
numPoints	number of points to write
coords	array[3] of pointers to x, y, and z.
cycleNumber	current cycle number
problemTime	current problem time

◆ writePolygonMeshObject()

void geos::SiloFile::writePolygonMeshObject	(	const string &	meshName,
		const localIndex	nnodes,
		real64 *	coords[3],
		const globalIndex *	dummy1,
		const int	numRegions,
		const int *	shapecnt,
		const localIndex const const	meshConnectivity,
		const globalIndex const const	globalElementNum,
		const int const const	dummy2,
		const int *const	shapetype,
		const int *const	shapesize,
		const int	cycleNumber,
		const real64	problemTime,
		const int	lnodelist
	)

Todo:: Verify: documentation missing / incomplete. The TPL version of doxygen on CI cannot parse unnamed parameters, dummy parameter introduced to remove warning

Parameters

meshName	name of the mesh in the silo db
nnodes	number of nodes
coords	array[3] of pointers to x, y, and z.
dummy1	unused parameter
numRegions
shapecnt	pointer to array that contains the number of zones per shape type
meshConnectivity	pointer to array that contains the zone to element map for each zone type
globalElementNum	pointer to array of global zone numbers for each shape type
dummy2	unused parameter
shapetype	pointer to array containing the shape types
shapesize	pointer to array containing the number of nodes in each zone in the shape types
cycleNumber	the current cycle number
problemTime	the current problem time
lnodelist

◆ writeStressVarDefinition()

void geos::SiloFile::writeStressVarDefinition ( string const & MatDir )

Todo:: Verify: documentation missing / incomplete

Parameters

MatDir

◆ writeVectorVarDefinition()

void geos::SiloFile::writeVectorVarDefinition	(	string const &	fieldName,
		string const &	subDirectory
	)

Todo:: Verify: documentation missing / incomplete

Parameters

fieldName	vector field name
subDirectory

◆ writeWrappersToSilo()

template<typename OUTPUTTYPE >

void geos::SiloFile::writeWrappersToSilo	(	string const &	meshname,
		const dataRepository::Group::wrapperMap &	wrappers,
		int const	centering,
		int const	cycleNum,
		real64 const	problemTime,
		bool const	isRestart,
		string const &	multiRoot,
		const localIndex_array &	mask
	)

Writes the contents of a group of Wrapper objects

Template Parameters

the	output variable type

Parameters

meshname	the name of the mesh attach this write to
wrappers	a group of wrappers
centering	the silo centering to use for this operation (DB_NODECENT, DB_ZONECENT)
cycleNum	the current cycle number
problemTime	the current problem time
isRestart	write restart only data
multiRoot	location to write the multivar entries
mask	indices to write out to the silo file

The documentation for this class was generated from the following file:

coreComponents/fileIO/silo/SiloFile.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ clearEmptiesFromMultiObjects()

◆ getMeshType()

◆ groupRank()

◆ initialize()

◆ makeSubDirectory()

◆ setFieldNames()

◆ setNumGroups()

◆ setOnlyPlotSpecifiedFieldNamesFlag()

◆ setOutputDirectory()

◆ setPlotFileRoot()

◆ setPlotLevel()

◆ setWriteCellElementMesh()

◆ setWriteEdgeMesh()

◆ setWriteFaceElementMesh()

◆ setWriteFaceMesh()

◆ waitForBaton()

◆ waitForBatonWrite()

◆ writeBeamMesh() [1/2]

◆ writeBeamMesh() [2/2]

◆ writeDataField() [1/4]

◆ writeDataField() [2/4]

◆ writeDataField() [3/4]

◆ writeDataField() [4/4]

◆ writeDomainPartition()

◆ writeElementMesh()

◆ writeElementRegionSilo()

◆ writeGroupSilo()

◆ writeMaterialDataField()

◆ writeMaterialDataField2d()

◆ writeMaterialDataField3d()

◆ writeMaterialDataField4d()

◆ writeMaterialMapsFullStorage()

◆ writeMaterialVarDefinition()

◆ writeMeshLevel()

◆ writeMeshObject()

◆ writeMultiXXXX()

◆ writePointMesh()

◆ writePolygonMeshObject()

◆ writeStressVarDefinition()

◆ writeVectorVarDefinition()

◆ writeWrappersToSilo()