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

#include <CellElementSubRegion.hpp>

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

Classes

struct  viewKeyStruct
 struct to serve as a container for variable strings and keys More...
 

Public Types

using NodeMapType = InterObjectRelation< array2d< localIndex, cells::NODE_MAP_PERMUTATION > >
 Alias for the type of the element-to-node map.
 
using EdgeMapType = FixedOneToManyRelation
 Alias for the type of the element-to-edge map.
 
using FaceMapType = FixedOneToManyRelation
 Alias for the type of the element-to-face map.
 
using EmbSurfMapType = InterObjectRelation< ArrayOfArrays< localIndex > >
 Type of map between cell blocks and embedded elements.
 
- 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
 Const getter for the catalog name. More...
 
void addFracturedElement (localIndex const cellElemIndex, localIndex const embSurfIndex)
 Add fractured element to list and relative entries to the map. More...
 
virtual void resizePerElementValues (localIndex const numNodesPerElement, localIndex const numEdgesPerElement, localIndex const numFacesPerElement) override
 Set all "perElement" values for this subregion. More...
 
virtual viewKeyStructviewKeys () override
 Get the view keys for Group access. More...
 
virtual const viewKeyStructviewKeys () const override
 Get the view keys for Group access, const version. More...
 
localIndex getFaceNodes (localIndex const elementIndex, localIndex const localFaceIndex, Span< localIndex > const nodeIndices) const
 Get the local indices of the nodes in a face of the element. More...
 
NodeMapTypenodeList ()
 Get the element-to-node map. More...
 
const NodeMapTypenodeList () const
 Get the element-to-node map. More...
 
localIndexnodeList (localIndex k, localIndex a)
 Get the local index of the a-th node of the k-th element. More...
 
const localIndexnodeList (localIndex k, localIndex a) const
 Get the local index of the a-th node of the k-th element. More...
 
FixedOneToManyRelationedgeList ()
 Get the element-to-edge map. More...
 
const FixedOneToManyRelationedgeList () const
 Get the element-to-edge map. More...
 
FixedOneToManyRelationfaceList ()
 Get the element-to-face map. More...
 
const FixedOneToManyRelationfaceList () const
 Get the element-to-face map. More...
 
localIndex faceList (localIndex k, localIndex a) const
 Get the local index of the a-th face of the k-th element. More...
 
array4d< real64 > & dNdX ()
 
arrayView4d< real64 const > dNdX () const
 
array2d< real64 > & detJ ()
 
arrayView2d< real64 const > detJ () const
 
SortedArray< localIndex > & fracturedElementsList ()
 
const SortedArrayView< localIndex const > fracturedElementsList () const
 
EmbSurfMapTypeembeddedSurfacesList ()
 
const EmbSurfMapTypeembeddedSurfacesList () const
 
void calculateElementCenters (arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &X) const
 Compute the center of each element in the subregion. More...
 
void calculateElementGeometricQuantities (NodeManager const &nodeManager, FaceManager const &faceManager) override
 Calculate the geometric quantities for each element in the subregion. More...
 
Constructor / Destructor
 CellElementSubRegion (string const &name, Group *const parent)
 Constructor for this class. More...
 
Helpers for CellElementSubRegion construction
void copyFromCellBlock (CellBlockABC const &cellBlock)
 Fill the CellElementSubRegion by copying those of the source CellBlock. More...
 
Overriding packing / Unpacking functions
virtual localIndex packUpDownMapsSize (arrayView1d< localIndex const > const &packList) const override
 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 override
 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) override
 Unpacks the specific elements in the @ packList. More...
 
localIndex packFracturedElementsSize (arrayView1d< localIndex const > const &packList, arrayView1d< globalIndex const > const &embeddedSurfacesLocalToGlobal) const
 Computes the pack size of the set of fractured elements and the element-to-embeddedSurfaces map of the elements in the @ packList. More...
 
localIndex packFracturedElements (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, arrayView1d< globalIndex const > const &embeddedSurfacesLocalToGlobal) const
 Packs the set of fractured elements and the element-to-embeddedSurfaces map of the elements in the @ packList. More...
 
localIndex unpackFracturedElements (buffer_unit_type const *&buffer, localIndex_array &packList, unordered_map< globalIndex, localIndex > const &embeddedSurfacesGlobalToLocal)
 Unpacks the set of fractured elemetn and the element-to-embeddedSurfaces map from buffer. More...
 
virtual void fixUpDownMaps (bool const clearIfUnmapped) final override
 Call ObjectManagerBase::fixUpDownMaps for the connectivity maps needed by the derived class (i.e., element-to-node map, element-to-face map, etc) More...
 
Miscellaneous
template<typename LAMBDA >
void forMaterials (LAMBDA lambda)
 Helper function to apply a lambda function over all constructive groups. More...
 
- Public Member Functions inherited from geos::ElementSubRegionBase
 ElementSubRegionBase (string const &name, dataRepository::Group *const parent)
 Constructor for this class. More...
 
 ~ElementSubRegionBase ()
 Destructor.
 
const localIndexnumNodesPerElement () const
 Get the number of nodes per element. More...
 
virtual localIndex numNodesPerElement (localIndex const k) const
 Get the number of nodes per element. More...
 
const localIndexnumFacesPerElement () const
 Get the number of faces per element. More...
 
const localIndexnumEdgesPerElement () const
 Gets the number of edges per element. More...
 
arrayView2d< real64 const > getElementCenter () const
 Get the center of each element in this subregion. More...
 
array2d< real64 > & getElementCenter ()
 Get the center of each element in this subregion. More...
 
arrayView1d< real64 const > getElementVolume () const
 Get the volume of each element in this subregion. More...
 
const dataRepository::GroupgetConstitutiveModels () const
 Get the group in which the constitutive models of this subregion are registered. More...
 
dataRepository::GroupgetConstitutiveModels ()
 Get the group in which the constitutive models of this subregion are registered. More...
 
template<typename T = constitutive::ConstitutiveBase>
const T & getConstitutiveModel (string const &name) const
 Get a pointer to the constitutive model. More...
 
template<typename T = constitutive::ConstitutiveBase>
T & getConstitutiveModel (string const &name)
 Get a pointer to the constitutive model. More...
 
ElementType getElementType () const
 Get the type of element in this subregion. More...
 
void setElementType (ElementType const elemType)
 Setter for m_elementType. 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 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 setMaxGlobalIndex ()
 Computes the maximum global index allong all the MPI ranks.
 
virtual void enforceStateFieldConsistencyPostTopologyChange (std::set< localIndex > const &targetIndices)
 Updates the child and target indices after a topology change. More...
 
template<typename FIELD_TRAIT >
dataRepository::Wrapper< typename FIELD_TRAIT::type > & registerField (string const &nameOfRegisteringObject)
 Register field with this ObjectManagerBase using a dataRepository::Wrapper. More...
 
template<typename FIELD_TRAIT >
dataRepository::Wrapper< typename FIELD_TRAIT::type > & registerField (FIELD_TRAIT const &fieldTrait, typename FIELD_TRAIT::type *newObject)
 Helper function to register fields. More...
 
template<typename FIELD_TRAIT0 , typename FIELD_TRAIT1 , typename ... FIELD_TRAITS>
void registerField (string const &nameOfRegisteringObject)
 Register a collection of fields with this ObjectManagerBase using a dataRepository::Wrapper. More...
 
template<typename FIELD_TRAIT >
GEOS_DECLTYPE_AUTO_RETURN getField () const
 Get a view to the field associated with a trait from this ObjectManagerBase. More...
 
template<typename FIELD_TRAIT >
GEOS_DECLTYPE_AUTO_RETURN getField ()
 Get the field associated with a trait from this ObjectManagerBase. More...
 
template<typename FIELD_TRAIT >
bool hasField () const
 Checks if a field has been registered. More...
 
virtual groupKeyStructgroupKeys ()
 Get the group keys for Group access. More...
 
virtual const groupKeyStructgroupKeys () const
 Get the group keys for Group access, const version. More...
 
Groupsets ()
 Get the group holding the object sets. More...
 
const Groupsets () 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...
 
const unordered_map< globalIndex, localIndex > & globalToLocalMap () const
 Get global to local map. More...
 
localIndex globalToLocalMap (globalIndex const gid) const
 Retrieves the local index for given global index. More...
 
const array1d< integer > & isExternal ()
 Get the locality information of the objects. More...
 
arrayView1d< integer const > isExternal () const
 Get the locality information of the objects. More...
 
const array1d< integer > & 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...
 
const NeighborData & 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
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...
 
virtual GroupcreateChild (string const &childKey, string const &childName)
 Creates a new sub-Group using the ObjectCatalog functionality. More...
 
template<typename T = Group, typename KEY = void>
T * getGroupPointer (KEY const &key)
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
const T * 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>
const T & 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>
const T & getGroupByPath (string const &path) const
 Retrieve a group from the hierarchy using a path. More...
 
subGroupMapgetSubGroups ()
 Get the subgroups object. More...
 
const subGroupMapgetSubGroups () 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 postProcessInputRecursive ()
 Recursively call postProcessInput() to apply post processing after reading input values.
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
 Create and register a Wrapper around a new object. More...
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
 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 expandObjectCatalogs ()
 Expand any catalogs in the data structure.
 
virtual void setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
 Inform the schema generator of any deviations between the xml and GEOS data structures. More...
 
virtual void registerDataOnMeshRecursive (Group &meshBodies)
 Calls RegisterDataOnMesh() recursively. More...
 
virtual void registerDataOnMesh (Group &meshBodies)
 Register data on mesh entities. More...
 
virtual localIndex packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of wrappers. More...
 
localIndex packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices for all registered wrappers. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of wrappers to a buffer. More...
 
localIndex pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices for all registered wrappers. More...
 
template<typename KEY >
const WrapperBasegetWrapperBase (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
 
const wrapperMapwrappers () 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 >
const Wrapper< T > & 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 >
const Wrapper< T > * 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...
 
const stringgetName () 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...
 
const DataContextgetDataContext () const
 
template<typename KEY >
const DataContextgetWrapperDataContext (KEY key) const
 
GroupgetParent ()
 Access the group's parent. More...
 
const GroupgetParent () 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...
 
const conduit::Node & getConduitNode () const
 Return the Conduit node object associated with this group. More...
 
void prepareToWrite ()
 Register the group and its wrappers with Conduit.
 
void finishWriting ()
 Write the group and its wrappers into Conduit.
 
void loadFromConduit ()
 Read the group and its wrappers from Conduit.
 
void enableLogLevelInput ()
 Enable verbosity input for object.
 
void setLogLevel (integer const logLevel)
 Set verbosity level. More...
 
integer getLogLevel () const
 

Static Public Member Functions

static string catalogName ()
 Const getter for the catalog name. 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 class. More...
 

Public Attributes

geos::CellElementSubRegion::viewKeyStruct m_CellBlockSubRegionViewKeys
 viewKey struct for the CellElementSubRegion class
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from geos::ElementSubRegionBase
template<class NODE_MAP >
void calculateElementCenters (NODE_MAP const &toNodesRelation, arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &X) const
 Compute the center of each element in the subregion. More...
 
- Protected Member Functions inherited from geos::dataRepository::Group
virtual void postProcessInput ()
 
virtual void initializePreSubGroups ()
 Called by Initialize() prior to initializing sub-Groups.
 
virtual void initializePostSubGroups ()
 Called by Initialize() after to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPreSubGroups ()
 Called by InitializePostInitialConditions() prior to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPostSubGroups ()
 Called by InitializePostInitialConditions() after to initializing sub-Groups.
 
virtual void postRestartInitialization ()
 Performs initialization required after reading from a restart file.
 
- Protected Attributes inherited from geos::ElementSubRegionBase
localIndex m_numNodesPerElement
 Number of nodes per element in this subregion.
 
localIndex m_numEdgesPerElement
 Number of edges per element in this subregion.
 
localIndex m_numFacesPerElement
 Number of faces per element in this subregion.
 
array2d< real64m_elementCenter
 Member level field for the element center.
 
array1d< real64m_elementVolume
 Member level field for the element volume.
 
ElementType m_elementType
 Type of element in this subregion.
 
- 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

Class specializing the element subregion for a cell element. This is the class used in the physics solvers to represent a collection of mesh cell elements

Definition at line 36 of file CellElementSubRegion.hpp.

Constructor & Destructor Documentation

◆ CellElementSubRegion()

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

Constructor for this class.

Parameters
[in]namethe name of this object manager
[in]parentthe parent Group

Member Function Documentation

◆ addFracturedElement()

void geos::CellElementSubRegion::addFracturedElement ( localIndex const  cellElemIndex,
localIndex const  embSurfIndex 
)

Add fractured element to list and relative entries to the map.

Parameters
cellElemIndexcell element index
embSurfIndexembedded surface element index

◆ calculateElementCenters()

void geos::CellElementSubRegion::calculateElementCenters ( arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &  X) const
inline

Compute the center of each element in the subregion.

Parameters
[in]Xan arrayView of (const) node positions

Definition at line 322 of file CellElementSubRegion.hpp.

◆ calculateElementGeometricQuantities()

void geos::CellElementSubRegion::calculateElementGeometricQuantities ( NodeManager const &  nodeManager,
FaceManager const &  faceManager 
)
overridevirtual

Calculate the geometric quantities for each element in the subregion.

Parameters
[in]nodeManagerthe nodeManager (for geometrical info and connectivity involving nodes)
[in]faceManagerthe faceManager (for geometrical info and connectivity involving faces)

Implements geos::ElementSubRegionBase.

◆ catalogName()

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

Const getter for the catalog name.

Returns
the name of this type in the catalog

Definition at line 53 of file CellElementSubRegion.hpp.

◆ copyFromCellBlock()

void geos::CellElementSubRegion::copyFromCellBlock ( CellBlockABC const &  cellBlock)

Fill the CellElementSubRegion by copying those of the source CellBlock.

Parameters
cellBlockthe CellBlock which properties (connectivity info) will be copied.

◆ detJ() [1/2]

array2d< real64 >& geos::CellElementSubRegion::detJ ( )
inline
Returns
The array of jacobian determinantes.

Definition at line 287 of file CellElementSubRegion.hpp.

◆ detJ() [2/2]

arrayView2d< real64 const > geos::CellElementSubRegion::detJ ( ) const
inline
Returns
The array of jacobian determinantes.

Definition at line 293 of file CellElementSubRegion.hpp.

◆ dNdX() [1/2]

array4d< real64 >& geos::CellElementSubRegion::dNdX ( )
inline
Returns
The array of shape function derivatives.

Definition at line 275 of file CellElementSubRegion.hpp.

◆ dNdX() [2/2]

arrayView4d< real64 const > geos::CellElementSubRegion::dNdX ( ) const
inline
Returns
The array of shape function derivatives.

Definition at line 281 of file CellElementSubRegion.hpp.

◆ edgeList() [1/2]

FixedOneToManyRelation& geos::CellElementSubRegion::edgeList ( )
inline

Get the element-to-edge map.

Returns
a reference to element-to-edge map

Definition at line 246 of file CellElementSubRegion.hpp.

◆ edgeList() [2/2]

const FixedOneToManyRelation& geos::CellElementSubRegion::edgeList ( ) const
inline

Get the element-to-edge map.

Returns
a reference to element-to-edge map

Definition at line 251 of file CellElementSubRegion.hpp.

◆ embeddedSurfacesList() [1/2]

EmbSurfMapType& geos::CellElementSubRegion::embeddedSurfacesList ( )
inline
Returns
The map to the embedded surfaces

Definition at line 311 of file CellElementSubRegion.hpp.

◆ embeddedSurfacesList() [2/2]

const EmbSurfMapType& geos::CellElementSubRegion::embeddedSurfacesList ( ) const
inline
Returns
The map to the embedded surfaces

Definition at line 316 of file CellElementSubRegion.hpp.

◆ faceList() [1/3]

FixedOneToManyRelation& geos::CellElementSubRegion::faceList ( )
inline

Get the element-to-face map.

Returns
a reference to the element to face map

Definition at line 257 of file CellElementSubRegion.hpp.

◆ faceList() [2/3]

const FixedOneToManyRelation& geos::CellElementSubRegion::faceList ( ) const
inline

Get the element-to-face map.

Returns
a reference to the element to face map

Definition at line 262 of file CellElementSubRegion.hpp.

◆ faceList() [3/3]

localIndex geos::CellElementSubRegion::faceList ( localIndex  k,
localIndex  a 
) const
inline

Get the local index of the a-th face of the k-th element.

Parameters
[in]kthe index of the element
[in]athe index of the face in the element
Returns
a const reference to the local index of the face

Definition at line 270 of file CellElementSubRegion.hpp.

◆ fixUpDownMaps()

virtual void geos::CellElementSubRegion::fixUpDownMaps ( bool const  clearIfUnmapped)
finaloverridevirtual

Call ObjectManagerBase::fixUpDownMaps for the connectivity maps needed by the derived class (i.e., element-to-node map, element-to-face map, etc)

Parameters
[in]clearIfUnmappedclearIfUnmapped

Reimplemented from geos::ElementSubRegionBase.

◆ forMaterials()

template<typename LAMBDA >
void geos::CellElementSubRegion::forMaterials ( LAMBDA  lambda)
inline

Helper function to apply a lambda function over all constructive groups.

Template Parameters
LAMBDAthe type of the lambda function
Parameters
lambdathe lambda function

Definition at line 163 of file CellElementSubRegion.hpp.

◆ fracturedElementsList() [1/2]

SortedArray< localIndex >& geos::CellElementSubRegion::fracturedElementsList ( )
inline
Returns
The sorted array of local fractured elements.

Definition at line 299 of file CellElementSubRegion.hpp.

◆ fracturedElementsList() [2/2]

const SortedArrayView< localIndex const > geos::CellElementSubRegion::fracturedElementsList ( ) const
inline
Returns
The sorted array view of local fractured elements.

Definition at line 305 of file CellElementSubRegion.hpp.

◆ getCatalogName()

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

Const getter for the catalog name.

Returns
the name of this type in the catalog

Implements geos::ObjectManagerBase.

Definition at line 59 of file CellElementSubRegion.hpp.

◆ getFaceNodes()

localIndex geos::CellElementSubRegion::getFaceNodes ( localIndex const  elementIndex,
localIndex const  localFaceIndex,
Span< localIndex > const  nodeIndices 
) const

Get the local indices of the nodes in a face of the element.

Parameters
[in]elementIndexThe local index of the target element.
[in]localFaceIndexThe local index of the target face in the element (this will be [0, numFacesInElement[)
[out]nodeIndicesMemory to which node indices for the face will be written, must have sufficient size.
Returns
tne number of values written into nodeIndices
Deprecated:
This method will be removed soon.

◆ nodeList() [1/4]

NodeMapType& geos::CellElementSubRegion::nodeList ( )
inline

Get the element-to-node map.

Returns
a reference to the element-to-node map

Definition at line 222 of file CellElementSubRegion.hpp.

◆ nodeList() [2/4]

const NodeMapType& geos::CellElementSubRegion::nodeList ( ) const
inline

Get the element-to-node map.

Returns
a reference to the element-to-node map

Definition at line 227 of file CellElementSubRegion.hpp.

◆ nodeList() [3/4]

localIndex& geos::CellElementSubRegion::nodeList ( localIndex  k,
localIndex  a 
)
inline

Get the local index of the a-th node of the k-th element.

Parameters
[in]kthe index of the element
[in]athe index of the node in the element
Returns
a reference to the local index of the node

Definition at line 235 of file CellElementSubRegion.hpp.

◆ nodeList() [4/4]

const localIndex& geos::CellElementSubRegion::nodeList ( localIndex  k,
localIndex  a 
) const
inline

Get the local index of the a-th node of the k-th element.

Parameters
[in]kthe index of the element
[in]athe index of the node in the element
Returns
a reference to the local index of the node

Definition at line 240 of file CellElementSubRegion.hpp.

◆ packFracturedElements()

localIndex geos::CellElementSubRegion::packFracturedElements ( buffer_unit_type *&  buffer,
arrayView1d< localIndex const > const &  packList,
arrayView1d< globalIndex const > const &  embeddedSurfacesLocalToGlobal 
) const

Packs the set of fractured elements and the element-to-embeddedSurfaces map of the elements in the @ packList.

Parameters
bufferThe buffer that will receive the packed data.
packListThe element we want packed.
embeddedSurfacesLocalToGlobalLocaltoGlobal map of the embedded surfaces.
Returns
The packed size.

◆ packFracturedElementsSize()

localIndex geos::CellElementSubRegion::packFracturedElementsSize ( arrayView1d< localIndex const > const &  packList,
arrayView1d< globalIndex const > const &  embeddedSurfacesLocalToGlobal 
) const

Computes the pack size of the set of fractured elements and the element-to-embeddedSurfaces map of the elements in the @ packList.

Parameters
packListThe element we want packed.
embeddedSurfacesLocalToGlobalLocaltoGlobal map of the embedded surfaces.
Returns
The packed size.

◆ packUpDownMaps()

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

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.

Reimplemented from geos::ObjectManagerBase.

◆ packUpDownMapsSize()

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

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

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

Reimplemented from geos::ObjectManagerBase.

◆ resizePerElementValues()

virtual void geos::CellElementSubRegion::resizePerElementValues ( localIndex const  numNodesPerElement,
localIndex const  numEdgesPerElement,
localIndex const  numFacesPerElement 
)
overridevirtual

Set all "perElement" values for this subregion.

Parameters
numNodesPerElementThe number of nodes per elem in this subregion.
numEdgesPerElementThe number of edges per elem in this subregion.
numFacesPerElementThe number of faces per elem in this subregion.

Reimplemented from geos::ElementSubRegionBase.

◆ unpackFracturedElements()

localIndex geos::CellElementSubRegion::unpackFracturedElements ( buffer_unit_type const *&  buffer,
localIndex_array packList,
unordered_map< globalIndex, localIndex > const &  embeddedSurfacesGlobalToLocal 
)

Unpacks the set of fractured elemetn and the element-to-embeddedSurfaces map from buffer.

Parameters
bufferThe buffer containing the packed data.
packListThe (un)packed element.
embeddedSurfacesGlobalToLocalGlobalToLocal map of the embedded surfaces.
Returns
The unpacked size.

◆ unpackUpDownMaps()

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

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.

Reimplemented from geos::ObjectManagerBase.

◆ viewKeys() [1/2]

virtual const viewKeyStruct& geos::CellElementSubRegion::viewKeys ( ) const
inlineoverridevirtual

Get the view keys for Group access, const version.

Returns
The keys.

Reimplemented from geos::ObjectManagerBase.

Definition at line 204 of file CellElementSubRegion.hpp.

◆ viewKeys() [2/2]

virtual viewKeyStruct& geos::CellElementSubRegion::viewKeys ( )
inlineoverridevirtual

Get the view keys for Group access.

Returns
The keys.

Reimplemented from geos::ObjectManagerBase.

Definition at line 203 of file CellElementSubRegion.hpp.


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