GEOS
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
geos::ElementRegionManager Class Reference

The ElementRegionManager class provides an interface to ObjectManagerBase in order to manage ElementRegion data. More...

#include <ElementRegionManager.hpp>

Inheritance diagram for geos::ElementRegionManager:
Inheritance graph
[legend]

Classes

struct  groupKeyStruct
 Group key associated with elementRegionsGroup. More...
 

Public Types

template<typename VIEWTYPE >
using ElementViewAccessor = array1d< array1d< VIEWTYPE > >
 The ElementViewAccessor at the ElementRegionManager level is an array of array of VIEWTYPE. More...
 
template<typename VIEWTYPE >
using ElementView = typename ElementViewAccessor< VIEWTYPE >::NestedViewType
 The ElementViewAccessor at the ElementRegionManager level is the type resulting from ElementViewAccessor< VIEWTYPE >::toNestedView(). More...
 
template<typename VIEWTYPE >
using ElementViewConst = typename ElementViewAccessor< VIEWTYPE >::NestedViewTypeConst
 The ElementViewAccessor at the ElementRegionManager level is the type resulting from ElementViewAccessor< VIEWTYPE >::toNestedViewConst(). More...
 
template<typename VIEWTYPE >
using ElementReferenceAccessor = array1d< array1d< ReferenceWrapper< VIEWTYPE > > >
 The ElementViewAccessor at the ElementRegionManager level is a 2D array of ReferenceWrapper around VIEWTYPE. More...
 
template<typename VIEWTYPE >
using MaterialViewAccessor = array1d< array1d< array1d< VIEWTYPE > > >
 The MaterialViewAccessor at the ElementRegionManager level is a 3D array of VIEWTYPE. More...
 
template<typename CONSTITUTIVE_TYPE >
using ConstitutiveRelationAccessor = array1d< array1d< array1d< CONSTITUTIVE_TYPE * > > >
 The ConstitutiveRelationAccessor at the ElementRegionManager level is a 3D array of CONSTITUTIVE_TYPE. More...
 
- Public Types inherited from geos::ObjectManagerBase
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.
 
- 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.
 

Public Member Functions

virtual string getCatalogName () const override final
 Virtual access to catalogName() More...
 
 ElementRegionManager (string const &name, Group *const parent)
 Constructor. More...
 
virtual ~ElementRegionManager () override
 Destructor.
 
template<typename T = ElementSubRegionBase>
localIndex getNumberOfElements () const
 Get the number of elements in all ElementSubRegions of type T. More...
 
void generateMesh (CellBlockManagerABC const &cellBlockManager)
 Generate the mesh. Produce an error if a required cellBlock doesn't exist in the source mesh. More...
 
void generateWells (CellBlockManagerABC const &cellBlockManager, MeshLevel &meshLevel)
 Generate the wells. More...
 
void buildSets (NodeManager const &nodeManager)
 Build sets from the node sets. More...
 
virtual GroupcreateChild (string const &childKey, string const &childName) override
 Create a new ElementRegion object as a child of this group. More...
 
virtual void expandObjectCatalogs () override
 Expand any catalogs in the data structure.
 
virtual void setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType) override
 Inform the schema generator of any deviations between the xml and GEOS data structures. More...
 
void resize (integer_array const &numElements, string_array const &regionNames, string_array const &elementTypes)
 Set the number of elements for a set of element regions. More...
 
virtual void setMaxGlobalIndex () override final
 Set the maximum local and global index.
 
subGroupMap const & getRegions () const
 Get a collection of element regions. More...
 
subGroupMapgetRegions ()
 Get a collection of element regions. More...
 
template<typename T = ElementRegionBase, typename KEY_TYPE = void>
T const & getRegion (KEY_TYPE const &key) const
 Get a element region. More...
 
template<typename T = ElementRegionBase, typename KEY_TYPE = void>
T & getRegion (KEY_TYPE const &key)
 Get a element region. More...
 
template<typename T = ElementRegionBase>
bool hasRegion (string const &name) const
 Determines if an ElementRegion with the input name exists. More...
 
localIndex numRegions () const
 Get number of the regions. More...
 
array2d< localIndexgetCellBlockToSubRegionMap (CellBlockManagerABC const &cellBlockManager) const
 Produce a map from cell block indices to element region and subregion indices. More...
 
template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LAMBDA >
void forElementRegions (LAMBDA &&lambda)
 This function is used to launch kernel function over all the element regions with region type = ElementRegionBase. More...
 
template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LAMBDA >
void forElementRegions (LAMBDA &&lambda) const
 This const function is used to launch kernel function over all the element regions with region type = ElementRegionBase. More...
 
template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
 This function is used to launch kernel function over the target element regions with region type = ElementRegionBase. More...
 
template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
 This const function is used to launch kernel function over the target element regions with region type = ElementRegionBase. More...
 
template<typename LAMBDA >
void forElementRegionsComplete (LAMBDA lambda) const
 This const function is used to launch kernel function over all the types of element regions. More...
 
template<typename LAMBDA >
void forElementRegionsComplete (LAMBDA lambda)
 This function is used to launch kernel function over all the types of element regions. More...
 
template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >
void forElementRegionsComplete (LAMBDA lambda)
 This function is used to launch kernel function over all the element regions that can be casted to one of the specified region types. More...
 
template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >
void forElementRegionsComplete (LAMBDA lambda) const
 This const function is used to launch kernel function over all the element regions that can be casted to one of the specified region types. More...
 
template<typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda) const
 This const function is used to launch kernel function over the specified target element regions. More...
 
template<typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda)
 This function is used to launch kernel function over the specified target element regions. More...
 
template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda)
 This function is used to launch kernel function over the specified target element regions with region type = specified element region types. More...
 
template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA lambda) const
 This const function is used to launch kernel function over the specified target element regions with region type = specified element region types. More...
 
template<typename LAMBDA >
void forElementSubRegions (LAMBDA &&lambda)
 This function is used to launch kernel function over the element subregions of all the subregion types. More...
 
template<typename LAMBDA >
void forElementSubRegions (LAMBDA &&lambda) const
 This const function is used to launch kernel function over the element subregions of all the subregion types. More...
 
template<typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
 This function is used to launch kernel function over the specified target element subregions. More...
 
template<typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
 This const function is used to launch kernel function over the specified target element subregions. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void forElementSubRegions (LAMBDA &&lambda)
 This function is used to launch kernel function over the element subregions of the specified subregion types. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void forElementSubRegions (LAMBDA &&lambda) const
 This const function is used to launch kernel function over the element subregions of the specified subregion types. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
 This function is used to launch kernel function over the specified target element subregions with the specified subregion types. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegions (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
 This const function is used to launch kernel function over the specified target element subregions with the specified subregion types. More...
 
template<typename LAMBDA >
void forElementSubRegionsComplete (LAMBDA &&lambda) const
 This const function is used to launch kernel function over the element subregions of all subregion types. More...
 
template<typename LAMBDA >
void forElementSubRegionsComplete (LAMBDA &&lambda)
 This function is used to launch kernel function over the element subregions of all subregion types. More...
 
template<typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
 This function is used to launch kernel function over the specified target element subregions. More...
 
template<typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
 This const function is used to launch kernel function over the specified target element subregions. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void forElementSubRegionsComplete (LAMBDA &&lambda)
 This function is used to launch kernel function over all the element subregions that can be casted to one of the specified subregion types. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void forElementSubRegionsComplete (LAMBDA &&lambda) const
 This const function is used to launch kernel function over all the element subregions that can be casted to one of the specified subregion types. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda)
 This function is used to launch kernel function over the specified target element subregions that can be casted to one of the specified subregion types. More...
 
template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forElementSubRegionsComplete (LOOKUP_CONTAINER const &targetRegions, LAMBDA &&lambda) const
 This const function is used to launch kernel function over the specified target element subregions that can be casted to one of the specified subregion types. More...
 
template<typename FIELD_TRAIT >
ElementViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > constructFieldAccessor (string const &neighborName=string()) const
 This is a const function to construct a ElementViewAccessor to access the data registered on the mesh. More...
 
template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ElementViewAccessor< LHS > constructViewAccessor (string const &name, string const &neighborName=string()) const
 This is a const function to construct a ElementViewAccessor to access the data registered on the mesh. More...
 
template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ElementViewAccessor< LHS > constructViewAccessor (string const &name, string const &neighborName=string())
 This is a function to construct a ElementViewAccessor to access the data registered on the mesh. More...
 
template<typename T , int NDIM, typename PERM = defaultLayout< NDIM >>
ElementViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > constructArrayViewAccessor (string const &name, string const &neighborName=string()) const
 This is a function to construct a ElementViewAccessor to access array data registered on the mesh. More...
 
template<typename VIEWTYPE >
ElementViewAccessor< ReferenceWrapper< VIEWTYPE > > constructReferenceAccessor (string const &viewName, string const &neighborName=string()) const
 This is a const function to construct a ElementViewAccessor to access the data registered on the mesh. More...
 
template<typename VIEWTYPE >
ElementViewAccessor< ReferenceWrapper< VIEWTYPE > > constructReferenceAccessor (string const &viewName, string const &neighborName=string())
 This is a function to construct a ElementViewAccessor to access the data registered on the mesh. More...
 
template<typename VIEWTYPE , typename LHS = VIEWTYPE>
MaterialViewAccessor< LHS > constructFullMaterialViewAccessor (string const &viewName, constitutive::ConstitutiveManager const &cm) const
 This is a const function to construct a MaterialViewAccessor to access the material data. More...
 
template<typename VIEWTYPE , typename LHS = VIEWTYPE>
MaterialViewAccessor< LHS > constructFullMaterialViewAccessor (string const &viewName, constitutive::ConstitutiveManager const &cm)
 This is a function to construct a MaterialViewAccessor to access the material data. More...
 
template<typename FIELD_TRAIT >
ElementViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > constructMaterialFieldAccessor (arrayView1d< string const > const &regionNames, arrayView1d< string const > const &materialNames, bool const allowMissingViews=false) const
 This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials. More...
 
template<typename MATERIAL_TYPE , typename FIELD_TRAIT >
ElementViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > constructMaterialFieldAccessor (bool const allowMissingViews=false) const
 This is a const function to construct a MaterialViewAccessor to access the material data for specified material type. More...
 
template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ElementViewAccessor< LHS > constructMaterialViewAccessor (string const &viewName, arrayView1d< string const > const &regionNames, string const &materialKeyName, bool const allowMissingViews=false) const
 This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials. More...
 
template<typename VIEWTYPE , typename LHS = VIEWTYPE>
ElementViewAccessor< LHS > constructMaterialViewAccessor (string const &viewName, arrayView1d< string const > const &regionNames, string const &materialKeyName, bool const allowMissingViews=false)
 This is a function to construct a MaterialViewAccessor to access the material data for specified regions/materials. More...
 
template<typename T , int NDIM, typename PERM = defaultLayout< NDIM >>
ElementViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > constructMaterialArrayViewAccessor (string const &viewName, arrayView1d< string const > const &regionNames, string const &materialKeyName, bool const allowMissingViews=false) const
 Construct a view accessor for material data, assuming array as storage type. More...
 
template<typename MATERIALTYPE , typename VIEWTYPE , typename LHS = VIEWTYPE>
ElementViewAccessor< LHS > constructMaterialViewAccessor (string const &viewName) const
 Construct a const view accessor to material data for specified material type. More...
 
template<typename MATERIALTYPE , typename T , int NDIM, typename PERM = defaultLayout< NDIM >>
ElementViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > constructMaterialArrayViewAccessor (string const &viewName) const
 Construct a const view accessor for material data, assuming array as storage type. More...
 
template<typename CONSTITUTIVE_TYPE >
ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE > constructFullConstitutiveAccessor (constitutive::ConstitutiveManager const &cm) const
 Construct a ConstitutiveRelationAccessor. More...
 
template<typename CONSTITUTIVE_TYPE >
ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE > constructFullConstitutiveAccessor (constitutive::ConstitutiveManager const &cm)
 Construct a ConstitutiveRelationAccessor. More...
 
int packSize (ElementViewAccessor< arrayView1d< localIndex > > const &packList) const
 Get the buffer size needed to pack all the wrappers of all the sub regions of all the regions. More...
 
int pack (buffer_unit_type *&buffer, ElementViewAccessor< arrayView1d< localIndex > > const &packList) const
 Pack all the wrappers of all the sub regions of all the regions. More...
 
int unpack (buffer_unit_type const *&buffer, ElementViewAccessor< arrayView1d< localIndex > > &packList)
 Unpack a buffer. More...
 
int unpack (buffer_unit_type const *&buffer, ElementReferenceAccessor< array1d< localIndex > > &packList)
 Unpack a buffer. More...
 
int packGlobalMapsSize (ElementViewAccessor< arrayView1d< localIndex > > const &packList) const
 Get the size of the buffer to be packed. More...
 
int packGlobalMaps (buffer_unit_type *&buffer, ElementViewAccessor< arrayView1d< localIndex > > const &packList) const
 Pack a buffer. More...
 
int unpackGlobalMaps (buffer_unit_type const *&buffer, ElementViewAccessor< ReferenceWrapper< localIndex_array > > &packList)
 Unpack a buffer. More...
 
int packUpDownMapsSize (ElementViewAccessor< arrayView1d< localIndex > > const &packList) const
 Get the buffer size needed to pack element-to-node and element-to-face maps. More...
 
int packUpDownMapsSize (ElementReferenceAccessor< array1d< localIndex > > const &packList) const
 Get the buffer size needed to pack element-to-node and element-to-face maps. More...
 
int packUpDownMaps (buffer_unit_type *&buffer, ElementViewAccessor< arrayView1d< localIndex > > const &packList) const
 Pack element-to-node and element-to-face maps. More...
 
int packUpDownMaps (buffer_unit_type *&buffer, ElementReferenceAccessor< array1d< localIndex > > const &packList) const
 Pack element-to-node and element-to-face maps. More...
 
int unpackUpDownMaps (buffer_unit_type const *&buffer, ElementReferenceAccessor< localIndex_array > &packList, bool const overwriteMap)
 Unpack element-to-node and element-to-face maps. More...
 
int packFracturedElementsSize (ElementViewAccessor< arrayView1d< localIndex > > const &packList, string const fractureRegionName) const
 Get the buffer size needed to pack the set of fractured elements and the map toEmbSurfaces. More...
 
int packFracturedElements (buffer_unit_type *&buffer, ElementViewAccessor< arrayView1d< localIndex > > const &packList, string const fractureRegionName) const
 Pack set of fractured elements and map toEmbSurfaces to a buffer or get the buffer size. More...
 
int unpackFracturedElements (buffer_unit_type const *&buffer, ElementReferenceAccessor< localIndex_array > &packList, string const fractureRegionName)
 Unpack set of fractured elements and map toEmbSurfaces to a buffer or get the buffer size. More...
 
virtual void resize (localIndex const newSize)
 Resize the group and all contained wrappers that resize with parent. More...
 
virtual localIndex packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of wrappers. More...
 
virtual localIndex packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices within a list of wrappers. More...
 
localIndex packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices for all registered wrappers. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of wrappers to a buffer. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices within a list of wrappers. More...
 
localIndex pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices for all registered wrappers. More...
 
virtual localIndex 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...
 
virtual localIndex unpackGlobalMaps (buffer_unit_type const *&buffer, localIndex_array &packList, integer const recursive)
 Unpacks the global maps from buffer. More...
 
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 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...
 
- Public Member Functions inherited from geos::ObjectManagerBase
 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< globalIndexconstructGlobalListOfBoundaryObjects () const
 Computes the (global) index list that are domain boundaries. More...
 
virtual ArrayOfSets< globalIndexextractMapFromObjectForAssignGlobalIndexNumbers (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 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 viewKeyStructviewKeys ()
 Get the view keys for Group access. More...
 
virtual viewKeyStruct const & viewKeys () const
 Get the view keys for Group access, const version. More...
 
virtual groupKeyStructgroupKeys ()
 Get the group keys for Group access. More...
 
virtual groupKeyStruct const & groupKeys () const
 Get the group keys for Group access, const version. More...
 
Groupsets ()
 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< globalIndexlocalToGlobalMap ()
 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...
 
- 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.
 
Groupoperator= (Group const &)=delete
 Deleted copy assignment operator. More...
 
Groupoperator= (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...
 
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...
 
subGroupMapgetSubGroups ()
 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< stringgetSubGroupsNames () 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...
 
WrapperBaseregisterWrapper (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 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 >
WrapperBasegetWrapperBase (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...
 
wrapperMapwrappers ()
 Get access to the internal wrapper storage. More...
 
indexType numWrappers () const
 Return the number of wrappers. More...
 
std::vector< stringgetWrappersNames () 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
 
GroupgetParent ()
 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...
 
GroupsetSizedFromParent (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

static string catalogName ()
 The function is to return the name of the ElementRegionManager in the object catalog. More...
 
- Static Public Member Functions inherited from geos::ObjectManagerBase
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 CatalogInterface::CatalogTypegetCatalog ()
 Acessing the unique instance of this catalog. 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::CatalogTypegetCatalog ()
 Get the singleton catalog for this Group. More...
 

Static Public Attributes

constexpr static int maxNumNodesPerElem = 8
 

Additional Inherited Members

- Public Attributes inherited from geos::ObjectManagerBase
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 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.
 
- Protected Attributes inherited from geos::ObjectManagerBase
Group m_sets
 Group that holds object sets.
 
std::set< stringm_packingExclusionList
 Names of the wrappers that should not be packed.
 
Group m_neighborGroup
 Group that holds all the NeighborData objects.
 
array1d< globalIndexm_localToGlobalMap
 Contains the global index of each object.
 
unordered_map< globalIndex, localIndexm_globalToLocalMap
 Map from object global index to the local index.
 
array1d< integerm_isExternal
 Array that holds if an object is external.
 
array1d< integerm_domainBoundaryIndicator
 Domain boundary indicator: 1 means the "index" is on the boundary.
 
array1d< integerm_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.
 

Detailed Description

The ElementRegionManager class provides an interface to ObjectManagerBase in order to manage ElementRegion data.

Definition at line 42 of file ElementRegionManager.hpp.

Member Typedef Documentation

◆ ConstitutiveRelationAccessor

template<typename CONSTITUTIVE_TYPE >
using geos::ElementRegionManager::ConstitutiveRelationAccessor = array1d< array1d< array1d< CONSTITUTIVE_TYPE * > > >

The ConstitutiveRelationAccessor at the ElementRegionManager level is a 3D array of CONSTITUTIVE_TYPE.

Template Parameters
CONSTITUTIVE_TYPEconstitutive type

Definition at line 103 of file ElementRegionManager.hpp.

◆ ElementReferenceAccessor

template<typename VIEWTYPE >
using geos::ElementRegionManager::ElementReferenceAccessor = array1d< array1d< ReferenceWrapper< VIEWTYPE > > >

The ElementViewAccessor at the ElementRegionManager level is a 2D array of ReferenceWrapper around VIEWTYPE.

Template Parameters
VIEWTYPEdata type

Definition at line 88 of file ElementRegionManager.hpp.

◆ ElementView

template<typename VIEWTYPE >
using geos::ElementRegionManager::ElementView = typename ElementViewAccessor< VIEWTYPE >::NestedViewType

The ElementViewAccessor at the ElementRegionManager level is the type resulting from ElementViewAccessor< VIEWTYPE >::toNestedView().

Template Parameters
VIEWTYPEdata type

Definition at line 73 of file ElementRegionManager.hpp.

◆ ElementViewAccessor

template<typename VIEWTYPE >
using geos::ElementRegionManager::ElementViewAccessor = array1d< array1d< VIEWTYPE > >

The ElementViewAccessor at the ElementRegionManager level is an array of array of VIEWTYPE.

Template Parameters
VIEWTYPEdata type

Definition at line 65 of file ElementRegionManager.hpp.

◆ ElementViewConst

template<typename VIEWTYPE >
using geos::ElementRegionManager::ElementViewConst = typename ElementViewAccessor< VIEWTYPE >::NestedViewTypeConst

The ElementViewAccessor at the ElementRegionManager level is the type resulting from ElementViewAccessor< VIEWTYPE >::toNestedViewConst().

Template Parameters
VIEWTYPEdata type

Definition at line 81 of file ElementRegionManager.hpp.

◆ MaterialViewAccessor

template<typename VIEWTYPE >
using geos::ElementRegionManager::MaterialViewAccessor = array1d< array1d< array1d< VIEWTYPE > > >

The MaterialViewAccessor at the ElementRegionManager level is a 3D array of VIEWTYPE.

Template Parameters
VIEWTYPEdata type var[elementRegionIndex][elementSubRegionIndex][materialIndexInRegion]

Definition at line 96 of file ElementRegionManager.hpp.

Constructor & Destructor Documentation

◆ ElementRegionManager()

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

Constructor.

Parameters
[in]namethe name of this ObjectManager
[in]parentthe parent Group

Member Function Documentation

◆ buildSets()

void geos::ElementRegionManager::buildSets ( NodeManager const &  nodeManager)

Build sets from the node sets.

Parameters
[in]nodeManagerThe node manager that will provide the node sets.
Note
ElementRegionManager's sub-regions need to be properly defined.

◆ catalogName()

static string geos::ElementRegionManager::catalogName ( )
inlinestatic

The function is to return the name of the ElementRegionManager in the object catalog.

Returns
string that contains the catalog name used to register/lookup this class in the object catalog

Definition at line 109 of file ElementRegionManager.hpp.

◆ constructArrayViewAccessor()

template<typename T , int NDIM, typename PERM >
ElementRegionManager::ElementViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > geos::ElementRegionManager::constructArrayViewAccessor ( string const &  name,
string const &  neighborName = string() 
) const

This is a function to construct a ElementViewAccessor to access array data registered on the mesh.

Template Parameters
Tdata type
NDIMnumber of array dimensions
PERMlayout permutation sequence type
Parameters
nameview name of the data
neighborNameneighbor data name
Returns
ElementViewAccessor that contains ArrayView<T const, NDIM> of data

Definition at line 1265 of file ElementRegionManager.hpp.

◆ constructFieldAccessor()

template<typename FIELD_TRAIT >
ElementRegionManager::ElementViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > geos::ElementRegionManager::constructFieldAccessor ( string const &  neighborName = string()) const

This is a const function to construct a ElementViewAccessor to access the data registered on the mesh.

Template Parameters
FIELD_TRAITfield type
Parameters
neighborNameneighbor data name
Returns
ElementViewAccessor that contains traits::ViewTypeConst< typename TRAIT::type > data

Definition at line 1256 of file ElementRegionManager.hpp.

◆ constructFullConstitutiveAccessor() [1/2]

template<typename CONSTITUTIVE_TYPE >
ElementRegionManager::ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE > geos::ElementRegionManager::constructFullConstitutiveAccessor ( constitutive::ConstitutiveManager const &  cm)

Construct a ConstitutiveRelationAccessor.

Template Parameters
CONSTITUTIVE_TYPEconstitutive type
Parameters
cmpointer to ConstitutiveManager
Returns
ConstitutiveRelationAccessor

Definition at line 1624 of file ElementRegionManager.hpp.

◆ constructFullConstitutiveAccessor() [2/2]

template<typename CONSTITUTIVE_TYPE >
ElementRegionManager::ConstitutiveRelationAccessor< CONSTITUTIVE_TYPE > geos::ElementRegionManager::constructFullConstitutiveAccessor ( constitutive::ConstitutiveManager const &  cm) const

Construct a ConstitutiveRelationAccessor.

Template Parameters
CONSTITUTIVE_TYPEconstitutive type
Parameters
cmpointer to ConstitutiveManager
Returns
ConstitutiveRelationAccessor

Definition at line 1591 of file ElementRegionManager.hpp.

◆ constructFullMaterialViewAccessor() [1/2]

template<typename VIEWTYPE , typename LHS >
ElementRegionManager::MaterialViewAccessor< LHS > geos::ElementRegionManager::constructFullMaterialViewAccessor ( string const &  viewName,
constitutive::ConstitutiveManager const &  cm 
)

This is a function to construct a MaterialViewAccessor to access the material data.

Template Parameters
VIEWTYPEdata type
Parameters
viewNameview name of the data
cmpointer to ConstitutiveManager
Returns
MaterialViewAccessor that contains VIEWTYPE data

Definition at line 1373 of file ElementRegionManager.hpp.

◆ constructFullMaterialViewAccessor() [2/2]

template<typename VIEWTYPE , typename LHS >
ElementRegionManager::MaterialViewAccessor< LHS > geos::ElementRegionManager::constructFullMaterialViewAccessor ( string const &  viewName,
constitutive::ConstitutiveManager const &  cm 
) const

This is a const function to construct a MaterialViewAccessor to access the material data.

Template Parameters
VIEWTYPEdata type
Parameters
viewNameview name of the data
cmpointer to ConstitutiveManager
Returns
MaterialViewAccessor that contains VIEWTYPE data

Definition at line 1335 of file ElementRegionManager.hpp.

◆ constructMaterialArrayViewAccessor() [1/2]

template<typename MATERIALTYPE , typename T , int NDIM, typename PERM >
ElementRegionManager::ElementViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > geos::ElementRegionManager::constructMaterialArrayViewAccessor ( string const &  viewName) const

Construct a const view accessor for material data, assuming array as storage type.

Template Parameters
MATERIALTYPE
Tunderlying data type
NDIMnumber of array dimensions
PERMlayout permutation sequence type
Parameters
viewNameview name of the data
Returns
MaterialViewAccessor that contains the data views. Empty views are returned for subregions that don't contain a model derived from MODELTYPE.

Definition at line 1584 of file ElementRegionManager.hpp.

◆ constructMaterialArrayViewAccessor() [2/2]

template<typename T , int NDIM, typename PERM >
ElementRegionManager::ElementViewAccessor< ArrayView< T const, NDIM, getUSD< PERM > > > geos::ElementRegionManager::constructMaterialArrayViewAccessor ( string const &  viewName,
arrayView1d< string const > const &  regionNames,
string const &  materialKeyName,
bool const  allowMissingViews = false 
) const

Construct a view accessor for material data, assuming array as storage type.

Template Parameters
Tunderlying data type
NDIMnumber of array dimensions
PERMlayout permutation sequence type
Parameters
viewNameview name of the data
regionNameslist of region names
materialKeyNamekey of the wrapper that holds the material name on the subRegion.
allowMissingViewsflag to indicate whether it is allowed to miss the specified material data in material list
Returns
MaterialViewAccessor that contains the data views

Definition at line 1533 of file ElementRegionManager.hpp.

◆ constructMaterialFieldAccessor() [1/2]

template<typename FIELD_TRAIT >
ElementRegionManager::ElementViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > geos::ElementRegionManager::constructMaterialFieldAccessor ( arrayView1d< string const > const &  regionNames,
arrayView1d< string const > const &  materialNames,
bool const  allowMissingViews = false 
) const

This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials.

Template Parameters
FIELD_TRAITfield trait
Parameters
regionNameslist of region names
materialNameslist of corresponding material names
allowMissingViewsflag to indicate whether it is allowed to miss the specified material data in material list
Returns
ElementViewAccessor that contains traits::ViewTypeConst< typename FIELD_TRAIT::type > data

Definition at line 1510 of file ElementRegionManager.hpp.

◆ constructMaterialFieldAccessor() [2/2]

template<typename MATERIAL_TYPE , typename FIELD_TRAIT >
ElementRegionManager::ElementViewAccessor< traits::ViewTypeConst< typename FIELD_TRAIT::type > > geos::ElementRegionManager::constructMaterialFieldAccessor ( bool const  allowMissingViews = false) const

This is a const function to construct a MaterialViewAccessor to access the material data for specified material type.

Template Parameters
MATERIAL_TYPEbase type of material model
FIELD_TRAITfield trait
Parameters
allowMissingViewsflag to indicate whether it is allowed to miss the specified material data in material list
Returns
ElementViewAccessor that contains traits::ViewTypeConst< typename TRAIT::type > data

Definition at line 1523 of file ElementRegionManager.hpp.

◆ constructMaterialViewAccessor() [1/3]

template<typename MATERIALTYPE , typename VIEWTYPE , typename LHS >
ElementRegionManager::ElementViewAccessor< LHS > geos::ElementRegionManager::constructMaterialViewAccessor ( string const &  viewName) const

Construct a const view accessor to material data for specified material type.

Template Parameters
MATERIALTYPEbase type of material model
VIEWTYPEdata type
Parameters
viewNameview name of the data
Returns
ElementViewAccessor that contains VIEWTYPE data. Empty views are returned for subregions that don't contain a model derived from MODELTYPE.

Definition at line 1547 of file ElementRegionManager.hpp.

◆ constructMaterialViewAccessor() [2/3]

template<typename VIEWTYPE , typename LHS >
ElementRegionManager::ElementViewAccessor< LHS > geos::ElementRegionManager::constructMaterialViewAccessor ( string const &  viewName,
arrayView1d< string const > const &  regionNames,
string const &  materialKeyName,
bool const  allowMissingViews = false 
)

This is a function to construct a MaterialViewAccessor to access the material data for specified regions/materials.

Template Parameters
VIEWTYPEdata type
Parameters
viewNameview name of the data
regionNameslist of region names
materialKeyNamekey of the wrapper that holds the material name on the subRegion.
allowMissingViewsflag to indicate whether it is allowed to miss the specified material data in material list
Returns
ElementViewAccessor that contains VIEWTYPE data

Definition at line 1462 of file ElementRegionManager.hpp.

◆ constructMaterialViewAccessor() [3/3]

template<typename VIEWTYPE , typename LHS >
ElementRegionManager::ElementViewAccessor< LHS > geos::ElementRegionManager::constructMaterialViewAccessor ( string const &  viewName,
arrayView1d< string const > const &  regionNames,
string const &  materialKeyName,
bool const  allowMissingViews = false 
) const

This is a const function to construct a MaterialViewAccessor to access the material data for specified regions/materials.

Template Parameters
VIEWTYPEdata type
Parameters
viewNameview name of the data
regionNameslist of region names
materialKeyNamekey of the wrapper that holds the material name on the subRegion.
allowMissingViewsflag to indicate whether it is allowed to miss the specified material data in material list
Returns
ElementViewAccessor that contains VIEWTYPE data

Definition at line 1411 of file ElementRegionManager.hpp.

◆ constructReferenceAccessor() [1/2]

template<typename VIEWTYPE >
ElementRegionManager::ElementViewAccessor< ReferenceWrapper< VIEWTYPE > > geos::ElementRegionManager::constructReferenceAccessor ( string const &  viewName,
string const &  neighborName = string() 
)

This is a function to construct a ElementViewAccessor to access the data registered on the mesh.

Template Parameters
VIEWTYPEdata type
Parameters
viewNameview name of the data
neighborNameneighbor data name
Returns
ElementViewAccessor that contains pointers to wrapped VIEWTYPE data

Definition at line 1305 of file ElementRegionManager.hpp.

◆ constructReferenceAccessor() [2/2]

template<typename VIEWTYPE >
ElementRegionManager::ElementViewAccessor< ReferenceWrapper< VIEWTYPE > > geos::ElementRegionManager::constructReferenceAccessor ( string const &  viewName,
string const &  neighborName = string() 
) const

This is a const function to construct a ElementViewAccessor to access the data registered on the mesh.

Template Parameters
VIEWTYPEdata type
Parameters
viewNameview name of the data
neighborNameneighbor data name
Returns
ElementViewAccessor that contains pointers to wrapped VIEWTYPE data

Definition at line 1275 of file ElementRegionManager.hpp.

◆ constructViewAccessor() [1/2]

template<typename VIEWTYPE , typename LHS >
ElementRegionManager::ElementViewAccessor< LHS > geos::ElementRegionManager::constructViewAccessor ( string const &  name,
string const &  neighborName = string() 
)

This is a function to construct a ElementViewAccessor to access the data registered on the mesh.

Template Parameters
VIEWTYPEdata type
Parameters
nameview name of the data
neighborNameneighbor data name
Returns
ElementViewAccessor that contains VIEWTYPE data

Definition at line 1225 of file ElementRegionManager.hpp.

◆ constructViewAccessor() [2/2]

template<typename VIEWTYPE , typename LHS >
ElementRegionManager::ElementViewAccessor< LHS > geos::ElementRegionManager::constructViewAccessor ( string const &  name,
string const &  neighborName = string() 
) const

This is a const function to construct a ElementViewAccessor to access the data registered on the mesh.

Template Parameters
VIEWTYPEdata type
Parameters
nameview name of the data
neighborNameneighbor data name
Returns
ElementViewAccessor that contains VIEWTYPE data

Definition at line 1194 of file ElementRegionManager.hpp.

◆ createChild()

virtual Group* geos::ElementRegionManager::createChild ( string const &  childKey,
string const &  childName 
)
overridevirtual

Create a new ElementRegion object as a child of this group.

Parameters
childKeycatalog key of the new ElementRegion derived type to create
childNamename of the new ElementRegion object
Returns
pointer to the created ElementRegion object

Reimplemented from geos::dataRepository::Group.

◆ forElementRegions() [1/4]

template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementRegions ( LAMBDA &&  lambda)
inline

This function is used to launch kernel function over all the element regions with region type = ElementRegionBase.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 285 of file ElementRegionManager.hpp.

◆ forElementRegions() [2/4]

template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementRegions ( LAMBDA &&  lambda) const
inline

This const function is used to launch kernel function over all the element regions with region type = ElementRegionBase.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 297 of file ElementRegionManager.hpp.

◆ forElementRegions() [3/4]

template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementRegions ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
)
inline

This function is used to launch kernel function over the target element regions with region type = ElementRegionBase.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 311 of file ElementRegionManager.hpp.

◆ forElementRegions() [4/4]

template<typename REGIONTYPE = ElementRegionBase, typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementRegions ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
) const
inline

This const function is used to launch kernel function over the target element regions with region type = ElementRegionBase.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 325 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [1/8]

template<typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LAMBDA  lambda)
inline

This function is used to launch kernel function over all the types of element regions.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 348 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [2/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LAMBDA  lambda)
inline

This function is used to launch kernel function over all the element regions that can be casted to one of the specified region types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 361 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [3/8]

template<typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LAMBDA  lambda) const
inline

This const function is used to launch kernel function over all the types of element regions.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 336 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [4/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LAMBDA  lambda) const
inline

This const function is used to launch kernel function over all the element regions that can be casted to one of the specified region types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 381 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [5/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA  lambda 
)
inline

This function is used to launch kernel function over the specified target element regions.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 416 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [6/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA  lambda 
)
inline

This function is used to launch kernel function over the specified target element regions with region type = specified element region types.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 431 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [7/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA  lambda 
) const
inline

This const function is used to launch kernel function over the specified target element regions.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 402 of file ElementRegionManager.hpp.

◆ forElementRegionsComplete() [8/8]

template<typename REGIONTYPE , typename ... REGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA  lambda 
) const
inline

This const function is used to launch kernel function over the specified target element regions with region type = specified element region types.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 449 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [1/8]

template<typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LAMBDA &&  lambda)
inline

This function is used to launch kernel function over the element subregions of all the subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 464 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [2/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LAMBDA &&  lambda)
inline

This function is used to launch kernel function over the element subregions of the specified subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 518 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [3/8]

template<typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LAMBDA &&  lambda) const
inline

This const function is used to launch kernel function over the element subregions of all the subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 477 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [4/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LAMBDA &&  lambda) const
inline

This const function is used to launch kernel function over the element subregions of the specified subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 538 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [5/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
)
inline

This function is used to launch kernel function over the specified target element subregions.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 491 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [6/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
)
inline

This function is used to launch kernel function over the specified target element subregions with the specified subregion types.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 559 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [7/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
) const
inline

This const function is used to launch kernel function over the specified target element subregions.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 505 of file ElementRegionManager.hpp.

◆ forElementSubRegions() [8/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegions ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
) const
inline

This const function is used to launch kernel function over the specified target element subregions with the specified subregion types.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 581 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [1/8]

template<typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LAMBDA &&  lambda)
inline

This function is used to launch kernel function over the element subregions of all subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 612 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [2/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LAMBDA &&  lambda)
inline

This function is used to launch kernel function over all the element subregions that can be casted to one of the specified subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 653 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [3/8]

template<typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LAMBDA &&  lambda) const
inline

This const function is used to launch kernel function over the element subregions of all subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 600 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [4/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LAMBDA &&  lambda) const
inline

This const function is used to launch kernel function over all the element subregions that can be casted to one of the specified subregion types.

Template Parameters
LAMBDAtype of the user-provided function
Parameters
lambdakernel function

Definition at line 678 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [5/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
)
inline

This function is used to launch kernel function over the specified target element subregions.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 626 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [6/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
)
inline

This function is used to launch kernel function over the specified target element subregions that can be casted to one of the specified subregion types.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 705 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [7/8]

template<typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
) const
inline

This const function is used to launch kernel function over the specified target element subregions.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 640 of file ElementRegionManager.hpp.

◆ forElementSubRegionsComplete() [8/8]

template<typename SUBREGIONTYPE , typename ... SUBREGIONTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void geos::ElementRegionManager::forElementSubRegionsComplete ( LOOKUP_CONTAINER const &  targetRegions,
LAMBDA &&  lambda 
) const
inline

This const function is used to launch kernel function over the specified target element subregions that can be casted to one of the specified subregion types.

Template Parameters
LOOKUP_CONTAINERtype of container of names or indices
LAMBDAtype of the user-provided function
Parameters
targetRegionstarget element region names or indices
lambdakernel function

Definition at line 735 of file ElementRegionManager.hpp.

◆ generateMesh()

void geos::ElementRegionManager::generateMesh ( CellBlockManagerABC const &  cellBlockManager)

Generate the mesh. Produce an error if a required cellBlock doesn't exist in the source mesh.

Parameters
[in,out]cellBlockManagerReference to the abstract cell block manager.

◆ generateWells()

void geos::ElementRegionManager::generateWells ( CellBlockManagerABC const &  cellBlockManager,
MeshLevel meshLevel 
)

Generate the wells.

Parameters
[in]cellBlockManagerpointer to cellBlockManager
[in]meshLevelpointer to meshLevel

◆ getCatalogName()

virtual string geos::ElementRegionManager::getCatalogName ( ) const
inlinefinaloverridevirtual

Virtual access to catalogName()

Returns
string that contains the catalog name used to register/lookup this class in the object catalog

Implements geos::ObjectManagerBase.

Definition at line 116 of file ElementRegionManager.hpp.

◆ getCellBlockToSubRegionMap()

array2d< localIndex > geos::ElementRegionManager::getCellBlockToSubRegionMap ( CellBlockManagerABC const &  cellBlockManager) const

Produce a map from cell block indices to element region and subregion indices.

Parameters
cellBlockManagerthe CellBlocKManager
Returns
a (numBlock x 2) array with each row corresponding to a cell block and containing region (first entry) and subregion (second entry) indices, or -1 if block was not used.

◆ getNumberOfElements()

template<typename T = ElementSubRegionBase>
localIndex geos::ElementRegionManager::getNumberOfElements ( ) const
inline

Get the number of elements in all ElementSubRegions of type T.

Returns
number of elements

Definition at line 136 of file ElementRegionManager.hpp.

◆ getRegion() [1/2]

template<typename T = ElementRegionBase, typename KEY_TYPE = void>
T& geos::ElementRegionManager::getRegion ( KEY_TYPE const &  key)
inline

Get a element region.

Parameters
keyThe key of the element region, either name or number.
Returns
Reference to T.
Exceptions
std::domain_errorif the requested region doesn't exist.

Definition at line 244 of file ElementRegionManager.hpp.

◆ getRegion() [2/2]

template<typename T = ElementRegionBase, typename KEY_TYPE = void>
T const& geos::ElementRegionManager::getRegion ( KEY_TYPE const &  key) const
inline

Get a element region.

Parameters
keyThe key of element region, either name or number.
Returns
Reference to const T.
Exceptions
std::domain_errorif the requested region doesn't exist.

Definition at line 232 of file ElementRegionManager.hpp.

◆ getRegions() [1/2]

subGroupMap& geos::ElementRegionManager::getRegions ( )
inline

Get a collection of element regions.

Returns
reference to mutable subGroupMap

Definition at line 220 of file ElementRegionManager.hpp.

◆ getRegions() [2/2]

subGroupMap const& geos::ElementRegionManager::getRegions ( ) const
inline

Get a collection of element regions.

Returns
reference to immutable subGroupMap

Definition at line 211 of file ElementRegionManager.hpp.

◆ hasRegion()

template<typename T = ElementRegionBase>
bool geos::ElementRegionManager::hasRegion ( string const &  name) const
inline

Determines if an ElementRegion with the input name exists.

Template Parameters
TThe type of ElementRegion. May be a specific derived type of ElementRegionBase.
Parameters
nameThe name/key of the ElementRegion
Returns
true if the region exists, false if not.

Definition at line 256 of file ElementRegionManager.hpp.

◆ numRegions()

localIndex geos::ElementRegionManager::numRegions ( ) const
inline

Get number of the regions.

Returns
number of the regions

Definition at line 265 of file ElementRegionManager.hpp.

◆ pack() [1/4]

localIndex geos::dataRepository::Group::pack

Pack a list of indices for all registered wrappers.

Parameters
[in,out]bufferthe buffer that will be packed.
[in]packListthe list of indices to pack
[in]recursivewhether or not to perform a recursive pack.
[in]onDevicewhether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]eventsa 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.

◆ pack() [2/4]

int geos::ElementRegionManager::pack ( buffer_unit_type *&  buffer,
ElementViewAccessor< arrayView1d< localIndex > > const &  packList 
) const

Pack all the wrappers of all the sub regions of all the regions.

Parameters
bufferpointer to the buffer to be packed
packListlist of indices to pack
Returns
the size of data packed to the buffer

◆ pack() [3/4]

virtual localIndex geos::dataRepository::Group::pack

Pack a list of indices within a list of wrappers.

Parameters
[in,out]bufferthe buffer that will be packed.
[in]wrapperNamesan array that contains the names of the wrappers to pack.
[in]packListthe list of indices to pack
[in]recursivewhether or not to perform a recursive pack.
[in]onDevicewhether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]eventsa 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.

◆ pack() [4/4]

virtual localIndex geos::dataRepository::Group::pack

Pack a list of wrappers to a buffer.

Parameters
[in,out]bufferthe buffer that will be packed.
[in]wrapperNamesan array that contains the names of the wrappers to pack.
[in]recursivewhether or not to perform a recursive pack.
[in]onDevicewhether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]eventsa 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, 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.

◆ packFracturedElements()

int geos::ElementRegionManager::packFracturedElements ( buffer_unit_type *&  buffer,
ElementViewAccessor< arrayView1d< localIndex > > const &  packList,
string const  fractureRegionName 
) const

Pack set of fractured elements and map toEmbSurfaces to a buffer or get the buffer size.

Parameters
bufferpointer to the buffer to be packed
packListlist of indices to pack
fractureRegionNamename of the fracture region
Returns
the size of the data packed

◆ packFracturedElementsSize()

int geos::ElementRegionManager::packFracturedElementsSize ( ElementViewAccessor< arrayView1d< localIndex > > const &  packList,
string const  fractureRegionName 
) const

Get the buffer size needed to pack the set of fractured elements and the map toEmbSurfaces.

Parameters
packListlist of indices to pack
fractureRegionNamename of the fracture region
Returns
the buffer size needed to pack the data

◆ packGlobalMaps() [1/2]

virtual localIndex geos::ObjectManagerBase::packGlobalMaps

Packs the global maps elements in the @ packList.

Parameters
bufferThe buffer that will receive the packed data.
packListThe element we want packed.
recursiveBoolean like integer for sub-groups packing.
Returns
The packed size.

◆ packGlobalMaps() [2/2]

int geos::ElementRegionManager::packGlobalMaps ( buffer_unit_type *&  buffer,
ElementViewAccessor< arrayView1d< localIndex > > const &  packList 
) const

Pack a buffer.

Parameters
bufferpointer to the buffer to be packed
packListlist of indices to pack
Returns
the size of the data packed

◆ packGlobalMapsSize() [1/2]

virtual localIndex geos::ObjectManagerBase::packGlobalMapsSize

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

Parameters
packListThe element we want packed.
recursiveBoolean like integer for sub-groups packing.
Returns
The packed size.

◆ packGlobalMapsSize() [2/2]

int geos::ElementRegionManager::packGlobalMapsSize ( ElementViewAccessor< arrayView1d< localIndex > > const &  packList) const

Get the size of the buffer to be packed.

Parameters
packListlist of indices to pack
Returns
the size of the data packed

◆ packSize() [1/4]

localIndex geos::dataRepository::Group::packSize

Get the size required to pack a list of indices for all registered wrappers.

Parameters
[in]packListthe list of indices to pack
[in]recursivewhether or not to perform a recursive pack.
[in]onDevicewhether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]eventsa 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.

◆ packSize() [2/4]

int geos::ElementRegionManager::packSize ( ElementViewAccessor< arrayView1d< localIndex > > const &  packList) const

Get the buffer size needed to pack all the wrappers of all the sub regions of all the regions.

Parameters
packListlist of indices to pack
Returns
the size of the buffer required to pack the wrappers

◆ packSize() [3/4]

virtual localIndex geos::dataRepository::Group::packSize

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

Parameters
[in]wrapperNamesan array that contains the names of the wrappers to pack.
[in]packListthe list of indices to pack
[in]recursivewhether or not to perform a recursive pack.
[in]onDevicewhether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]eventsa 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.

◆ packSize() [4/4]

virtual localIndex geos::dataRepository::Group::packSize

Get the size required to pack a list of wrappers.

Parameters
[in]wrapperNamesan array that contains the names of the wrappers to pack.
[in]recursivewhether or not to perform a recursive pack.
[in]onDevicewhether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]eventsa 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 wrappers.

◆ packUpDownMaps() [1/3]

virtual localIndex geos::ObjectManagerBase::packUpDownMaps
inline

Packs the specific elements in the @ packList.

Parameters
bufferThe buffer that will receive the packed data.
packListThe element we want packed.
Returns
The packed size.

Definition at line 165 of file ObjectManagerBase.hpp.

◆ packUpDownMaps() [2/3]

int geos::ElementRegionManager::packUpDownMaps ( buffer_unit_type *&  buffer,
ElementReferenceAccessor< array1d< localIndex > > const &  packList 
) const

Pack element-to-node and element-to-face maps.

Parameters
bufferpointer to the buffer to be packed
packListlist of indices to pack
Returns
the size of data packed.

◆ packUpDownMaps() [3/3]

int geos::ElementRegionManager::packUpDownMaps ( buffer_unit_type *&  buffer,
ElementViewAccessor< arrayView1d< localIndex > > const &  packList 
) const

Pack element-to-node and element-to-face maps.

Parameters
bufferpointer to the buffer to be packed
packListlist of indices to pack
Returns
the size of data packed.

◆ packUpDownMapsSize() [1/3]

virtual localIndex geos::ObjectManagerBase::packUpDownMapsSize
inline

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

Parameters
packListThe element we want packed.
Returns
The packed size.

Definition at line 153 of file ObjectManagerBase.hpp.

◆ packUpDownMapsSize() [2/3]

int geos::ElementRegionManager::packUpDownMapsSize ( ElementReferenceAccessor< array1d< localIndex > > const &  packList) const

Get the buffer size needed to pack element-to-node and element-to-face maps.

Parameters
packListlist of indices to pack
Returns
the size of data packed.

◆ packUpDownMapsSize() [3/3]

int geos::ElementRegionManager::packUpDownMapsSize ( ElementViewAccessor< arrayView1d< localIndex > > const &  packList) const

Get the buffer size needed to pack element-to-node and element-to-face maps.

Parameters
packListlist of indices to pack
Returns
the size of data packed.

◆ resize() [1/2]

void geos::ElementRegionManager::resize ( integer_array const &  numElements,
string_array const &  regionNames,
string_array const &  elementTypes 
)

Set the number of elements for a set of element regions.

Parameters
numElementslist of the new element numbers
regionNameslist of the element region names
elementTypeslist of the element types

◆ resize() [2/2]

virtual void geos::dataRepository::Group::resize

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

Parameters
newSizethe new size of the group

◆ setSchemaDeviations()

virtual void geos::ElementRegionManager::setSchemaDeviations ( xmlWrapper::xmlNode  schemaRoot,
xmlWrapper::xmlNode  schemaParent,
integer  documentationType 
)
overridevirtual

Inform the schema generator of any deviations between the xml and GEOS data structures.

Parameters
schemaRootXML node corresponding to the root
schemaParentXML node for the parent node
documentationTypetype of XML schema generated

Reimplemented from geos::dataRepository::Group.

◆ unpack() [1/3]

virtual localIndex geos::ObjectManagerBase::unpack
override

Unpack a buffer.

Parameters
[in,out]bufferthe buffer to unpack
[in,out]packListthe list of indices that will be unpacked.
[in]recursivewhether or not to perform a recursive unpack.
[in]onDevicewhether to use device-based packing functions (buffer must be either pinned or a device pointer)
[out]eventsa collection of events to poll for completion of async packing kernels ( device packing is incomplete until all events are finalized )
[in]opthe 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.

◆ unpack() [2/3]

int geos::ElementRegionManager::unpack ( buffer_unit_type const *&  buffer,
ElementReferenceAccessor< array1d< localIndex > > &  packList 
)

Unpack a buffer.

Parameters
bufferpointer to the buffer to be unpacked
packListlist of indices to unpack
Returns
the size of data unpacked.

◆ unpack() [3/3]

int geos::ElementRegionManager::unpack ( buffer_unit_type const *&  buffer,
ElementViewAccessor< arrayView1d< localIndex > > &  packList 
)

Unpack a buffer.

Parameters
bufferpointer to the buffer to be unpacked
packListlist of indices to unpack
Returns
the size of data unpacked

◆ unpackFracturedElements()

int geos::ElementRegionManager::unpackFracturedElements ( buffer_unit_type const *&  buffer,
ElementReferenceAccessor< localIndex_array > &  packList,
string const  fractureRegionName 
)

Unpack set of fractured elements and map toEmbSurfaces to a buffer or get the buffer size.

Parameters
bufferpointer to the buffer to be packed
packListlist of indices to pack
fractureRegionNamename of the fracture region
Returns
the size of the data unpacked

◆ unpackGlobalMaps() [1/2]

int geos::ElementRegionManager::unpackGlobalMaps ( buffer_unit_type const *&  buffer,
ElementViewAccessor< ReferenceWrapper< localIndex_array > > &  packList 
)

Unpack a buffer.

Parameters
bufferpointer to the buffer to be unpacked
packListlist of indices to pack
Returns
the size of the data unpacked

◆ unpackGlobalMaps() [2/2]

virtual localIndex geos::ObjectManagerBase::unpackGlobalMaps

Unpacks the global maps from buffer.

Parameters
bufferThe buffer containing the packed data.
packListThe (un)packed element.
recursiveBoolean like integer for sub-groups unpacking.
Returns
The unpacked size.

◆ unpackUpDownMaps() [1/2]

virtual localIndex geos::ObjectManagerBase::unpackUpDownMaps
inline

Unpacks the specific elements in the @ packList.

Parameters
bufferThe buffer containing the packed data.
packListThe (un)packed element.
overwriteUpMapsClear the up maps provided.
overwriteDownMapsClear the down maps provided.
Returns
The packed size.

Definition at line 181 of file ObjectManagerBase.hpp.

◆ unpackUpDownMaps() [2/2]

int geos::ElementRegionManager::unpackUpDownMaps ( buffer_unit_type const *&  buffer,
ElementReferenceAccessor< localIndex_array > &  packList,
bool const  overwriteMap 
)

Unpack element-to-node and element-to-face maps.

Parameters
bufferpointer to the buffer to be unpacked
packListlist of indices to pack
overwriteMapflag to indicate whether to overwrite the local map
Returns
the size of data packed.

Member Data Documentation

◆ maxNumNodesPerElem

constexpr static int geos::ElementRegionManager::maxNumNodesPerElem = 8
staticconstexpr

Limit on max number of nodes for each element

Definition at line 58 of file ElementRegionManager.hpp.


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