GEOSX
|
The ObjectManagerBase is the base object of all object managers in the mesh data hierachy. More...
#include <ObjectManagerBase.hpp>
Classes | |
struct | groupKeyStruct |
struct to serve as a container for group strings and keys More... | |
struct | viewKeyStruct |
struct to serve as a container for variable strings and keys More... | |
Public Member Functions | |
ObjectManagerBase (string const &name, dataRepository::Group *const parent) | |
Constructor. More... | |
~ObjectManagerBase () override | |
Destructor. | |
virtual localIndex | packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const override |
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, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const override |
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 onDevice, parallelDeviceEvents &events) override |
Unpack a buffer. More... | |
template<bool DOPACK> | |
localIndex | packSets (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const |
Packs the elements of each set that actually are in packList . More... | |
localIndex | unpackSets (buffer_unit_type const *&buffer) |
Unpack the content of buffer into the sets of the instance. More... | |
virtual void | viewPackingExclusionList (SortedArray< localIndex > &exclusionList) const |
Inserts in exclusionList the data that shall not be packed. More... | |
virtual localIndex | packGlobalMapsSize (arrayView1d< localIndex const > const &packList, integer const recursive) const |
Computes the pack size of the global maps elements in the @ packList. More... | |
virtual localIndex | packGlobalMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive) const |
Packs the global maps elements in the @ packList. More... | |
void | setReceiveLists () |
Clear and redefines the ghosts to receive. | |
virtual localIndex | packUpDownMapsSize (arrayView1d< localIndex const > const &packList) const |
Computes the pack size of the specific elements in the @ packList. More... | |
virtual localIndex | packUpDownMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const |
Packs the specific elements in the @ packList. More... | |
virtual localIndex | unpackUpDownMaps (buffer_unit_type const *&buffer, array1d< localIndex > &packList, bool const overwriteUpMaps, bool const overwriteDownMaps) |
Unpacks the specific elements in the @ packList. More... | |
virtual localIndex | unpackGlobalMaps (buffer_unit_type const *&buffer, localIndex_array &packList, integer const recursive) |
Unpacks the global maps from buffer . More... | |
localIndex | packParentChildMapsSize (arrayView1d< localIndex const > const &packList) const |
Computes the pack size of the parent/child relations in packList . More... | |
localIndex | packParentChildMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const |
Packs the parent/child relations in packList . More... | |
localIndex | unpackParentChildMaps (buffer_unit_type const *&buffer, localIndex_array &packList) |
Unacks the parent/child relations in packList . More... | |
void | moveSets (LvArray::MemorySpace const targetSpace) |
Manually move all sets to a memory space. More... | |
localIndex | resize (localIndex const newSize, const bool) |
Resize the group and all contained wrappers that resize with parent. More... | |
void | createSet (const string &newSetName) |
Creates a new set. More... | |
void | constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, const array2d< localIndex > &map, const string &setName) |
Builds a new set on this instance given another objects set and the map between them. More... | |
void | constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, const array1d< localIndex_array > &map, const string &setName) |
Builds a new set on this instance given another objects set and the map between them. More... | |
void | constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, ArrayOfArraysView< localIndex const > const &map, const string &setName) |
Builds a new set on this instance given another objects set and the map between them. More... | |
void | constructGlobalToLocalMap () |
Constructs the global to local map. | |
void | constructLocalListOfBoundaryObjects (localIndex_array &objectList) const |
Computes the (local) index list that are domain boundaries. More... | |
void | constructGlobalListOfBoundaryObjects (globalIndex_array &objectList) const |
Computes the (global) index list that are domain boundaries. More... | |
virtual void | extractMapFromObjectForAssignGlobalIndexNumbers (NodeManager const &nodeManager, std::vector< std::vector< globalIndex > > &map) |
Extract map from object and assign global indices. More... | |
void | setGhostRankForSenders (int const neighborRank) |
Defines neighborRank ownership for ghost objects. More... | |
localIndex | getNumberOfGhosts () const |
Get the number of ghost objects. More... | |
localIndex | getNumberOfLocalIndices () const |
Get the number of locally owned objects. More... | |
integer | splitObject (localIndex const indexToSplit, int const rank, localIndex &newIndex) |
Split object to deal with topology changes. More... | |
void | inheritGhostRankFromParent (std::set< localIndex > const &indices) |
sets the value of m_ghostRank to the value of the objects parent. More... | |
void | copyObject (localIndex const source, localIndex const destination) |
Copy object from source to @ destination. More... | |
virtual void | setMaxGlobalIndex () |
Computes the maximum global index allong all the MPI ranks. | |
virtual void | enforceStateFieldConsistencyPostTopologyChange (std::set< localIndex > const &targetIndices) |
Updates the child and target indices after a topology change. More... | |
template<typename MESH_DATA_TRAIT > | |
dataRepository::Wrapper< typename MESH_DATA_TRAIT::type > & | registerExtrinsicData (string const &nameOfRegisteringObject) |
Register data with this ObjectManagerBase using a dataRepository::Wrapper. More... | |
template<typename MESH_DATA_TRAIT0 , typename MESH_DATA_TRAIT1 , typename ... MESH_DATA_TRAITS> | |
void | registerExtrinsicData (string const &nameOfRegisteringObject) |
Register a collection of data with this ObjectManagerBase using a dataRepository::Wrapper. More... | |
template<typename MESH_DATA_TRAIT > | |
GEOSX_DECLTYPE_AUTO_RETURN | getExtrinsicData () const |
Get a view to the data associated with a trait from this ObjectManagerBase. More... | |
template<typename MESH_DATA_TRAIT > | |
GEOSX_DECLTYPE_AUTO_RETURN | getExtrinsicData () |
Get the data associated with a trait from this ObjectManagerBase. More... | |
template<typename MESH_DATA_TRAIT > | |
bool | hasExtrinsicData () const |
Checks if an extrinsic data has been registered. More... | |
virtual viewKeyStruct & | viewKeys () |
Get the view keys for Group access. More... | |
virtual viewKeyStruct const & | viewKeys () const |
Get the view keys for Group access, const version. More... | |
virtual groupKeyStruct & | groupKeys () |
Get the group keys for Group access. More... | |
virtual groupKeyStruct const & | groupKeys () const |
Get the group keys for Group access, const version. More... | |
Group & | sets () |
Get the group holding the object sets. More... | |
Group const & | sets () const |
Get the group holding the object sets, const version. More... | |
SortedArray< localIndex > & | externalSet () |
Get the external set. More... | |
SortedArrayView< localIndex const > | externalSet () const |
Get the external set, const version. More... | |
void | updateGlobalToLocalMap (localIndex const lid) |
Updates (if needed) the global index for local index lid . More... | |
arrayView1d< globalIndex > | localToGlobalMap () |
Get local to global map. More... | |
arrayView1d< globalIndex const > | localToGlobalMap () const |
Get local to global map, const version. More... | |
unordered_map< globalIndex, localIndex > const & | globalToLocalMap () const |
Get global to local map. More... | |
localIndex | globalToLocalMap (globalIndex const gid) const |
Retrieves the local index for given global index. More... | |
array1d< integer > const & | isExternal () |
Get the locality information of the objects. More... | |
arrayView1d< integer const > | isExternal () const |
Get the locality information of the objects. More... | |
array1d< integer > const & | ghostRank () |
Get the ghost information of each object. More... | |
arrayView1d< integer const > | ghostRank () const |
Get the ghost information of each object, const version. More... | |
NeighborData & | getNeighborData (int const rank) |
Get neighbor data for given rank . More... | |
NeighborData const & | getNeighborData (int const rank) const |
Get neighbor data for given rank , const version. More... | |
void | addNeighbor (int const rank) |
Add a neighbor for rank . More... | |
void | removeNeighbor (int const rank) |
Remove neighbor for rank . More... | |
globalIndex | localMaxGlobalIndex () const |
Get the local maximum global index on this rank. More... | |
globalIndex | maxGlobalIndex () const |
Get the maximum global index of all objects across all rank. See. More... | |
arrayView1d< integer > | getDomainBoundaryIndicator () |
Get the domain boundary indicator. More... | |
arrayView1d< integer const > | getDomainBoundaryIndicator () const |
Get the domain boundary indicator. More... | |
Public Member Functions inherited from geosx::dataRepository::Group | |
virtual bool | registerCallback (void *func, const std::type_info &funcType) |
Register a callback function on the group. More... | |
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) |
Prints the data hierarchy recursively. More... | |
string | dumpInputOptions () 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... | |
template<typename T = Group> | |
bool | hasGroup (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 () |
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::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 (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 (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 (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 &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 | 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... | |
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... | |
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 > | |
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... | |
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. 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 () |
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 () |
Enable verbosity input for object. | |
integer | getLogLevel () const |
Static Public Member Functions | |
template<typename TYPE_RELATION > | |
static void | fixUpDownMaps (TYPE_RELATION &relation, map< localIndex, array1d< globalIndex > > &unmappedIndices, bool const clearIfUnmapped) |
Fixing the up/down maps by mapping the unmapped indices. More... | |
template<typename TYPE_RELATION > | |
static void | fixUpDownMaps (TYPE_RELATION &relation, map< localIndex, SortedArray< globalIndex > > &unmappedIndices, bool const clearIfUnmapped) |
Fixing the up/down maps by mapping the unmapped indices. More... | |
static void | fixUpDownMaps (ArrayOfSets< localIndex > &relation, unordered_map< globalIndex, localIndex > const &globalToLocal, map< localIndex, SortedArray< globalIndex > > &unmappedIndices, bool const clearIfUnmapped) |
Fixing the up/down maps by mapping the unmapped indices. More... | |
static void | cleanUpMap (std::set< localIndex > const &targetIndices, array1d< SortedArray< localIndex > > &upmap, arrayView2d< localIndex const > const &downmap) |
Removes from the list of arrays of upmap all the elements for which the "mirror target array" of downmap does not contain the proper target index. More... | |
static void | cleanUpMap (std::set< localIndex > const &targetIndices, ArrayOfSetsView< localIndex > const &upmap, arrayView2d< localIndex const > const &downmap) |
Removes from the list of sets of upmap all the elements for which the "mirror target array" of downmap does not contain the proper target index. More... | |
static void | cleanUpMap (std::set< localIndex > const &targetIndices, array1d< SortedArray< localIndex > > &upmap, arrayView1d< arrayView1d< localIndex const > const > const &downmap) |
Removes from the list of arrays of upmap all the elements for which the "mirror target array" of downmap does not contain the proper target index. More... | |
static void | cleanUpMap (std::set< localIndex > const &targetIndices, ArrayOfSetsView< localIndex > const &upmap, arrayView1d< arrayView1d< localIndex const > const > const &downmap) |
Removes from the list of sets of upmap all the elements for which the "mirror target array" of downmap does not contain the proper target index. More... | |
static void | cleanUpMap (std::set< localIndex > const &targetIndices, ArrayOfSetsView< localIndex > const &upmap, ArrayOfArraysView< localIndex const > const &downmap) |
Removes from the list of sets of upmap all the elements for which the "mirror target array" of downmap does not contain the proper target index. More... | |
static localIndex | getParentRecusive (arraySlice1d< localIndex const > const &parentIndices, localIndex const lookup) |
Get the upmost parent. 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... | |
Public Attributes | |
struct geosx::ObjectManagerBase::viewKeyStruct | m_ObjectManagerBaseViewKeys |
viewKey struct for the ObjectManagerBase class | |
struct geosx::ObjectManagerBase::groupKeyStruct | m_ObjectManagerBaseGroupKeys |
groupKey struct for the ObjectManagerBase class | |
Protected Attributes | |
Group | m_sets |
Group that holds object sets. | |
Group | m_neighborGroup |
Group that holds all the NeighborData objects. | |
array1d< globalIndex > | m_localToGlobalMap |
Contains the global index of each object. | |
unordered_map< globalIndex, localIndex > | m_globalToLocalMap |
Map from object global index to the local index. | |
array1d< integer > | m_isExternal |
Array that holds if an object is external. | |
array1d< integer > | m_domainBoundaryIndicator |
Domain boundary indicator: 1 means the "index" is on the boundary. | |
array1d< integer > | m_ghostRank |
Array that holds the ghost information about each object. More... | |
unordered_map< int, NeighborData > | m_neighborData |
A map from rank to the associated NeighborData object. | |
real64 | m_overAllocationFactor = 1.1 |
Factor by which to overallocate when adding objects. | |
globalIndex | m_maxGlobalIndex = -1 |
The maximum global index of all objects across all rank. | |
globalIndex | m_localMaxGlobalIndex = -1 |
The maximum global index of any object of all objects on this rank. | |
Static Factory Catalog Functions | |
using | CatalogInterface = dataRepository::CatalogInterface< ObjectManagerBase, string const &, dataRepository::Group *const > |
Nested type for the factory pattern, defining the base class (ObjectManagerBase) and the builder arguments (string const &, dataRepository::Group * const) of the derived products. | |
virtual const string | getCatalogName () const =0 |
Get the name of the catalog. More... | |
static CatalogInterface::CatalogType & | getCatalog () |
Acessing the unique instance of this catalog. More... | |
Additional Inherited Members | |
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, string const &, Group *const > |
Type alias for catalog interface used by this class. See CatalogInterface. | |
Protected Member Functions inherited from geosx::dataRepository::Group | |
virtual void | postProcessInput () |
virtual void | initializePreSubGroups () |
Called by Initialize() prior to initializing sub-Groups. | |
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. | |
The ObjectManagerBase is the base object of all object managers in the mesh data hierachy.
Definition at line 34 of file ObjectManagerBase.hpp.
|
explicit |
Constructor.
[in] | name | Name of this object manager |
[in] | parent | Parent Group |
|
inline |
Add a neighbor for rank
.
rank | The rank of the new neighbor. |
Definition at line 903 of file ObjectManagerBase.hpp.
|
static |
Removes from the list of arrays of upmap
all the elements for which the "mirror target array" of downmap
does not contain the proper target index.
targetIndices | The indices we want to keep. | |
[in,out] | upmap | The map to be filtered |
downmap | The map used to check for target availability. |
|
static |
Removes from the list of sets of upmap
all the elements for which the "mirror target array" of downmap
does not contain the proper target index.
targetIndices | The indices we want to keep. | |
[in,out] | upmap | The map to be filtered |
downmap | The map used to check for target availability. |
|
static |
Removes from the list of arrays of upmap
all the elements for which the "mirror target array" of downmap
does not contain the proper target index.
targetIndices | The indices we want to keep. | |
[in,out] | upmap | The map to be filtered |
downmap | The map used to check for target availability. |
|
static |
Removes from the list of sets of upmap
all the elements for which the "mirror target array" of downmap
does not contain the proper target index.
targetIndices | The indices we want to keep. | |
[in,out] | upmap | The map to be filtered |
downmap | The map used to check for target availability. |
|
static |
Removes from the list of sets of upmap
all the elements for which the "mirror target array" of downmap
does not contain the proper target index.
targetIndices | The indices we want to keep. | |
[in,out] | upmap | The map to be filtered |
downmap | The map used to check for target availability. |
void geosx::ObjectManagerBase::constructGlobalListOfBoundaryObjects | ( | globalIndex_array & | objectList | ) | const |
Computes the (global) index list that are domain boundaries.
[in,out] | objectList | Sorted container that is filled with the global indices. |
Note that objectList
is not cleared and domain boundary indices are only appended.
void geosx::ObjectManagerBase::constructLocalListOfBoundaryObjects | ( | localIndex_array & | objectList | ) | const |
Computes the (local) index list that are domain boundaries.
[in,out] | objectList | Container that is filled with the local indices. |
Note that objectList
is not cleared and domain boundary indices are only appended.
void geosx::ObjectManagerBase::constructSetFromSetAndMap | ( | SortedArrayView< localIndex const > const & | inputSet, |
const array2d< localIndex > & | map, | ||
const string & | setName | ||
) |
Builds a new set on this instance given another objects set and the map between them.
inputSet | The input set. |
map | The map between the newly created set and the inputSet . |
setName | The newly created set name. |
void geosx::ObjectManagerBase::constructSetFromSetAndMap | ( | SortedArrayView< localIndex const > const & | inputSet, |
const array1d< localIndex_array > & | map, | ||
const string & | setName | ||
) |
Builds a new set on this instance given another objects set and the map between them.
inputSet | The input set. |
map | The map between the newly created set and the inputSet . |
setName | The newly created set name. |
void geosx::ObjectManagerBase::constructSetFromSetAndMap | ( | SortedArrayView< localIndex const > const & | inputSet, |
ArrayOfArraysView< localIndex const > const & | map, | ||
const string & | setName | ||
) |
Builds a new set on this instance given another objects set and the map between them.
inputSet | The input set. |
map | The map between the newly created set and the inputSet . |
setName | The newly created set name. |
void geosx::ObjectManagerBase::copyObject | ( | localIndex const | source, |
localIndex const | destination | ||
) |
Copy object from source
to @ destination.
source | The source index. |
destination | The destination index. |
void geosx::ObjectManagerBase::createSet | ( | const string & | newSetName | ) |
Creates a new set.
newSetName | The set name. |
|
virtual |
Updates the child and target indices after a topology change.
targetIndices | The indices top update. |
Reimplemented in geosx::FaceManager.
|
inline |
Get the external set.
Definition at line 805 of file ObjectManagerBase.hpp.
|
inline |
Get the external set, const version.
Definition at line 812 of file ObjectManagerBase.hpp.
|
inlinevirtual |
Extract map from object and assign global indices.
nodeManager | The node manager. |
map | The map. |
Dummy version, needs to be specialised by derived classes.
Reimplemented in geosx::FaceManager, and geosx::EdgeManager.
Definition at line 370 of file ObjectManagerBase.hpp.
|
static |
Fixing the up/down maps by mapping the unmapped indices.
TYPE_RELATION | Some InterObjectRelation template class instance. |
relation | Global to local indices relations. |
unmappedIndices | Unmapped indices we will map during this function call. |
clearIfUnmapped | Shall we clear the unmapped indices. Here unused. |
Definition at line 994 of file ObjectManagerBase.hpp.
|
static |
Fixing the up/down maps by mapping the unmapped indices.
TYPE_RELATION | Some InterObjectRelation template class instance. |
relation | Global to local indices relations. |
unmappedIndices | Unmapped indices we will map during this function call. |
clearIfUnmapped | Shall we clear the unmapped indices. |
Definition at line 1030 of file ObjectManagerBase.hpp.
|
inlinestatic |
Fixing the up/down maps by mapping the unmapped indices.
relation | Global to local indices relations. |
globalToLocal | This map is used instead of the map provided by relation . |
unmappedIndices | Unmapped indices we will map during this function call. |
clearIfUnmapped | Shall we clear the unmapped indices. Here unused. |
Definition at line 1066 of file ObjectManagerBase.hpp.
|
static |
Acessing the unique instance of this catalog.
|
pure virtual |
Get the name of the catalog.
Implemented in geosx::NodeManager, geosx::EmbeddedSurfaceNodeManager, geosx::ElementRegionManager, geosx::PerforationData, geosx::SurfaceElementRegion, geosx::EmbeddedSurfaceSubRegion, geosx::WellElementSubRegion, geosx::CellElementRegion, geosx::WellElementRegion, geosx::FaceElementRegion, geosx::EmbeddedSurfaceRegion, geosx::FaceManager, geosx::EdgeManager, geosx::CellBlock, geosx::SurfaceElementSubRegion, geosx::FaceElementSubRegion, geosx::AggregateElementSubRegion, and geosx::CellBlockManager.
|
inline |
Get the domain boundary indicator.
Definition at line 940 of file ObjectManagerBase.hpp.
|
inline |
Get the domain boundary indicator.
Definition at line 946 of file ObjectManagerBase.hpp.
|
inline |
Get a view to the data associated with a trait from this ObjectManagerBase.
MESH_DATA_TRAIT | The trait that holds the type and key of the data to be retrieved from this ObjectManagerBase. |
Definition at line 618 of file ObjectManagerBase.hpp.
|
inline |
Get the data associated with a trait from this ObjectManagerBase.
MESH_DATA_TRAIT | The trait that holds the type and key of the data to be retrieved from this ObjectManagerBase. |
Definition at line 630 of file ObjectManagerBase.hpp.
|
inline |
Get neighbor data for given rank
.
rank | The rank |
Definition at line 888 of file ObjectManagerBase.hpp.
|
inline |
Get neighbor data for given rank
, const version.
rank | The rank |
Definition at line 896 of file ObjectManagerBase.hpp.
localIndex geosx::ObjectManagerBase::getNumberOfGhosts | ( | ) | const |
Get the number of ghost objects.
localIndex geosx::ObjectManagerBase::getNumberOfLocalIndices | ( | ) | const |
Get the number of locally owned objects.
|
inlinestatic |
Get the upmost parent.
parentIndices | The list of parent indices. |
lookup | The index for which we are looking for the parent |
Get the upmost parent (i.e. parent of parent of parent...) of lookup
that has no more valid parent in parentIndices
.
Definition at line 549 of file ObjectManagerBase.hpp.
Get the ghost information of each object.
Definition at line 873 of file ObjectManagerBase.hpp.
|
inline |
Get the ghost information of each object, const version.
Definition at line 880 of file ObjectManagerBase.hpp.
|
inline |
Get global to local map.
Definition at line 844 of file ObjectManagerBase.hpp.
|
inline |
Retrieves the local index for given global index.
gid | The global index. |
Definition at line 852 of file ObjectManagerBase.hpp.
|
inlinevirtual |
Get the group keys for Group access.
Definition at line 780 of file ObjectManagerBase.hpp.
|
inlinevirtual |
Get the group keys for Group access, const version.
Definition at line 785 of file ObjectManagerBase.hpp.
|
inline |
Checks if an extrinsic data has been registered.
MESH_DATA_TRAIT | The trait that holds the type and key of the data to be retrieved from this ObjectManagerBase. |
true
if the data has been registered, false
otherwise. Definition at line 642 of file ObjectManagerBase.hpp.
void geosx::ObjectManagerBase::inheritGhostRankFromParent | ( | std::set< localIndex > const & | indices | ) |
sets the value of m_ghostRank to the value of the objects parent.
indices | the list of indices for which to set the ghost rank |
This function takes a list of indices, and then sets the value of m_ghostRank for those indices to be equal to the value of the "parent" index. This assumes that "parentIndex" is allocated and filled correctly.
Get the locality information of the objects.
Definition at line 859 of file ObjectManagerBase.hpp.
|
inline |
Get the locality information of the objects.
Definition at line 866 of file ObjectManagerBase.hpp.
|
inline |
Get the local maximum global index on this rank.
Definition at line 924 of file ObjectManagerBase.hpp.
|
inline |
Get local to global map.
Definition at line 830 of file ObjectManagerBase.hpp.
|
inline |
Get local to global map, const version.
Definition at line 837 of file ObjectManagerBase.hpp.
|
inline |
Get the maximum global index of all objects across all rank. See.
Definition at line 931 of file ObjectManagerBase.hpp.
void geosx::ObjectManagerBase::moveSets | ( | LvArray::MemorySpace const | targetSpace | ) |
Manually move all sets to a memory space.
targetSpace | The memory space to move sets to. |
|
overridevirtual |
Pack a list of indices within a list of wrappers.
[in,out] | buffer | the buffer that will be packed. |
[in] | wrapperNames | an array that contains the names of the wrappers to pack. |
[in] | packList | the list of indices to pack |
[in] | recursive | whether or not to perform a recursive pack. |
[in] | onDevice | whether to use device-based packing functions (buffer must be either pinned or a device pointer) |
[out] | events | a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized ) |
This function takes in a reference to a pointer buffer
, and packs data specified by wrapperNames
, packList
, and recursive
to that pointer location. The pointer is altered and returned to the new location corresponding the original value of buffer
plus the size of data packed to the buffer.
Reimplemented from geosx::dataRepository::Group.
|
virtual |
Packs the global maps elements in the @ packList.
buffer | The buffer that will receive the packed data. |
packList | The element we want packed. |
recursive | Boolean like integer for sub-groups packing. |
|
virtual |
Computes the pack size of the global maps elements in the @ packList.
packList | The element we want packed. |
recursive | Boolean like integer for sub-groups packing. |
|
inline |
Packs the parent/child relations in packList
.
buffer | The buffer that will receive the packed data. |
packList | The indices we want packed. |
Definition at line 224 of file ObjectManagerBase.hpp.
|
inline |
Computes the pack size of the parent/child relations in packList
.
packList | The indices we want packed. |
Definition at line 212 of file ObjectManagerBase.hpp.
localIndex geosx::ObjectManagerBase::packSets | ( | buffer_unit_type *& | buffer, |
arrayView1d< localIndex const > const & | packList | ||
) | const |
Packs the elements of each set that actually are in packList
.
DOPACK | Template parameter that decides at compile time whether one should actually pack or not. |
buffer | The buffer that will store the packed data. |
packList | The elements of each set that should be packed. |
Note that the returned value does not depend on parameter DOPACK
.
|
overridevirtual |
Get the size required to pack a list of indices within a list of wrappers.
[in] | wrapperNames | an array that contains the names of the wrappers to pack. |
[in] | packList | the list of indices to pack |
[in] | recursive | whether or not to perform a recursive pack. |
[in] | onDevice | whether to use device-based packing functions (buffer must be either pinned or a device pointer) |
[out] | events | a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized ) |
Reimplemented from geosx::dataRepository::Group.
|
inlinevirtual |
Packs the specific elements in the @ packList.
buffer | The buffer that will receive the packed data. |
packList | The element we want packed. |
Reimplemented in geosx::WellElementSubRegion, geosx::FaceManager, geosx::EmbeddedSurfaceNodeManager, geosx::NodeManager, geosx::EmbeddedSurfaceSubRegion, geosx::EdgeManager, geosx::FaceElementSubRegion, and geosx::CellElementSubRegion.
Definition at line 168 of file ObjectManagerBase.hpp.
|
inlinevirtual |
Computes the pack size of the specific elements in the @ packList.
packList | The element we want packed. |
Reimplemented in geosx::WellElementSubRegion, geosx::FaceManager, geosx::EmbeddedSurfaceNodeManager, geosx::NodeManager, geosx::EmbeddedSurfaceSubRegion, geosx::EdgeManager, geosx::FaceElementSubRegion, and geosx::CellElementSubRegion.
Definition at line 156 of file ObjectManagerBase.hpp.
|
inline |
Register data with this ObjectManagerBase using a dataRepository::Wrapper.
MESH_DATA_TRAIT | The trait struct that holds the information for the data being registered with the repository. |
nameOfRegisteringObject | The name of the object that is requesting that this data be registered. |
MESH_DATA_TRAIT
. Definition at line 573 of file ObjectManagerBase.hpp.
|
inline |
Register a collection of data with this ObjectManagerBase using a dataRepository::Wrapper.
MESH_DATA_TRAIT0 | The first of the trait structs that holds the information for the data being registered with the repository. |
MESH_DATA_TRAIT1 | The second of the trait structs that holds the information for the data being registered with the repository. |
MESH_DATA_TRAITS | The parameter pack of trait structs that holds the information for the data being registered with the repository. |
nameOfRegisteringObject | The name of the object that is requesting that this data be registered. |
Definition at line 604 of file ObjectManagerBase.hpp.
|
inline |
Remove neighbor for rank
.
rank | The rank of the removed neighbor. |
Definition at line 914 of file ObjectManagerBase.hpp.
|
inline |
Resize the group and all contained wrappers that resize with parent.
newSize | the new size of the group |
Definition at line 299 of file ObjectManagerBase.hpp.
|
inline |
Defines neighborRank
ownership for ghost objects.
neighborRank | The rank that owns the ghost objects. |
Definition at line 381 of file ObjectManagerBase.hpp.
|
inline |
Get the group holding the object sets.
Definition at line 791 of file ObjectManagerBase.hpp.
|
inline |
Get the group holding the object sets, const version.
Definition at line 798 of file ObjectManagerBase.hpp.
integer geosx::ObjectManagerBase::splitObject | ( | localIndex const | indexToSplit, |
int const | rank, | ||
localIndex & | newIndex | ||
) |
Split object to deal with topology changes.
indexToSplit | Where to split. |
rank | MPI rank. |
newIndex | At which index the we'll have the new split instance. |
|
overridevirtual |
Unpack a buffer.
[in,out] | buffer | the buffer to unpack |
[in,out] | packList | the list of indices that will be unpacked. |
[in] | recursive | whether or not to perform a recursive unpack. |
[in] | onDevice | whether to use device-based packing functions (buffer must be either pinned or a device pointer) |
[out] | events | a collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized ) |
This function takes a reference to a pointer to const buffer type, and unpacks data from that buffer into the current Group. If packList
is non-empty, then a check is made to ensure that the data that is unpacked matches packList
. If packList
is empty, the values of the indices that are unpacked are stored and returned in packList.
Reimplemented from geosx::dataRepository::Group.
|
virtual |
Unpacks the global maps from buffer
.
buffer | The buffer containing the packed data. |
packList | The (un)packed element. |
recursive | Boolean like integer for sub-groups unpacking. |
localIndex geosx::ObjectManagerBase::unpackParentChildMaps | ( | buffer_unit_type const *& | buffer, |
localIndex_array & | packList | ||
) |
Unacks the parent/child relations in packList
.
buffer | The buffer containing the packed data. |
packList | The unpacked indices. |
localIndex geosx::ObjectManagerBase::unpackSets | ( | buffer_unit_type const *& | buffer | ) |
Unpack the content of buffer
into the sets of the instance.
buffer | The buffer containing the packed data. |
|
inlinevirtual |
Unpacks the specific elements in the @ packList.
buffer | The buffer containing the packed data. |
packList | The (un)packed element. |
overwriteUpMaps | Clear the up maps provided. |
overwriteDownMaps | Clear the down maps provided. |
Reimplemented in geosx::EmbeddedSurfaceSubRegion, geosx::FaceElementSubRegion, and geosx::CellElementSubRegion.
Definition at line 184 of file ObjectManagerBase.hpp.
|
inline |
Updates (if needed) the global index for local index lid
.
lid | The local index |
Definition at line 819 of file ObjectManagerBase.hpp.
|
inlinevirtual |
Get the view keys for Group access.
Reimplemented in geosx::CellElementSubRegion.
Definition at line 769 of file ObjectManagerBase.hpp.
|
inlinevirtual |
Get the view keys for Group access, const version.
Reimplemented in geosx::CellElementSubRegion.
Definition at line 775 of file ObjectManagerBase.hpp.
|
virtual |
Inserts in exclusionList
the data that shall not be packed.
[in,out] | exclusionList | Will receive the wrapper indices of the data that should not be packed. |
Note that data will be inserted into exclusionList
and that data previously present in exclusionList
may remain.
Reimplemented in geosx::WellElementSubRegion, geosx::FaceManager, geosx::EmbeddedSurfaceNodeManager, geosx::NodeManager, geosx::EmbeddedSurfaceSubRegion, geosx::FaceElementSubRegion, and geosx::CellElementSubRegion.
Array that holds the ghost information about each object.
A value of -2 means that the object is owned locally and not communicated. A value of -1 means that the object is owned locally and is communicated. A positive value means that the object is a ghost and is owned by that rank.
Definition at line 977 of file ObjectManagerBase.hpp.