The ObjectManagerBase is the base object of all object managers in the mesh data hierachy. More...

#include <ObjectManagerBase.hpp>

Inheritance diagram for geos::ObjectManagerBase:

[legend]

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, MPI_Op op=MPI_REPLACE) override
	Unpack a buffer. More...

template<bool DO_PACKING>
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...

void	excludeWrappersFromPacking (std::set< string > const &wrapperNames)
	Registers wrappers that will be excluded from packing. 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...

SortedArray< localIndex > &	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.

array1d< globalIndex >	constructGlobalListOfBoundaryObjects () const
	Computes the (global) index list that are domain boundaries. More...

virtual ArrayOfSets< globalIndex >	extractMapFromObjectForAssignGlobalIndexNumbers (ObjectManagerBase const &nodeManager)
	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...

void	eraseObject (std::set< localIndex > const &indicesToErase)
	Erase object from this object manager. 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 FIELD_TRAIT >
dataRepository::Wrapper< typename FIELD_TRAIT::type > &	registerField (string const &nameOfRegisteringObject)
	Register field with this ObjectManagerBase using a `dataRepository::Wrapper`. More...

template<typename FIELD_TRAIT >
dataRepository::Wrapper< typename FIELD_TRAIT::type > &	registerField (FIELD_TRAIT const &fieldTrait, typename FIELD_TRAIT::type *newObject)
	Helper function to register fields. More...

template<typename FIELD_TRAIT0 , typename FIELD_TRAIT1 , typename ... FIELD_TRAITS>
void	registerField (string const &nameOfRegisteringObject)
	Register a collection of fields with this ObjectManagerBase using a dataRepository::Wrapper. More...

template<typename FIELD_TRAIT >
GEOS_DECLTYPE_AUTO_RETURN	getField () const
	Get a view to the field associated with a trait from this `ObjectManagerBase`. More...

template<typename FIELD_TRAIT >
GEOS_DECLTYPE_AUTO_RETURN	getField ()
	Get the field associated with a trait from this `ObjectManagerBase`. More...

template<typename FIELD_TRAIT >
bool	hasField () const
	Checks if a field 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 > &	getSet (string const &setName)
	Get a set by name. More...

SortedArrayView< localIndex const >	getSet (string const &setName) const
	Get a set by name, 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...

array1d< integer > &	getDomainBoundaryIndicator ()
	Get the domain boundary indicator. More...

arrayView1d< integer const >	getDomainBoundaryIndicator () const
	Get the domain boundary indicator. More...

virtual void	outputObjectConnectivity () const
	Function to output connectivity in order to assist debugging issues with object connectivity.

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

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

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

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

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	getParentRecursive (arraySlice1d< localIndex const > const &parentIndices, localIndex const lookup)
	Get the upmost parent. 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...

Public Attributes
struct geos::ObjectManagerBase::viewKeyStruct	m_ObjectManagerBaseViewKeys
	viewKey struct for the ObjectManagerBase class

struct geos::ObjectManagerBase::groupKeyStruct	m_ObjectManagerBaseGroupKeys
	groupKey struct for the ObjectManagerBase class

Protected Attributes
Group	m_sets
	Group that holds object sets.

std::set< string >	m_packingExclusionList
	Names of the wrappers that should not be packed.

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

Protected Member Functions inherited from geos::dataRepository::Group
virtual void	postInputInitialization ()

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.

Detailed Description

The ObjectManagerBase is the base object of all object managers in the mesh data hierachy.

Definition at line 33 of file ObjectManagerBase.hpp.

Constructor & Destructor Documentation

◆ ObjectManagerBase()

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

explicit

Constructor.

Parameters

[in]	name	Name of this object manager
[in]	parent	Parent Group

Member Function Documentation

◆ addNeighbor()

void geos::ObjectManagerBase::addNeighbor ( int const rank )

inline

Add a neighbor for rank.

Parameters

rank	The rank of the new neighbor.

Definition at line 884 of file ObjectManagerBase.hpp.

◆ cleanUpMap() [1/5]

static void geos::ObjectManagerBase::cleanUpMap	(	std::set< localIndex > const &	targetIndices,
		array1d< SortedArray< localIndex > > &	upmap,
		arrayView1d< arrayView1d< localIndex const > const > const &	downmap
	)

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.

Parameters

	targetIndices	The indices we want to keep.
[in,out]	upmap	The map to be filtered
	downmap	The map used to check for target availability.

◆ cleanUpMap() [2/5]

static void geos::ObjectManagerBase::cleanUpMap	(	std::set< localIndex > const &	targetIndices,
		array1d< SortedArray< localIndex > > &	upmap,
		arrayView2d< localIndex const > const &	downmap
	)

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.

Parameters

	targetIndices	The indices we want to keep.
[in,out]	upmap	The map to be filtered
	downmap	The map used to check for target availability.

◆ cleanUpMap() [3/5]

static void geos::ObjectManagerBase::cleanUpMap	(	std::set< localIndex > const &	targetIndices,
		ArrayOfSetsView< localIndex > const &	upmap,
		ArrayOfArraysView< localIndex const > const &	downmap
	)

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.

Parameters

	targetIndices	The indices we want to keep.
[in,out]	upmap	The map to be filtered
	downmap	The map used to check for target availability.

◆ cleanUpMap() [4/5]

static void geos::ObjectManagerBase::cleanUpMap	(	std::set< localIndex > const &	targetIndices,
		ArrayOfSetsView< localIndex > const &	upmap,
		arrayView1d< arrayView1d< localIndex const > const > const &	downmap
	)

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.

Parameters

	targetIndices	The indices we want to keep.
[in,out]	upmap	The map to be filtered
	downmap	The map used to check for target availability.

◆ cleanUpMap() [5/5]

static void geos::ObjectManagerBase::cleanUpMap	(	std::set< localIndex > const &	targetIndices,
		ArrayOfSetsView< localIndex > const &	upmap,
		arrayView2d< localIndex const > const &	downmap
	)

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.

Parameters

	targetIndices	The indices we want to keep.
[in,out]	upmap	The map to be filtered
	downmap	The map used to check for target availability.

◆ constructGlobalListOfBoundaryObjects()

array1d< globalIndex > geos::ObjectManagerBase::constructGlobalListOfBoundaryObjects ( ) const

Computes the (global) index list that are domain boundaries.

Returns: Sorted container that is filled with the global indices.

◆ constructSetFromSetAndMap() [1/3]

void geos::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.

Parameters

inputSet	The input set.
map	The map between the newly created set and the `inputSet`.
setName	The newly created set name.

◆ constructSetFromSetAndMap() [2/3]

void geos::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.

Parameters

inputSet	The input set.
map	The map between the newly created set and the `inputSet`.
setName	The newly created set name.

◆ constructSetFromSetAndMap() [3/3]

void geos::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.

Parameters

inputSet	The input set.
map	The map between the newly created set and the `inputSet`.
setName	The newly created set name.

◆ copyObject()

void geos::ObjectManagerBase::copyObject	(	localIndex const	source,
		localIndex const	destination
	)

Copy object from source to @ destination.

Parameters

source	The source index.
destination	The destination index.

◆ createSet()

SortedArray< localIndex >& geos::ObjectManagerBase::createSet ( const string & newSetName )

Creates a new set.

Parameters

newSetName The set name.

Returns: reference to the set

◆ enforceStateFieldConsistencyPostTopologyChange()

virtual void geos::ObjectManagerBase::enforceStateFieldConsistencyPostTopologyChange ( std::set< localIndex > const & targetIndices )

virtual

Updates the child and target indices after a topology change.

Parameters

targetIndices The indices top update.

Reimplemented in geos::FaceManager.

◆ eraseObject()

void geos::ObjectManagerBase::eraseObject ( std::set< localIndex > const & indicesToErase )

Erase object from this object manager.

Parameters

indicesToErase The local indices of the object to be erased.

◆ excludeWrappersFromPacking()

void geos::ObjectManagerBase::excludeWrappersFromPacking ( std::set< string > const & wrapperNames )

Registers wrappers that will be excluded from packing.

Parameters

wrapperNames The wrapper names.

◆ externalSet() [1/2]

SortedArray< localIndex >& geos::ObjectManagerBase::externalSet ( )

inline

Get the external set.

Returns: Sorted array indices.

Definition at line 786 of file ObjectManagerBase.hpp.

◆ externalSet() [2/2]

SortedArrayView< localIndex const > geos::ObjectManagerBase::externalSet ( ) const

inline

Get the external set, const version.

Returns: Sorted array indices.

Definition at line 793 of file ObjectManagerBase.hpp.

◆ extractMapFromObjectForAssignGlobalIndexNumbers()

virtual ArrayOfSets< globalIndex > geos::ObjectManagerBase::extractMapFromObjectForAssignGlobalIndexNumbers ( ObjectManagerBase const & nodeManager )

inlinevirtual

Extract map from object and assign global indices.

Parameters

nodeManager The node manager.

Returns: The map.

Dummy version, needs to be specialised by derived classes.

Reimplemented in geos::FaceManager, and geos::EdgeManager.

Definition at line 359 of file ObjectManagerBase.hpp.

◆ fixUpDownMaps() [1/3]

void geos::ObjectManagerBase::fixUpDownMaps	(	ArrayOfSets< localIndex > &	relation,
		unordered_map< globalIndex, localIndex > const &	globalToLocal,
		map< localIndex, SortedArray< globalIndex > > &	unmappedIndices,
		bool const	clearIfUnmapped
	)

inlinestatic

Fixing the up/down maps by mapping the unmapped indices.

Parameters

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 1061 of file ObjectManagerBase.hpp.

◆ fixUpDownMaps() [2/3]

template<typename TYPE_RELATION >

void geos::ObjectManagerBase::fixUpDownMaps	(	TYPE_RELATION &	relation,
		map< localIndex, array1d< globalIndex > > &	unmappedIndices,
		bool const	clearIfUnmapped
	)

static

Fixing the up/down maps by mapping the unmapped indices.

Template Parameters

TYPE_RELATION Some InterObjectRelation template class instance.

Parameters

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 988 of file ObjectManagerBase.hpp.

◆ fixUpDownMaps() [3/3]

template<typename TYPE_RELATION >

void geos::ObjectManagerBase::fixUpDownMaps	(	TYPE_RELATION &	relation,
		map< localIndex, SortedArray< globalIndex > > &	unmappedIndices,
		bool const	clearIfUnmapped
	)

static

Fixing the up/down maps by mapping the unmapped indices.

Template Parameters

TYPE_RELATION Some InterObjectRelation template class instance.

Parameters

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 1025 of file ObjectManagerBase.hpp.

◆ getCatalog()

static CatalogInterface::CatalogType& geos::ObjectManagerBase::getCatalog ( )

static

Acessing the unique instance of this catalog.

Returns: A reference to the singleton.

◆ getCatalogName()

virtual string geos::ObjectManagerBase::getCatalogName ( ) const

pure virtual

Get the name of the catalog.

Returns: The name.

Implemented in geos::WellElementRegion, geos::SurfaceElementRegion, geos::ParticleSubRegion, geos::ParticleRegion, geos::ParticleManager, geos::NodeManager, geos::EmbeddedSurfaceNodeManager, geos::ElementRegionManager, geos::CellElementSubRegion, geos::CellElementRegion, geos::WellElementSubRegion, geos::SurfaceElementSubRegion, geos::PerforationData, geos::FaceManager, geos::FaceElementSubRegion, geos::EmbeddedSurfaceSubRegion, and geos::EdgeManager.

◆ getDomainBoundaryIndicator() [1/2]

array1d< integer >& geos::ObjectManagerBase::getDomainBoundaryIndicator ( )

inline

Get the domain boundary indicator.

Returns: The information in an array of integers, mainly treated as booleans.

Note: Domain boundary is to be understood as the boundary of the domain on the current rank, not the whole physical domain which spans all the ranks.

Definition at line 922 of file ObjectManagerBase.hpp.

◆ getDomainBoundaryIndicator() [2/2]

arrayView1d< integer const > geos::ObjectManagerBase::getDomainBoundaryIndicator ( ) const

inline

Get the domain boundary indicator.

Returns: The information in an array of integers, mainly treated as booleans.

Note: Domain boundary is to be understood as the boundary of the domain on the current rank, not the whole physical domain which spans all the ranks.

Definition at line 928 of file ObjectManagerBase.hpp.

◆ getField() [1/2]

template<typename FIELD_TRAIT >

GEOS_DECLTYPE_AUTO_RETURN geos::ObjectManagerBase::getField ( )

inline

Get the field associated with a trait from this ObjectManagerBase.

Template Parameters

FIELD_TRAIT The trait that holds the type and key of the field to be retrieved from this ObjectManagerBase.

Returns: A reference to the field.

Definition at line 639 of file ObjectManagerBase.hpp.

◆ getField() [2/2]

template<typename FIELD_TRAIT >

GEOS_DECLTYPE_AUTO_RETURN geos::ObjectManagerBase::getField ( ) const

inline

Get a view to the field associated with a trait from this ObjectManagerBase.

Template Parameters

FIELD_TRAIT The trait that holds the type and key of the field to be retrieved from this ObjectManagerBase.

Returns: A const reference to a view to const field.

Definition at line 627 of file ObjectManagerBase.hpp.

◆ getNeighborData() [1/2]

NeighborData& geos::ObjectManagerBase::getNeighborData ( int const rank )

inline

Get neighbor data for given rank.

Parameters

rank The rank

Returns: The neighbor data.

Definition at line 869 of file ObjectManagerBase.hpp.

◆ getNeighborData() [2/2]

NeighborData const& geos::ObjectManagerBase::getNeighborData ( int const rank ) const

inline

Get neighbor data for given rank, const version.

Parameters

rank The rank

Returns: The neighbor data.

Definition at line 877 of file ObjectManagerBase.hpp.

◆ getNumberOfGhosts()

localIndex geos::ObjectManagerBase::getNumberOfGhosts ( ) const

Get the number of ghost objects.

Returns: The number of ghost objects.

◆ getNumberOfLocalIndices()

localIndex geos::ObjectManagerBase::getNumberOfLocalIndices ( ) const

Get the number of locally owned objects.

Returns: The number of locally owned objects.

◆ getParentRecursive()

static localIndex geos::ObjectManagerBase::getParentRecursive	(	arraySlice1d< localIndex const > const &	parentIndices,
		localIndex const	lookup
	)

inlinestatic

Get the upmost parent.

Parameters

parentIndices	The list of parent indices.
lookup	The index for which we are looking for the parent

Returns: The upmost parent index.

Get the upmost parent (i.e. parent of parent of parent...) of lookup that has no more valid parent in parentIndices.

Definition at line 543 of file ObjectManagerBase.hpp.

◆ getSet() [1/2]

SortedArray< localIndex >& geos::ObjectManagerBase::getSet ( string const & setName )

inline

Get a set by name.

Parameters

setName Name of the set.

Returns: Sorted array indices.

Definition at line 771 of file ObjectManagerBase.hpp.

◆ getSet() [2/2]

SortedArrayView< localIndex const > geos::ObjectManagerBase::getSet ( string const & setName ) const

inline

Get a set by name, const version.

Parameters

setName Name of the set.

Returns: Sorted array indices.

Definition at line 779 of file ObjectManagerBase.hpp.

◆ ghostRank() [1/2]

array1d< integer > const& geos::ObjectManagerBase::ghostRank ( )

inline

Get the ghost information of each object.

Returns: See

See also: m_ghostRank

Definition at line 854 of file ObjectManagerBase.hpp.

◆ ghostRank() [2/2]

arrayView1d< integer const > geos::ObjectManagerBase::ghostRank ( ) const

inline

Get the ghost information of each object, const version.

Returns: See

See also: m_ghostRank

Definition at line 861 of file ObjectManagerBase.hpp.

◆ globalToLocalMap() [1/2]

unordered_map< globalIndex, localIndex > const& geos::ObjectManagerBase::globalToLocalMap ( ) const

inline

Get global to local map.

Returns: The mapping relationship as a array.

Definition at line 825 of file ObjectManagerBase.hpp.

◆ globalToLocalMap() [2/2]

localIndex geos::ObjectManagerBase::globalToLocalMap ( globalIndex const gid ) const

inline

Retrieves the local index for given global index.

Parameters

gid	The global index.

Returns: The local index.

Definition at line 833 of file ObjectManagerBase.hpp.

◆ groupKeys() [1/2]

virtual groupKeyStruct& geos::ObjectManagerBase::groupKeys ( )

inlinevirtual

Get the group keys for Group access.

Returns: The keys.

Definition at line 745 of file ObjectManagerBase.hpp.

◆ groupKeys() [2/2]

virtual groupKeyStruct const& geos::ObjectManagerBase::groupKeys ( ) const

inlinevirtual

Get the group keys for Group access, const version.

Returns: The keys.

Definition at line 750 of file ObjectManagerBase.hpp.

◆ hasField()

template<typename FIELD_TRAIT >

bool geos::ObjectManagerBase::hasField ( ) const

inline

Checks if a field has been registered.

Template Parameters

FIELD_TRAIT The trait that holds the type and key of the field to be retrieved from this ObjectManagerBase.

Returns: true if the field has been registered, false otherwise.

Definition at line 651 of file ObjectManagerBase.hpp.

◆ inheritGhostRankFromParent()

void geos::ObjectManagerBase::inheritGhostRankFromParent ( std::set< localIndex > const & indices )

sets the value of m_ghostRank to the value of the objects parent.

Parameters

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.

◆ isExternal() [1/2]

array1d< integer > const& geos::ObjectManagerBase::isExternal ( )

inline

Get the locality information of the objects.

Returns: The information is stored as an array of integers, see m_isExternal

Definition at line 840 of file ObjectManagerBase.hpp.

◆ isExternal() [2/2]

arrayView1d< integer const > geos::ObjectManagerBase::isExternal ( ) const

inline

Get the locality information of the objects.

Returns: The information is stored as an array of integers, see m_isExternal

Definition at line 847 of file ObjectManagerBase.hpp.

◆ localMaxGlobalIndex()

globalIndex geos::ObjectManagerBase::localMaxGlobalIndex ( ) const

inline

Get the local maximum global index on this rank.

Returns: The index.

Definition at line 905 of file ObjectManagerBase.hpp.

◆ localToGlobalMap() [1/2]

arrayView1d< globalIndex > geos::ObjectManagerBase::localToGlobalMap ( )

inline

Get local to global map.

Returns: The mapping relationship as a array.

Definition at line 811 of file ObjectManagerBase.hpp.

◆ localToGlobalMap() [2/2]

arrayView1d< globalIndex const > geos::ObjectManagerBase::localToGlobalMap ( ) const

inline

Get local to global map, const version.

Returns: The mapping relationship as a array.

Definition at line 818 of file ObjectManagerBase.hpp.

◆ maxGlobalIndex()

globalIndex geos::ObjectManagerBase::maxGlobalIndex ( ) const

inline

Get the maximum global index of all objects across all rank. See.

See also: m_maxGlobalIndex

Returns: The index.

Definition at line 912 of file ObjectManagerBase.hpp.

◆ moveSets()

void geos::ObjectManagerBase::moveSets ( LvArray::MemorySpace const targetSpace )

Manually move all sets to a memory space.

Parameters

targetSpace The memory space to move sets to.

◆ pack()

virtual localIndex geos::ObjectManagerBase::pack	(	buffer_unit_type *&	buffer,
		string_array const &	wrapperNames,
		arrayView1d< localIndex const > const &	packList,
		integer const	recursive,
		bool	onDevice,
		parallelDeviceEvents &	events
	)		const

overridevirtual

Pack a list of indices within a list of wrappers.

Parameters

[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 )

Returns: the size of data packed to the buffer.

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 geos::dataRepository::Group.

◆ packGlobalMaps()

virtual localIndex geos::ObjectManagerBase::packGlobalMaps	(	buffer_unit_type *&	buffer,
		arrayView1d< localIndex const > const &	packList,
		integer const	recursive
	)		const

virtual

Packs the global maps elements in the @ packList.

Parameters

buffer	The buffer that will receive the packed data.
packList	The element we want packed.
recursive	Boolean like integer for sub-groups packing.

Returns: The packed size.

◆ packGlobalMapsSize()

virtual localIndex geos::ObjectManagerBase::packGlobalMapsSize	(	arrayView1d< localIndex const > const &	packList,
		integer const	recursive
	)		const

virtual

Computes the pack size of the global maps elements in the @ packList.

Parameters

packList	The element we want packed.
recursive	Boolean like integer for sub-groups packing.

Returns: The packed size.

◆ packParentChildMaps()

localIndex geos::ObjectManagerBase::packParentChildMaps	(	buffer_unit_type *&	buffer,
		arrayView1d< localIndex const > const &	packList
	)		const

inline

Packs the parent/child relations in packList.

Parameters

buffer	The buffer that will receive the packed data.
packList	The indices we want packed.

Returns: The packed size.

Definition at line 221 of file ObjectManagerBase.hpp.

◆ packParentChildMapsSize()

localIndex geos::ObjectManagerBase::packParentChildMapsSize ( arrayView1d< localIndex const > const & packList ) const

inline

Computes the pack size of the parent/child relations in packList.

Parameters

packList The indices we want packed.

Returns: The packed size.

Definition at line 209 of file ObjectManagerBase.hpp.

◆ packSets()

template<bool DO_PACKING>

localIndex geos::ObjectManagerBase::packSets	(	buffer_unit_type *&	buffer,
		arrayView1d< localIndex const > const &	packList
	)		const

Packs the elements of each set that actually are in packList.

Template Parameters

DO_PACKING Template parameter that decides at compile time whether one should actually pack or not.

Parameters

buffer	The buffer that will store the packed data.
packList	The elements of each set that should be packed.

Returns: The size of the (potentially) packed data.

Note that the returned value does not depend on parameter DO_PACKING.

◆ packSize()

virtual localIndex geos::ObjectManagerBase::packSize	(	string_array const &	wrapperNames,
		arrayView1d< localIndex const > const &	packList,
		integer const	recursive,
		bool	onDevice,
		parallelDeviceEvents &	events
	)		const

overridevirtual

Get the size required to pack a list of indices within a list of wrappers.

Parameters

[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 )

Returns: the size of the buffer required to pack the wrapper indices.

Reimplemented from geos::dataRepository::Group.

◆ packUpDownMaps()

virtual localIndex geos::ObjectManagerBase::packUpDownMaps	(	buffer_unit_type *&	buffer,
		arrayView1d< localIndex const > const &	packList
	)		const

inlinevirtual

Packs the specific elements in the @ packList.

Parameters

buffer	The buffer that will receive the packed data.
packList	The element we want packed.

Returns: The packed size.

Reimplemented in geos::WellElementSubRegion, geos::NodeManager, geos::FaceManager, geos::FaceElementSubRegion, geos::EmbeddedSurfaceSubRegion, geos::EmbeddedSurfaceNodeManager, geos::EdgeManager, and geos::CellElementSubRegion.

Definition at line 165 of file ObjectManagerBase.hpp.

◆ packUpDownMapsSize()

virtual localIndex geos::ObjectManagerBase::packUpDownMapsSize ( arrayView1d< localIndex const > const & packList ) const

inlinevirtual

Computes the pack size of the specific elements in the @ packList.

Parameters

packList The element we want packed.

Returns: The packed size.

Reimplemented in geos::WellElementSubRegion, geos::NodeManager, geos::FaceManager, geos::FaceElementSubRegion, geos::EmbeddedSurfaceSubRegion, geos::EmbeddedSurfaceNodeManager, geos::EdgeManager, and geos::CellElementSubRegion.

Definition at line 153 of file ObjectManagerBase.hpp.

◆ registerField() [1/3]

template<typename FIELD_TRAIT >

dataRepository::Wrapper< typename FIELD_TRAIT::type >& geos::ObjectManagerBase::registerField	(	FIELD_TRAIT const &	fieldTrait,
		typename FIELD_TRAIT::type *	newObject
	)

inline

Helper function to register fields.

Template Parameters

FIELD_TRAIT the type of field

Parameters

[in]	fieldTrait	the struct corresponding to the field being registered
[in]	newObject	a pointer to the object that is being registered

Returns: A reference to the newly registered/created Wrapper

Definition at line 591 of file ObjectManagerBase.hpp.

◆ registerField() [2/3]

template<typename FIELD_TRAIT >

dataRepository::Wrapper< typename FIELD_TRAIT::type >& geos::ObjectManagerBase::registerField ( string const & nameOfRegisteringObject )

inline

Register field with this ObjectManagerBase using a dataRepository::Wrapper.

Template Parameters

FIELD_TRAIT The trait struct that holds the information for the field being registered with the repository.

Parameters

nameOfRegisteringObject The name of the object that is requesting that this field be registered.

Returns: A wrapper to the field by FIELD_TRAIT.

Definition at line 566 of file ObjectManagerBase.hpp.

◆ registerField() [3/3]

template<typename FIELD_TRAIT0 , typename FIELD_TRAIT1 , typename ... FIELD_TRAITS>

void geos::ObjectManagerBase::registerField ( string const & nameOfRegisteringObject )

inline

Register a collection of fields with this ObjectManagerBase using a dataRepository::Wrapper.

Template Parameters

FIELD_TRAIT0	The first of the trait structs that holds the information for the field being registered with the repository.
FIELD_TRAIT1	The second of the trait structs that holds the information for the field being registered with the repository.
FIELD_TRAITS	The parameter pack of trait structs that holds the information for the field being registered with the repository.

Parameters

nameOfRegisteringObject The name of the object that is requesting that this field be registered.

Definition at line 614 of file ObjectManagerBase.hpp.

◆ removeNeighbor()

void geos::ObjectManagerBase::removeNeighbor ( int const rank )

inline

Remove neighbor for rank.

Parameters

rank	The rank of the removed neighbor.

Definition at line 895 of file ObjectManagerBase.hpp.

◆ resize()

localIndex geos::ObjectManagerBase::resize	(	localIndex const	newSize,
		const bool
	)

inline

Resize the group and all contained wrappers that resize with parent.

Parameters

newSize the new size of the group

Returns: Always 0, whatever the new size is.

Definition at line 296 of file ObjectManagerBase.hpp.

◆ setGhostRankForSenders()

void geos::ObjectManagerBase::setGhostRankForSenders ( int const neighborRank )

inline

Defines neighborRank ownership for ghost objects.

Parameters

neighborRank The rank that owns the ghost objects.

Definition at line 369 of file ObjectManagerBase.hpp.

◆ sets() [1/2]

Group& geos::ObjectManagerBase::sets ( )

inline

Get the group holding the object sets.

Returns: The Group intance holding the sets.

Definition at line 756 of file ObjectManagerBase.hpp.

◆ sets() [2/2]

Group const& geos::ObjectManagerBase::sets ( ) const

inline

Get the group holding the object sets, const version.

Returns: The Group intance holding the sets.

Definition at line 763 of file ObjectManagerBase.hpp.

◆ splitObject()

integer geos::ObjectManagerBase::splitObject	(	localIndex const	indexToSplit,
		int const	rank,
		localIndex &	newIndex
	)

Split object to deal with topology changes.

Parameters

indexToSplit	Where to split.
rank	MPI rank.
newIndex	At which index the we'll have the new split instance.

Returns: Always 1.

◆ unpack()

virtual localIndex geos::ObjectManagerBase::unpack	(	buffer_unit_type const *&	buffer,
		arrayView1d< localIndex > &	packList,
		integer const	recursive,
		bool	onDevice,
		parallelDeviceEvents &	events,
		MPI_Op	op = `MPI_REPLACE`
	)

overridevirtual

Unpack a buffer.

Parameters

[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 )
[in]	op	the operation to perform while unpacking

Returns: the number of bytes unpacked.

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 geos::dataRepository::Group.

◆ unpackGlobalMaps()

virtual localIndex geos::ObjectManagerBase::unpackGlobalMaps	(	buffer_unit_type const *&	buffer,
		localIndex_array &	packList,
		integer const	recursive
	)

virtual

Unpacks the global maps from buffer.

Parameters

buffer	The buffer containing the packed data.
packList	The (un)packed element.
recursive	Boolean like integer for sub-groups unpacking.

Returns: The unpacked size.

◆ unpackParentChildMaps()

localIndex geos::ObjectManagerBase::unpackParentChildMaps	(	buffer_unit_type const *&	buffer,
		localIndex_array &	packList
	)

Unacks the parent/child relations in packList.

Parameters

buffer	The buffer containing the packed data.
packList	The unpacked indices.

Returns

◆ unpackSets()

localIndex geos::ObjectManagerBase::unpackSets ( buffer_unit_type const *& buffer )

Unpack the content of buffer into the sets of the instance.

Parameters

buffer The buffer containing the packed data.

Returns: The unpacked size.

◆ unpackUpDownMaps()

virtual localIndex geos::ObjectManagerBase::unpackUpDownMaps	(	buffer_unit_type const *&	buffer,
		array1d< localIndex > &	packList,
		bool const	overwriteUpMaps,
		bool const	overwriteDownMaps
	)

inlinevirtual

Unpacks the specific elements in the @ packList.

Parameters

buffer	The buffer containing the packed data.
packList	The (un)packed element.
overwriteUpMaps	Clear the up maps provided.
overwriteDownMaps	Clear the down maps provided.

Returns: The packed size.

Reimplemented in geos::FaceElementSubRegion, geos::EmbeddedSurfaceSubRegion, geos::EmbeddedSurfaceNodeManager, and geos::CellElementSubRegion.

Definition at line 181 of file ObjectManagerBase.hpp.

◆ updateGlobalToLocalMap()

void geos::ObjectManagerBase::updateGlobalToLocalMap ( localIndex const lid )

inline

Updates (if needed) the global index for local index lid.

Parameters

lid	The local index

Definition at line 800 of file ObjectManagerBase.hpp.

◆ viewKeys() [1/2]

virtual viewKeyStruct& geos::ObjectManagerBase::viewKeys ( )

inlinevirtual

Get the view keys for Group access.

Returns: The keys.

Reimplemented in geos::ParticleSubRegion, and geos::CellElementSubRegion.

Definition at line 734 of file ObjectManagerBase.hpp.

◆ viewKeys() [2/2]

virtual viewKeyStruct const& geos::ObjectManagerBase::viewKeys ( ) const

inlinevirtual

Get the view keys for Group access, const version.

Returns: The keys.

Reimplemented in geos::ParticleSubRegion, and geos::CellElementSubRegion.

Definition at line 740 of file ObjectManagerBase.hpp.

Member Data Documentation

◆ m_ghostRank

array1d< integer > geos::ObjectManagerBase::m_ghostRank

protected

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 971 of file ObjectManagerBase.hpp.

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

coreComponents/mesh/ObjectManagerBase.hpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Factory Catalog Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ObjectManagerBase()

Member Function Documentation

◆ addNeighbor()

◆ cleanUpMap() [1/5]

◆ cleanUpMap() [2/5]

◆ cleanUpMap() [3/5]

◆ cleanUpMap() [4/5]

◆ cleanUpMap() [5/5]

◆ constructGlobalListOfBoundaryObjects()

◆ constructSetFromSetAndMap() [1/3]

◆ constructSetFromSetAndMap() [2/3]

◆ constructSetFromSetAndMap() [3/3]

◆ copyObject()

◆ createSet()

◆ enforceStateFieldConsistencyPostTopologyChange()

◆ eraseObject()

◆ excludeWrappersFromPacking()

◆ externalSet() [1/2]

◆ externalSet() [2/2]

◆ extractMapFromObjectForAssignGlobalIndexNumbers()

◆ fixUpDownMaps() [1/3]

◆ fixUpDownMaps() [2/3]

◆ fixUpDownMaps() [3/3]

◆ getCatalog()

◆ getCatalogName()

◆ getDomainBoundaryIndicator() [1/2]

◆ getDomainBoundaryIndicator() [2/2]

◆ getField() [1/2]

◆ getField() [2/2]

◆ getNeighborData() [1/2]

◆ getNeighborData() [2/2]

◆ getNumberOfGhosts()

◆ getNumberOfLocalIndices()

◆ getParentRecursive()

◆ getSet() [1/2]

◆ getSet() [2/2]

◆ ghostRank() [1/2]

◆ ghostRank() [2/2]

◆ globalToLocalMap() [1/2]

◆ globalToLocalMap() [2/2]

◆ groupKeys() [1/2]

◆ groupKeys() [2/2]

◆ hasField()

◆ inheritGhostRankFromParent()

◆ isExternal() [1/2]

◆ isExternal() [2/2]

◆ localMaxGlobalIndex()

◆ localToGlobalMap() [1/2]

◆ localToGlobalMap() [2/2]

◆ maxGlobalIndex()

◆ moveSets()

◆ pack()

◆ packGlobalMaps()

◆ packGlobalMapsSize()

◆ packParentChildMaps()

◆ packParentChildMapsSize()

◆ packSets()

◆ packSize()

◆ packUpDownMaps()

◆ packUpDownMapsSize()

◆ registerField() [1/3]

◆ registerField() [2/3]

◆ registerField() [3/3]

◆ removeNeighbor()

◆ resize()

◆ setGhostRankForSenders()

◆ sets() [1/2]

◆ sets() [2/2]

◆ splitObject()

◆ unpack()

◆ unpackGlobalMaps()