Intermediate class for code factorisation. It mainly deals with collector and buffer management. It delegates the actual collection to derived classes. More...

#include <HistoryCollectionBase.hpp>

Inheritance diagram for geos::HistoryCollectionBase:

[legend]

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

void	initializePostSubGroups () override
	Forwarding public initializing function...

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

virtual bool	execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...

void	registerBufferProvider (localIndex collectionIdx, BufferProvider bufferProvider) override
	Register a callback that provides the current head of the time history data buffer. More...

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

void	registerTimeBufferProvider (TimeBufferProvider timeBufferProvider) override
	Register a callback that gives the current head of the time data buffer. More...

HistoryCollection &	getMetaDataCollector (localIndex metaIdx) override
	Get a collector of meta-information for this collector. More...

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

virtual HistoryMetadata	getMetaData (DomainPartition const &domain, localIndex collectionIdx) const =0
	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 localIndex	numMetaDataCollectors () const =0
	Get the number of collectors of meta-information (set indices, etc) writing time-independent information during initialization. More...

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

void	postInputInitialization () override

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 void	cleanup (real64 const time_n, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &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	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
template<typename LOG_LEVEL_INFO >
std::enable_if_t< geos::is_log_level_info< LOG_LEVEL_INFO >, void >	addLogLevel ()
	Append a levelCondition and a log description to the description of the wrapped object given a log info struct. Must be called in constructor. More...

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>
T const *	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>
T const &	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>
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...

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	postInputInitializationRecursive ()
	Recursively call postInputInitialization() 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 >
WrapperBase const &	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

wrapperMap const &	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 >
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 , typename LOOKUP_TYPE >
Wrapper< T > const *	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...

string const &	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...

DataContext const &	getDataContext () const

template<typename KEY >
DataContext const &	getWrapperDataContext (KEY key) const

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

Group const &	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...

conduit::Node const &	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 ()

void	setLogLevel (integer const logLevel)
	Set verbosity level. More...

integer	getLogLevel () const

Protected Member Functions
dataRepository::Group const *	getTargetObject (DomainPartition const &domain, string const &objectPath) const
	Retrieve the target object from the data repository. More...

virtual void	collect (DomainPartition const &domain, 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 geos::dataRepository::Group
virtual void	initializePreSubGroups ()
	Called by Initialize() prior 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.

Protected Attributes
bool	m_targetIsMeshObject
	whether the target object is associated with mesh entities (fields, etc)

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

TimeBufferProvider	m_timeBufferProvider
	Callbacks to get the current time buffer head to write time data into.

std::vector< BufferProvider >	m_bufferProviders
	Callbacks to get the current buffer head to write history data into.

std::vector< std::unique_ptr< HistoryCollection > >	m_metaDataCollectors
	The set of metadata collectors for this collector. More...

Additional Inherited Members
Public Types inherited from geos::HistoryCollection
using	BufferProvider = std::function< buffer_unit_type *(localIndex) >
	Type of buffer provider.

using	TimeBufferProvider = std::function< buffer_unit_type *() >
	Type of time buffer provider.

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

Public Types inherited from geos::ExecutableGroup
enum class	TimesteppingBehavior : integer { DeterminesTimeStepSize , 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.

Static Public Member Functions inherited from geos::TaskBase
static CatalogInterface::CatalogType &	getCatalog ()
	Get the catalog interface for the TaskBase. 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 Group. More...

Detailed Description

Intermediate class for code factorisation. It mainly deals with collector and buffer management. It delegates the actual collection to derived classes.

Definition at line 33 of file HistoryCollectionBase.hpp.

Constructor & Destructor Documentation

◆ HistoryCollectionBase()

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

inline

Constructor.

Parameters

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

Definition at line 37 of file HistoryCollectionBase.hpp.

Member Function Documentation

◆ collect()

virtual void geos::HistoryCollectionBase::collect	(	DomainPartition const &	domain,
		localIndex const	collectionIdx,
		buffer_unit_type *&	buffer
	)

protectedpure virtual

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

Parameters

[in]	domain	The DomainPartition to collect time history on.
[in]	collectionIdx	The index of the collection operation to collect from the targeted collection event.
[in,out]	buffer	A properly-sized buffer to serialize history data into.

◆ execute()

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

overridevirtual

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.

Returns: True iff this event requires exiting the event loop.

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

Reimplemented from geos::TaskBase.

◆ getMetaDataCollector()

HistoryCollection& geos::HistoryCollectionBase::getMetaDataCollector ( localIndex metaIdx )

overridevirtual

Get a collector of meta-information for this collector.

Parameters

[in] metaIdx Which of the meta-info collectors to return. (see HistoryCollection::numMetaDataCollectors()).

Returns: A mutable reference.

Implements geos::HistoryCollection.

◆ getTargetObject()

dataRepository::Group const* geos::HistoryCollectionBase::getTargetObject	(	DomainPartition const &	domain,
		string const &	objectPath
	)		const

protected

Retrieve the target object from the data repository.

Parameters

[in]	domain	The DomainPartition of the problem.
[in]	objectPath	The data repo path of the target object.

Returns: The target object as a Group

Note: If the object path is absolute this returns the target object by calling getGroupByPath. If the object path is relative, it searches relative to the mesh in the same way the fieldSpecification does, so any objectPath that works in fieldSpecification will also work here.

◆ getTimeMetaData()

HistoryMetadata geos::HistoryCollectionBase::getTimeMetaData ( ) const

overridevirtual

Get a metadata object relating the the Time variable itself.

Returns: A HistroyMetadata object describing the Time variable.

Implements geos::HistoryCollection.

◆ numCollectors()

localIndex geos::HistoryCollectionBase::numCollectors ( ) const

overridevirtual

Get the number of discrete collection operations this collector conducts.

Returns: The number of collection operations for this collector.

Implements geos::HistoryCollection.

◆ registerBufferProvider()

void geos::HistoryCollectionBase::registerBufferProvider	(	localIndex	collectionIdx,
		BufferProvider	bufferProvider
	)

overridevirtual

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

Parameters

[in]	collectionIdx	Which collection item to register the buffer callback for.
[in]	bufferProvider	A functional that when invoked returns a pointer to the head of a buffer at least large enough to serialize one time step of history data into.

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

Implements geos::HistoryCollection.

◆ registerTimeBufferProvider()

void geos::HistoryCollectionBase::registerTimeBufferProvider ( TimeBufferProvider timeBufferProvider )

overridevirtual

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

Parameters

[in] timeBufferProvider 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()

Implements geos::HistoryCollection.

Member Data Documentation

◆ m_metaDataCollectors

std::vector< std::unique_ptr< HistoryCollection > > geos::HistoryCollectionBase::m_metaDataCollectors

protected

The set of metadata collectors for this collector.

Note: Currently only used to collect coordinates of mesh objects when collecting field data.

Definition at line 121 of file HistoryCollectionBase.hpp.

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

coreComponents/fileIO/timeHistory/HistoryCollectionBase.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HistoryCollectionBase()

Member Function Documentation

◆ collect()

◆ execute()

◆ getMetaDataCollector()

◆ getTargetObject()

◆ getTimeMetaData()

◆ numCollectors()

◆ registerBufferProvider()

◆ registerTimeBufferProvider()

Member Data Documentation

◆ m_metaDataCollectors