geos::SiloOutput Class Reference

#include <SiloOutput.hpp>

Inheritance diagram for geos::SiloOutput:

Public Member Functions
	SiloOutput (string const &name, Group *const parent)
	Constructor. More...
virtual	~SiloOutput () override
	Destructor.
virtual bool	execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Writes out a Silo plot file. More...
virtual void	cleanup (real64 const time_n, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Writes out a Silo plot file at the end of the simulation. More...
Public Member Functions inherited from geos::OutputBase
	OutputBase (string const &name, Group *const parent)
	Constructor. More...
virtual	~OutputBase () override
	Destructor.
virtual void	setupDirectoryStructure ()
	Method for setting up output directories.
string	childDirectory () const
	Get the path of the child directory where output will be written. More...
integer	parallelThreads () const
	Get the number of parallel threads to use to write plotfiles. More...
Public Member Functions inherited from geos::ExecutableGroup
virtual void	signalToPrepareForExecution (real64 const time_n, real64 const dt, integer const cycle, DomainPartition &domain)
	Inform the object that it expects to execute during the next timestep. More...
virtual real64	getTimestepRequest (real64 const time)
	Supplies the timestep request for this target to the event manager. More...
void	setTimesteppingBehavior (TimesteppingBehavior const timesteppingBehavior)
	Set the timestep behavior for a target. More...
TimesteppingBehavior	getTimesteppingBehavior () const
	Get the target's time step behavior. More...
Public Member Functions inherited from geos::dataRepository::Group
virtual bool	registerCallback (void *func, const std::type_info &funcType)
	Register a callback function on the group. More...
virtual void	reinit ()
	Performs re-initialization of certain variable depending on the solver being used.
	Group (string const &name, Group *const parent)
	Constructor. More...
	Group (string const &name, conduit::Node &rootNode)
	Constructor. More...
	Group (Group &&source)=default
	Move constructor. More...
virtual	~Group ()
	Destructor, deletes all Groups and Wrappers owned by this Group.
	Group ()=delete
	Deleted default constructor.
	Group (Group const &)=delete
	Deleted copy constructor.
Group &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...
Group &	operator= (Group &&)=delete
	Deleted move assignment operator. More...
void	printDataHierarchy (integer indent=0) const
	Prints the data hierarchy recursively. More...
string	dumpInputOptions () const
string	dumpSubGroupsNames () const
string	dumpWrappersNames () const
template<typename T = Group>
T &	registerGroup (string const &name, std::unique_ptr< T > newObject)
	Register a new Group as a sub-group of current Group. More...
template<typename T = Group>
T &	registerGroup (string const &name, T *newObject)
	Register a new Group as a sub-group of current Group. More...
template<typename T = Group>
T &	registerGroup (string const &name)
	Register a new Group as a sub-group of current Group. More...
template<typename T = Group>
T &	registerGroup (subGroupMap::KeyIndex const &keyIndex)
	Register a new Group as a sub-group of current Group. More...
template<typename T = Group, typename TBASE = Group>
T &	registerGroup (string const &name, string const &catalogName)
	Register a new Group as a sub-group of current Group. More...
void	deregisterGroup (string const &name)
	Removes a child group from this group. More...
virtual Group *	createChild (string const &childKey, string const &childName)
	Creates a new sub-Group using the ObjectCatalog functionality. More...
template<typename T = Group, typename KEY = void>
T *	getGroupPointer (KEY const &key)
	Return a pointer to a sub-group of the current Group. More...
template<typename T = Group, typename KEY = void>
const T *	getGroupPointer (KEY const &key) const
	Return a pointer to a sub-group of the current Group. More...
template<typename T = Group, typename KEY = void>
T &	getGroup (KEY const &key)
	Return a reference to a sub-group of the current Group. More...
template<typename T = Group, typename KEY = void>
const T &	getGroup (KEY const &key) const
	Return a reference to a sub-group of the current Group. More...
template<typename T = Group>
T &	getGroupByPath (string const &path)
	Retrieve a group from the hierarchy using a path. More...
template<typename T = Group>
const T &	getGroupByPath (string const &path) const
	Retrieve a group from the hierarchy using a path. More...
subGroupMap &	getSubGroups ()
	Get the subgroups object. More...
const subGroupMap &	getSubGroups () const
	Get the subgroups object. More...
localIndex	numSubGroups () const
	return the number of sub groups in this Group More...
std::vector< string >	getSubGroupsNames () const
template<typename T = Group>
bool	hasGroup (string const &name) const
	Check whether a sub-group exists. More...
template<typename T >
bool	hasSubGroupOfType () const
	Check whether a sub-group exists by type. More...
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA &&lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA &&lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroupsIndex (LAMBDA &&lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroupsIndex (LAMBDA &&lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...
template<typename LAMBDA >
void	forWrappers (LAMBDA &&lambda)
	Apply the given functor to wrappers. More...
template<typename LAMBDA >
void	forWrappers (LAMBDA &&lambda) const
	Apply the given functor to wrappers. More...
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA &&lambda)
	Apply the given functor to wrappers that can be cast to one of specified types. More...
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA &&lambda) const
	Apply the given functor to wrappers that can be cast to one of specified types. More...
virtual void	initialize_postMeshGeneration ()
	initialization post generation of the mesh.
void	initialize ()
	Run initialization functions on this and all subgroups. More...
virtual void	initializationOrder (string_array &order)
	Sets the initialization order for sub-Groups. More...
void	initializePostInitialConditions ()
	Initialization routine to be called after calling ApplyInitialConditions(). More...
void	postRestartInitializationRecursive ()
	Initialization routine to be called after calling reading a restart file. More...
void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when Include nodes are encountered. More...
void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
	Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...
void	postProcessInputRecursive ()
	Recursively call postProcessInput() to apply post processing after reading input values.
template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
	Create and register a Wrapper around a new object. More...
template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
	Create and register a Wrapper around a new object. More...
template<typename T >
Wrapper< T > &	registerWrapper (string const &name, std::unique_ptr< T > newObject)
	Register a Wrapper around a given object and take ownership. More...
template<typename T >
Wrapper< T > &	registerWrapper (string const &name, T *newObject)
	Register a Wrapper around an existing object, does not take ownership of the object. More...
WrapperBase &	registerWrapper (std::unique_ptr< WrapperBase > wrapper)
	Register and take ownership of an existing Wrapper. More...
void	deregisterWrapper (string const &name)
	Removes a Wrapper from this group. More...
void	generateDataStructureSkeleton (integer const level)
	Build a complete datastructure for schema generation. More...
virtual void	expandObjectCatalogs ()
	Expand any catalogs in the data structure.
virtual void	setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
	Inform the schema generator of any deviations between the xml and GEOS data structures. More...
virtual void	registerDataOnMeshRecursive (Group &meshBodies)
	Calls RegisterDataOnMesh() recursively. More...
virtual void	registerDataOnMesh (Group &meshBodies)
	Register data on mesh entities. More...
virtual localIndex	packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of wrappers. More...
virtual localIndex	packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices within a list of wrappers. More...
localIndex	packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices for all registered wrappers. More...
virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of wrappers to a buffer. More...
virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices within a list of wrappers. More...
localIndex	pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices for all registered wrappers. More...
virtual localIndex	unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE)
	Unpack a buffer. More...
template<typename KEY >
const WrapperBase &	getWrapperBase (KEY const &key) const
	Return a reference to a WrapperBase stored in this group. More...
template<typename KEY >
WrapperBase &	getWrapperBase (KEY const &key)
	Return a reference to a WrapperBase stored in this group. More...
indexType	getWrapperIndex (string const &name) const
const wrapperMap &	wrappers () const
	Get access to the internal wrapper storage. More...
wrapperMap &	wrappers ()
	Get access to the internal wrapper storage. More...
indexType	numWrappers () const
	Return the number of wrappers. More...
std::vector< string >	getWrappersNames () const
template<typename LOOKUP_TYPE >
bool	hasWrapper (LOOKUP_TYPE const &lookup) const
	Check if a wrapper exists. More...
template<typename T , typename LOOKUP_TYPE >
const Wrapper< T > &	getWrapper (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > &	getWrapper (LOOKUP_TYPE const &index)
	Retrieve a Wrapper stored in this group. More...
template<typename T , typename LOOKUP_TYPE >
const Wrapper< T > *	getWrapperPointer (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > *	getWrapperPointer (LOOKUP_TYPE const &index)
	Retrieve a Wrapper stored in this group. More...
template<typename T , typename LOOKUP_TYPE >
GEOS_DECLTYPE_AUTO_RETURN	getReference (LOOKUP_TYPE const &lookup) const
	Look up a wrapper and get reference to wrapped object. More...
template<typename T , typename LOOKUP_TYPE >
T &	getReference (LOOKUP_TYPE const &lookup)
	Look up a wrapper and get reference to wrapped object. More...
virtual void	resize (localIndex const newSize)
	Resize the group and all contained wrappers that resize with parent. More...
virtual void	reserve (indexType const newsize)
	Set the new capacity and reserve it in all wrappers that resize with parent. More...
localIndex	capacity () const
	Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...
localIndex	size () const
	Get the "size" of the group, which determines the number of elements in resizable wrappers. More...
const string &	getName () const
	Get group name. More...
string	getPath () const
	Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...
const DataContext &	getDataContext () const
template<typename KEY >
const DataContext &	getWrapperDataContext (KEY key) const
Group &	getParent ()
	Access the group's parent. More...
const Group &	getParent () const
	Access the group's parent. More...
bool	hasParent () const
localIndex	getIndexInParent () const
	Get the group's index within its parent group. More...
localIndex	getSubGroupIndex (keyType const &key) const
	Get the index of a sub-Group within this group. More...
int	sizedFromParent () const
	Check whether this Group is resized when its parent is resized. More...
Group &	setSizedFromParent (int val)
	Set whether this wrapper is resized when its parent is resized. More...
RestartFlags	getRestartFlags () const
	Get flags that control restart output of this group. More...
void	setRestartFlags (RestartFlags flags)
	Set flags that control restart output of this group. More...
InputFlags	getInputFlags () const
	Get input flags for schema generation. More...
void	setInputFlags (InputFlags flags)
	Set input flags for schema generation. More...
conduit::Node &	getConduitNode ()
	Return the Conduit node object associated with this group. More...
const conduit::Node &	getConduitNode () const
	Return the Conduit node object associated with this group. More...
void	prepareToWrite ()
	Register the group and its wrappers with Conduit.
void	finishWriting ()
	Write the group and its wrappers into Conduit.
void	loadFromConduit ()
	Read the group and its wrappers from Conduit.
void	enableLogLevelInput ()
	Enable verbosity input for object.
void	setLogLevel (integer const logLevel)
	Set verbosity level. More...
integer	getLogLevel () const

Static Public Member Functions
static string	catalogName ()
	Catalog name interface. More...
Static Public Member Functions inherited from geos::OutputBase
static string	catalogName ()
	Catalog name interface. More...
static void	setOutputDirectory (string const &outputDir)
	Setter for the output directory. More...
static string	getOutputDirectory ()
	Getter for the output directory. More...
static void	setFileNameRoot (string const &root)
	Setter for the file name root. More...
static string	getFileNameRoot ()
	Getter for the file name root. More...
Static Public Member Functions inherited from geos::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool	applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
	Apply a given functor to a container if the container can be cast to one of the specified types. More...
static CatalogInterface::CatalogType &	getCatalog ()
	Get the singleton catalog for this class. More...

Additional Inherited Members
Public Types inherited from geos::ExecutableGroup
enum	TimesteppingBehavior : integer { TimesteppingBehavior::DeterminesTimeStepSize, TimesteppingBehavior::DoesNotDetermineTimeStepSize }
	Timestepping type. More...
Public Types inherited from geos::dataRepository::Group
using	subGroupMap = MappedVector< Group, Group *, keyType, indexType >
	The template specialization of MappedVector to use for the collection of sub-Group objects.
using	wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
	The template specialization of MappedVector to use for the collection wrappers objects.
using	CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.
Protected Member Functions inherited from geos::OutputBase
virtual void	initializePreSubGroups () override
	Do initialization prior to calling initialization operations on the subgroups. More...
Protected Member Functions inherited from geos::dataRepository::Group
virtual void	initializePostSubGroups ()
	Called by Initialize() after to initializing sub-Groups.
virtual void	initializePostInitialConditionsPreSubGroups ()
	Called by InitializePostInitialConditions() prior to initializing sub-Groups.
virtual void	initializePostInitialConditionsPostSubGroups ()
	Called by InitializePostInitialConditions() after to initializing sub-Groups.
virtual void	postRestartInitialization ()
	Performs initialization required after reading from a restart file.

Detailed Description

A class for creating silo-based outputs

Definition at line 33 of file SiloOutput.hpp.

Constructor & Destructor Documentation

SiloOutput()

geos::SiloOutput::SiloOutput	(	string const &	name,
		Group *const	parent
	)

Constructor.

Parameters

name	The name of this Group.
parent	The parent Group.

Member Function Documentation

catalogName()

static string geos::SiloOutput::catalogName ( )

inlinestatic

Catalog name interface.

Returns

This type's catalog name

Definition at line 47 of file SiloOutput.hpp.

cleanup()

virtual void geos::SiloOutput::cleanup ( real64 const  time_n, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

inlineoverridevirtual

Writes out a Silo plot file at the end of the simulation.

Called as the code exits the main run loop.

Parameters

[in]	time_n	current time level
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain

Reimplemented from geos::ExecutableGroup.

Definition at line 64 of file SiloOutput.hpp.

execute()

virtual bool geos::SiloOutput::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridevirtual

Writes out a Silo plot file.

Implements geos::ExecutableGroup.

---

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

• coreComponents/fileIO/Outputs/SiloOutput.hpp