GEOSX
|
#include <PackCollection.hpp>
Public Member Functions | |
PackCollection (string const &name, Group *parent) | |
Constructor. More... | |
virtual void | initializePostSubGroups () override |
virtual HistoryMetadata | getMetadata (DomainPartition const &domain, localIndex collectionIdx) override |
Get the metadata for what this collector collects. More... | |
virtual const string & | getTargetName () const override |
Get the name of the object being targeted for collection. More... | |
virtual void | updateSetsIndices (DomainPartition &domain) override final |
Update the indices related to the sets being collected. More... | |
virtual localIndex | getNumMetaCollectors () const override final |
Get the number of collectors of meta-information (set indices, etc) writing time-independent information during initialization. More... | |
Public Member Functions inherited from geosx::HistoryCollection | |
HistoryCollection (string const &name, Group *parent) | |
Constructor. More... | |
void | initializePostSubGroups () override |
virtual localIndex | getCollectionCount () const |
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 |
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 HistoryCollection & | getMetaCollector (localIndex metaIdx) |
Get a pointer to a collector of meta-information for this collector. More... | |
Static Public Member Functions | |
static string | catalogName () |
Catalog name interface. More... | |
Protected Member Functions | |
void | buildMetaCollectors () |
Construct the metadata collectors for this collector. | |
void | disableCoordCollection () |
virtual void | collect (DomainPartition &domain, real64 const time_n, real64 const dt, localIndex const collectionIdx, buffer_unit_type *&buffer) override |
Collect history information into the provided buffer. Typically called from HistoryCollection::execute . More... | |
Protected Member Functions inherited from geosx::HistoryCollection | |
dataRepository::Group const * | getTargetObject (DomainPartition const &domain, string const &objectPath) |
Retrieve the target object from the data repository. More... | |
Additional Inherited Members | |
Protected Attributes inherited from geosx::HistoryCollection | |
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. | |
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. | |
std::vector< std::unique_ptr< HistoryCollection > > | m_metaCollectors |
A task class for serializing history information using the MPI communication packing routines.
Definition at line 34 of file PackCollection.hpp.
Constructor.
name | The name of this Group. |
parent | The parent Group. |
|
inlinestatic |
Catalog name interface.
Definition at line 47 of file PackCollection.hpp.
|
overrideprotectedvirtual |
Collect history information into the provided buffer. Typically called from HistoryCollection::execute .
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. |
Implements geosx::HistoryCollection.
|
inlineprotected |
Do not construct metadata collectors to collect coordinate information. ( Prevents reccuring initialization of coordinate collection for coordinate collectors ).
Definition at line 95 of file PackCollection.hpp.
|
overridevirtual |
Get the metadata for what this collector collects.
domain | The DomainPartition. |
collectionIdx | Which collected item to get metadata for. |
Reimplemented from geosx::HistoryCollection.
|
finaloverridevirtual |
Get the number of collectors of meta-information (set indices, etc) writing time-independent information during initialization.
Reimplemented from geosx::HistoryCollection.
|
inlineoverridevirtual |
Get the name of the object being targeted for collection.
Implements geosx::HistoryCollection.
Definition at line 55 of file PackCollection.hpp.
|
finaloverridevirtual |
Update the indices related to the sets being collected.
domain | The domain partition. |
Implements geosx::HistoryCollection.