#include <TimeHistoryCollection.hpp>

Inheritance diagram for geosx::HistoryCollection:

[legend]

Public Member Functions
	HistoryCollection (string const &name, Group *parent)
	Constructor. More...

void	InitializePostSubGroups (Group *const group) override
	Called by Initialize() after to initializing sub-Groups. More...

virtual localIndex	getCollectionCount () const
	Get the number of discrete collection operations this collector conducts. More...

virtual HistoryMetadata	getMetadata (ProblemManager &problemManager, localIndex collectionIdx)
	Get the metadata for what this collector collects. More...

virtual const string &	getTargetName () const =0
	Get the name of the object being targeted for collection. More...

virtual void	Execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, Group *domain) override
	Collects history data. More...

void	registerBufferCall (localIndex collectionIdx, std::function< buffer_unit_type *() > bufferCall)
	Register a callback that gives the current head of the time history data buffer. More...

HistoryMetadata	getTimeMetadata () const
	Get a metadata object relating the the Time variable itself. More...

void	registerTimeBufferCall (std::function< buffer_unit_type *() > timeBufferCall)
	Register a callback that gives the current head of the time data buffer. More...

virtual localIndex	getNumMetaCollectors () const
	Get the number of collectors of meta-information (set indices, etc) writing time-independent information during initialization. More...

virtual std::unique_ptr< HistoryCollection >	getMetaCollector (ProblemManager &problemManager, localIndex metaIdx)
	Get a pointer to a collector of meta-information for this collector. More...

virtual void	updateSetsIndices (DomainPartition &domain)=0
	Update the indices from the sets being collected. More...

Public Member Functions inherited from geosx::TaskBase
	TaskBase (std::string const &name, Group *const parent)
	Constructor. More...

void	PostProcessInput () override

Public Member Functions inherited from geosx::ExecutableGroup
virtual void	SignalToPrepareForExecution (real64 const time_n, real64 const dt, integer const cycle, dataRepository::Group *domain)
	Inform the object that it expects to execute during the next timestep. More...

virtual void	Cleanup (real64 const time_n, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, dataRepository::Group *domain)
	Called as the code exits the main run loop. More...

virtual real64	GetTimestepRequest (real64 const time)
	Supplies the timestep request for this target to the event manager. More...

void	SetTimestepBehavior (integer const behavior)
	Set the timestep behavior for a target. More...

integer	GetTimestepBehavior ()
	Get the target's time step behavior. More...

Public Member Functions inherited from geosx::dataRepository::Group
	Group (std::string const &name, Group *const parent)
	Constructor. More...

	Group (Group &&source)
	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 (Group const &&)=delete
	Deleted move constructor.

Group &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...

Group &	operator= (Group &&)=delete
	Deleted move assignment operator. More...

virtual const std::type_info &	get_typeid () const
	Get typeid for current group. More...

bool	CheckTypeID (std::type_info const &typeToCheck) const
	Check a type_info against the type_info of this Group. More...

void	PrintDataHierarchy (integer indent=0)
	Prints the data hierarchy recursively. More...

string	dumpInputOptions () const

template<typename T = Group>
T *	RegisterGroup (std::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 (std::string const &name, T *newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T *	RegisterGroup (std::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 (std::string const &name, std::string const &catalogName)
	Register a new Group as a sub-group of current Group. More...

void	deregisterGroup (std::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>
T *	GetGroup (localIndex index)
	Retrieve a sub-group from the current Group using an index. More...

template<typename T = Group>
T const *	GetGroup (localIndex index) const
	Retrieve a sub-group from the current Group using an index. More...

template<typename T = Group>
T *	GetGroup (string const &name)
	Retrieve a sub-group from the current Group using a string. More...

template<typename T = Group>
T const *	GetGroup (string const &name) const
	Retrieve a sub-group from the current Group using a string. More...

template<typename T = Group>
T &	getGroupReference (string const &key)

template<typename T = Group>
T const &	getGroupReference (string const &key) const

template<typename T = Group>
T &	GetGroupReference (subGroupMap::KeyIndex const &key)

template<typename T = Group>
T const &	GetGroupReference (subGroupMap::KeyIndex const &key) const

template<typename T = Group>
T *	GetGroup (subGroupMap::KeyIndex const &key)
	Retrieve a sub-group from the current Group using a KeyIndexT. More...

template<typename T = Group>
T const *	GetGroup (subGroupMap::KeyIndex const &key) const
	Retrieve a sub-group from the current Group using a KeyIndexT. More...

template<typename T = Group>
T *	GetGroupByPath (string const &path)
	Retrieve a group from the hierarchy using a path. More...

template<typename T = Group>
T const *	GetGroupByPath (string const &path) const
	Retrieve a group from the hierarchy using a path. More...

subGroupMap &	GetSubGroups ()
	Get the subgroups object. More...

subGroupMap const &	GetSubGroups () const
	Get the subgroups object. More...

localIndex	numSubGroups () const
	return the number of sub groups in this Group More...

bool	hasGroup (std::string const &name) const
	Check whether a sub-group exists. 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 LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda)

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda) const

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...

void	Initialize (Group *const group)
	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 (Group *const group)
	Initialization routine to be called after calling ApplyInitialConditions(). More...

void	postRestartInitializationRecursive (Group *const domain)
	Initialization routine to be called after calling reading a restart file. More...

void	ProcessInputFileRecursive (xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. More...

void	PostProcessInputRecursive ()
	Recursively call PostProcessInput() to apply post processing after reading input values.

template<typename T , typename TBASE = T>
Wrapper< TBASE > *	registerWrapper (std::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)

template<typename T >
Wrapper< T > *	registerWrapper (std::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 (std::string const &name, T *newObject)
	Register a Wrapper around an existing object, does not take ownership of the object. More...

WrapperBase *	registerWrapper (string const &name, 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 *const meshBodies)
	Calls RegisterDataOnMesh() recursively. More...

virtual void	RegisterDataOnMesh (Group *const meshBodies)
	Register data on mesh entities. More...

virtual localIndex	PackSize (string_array const &wrapperNames, integer const recursive, bool on_device=false) 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 on_device=false) const
	Get the size required to pack a list of indices within a list of wrappers. More...

virtual localIndex	Pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool on_device=false) 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 on_device=false) const
	Pack a list of indices within a list of wrappers. More...

virtual localIndex	Unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool on_device=false)
	Unpack a buffer. More...

WrapperBase const *	getWrapperBase (indexType const index) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (indexType const index)
	Retrieve a WrapperBase stored in this group. More...

WrapperBase const *	getWrapperBase (std::string const &name) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (std::string const &name)
	Retrieve a WrapperBase stored in this group. More...

WrapperBase const *	getWrapperBase (wrapperMap::KeyIndex const &keyIndex) const
	Retrieve a WrapperBase stored in this group. More...

WrapperBase *	getWrapperBase (wrapperMap::KeyIndex const &keyIndex)
	Retrieve a WrapperBase stored in this group. More...

indexType	getWrapperIndex (std::string const &name) const

wrapperMap const &	wrappers () const
	Get access to the internal wrapper storage. More...

wrapperMap &	wrappers ()
	Get access to the internal wrapper storage. More...

template<typename LOOKUP_TYPE >
bool	hasWrapper (LOOKUP_TYPE const &lookup) const
	Check if a wrapper exists. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const *	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 >
Wrapper< T > const *	getWrapper (char const *const key) const
	Retrieve a Wrapper stored in this group. More...

template<typename T >
Wrapper< T > *	getWrapper (char const *const key)
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
GEOSX_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...

template<typename T >
GEOSX_DECLTYPE_AUTO_RETURN	getReference (char const *const name) const

template<typename T >
T &	getReference (char const *const name)

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...

Group *	getParent ()
	Access the group's parent. More...

Group const *	getParent () const
	Access the group's parent. More...

localIndex	getIndexInParent () const
	Get the group's index withing its parent group. More...

integer	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 ()
	Get 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.

integer	getLogLevel () const

template<typename T >
T	group_cast ()
	Downcast this Group. More...

template<typename T >
T	group_cast () const
	Downcast this Group. More...

Protected Member Functions
virtual void	collect (DomainPartition &domain, real64 const time_n, real64 const dt, localIndex const collectionIdx, buffer_unit_type *&buffer)=0
	Collect history information into the provided buffer. Typically called from HistoryCollection::Execute . More...

Protected Member Functions inherited from geosx::dataRepository::Group
virtual void	InitializePreSubGroups (Group *const group)
	Called by Initialize() prior to initializing sub-Groups. More...

virtual void	InitializePostInitialConditions_PreSubGroups (Group *const group)
	Called by InitializePostInitialConditions() prior to initializing sub-Groups. More...

virtual void	InitializePostInitialConditions_PostSubGroups (Group *const group)
	Called by InitializePostInitialConditions() after to initializing sub-Groups. More...

virtual void	postRestartInitialization (Group *const domain)
	Performs initialization required after reading from a restart file. More...

Protected Attributes
localIndex	m_collectionCount
	The number of discrete collection operations described by metadata this collection collects.

std::function< buffer_unit_type *() >	m_timeBufferCall
	Callbacks to get the current time buffer head to write time data into.

std::vector< std::function< buffer_unit_type *() > >	m_bufferCalls
	Callbacks to get the current buffer head to write history data into.

Additional Inherited Members
Public Types inherited from geosx::TaskBase
using	CatalogInterface = dataRepository::CatalogInterface< TaskBase, std::string const &, Group *const >
	The catalog interface type for TaskBase.

Public Types inherited from geosx::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, std::string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Static Public Member Functions inherited from geosx::TaskBase
static string	CatalogName ()
	Catalog name interface. More...

static CatalogInterface::CatalogType &	GetCatalog ()
	Get the catalog interface for the TaskBase. More...

Static Public Member Functions inherited from geosx::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...

template<typename T >
static T	group_cast (Group *group)
	Downcast a Group *. More...

template<typename T >
static T	group_cast (Group const *group)
	Downcast a Group const *. More...

Detailed Description

A task class for serializing time history data into a buffer for later I/O.

Definition at line 39 of file TimeHistoryCollection.hpp.

Constructor & Destructor Documentation

◆ HistoryCollection()

geosx::HistoryCollection::HistoryCollection	(	string const &	name,
		Group *	parent
	)

inline

Constructor.

Parameters

[in]	name	the name of this object manager
[in]	parent	the parent Group

Definition at line 43 of file TimeHistoryCollection.hpp.

Member Function Documentation

◆ collect()

virtual void geosx::HistoryCollection::collect	(	DomainPartition &	domain,
		real64 const	time_n,
		real64 const	dt,
		localIndex const	collectionIdx,
		buffer_unit_type *&	buffer
	)

protectedpure virtual

Collect history information into the provided buffer. Typically called from HistoryCollection::Execute .

Parameters

domain	The DomainPartition to collect time history on.
time_n	The current simulation time.
dt	The current simulation time delta.
collectionIdx	The index of the collection operation to collect from the targeted collection event.
buffer	A properly-sized buffer to serialize history data into.

Implemented in geosx::PackCollection.

◆ Execute()

virtual void geosx::HistoryCollection::Execute	(	real64 const	time_n,
		real64 const	dt,
		integer const	cycleNumber,
		integer const	eventCounter,
		real64 const	eventProgress,
		Group *	domain
	)

inlineoverridevirtual

Collects history data.

If the event forecast is equal to 0, then call the step function on its target and/or children. Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[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 up-casted to a Group.

If the start criteria are satisfied, then the event manager will call this method.

Reimplemented from geosx::TaskBase.

Definition at line 89 of file TimeHistoryCollection.hpp.

◆ getCollectionCount()

virtual localIndex geosx::HistoryCollection::getCollectionCount ( ) const

inlinevirtual

Get the number of discrete collection operations this collector conducts.

Returns: The number of collection operations for this collector.

Definition at line 61 of file TimeHistoryCollection.hpp.

◆ getMetaCollector()

virtual std::unique_ptr< HistoryCollection > geosx::HistoryCollection::getMetaCollector	(	ProblemManager &	problemManager,
		localIndex	metaIdx
	)

inlinevirtual

Get a pointer to a collector of meta-information for this collector.

Parameters

problemManager	The ProblemManager.
metaIdx	Which of the meta-info collectors to return. (see HistoryCollection::GetNumMetaCollectors( ) ).

Returns: A unique pointer to the HistoryCollection object used for meta-info collection. Intented to fall out of scope and desctruct immediately after being used to perform output during simulation initialization.

Definition at line 170 of file TimeHistoryCollection.hpp.

◆ getMetadata()

virtual HistoryMetadata geosx::HistoryCollection::getMetadata	(	ProblemManager &	problemManager,
		localIndex	collectionIdx
	)

inlinevirtual

Get the metadata for what this collector collects.

Parameters

problemManager	The problem manager.
collectionIdx	Which collected item to get metadata for.

Returns: A HistoryMetadata object describing the history data being collected by this collector.

Reimplemented in geosx::PackCollection.

Definition at line 72 of file TimeHistoryCollection.hpp.

◆ getNumMetaCollectors()

virtual localIndex geosx::HistoryCollection::getNumMetaCollectors ( ) const

inlinevirtual

Get the number of collectors of meta-information (set indices, etc) writing time-independent information during initialization.

Returns: The number of collectors of meta-information for this collector.

Definition at line 157 of file TimeHistoryCollection.hpp.

◆ getTargetName()

virtual const string& geosx::HistoryCollection::getTargetName ( ) const

pure virtual

Get the name of the object being targeted for collection.

Returns: The collection target's name

Implemented in geosx::PackCollection.

◆ getTimeMetadata()

HistoryMetadata geosx::HistoryCollection::getTimeMetadata ( ) const

inline

Get a metadata object relating the the Time variable itself.

Returns: A HistroyMetadata object describing the Time variable.

Definition at line 137 of file TimeHistoryCollection.hpp.

◆ InitializePostSubGroups()

void geosx::HistoryCollection::InitializePostSubGroups ( Group *const group )

inlineoverridevirtual

Called by Initialize() after to initializing sub-Groups.

Parameters

[in] group A group that is passed in to the initialization functions in order to facilitate the initialization.

Reimplemented from geosx::dataRepository::Group.

Definition at line 51 of file TimeHistoryCollection.hpp.

◆ registerBufferCall()

void geosx::HistoryCollection::registerBufferCall	(	localIndex	collectionIdx,
		std::function< buffer_unit_type *() >	bufferCall
	)

inline

Register a callback that gives the current head of the time history data buffer.

s

Parameters

collectionIdx	Which collection item to register the buffer callback for.
bufferCall	A functional that when invoked returns a pointer to the head of a buffer at least large enough to serialize one timestep of history data into.

Note: This is typically meant to callback to BufferedHistoryIO::GetBufferHead( )

Definition at line 127 of file TimeHistoryCollection.hpp.

◆ registerTimeBufferCall()

void geosx::HistoryCollection::registerTimeBufferCall ( std::function< buffer_unit_type *() > timeBufferCall )

inline

Register a callback that gives the current head of the time data buffer.

Parameters

timeBufferCall A functional that when invoked returns a pointer to the head of a buffer at least large enough to serialize one instance of the Time variable into.

Note: This is typically meant to callback to BufferedHistoryIO::GetBufferHead( )

Definition at line 148 of file TimeHistoryCollection.hpp.

◆ updateSetsIndices()

virtual void geosx::HistoryCollection::updateSetsIndices ( DomainPartition & domain )

pure virtual

Update the indices from the sets being collected.

Parameters

domain The DomainPartition of the problem.

Implemented in geosx::PackCollection.

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

coreComponents/managers/TimeHistory/TimeHistoryCollection.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HistoryCollection()

Member Function Documentation

◆ collect()

◆ Execute()

◆ getCollectionCount()

◆ getMetaCollector()

◆ getMetadata()

◆ getNumMetaCollectors()

◆ getTargetName()

◆ getTimeMetadata()

◆ InitializePostSubGroups()

◆ registerBufferCall()

◆ registerTimeBufferCall()

◆ updateSetsIndices()