#include <TimeHistoryCollection.hpp>
A task class for serializing time history data into a buffer for later I/O.
Definition at line 41 of file TimeHistoryCollection.hpp.
◆ HistoryCollection()
geosx::HistoryCollection::HistoryCollection |
( |
string const & |
name, |
|
|
Group * |
parent |
|
) |
| |
|
inline |
◆ collect()
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()
◆ 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 63 of file TimeHistoryCollection.hpp.
◆ getMetaCollector()
Get a pointer to a collector of meta-information for this collector.
- Parameters
-
- 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 172 of file TimeHistoryCollection.hpp.
◆ getMetadata()
◆ 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.
Reimplemented in geosx::PackCollection.
Definition at line 160 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.
◆ getTargetObject()
Retrieve the target object from the data repository.
- Parameters
-
domain | The DomainPartition of the problem. |
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.
Definition at line 194 of file TimeHistoryCollection.hpp.
◆ getTimeMetadata()
Get a metadata object relating the the Time variable itself.
- Returns
- A HistroyMetadata object describing the Time variable.
Definition at line 140 of file TimeHistoryCollection.hpp.
◆ registerBufferCall()
Register a callback that gives the current head of the time history data buffer.
- 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 130 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 151 of file TimeHistoryCollection.hpp.
◆ updateSetsIndices()
virtual void geosx::HistoryCollection::updateSetsIndices |
( |
DomainPartition & |
domain | ) |
|
|
pure virtual |
◆ m_metaCollectors
std::vector< std::unique_ptr< HistoryCollection > > geosx::HistoryCollection::m_metaCollectors |
|
protected |
The set of metadata collectors for this collector ( currently only used to collect coordinates of mesh objects when collecting field data )
Definition at line 251 of file TimeHistoryCollection.hpp.
The documentation for this class was generated from the following file: