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

This class provides an interface to ObjectManagerBase in order to manage edge data. More...

#include <EdgeManager.hpp>

Inheritance diagram for geosx::EdgeManager:
Inheritance graph
[legend]

Classes

struct  groupKeyStruct
 Container of keys needed to access the data of the class member. More...
 
struct  viewKeyStruct
 Container of keys needed to access the data of the class member. More...
 

Public Types

using NodeMapType = FixedOneToManyRelation
 EdgeToNode map type.
 
using FaceMapType = InterObjectRelation< ArrayOfSets< localIndex > >
 EdgeToFace map type.
 
- Public Types inherited from geosx::ObjectManagerBase
using CatalogInterface = dataRepository::CatalogInterface< ObjectManagerBase, std::string const &, dataRepository::Group *const >
 Nested type for the factory pattern, defining the base class (ObjectManagerBase) and the builder arguments (std::string const &, dataRepository::Group * const) of the derived products.
 
- Public Types inherited from geosx::dataRepository::Group
using subGroupMap = MappedVector< Group, Group *, keyType, indexType >
 The template specialization of MappedVector to use for the collection of sub-Group objects.
 
using wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
 The template specialization of MappedVector to use for the collection wrappers objects.
 
using CatalogInterface = dataRepository::CatalogInterface< Group, std::string const &, Group *const >
 Type alias for catalog interface used by this class. See CatalogInterface.
 

Public Member Functions

virtual void resize (localIndex const newSize) override
 Resize the EdgeManager object and all it members. More...
 
void SetDomainBoundaryObjects (const ObjectDataStructureBaseT *const referenceObject=nullptr)
 Set the node of the domain boundary object. More...
 
void SetIsExternal (FaceManager const *const faceManager)
 Set external edges. More...
 
void BuildEdges (FaceManager *const faceManager, NodeManager *const nodeManager)
 Build faces-to-edges and nodes-to-edges relation maps. More...
 
void BuildEdges (localIndex const numNodes, ArrayOfArraysView< localIndex const > const &faceToNodeMap, ArrayOfArrays< localIndex > &faceToEdgeMap)
 Build faces-to-edges and nodes-to-edges relation maps. More...
 
virtual void ExtractMapFromObjectForAssignGlobalIndexNumbers (ObjectManagerBase const *const nodeManager, std::vector< std::vector< globalIndex > > &globalEdgeNodes) override
 Build globalEdgeNodes, a vector containing all the global indices of each nodes of each edges. More...
 
virtual localIndex PackUpDownMapsSize (arrayView1d< localIndex const > const &packList) const override
 Compute the future size of a packed list. More...
 
virtual localIndex PackUpDownMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const override
 Pack an array of edge indices in a buffer. More...
 
virtual localIndex UnpackUpDownMaps (buffer_unit_type const *&buffer, localIndex_array &packList, bool const overwriteUpMaps, bool const overwriteDownMaps) override
 Unpack a buffer to an array of indices that has been packed. More...
 
void FixUpDownMaps (bool const clearIfUnmapped)
 Call FixUpDownMaps of the class ObjectManagerBase for nodes-to-edges and nodes-to-faces relation maps. More...
 
void compressRelationMaps ()
 Compress all nodes-to-faces relation maps so that the values of each array are contiguous with no extra capacity in between.
 
void depopulateUpMaps (std::set< localIndex > const &receivedEdges, ArrayOfArraysView< localIndex const > const &facesToEdges)
 Clean up the edges-to-faces mapping with respect to a new list of edges. More...
 
void ConnectivityFromGlobalToLocal (const SortedArray< localIndex > &indices, const map< globalIndex, localIndex > &nodeGlobalToLocal, const map< globalIndex, localIndex > &faceGlobalToLocal)
 Build the mapping edge-to-nodes relation from the mapping global to local nodes. More...
 
void AddToEdgeToFaceMap (FaceManager const *const faceManager, arrayView1d< localIndex const > const &newFaceIndices)
 Add new faces to the faces to edges map. More...
 
void SplitEdge (const localIndex indexToSplit, const localIndex parentNodeIndex, const localIndex childNodeIndex[2], array1d< SortedArray< localIndex > > &nodesToEdges)
 Split an edge (separate its two extremity nodes) More...
 
bool hasNode (const localIndex edgeID, const localIndex nodeID) const
 Check if edge edgeID contains node nodeID. More...
 
template<typename OUT_VECTOR >
void calculateCenter (localIndex const edgeIndex, arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &X, OUT_VECTOR &&edgeCenter) const
 Calculate the center of an edge given its index. More...
 
template<typename OUT_VECTOR >
void calculateLength (localIndex const edgeIndex, arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &X, OUT_VECTOR &&edgeVector) const
 Calculate the edge segment. More...
 
Constructors/destructors
 EdgeManager (std::string const &name, Group *const parent)
 main constructor for EdgeManager Objects More...
 
 ~EdgeManager () override
 default destructor
 
Getters for stored value.
NodeMapTypenodeList ()
 Get a node list. More...
 
NodeMapType const & nodeList () const
 Provide an accessor to an immutable node list. More...
 
localIndexnodeList (localIndex const edgeIndex, localIndex const nodeIndex)
 Get a reference to a node list. More...
 
localIndex nodeList (localIndex const edgeIndex, localIndex const nodeIndex) const
 Get a node list. More...
 
FaceMapTypefaceList ()
 Get the edge-to-face relation. More...
 
FaceMapType const & faceList () const
 Get an immutable accessor to the edge-to-face relation. More...
 
- Public Member Functions inherited from geosx::ObjectManagerBase
 ObjectManagerBase (std::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 on_device=false) 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 on_device=false) 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 on_device=false) override
 Unpack a buffer. More...
 
template<bool DOPACK>
localIndex PackSets (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const
 Packs the elements of each set that actually are in packList. More...
 
localIndex UnpackSets (buffer_unit_type const *&buffer)
 Unpack the content of buffer into the sets of the instance. More...
 
virtual void ViewPackingExclusionList (SortedArray< localIndex > &exclusionList) const
 Inserts in exclusionList the data that shall not be packed. More...
 
virtual localIndex PackGlobalMapsSize (arrayView1d< localIndex const > const &packList, integer const recursive) const
 Computes the pack size of the global maps elements in the @ packList. More...
 
virtual localIndex PackGlobalMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive) const
 Packs the global maps elements in the @ packList. More...
 
void SetReceiveLists ()
 Clear and redefines the ghosts to receive.
 
virtual localIndex UnpackUpDownMaps (buffer_unit_type const *&buffer, array1d< localIndex > &packList, bool const overwriteUpMaps, bool const overwriteDownMaps)
 Unpacks the specific elements in the @ packList. More...
 
virtual localIndex UnpackGlobalMaps (buffer_unit_type const *&buffer, localIndex_array &packList, integer const recursive)
 Unpacks the global maps from buffer. More...
 
localIndex PackParentChildMapsSize (arrayView1d< localIndex const > const &packList) const
 Computes the pack size of the parent/child relations in packList. More...
 
localIndex PackParentChildMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const
 Packs the parent/child relations in packList. More...
 
localIndex UnpackParentChildMaps (buffer_unit_type const *&buffer, localIndex_array &packList)
 Unacks the parent/child relations in packList. More...
 
void moveSets (LvArray::MemorySpace const targetSpace)
 Manually move all sets to a memory space. More...
 
localIndex resize (localIndex const newSize, const bool)
 Resize the group and all contained wrappers that resize with parent. More...
 
void CreateSet (const std::string &newSetName)
 Creates a new set. More...
 
void ConstructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, const array2d< localIndex > &map, const std::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 std::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 std::string &setName)
 Builds a new set on this instance given another objects set and the map between them. More...
 
void ConstructGlobalToLocalMap ()
 Constructs the global to local map.
 
void ConstructLocalListOfBoundaryObjects (localIndex_array &objectList) const
 Computes the (local) index list that are domain boundaries. More...
 
void ConstructGlobalListOfBoundaryObjects (globalIndex_array &objectList) const
 Computes the (global) index list that are domain boundaries. More...
 
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 SetMaxGlobalIndex ()
 Computes the maximum global index allong all the MPI ranks.
 
virtual void enforceStateFieldConsistencyPostTopologyChange (std::set< localIndex > const &targetIndices)
 Updates the child and target indices after a topology change. More...
 
template<typename MESH_DATA_TRAIT >
dataRepository::Wrapper< typename MESH_DATA_TRAIT::type > & registerExtrinsicData (string const &nameOfRegisteringObject)
 Register data with this ObjectManagerBase using a dataRepository::Wrapper. More...
 
template<typename MESH_DATA_TRAIT0 , typename MESH_DATA_TRAIT1 , typename ... MESH_DATA_TRAITS>
void registerExtrinsicData (string const &nameOfRegisteringObject)
 Register a collection of data with this ObjectManagerBase using a dataRepository::Wrapper. More...
 
template<typename MESH_DATA_TRAIT >
GEOSX_DECLTYPE_AUTO_RETURN getExtrinsicData () const
 Get a view to the data associated with a trait from this ObjectManagerBase. More...
 
template<typename MESH_DATA_TRAIT >
GEOSX_DECLTYPE_AUTO_RETURN getExtrinsicData ()
 Get the data associated with a trait from this ObjectManagerBase. More...
 
template<typename MESH_DATA_TRAIT >
bool hasExtrinsicData () const
 Checks if an extrinsic data has been registered. More...
 
virtual 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 > & 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 maxGlobalIndex () const
 Get the maximum global index of all objects across all rank. See. More...
 
arrayView1d< integergetDomainBoundaryIndicator ()
 Get the domain boundary indicator. More...
 
arrayView1d< integer const > getDomainBoundaryIndicator () const
 Get the domain boundary indicator. More...
 
- Public Member Functions inherited from geosx::dataRepository::Group
 Group (std::string const &name, Group *const parent)
 Constructor. More...
 
 Group (Group &&source)
 Move constructor. More...
 
virtual ~Group ()
 Destructor, deletes all Groups and Wrappers owned by this Group.
 
 Group ()=delete
 Deleted default constructor.
 
 Group (Group const &)=delete
 Deleted copy constructor.
 
 Group (Group const &&)=delete
 Deleted move constructor.
 
Groupoperator= (Group const &)=delete
 Deleted copy assignment operator. More...
 
Groupoperator= (Group &&)=delete
 Deleted move assignment operator. More...
 
virtual const std::type_info & get_typeid () const
 Get typeid for current group. More...
 
bool CheckTypeID (std::type_info const &typeToCheck) const
 Check a type_info against the type_info of this Group. More...
 
void PrintDataHierarchy (integer indent=0)
 Prints the data hierarchy recursively. More...
 
string dumpInputOptions () const
 
template<typename T = Group>
T * RegisterGroup (std::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 (std::string const &name, T *newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T * RegisterGroup (std::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 (std::string const &name, std::string const &catalogName)
 Register a new Group as a sub-group of current Group. More...
 
void deregisterGroup (std::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>
T * GetGroup (localIndex index)
 Retrieve a sub-group from the current Group using an index. More...
 
template<typename T = Group>
T const * GetGroup (localIndex index) const
 Retrieve a sub-group from the current Group using an index. More...
 
template<typename T = Group>
T * GetGroup (string const &name)
 Retrieve a sub-group from the current Group using a string. More...
 
template<typename T = Group>
T const * GetGroup (string const &name) const
 Retrieve a sub-group from the current Group using a string. More...
 
template<typename T = Group>
T & getGroupReference (string const &key)
 
template<typename T = Group>
T const & getGroupReference (string const &key) const
 
template<typename T = Group>
T & GetGroupReference (subGroupMap::KeyIndex const &key)
 
template<typename T = Group>
T const & GetGroupReference (subGroupMap::KeyIndex const &key) const
 
template<typename T = Group>
T * GetGroup (subGroupMap::KeyIndex const &key)
 Retrieve a sub-group from the current Group using a KeyIndexT. More...
 
template<typename T = Group>
T const * GetGroup (subGroupMap::KeyIndex const &key) const
 Retrieve a sub-group from the current Group using a KeyIndexT. 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...
 
bool hasGroup (std::string const &name) const
 Check whether a sub-group exists. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda)
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA lambda) const
 
template<typename LAMBDA >
void forWrappers (LAMBDA lambda)
 Apply the given functor to wrappers. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA lambda) const
 Apply the given functor to wrappers. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA lambda)
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA lambda) const
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
void Initialize (Group *const group)
 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 (Group *const group)
 Initialization routine to be called after calling ApplyInitialConditions(). More...
 
void postRestartInitializationRecursive (Group *const domain)
 Initialization routine to be called after calling reading a restart file. More...
 
void ProcessInputFileRecursive (xmlWrapper::xmlNode &targetNode)
 Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. More...
 
void PostProcessInputRecursive ()
 Recursively call PostProcessInput() to apply post processing after reading input values.
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > * registerWrapper (std::string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
 Create and register a Wrapper around a new object. More...
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > * registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
 
template<typename T >
Wrapper< T > * registerWrapper (std::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 (std::string const &name, T *newObject)
 Register a Wrapper around an existing object, does not take ownership of the object. More...
 
WrapperBaseregisterWrapper (string const &name, std::unique_ptr< WrapperBase > wrapper)
 Register and take ownership of an existing Wrapper. More...
 
void deregisterWrapper (string const &name)
 Removes a Wrapper from this group. More...
 
void GenerateDataStructureSkeleton (integer const level)
 Build a complete datastructure for schema generation. More...
 
virtual void ExpandObjectCatalogs ()
 Expand any catalogs in the data structure.
 
virtual void SetSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
 Inform the schema generator of any deviations between the xml and GEOS data structures. More...
 
virtual void RegisterDataOnMeshRecursive (Group *const meshBodies)
 Calls RegisterDataOnMesh() recursively. More...
 
virtual void RegisterDataOnMesh (Group *const meshBodies)
 Register data on mesh entities. More...
 
virtual localIndex PackSize (string_array const &wrapperNames, integer const recursive, bool on_device=false) const
 Get the size required to pack a list of wrappers. More...
 
virtual localIndex Pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool on_device=false) const
 Pack a list of wrappers to a buffer. More...
 
WrapperBase const * getWrapperBase (indexType const index) const
 Retrieve a WrapperBase stored in this group. More...
 
WrapperBasegetWrapperBase (indexType const index)
 Retrieve a WrapperBase stored in this group. More...
 
WrapperBase const * getWrapperBase (std::string const &name) const
 Retrieve a WrapperBase stored in this group. More...
 
WrapperBasegetWrapperBase (std::string const &name)
 Retrieve a WrapperBase stored in this group. More...
 
WrapperBase const * getWrapperBase (wrapperMap::KeyIndex const &keyIndex) const
 Retrieve a WrapperBase stored in this group. More...
 
WrapperBasegetWrapperBase (wrapperMap::KeyIndex const &keyIndex)
 Retrieve a WrapperBase stored in this group. More...
 
indexType getWrapperIndex (std::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...
 
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 >
Wrapper< T > const * getWrapper (char const *const key) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T >
Wrapper< T > * getWrapper (char const *const key)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
GEOSX_DECLTYPE_AUTO_RETURN getReference (LOOKUP_TYPE const &lookup) const
 Look up a wrapper and get reference to wrapped object. More...
 
template<typename T , typename LOOKUP_TYPE >
T & getReference (LOOKUP_TYPE const &lookup)
 Look up a wrapper and get reference to wrapped object. More...
 
template<typename T >
GEOSX_DECLTYPE_AUTO_RETURN getReference (char const *const name) const
 
template<typename T >
T & getReference (char const *const name)
 
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 string getName () const
 Get group name. More...
 
GroupgetParent ()
 Access the group's parent. More...
 
Group const * getParent () const
 Access the group's parent. More...
 
localIndex getIndexInParent () const
 Get the group's index withing its parent group. More...
 
integer sizedFromParent () const
 Check whether this Group is resized when its parent is resized. More...
 
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 ()
 Get the Conduit node object associated with this group. More...
 
void prepareToWrite ()
 Register the group and its wrappers with Conduit.
 
void finishWriting ()
 Write the group and its wrappers into Conduit.
 
void loadFromConduit ()
 Read the group and its wrappers from Conduit.
 
void enableLogLevelInput ()
 Enable verbosity input for object.
 
integer getLogLevel () const
 
template<typename T >
group_cast ()
 Downcast this Group. More...
 
template<typename T >
group_cast () const
 Downcast this Group. More...
 

Static Public Member Functions

static localIndex faceMapExtraSpacePerEdge ()
 Oversize the Face mapping by this amount for each edge (hardcoded) More...
 
- Static Public Member Functions inherited from geosx::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 GetParentRecusive (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 geosx::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
 Apply a given functor to a container if the container can be cast to one of the specified types. More...
 
static CatalogInterface::CatalogTypeGetCatalog ()
 Get the singleton catalog for this class. More...
 
template<typename T >
static T group_cast (Group *group)
 Downcast a Group *. More...
 
template<typename T >
static T group_cast (Group const *group)
 Downcast a Group const *. More...
 

Public Attributes

SortedArray< localIndexm_recalculateFractureConnectorEdges
 map from the edges to the fracture connectors index (edges that are fracture connectors)
 
map< localIndex, localIndexm_edgesToFractureConnectorsEdges
 todo
 
array1d< localIndexm_fractureConnectorsEdgesToEdges
 todo
 
ArrayOfArrays< localIndexm_fractureConnectorEdgesToFaceElements
 todo
 
- Public Attributes inherited from geosx::ObjectManagerBase
struct geosx::ObjectManagerBase::viewKeyStruct m_ObjectManagerBaseViewKeys
 viewKey struct for the ObjectManagerBase class
 
struct geosx::ObjectManagerBase::groupKeyStruct m_ObjectManagerBaseGroupKeys
 groupKey struct for the ObjectManagerBase class
 

Static Factory Catalog Functions

static const string CatalogName ()
 
virtual const string getCatalogName () const override
 Getter used to access the edge manager catalog name. More...
 

viewKeyStruct/groupKeyStruct

geosx::EdgeManager::viewKeyStruct viewKeys
 viewKeys
 
geosx::EdgeManager::groupKeyStruct groupKeys
 groupKeys
 
constexpr int maxEdgesPerNode () const
 }@ More...
 

Additional Inherited Members

- Protected Member Functions inherited from geosx::dataRepository::Group
virtual void PostProcessInput ()
 
virtual void InitializePreSubGroups (Group *const group)
 Called by Initialize() prior to initializing sub-Groups. More...
 
virtual void InitializePostSubGroups (Group *const group)
 Called by Initialize() after to initializing sub-Groups. More...
 
virtual void InitializePostInitialConditions_PreSubGroups (Group *const group)
 Called by InitializePostInitialConditions() prior to initializing sub-Groups. More...
 
virtual void InitializePostInitialConditions_PostSubGroups (Group *const group)
 Called by InitializePostInitialConditions() after to initializing sub-Groups. More...
 
virtual void postRestartInitialization (Group *const domain)
 Performs initialization required after reading from a restart file. More...
 
- Protected Attributes inherited from geosx::ObjectManagerBase
Group m_sets
 Group that holds object sets.
 
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

This class provides an interface to ObjectManagerBase in order to manage edge data.

An edge is bounded by two nodes. This class aims to manage all the edges of every cell elements in a DomainPartition.

Definition at line 42 of file EdgeManager.hpp.

Constructor & Destructor Documentation

◆ EdgeManager()

geosx::EdgeManager::EdgeManager ( std::string const &  name,
Group *const  parent 
)

main constructor for EdgeManager Objects

Parameters
[in]namethe name of the EdgeManager object in the repository
[in]parentthe parent group of the EdgeManager object being constructed

Member Function Documentation

◆ AddToEdgeToFaceMap()

void geosx::EdgeManager::AddToEdgeToFaceMap ( FaceManager const *const  faceManager,
arrayView1d< localIndex const > const &  newFaceIndices 
)

Add new faces to the faces to edges map.

Parameters
[in]faceManagerthe FaceManager
[in]newFaceIndicesthe new face indices to be added

◆ BuildEdges() [1/2]

void geosx::EdgeManager::BuildEdges ( FaceManager *const  faceManager,
NodeManager *const  nodeManager 
)

Build faces-to-edges and nodes-to-edges relation maps.

Parameters
[in]faceManagermanager of all faces in the DomainPartition
[in]nodeManagermanager of all nodes in the DomainPartition

◆ BuildEdges() [2/2]

void geosx::EdgeManager::BuildEdges ( localIndex const  numNodes,
ArrayOfArraysView< localIndex const > const &  faceToNodeMap,
ArrayOfArrays< localIndex > &  faceToEdgeMap 
)

Build faces-to-edges and nodes-to-edges relation maps.

Parameters
[in]numNodesnumber of nodes
[in]faceToNodeMapmanager face-to-nodes map
[in]faceToEdgeMapmanager face-to-edges map

◆ calculateCenter()

template<typename OUT_VECTOR >
void geosx::EdgeManager::calculateCenter ( localIndex const  edgeIndex,
arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &  X,
OUT_VECTOR &&  edgeCenter 
) const
inline

Calculate the center of an edge given its index.

Template Parameters
OUT_VECTORtype of output
Parameters
edgeIndexindex of the edge
Xarray view of nodes associated with the edge
edgeCenteroutput vector containing coordinate of the edge center

Definition at line 406 of file EdgeManager.hpp.

◆ calculateLength()

template<typename OUT_VECTOR >
void geosx::EdgeManager::calculateLength ( localIndex const  edgeIndex,
arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &  X,
OUT_VECTOR &&  edgeVector 
) const
inline

Calculate the edge segment.

Template Parameters
OUT_VECTORtype of output
Parameters
edgeIndexindex of the edge
Xarray view of the nodes associated with the NodeManager of current domain
edgeVectoroutput vector containing edge segment

Definition at line 416 of file EdgeManager.hpp.

◆ CatalogName()

static const string geosx::EdgeManager::CatalogName ( )
inlinestatic
Returns
the string representing the edge manager name in the catalog

Definition at line 60 of file EdgeManager.hpp.

◆ ConnectivityFromGlobalToLocal()

void geosx::EdgeManager::ConnectivityFromGlobalToLocal ( const SortedArray< localIndex > &  indices,
const map< globalIndex, localIndex > &  nodeGlobalToLocal,
const map< globalIndex, localIndex > &  faceGlobalToLocal 
)

Build the mapping edge-to-nodes relation from the mapping global to local nodes.

Parameters
[in]indicesarray of index of the global to local nodes
[in]nodeGlobalToLocalmap of the global to local nodes
[in]faceGlobalToLocalGEOX UNUSED PARAMETER

◆ depopulateUpMaps()

void geosx::EdgeManager::depopulateUpMaps ( std::set< localIndex > const &  receivedEdges,
ArrayOfArraysView< localIndex const > const &  facesToEdges 
)

Clean up the edges-to-faces mapping with respect to a new list of edges.

Parameters
[in]receivedEdgesthe new list of edges indices
[in]facesToEdgesmap to go from faces to edges

◆ ExtractMapFromObjectForAssignGlobalIndexNumbers()

virtual void geosx::EdgeManager::ExtractMapFromObjectForAssignGlobalIndexNumbers ( ObjectManagerBase const *const  nodeManager,
std::vector< std::vector< globalIndex > > &  globalEdgeNodes 
)
overridevirtual

Build globalEdgeNodes, a vector containing all the global indices of each nodes of each edges.

Parameters
[in]nodeManagerthe nodeManager object.
[out]globalEdgeNodesthe globalEdgesNodes array to be built [ [global_index_node_0_edge_0, global_index_node1_edge_0], [global_index_node_0_edge_1, global_index_node1_edge_1] ....]

Reimplemented from geosx::ObjectManagerBase.

◆ faceList() [1/2]

FaceMapType& geosx::EdgeManager::faceList ( )
inline

Get the edge-to-face relation.

Returns
A FaceMapType

Definition at line 352 of file EdgeManager.hpp.

◆ faceList() [2/2]

FaceMapType const& geosx::EdgeManager::faceList ( ) const
inline

Get an immutable accessor to the edge-to-face relation.

Returns
An immutable FaceMapType

Definition at line 358 of file EdgeManager.hpp.

◆ faceMapExtraSpacePerEdge()

static localIndex geosx::EdgeManager::faceMapExtraSpacePerEdge ( )
inlinestatic

Oversize the Face mapping by this amount for each edge (hardcoded)

Returns
extra space for each edge of the EdgetoFace map

Definition at line 77 of file EdgeManager.hpp.

◆ FixUpDownMaps()

void geosx::EdgeManager::FixUpDownMaps ( bool const  clearIfUnmapped)

Call FixUpDownMaps of the class ObjectManagerBase for nodes-to-edges and nodes-to-faces relation maps.

Parameters
[in]clearIfUnmappedboolean to indicate if the unmaped indices should be removed or not

◆ getCatalogName()

virtual const string geosx::EdgeManager::getCatalogName ( ) const
inlineoverridevirtual

Getter used to access the edge manager catalog name.

Returns
the edge manager catalog name

Implements geosx::ObjectManagerBase.

Definition at line 68 of file EdgeManager.hpp.

◆ hasNode()

bool geosx::EdgeManager::hasNode ( const localIndex  edgeID,
const localIndex  nodeID 
) const

Check if edge edgeID contains node nodeID.

Parameters
[in]edgeIDlocal index of the edge
[in]nodeIDlocal index of the node
Returns
boolean : true if the node nodeID is part of the edge edgeID; false otherwise

◆ maxEdgesPerNode()

constexpr int geosx::EdgeManager::maxEdgesPerNode ( ) const
inline

}@

Return the maximum number of edges per node.

Returns
Maximum allowable number of edges connected to one node (hardcoded for now)

Definition at line 311 of file EdgeManager.hpp.

◆ nodeList() [1/4]

NodeMapType& geosx::EdgeManager::nodeList ( )
inline

Get a node list.

Returns
reference to the list of edge to node relation

Definition at line 322 of file EdgeManager.hpp.

◆ nodeList() [2/4]

NodeMapType const& geosx::EdgeManager::nodeList ( ) const
inline

Provide an accessor to an immutable node list.

Returns
reference to the list of edge to node relation

Definition at line 328 of file EdgeManager.hpp.

◆ nodeList() [3/4]

localIndex& geosx::EdgeManager::nodeList ( localIndex const  edgeIndex,
localIndex const  nodeIndex 
)
inline

Get a reference to a node list.

Parameters
[in]edgeIndexlocal index of the edge
[in]nodeIndexlocal index of the node
Returns
a reference of the index of the edge to node relation

Definition at line 336 of file EdgeManager.hpp.

◆ nodeList() [4/4]

localIndex geosx::EdgeManager::nodeList ( localIndex const  edgeIndex,
localIndex const  nodeIndex 
) const
inline

Get a node list.

Parameters
[in]edgeIndexlocal index of the edge
[in]nodeIndexlocal index of the node
Returns
a reference of the index of the edge to node relation

Definition at line 345 of file EdgeManager.hpp.

◆ PackUpDownMaps()

virtual localIndex geosx::EdgeManager::PackUpDownMaps ( buffer_unit_type *&  buffer,
arrayView1d< localIndex const > const &  packList 
) const
overridevirtual

Pack an array of edge indices in a buffer.

Packed data are meant to be communicated to other MPI ranks

Parameters
[in,out]buffera buffer to pack the edge index data into
[in]packListthe indices of edge to pack
Returns
The size of the packed array

Reimplemented from geosx::ObjectManagerBase.

◆ PackUpDownMapsSize()

virtual localIndex geosx::EdgeManager::PackUpDownMapsSize ( arrayView1d< localIndex const > const &  packList) const
overridevirtual

Compute the future size of a packed list.

Packed data are meant to be communicated to other MPI ranks

Parameters
[in]packListthe list of edge indices to be packed
Returns
The size of the packed list

Reimplemented from geosx::ObjectManagerBase.

◆ resize()

virtual void geosx::EdgeManager::resize ( localIndex const  newSize)
overridevirtual

Resize the EdgeManager object and all it members.

the size of the EdgeMananager is the number of edges in the domain.

Parameters
[in]newSizethe new number of edges.

Reimplemented from geosx::dataRepository::Group.

◆ SetDomainBoundaryObjects()

void geosx::EdgeManager::SetDomainBoundaryObjects ( const ObjectDataStructureBaseT *const  referenceObject = nullptr)

Set the node of the domain boundary object.

Parameters
[in]referenceObjectthe reference of the face manager.

◆ SetIsExternal()

void geosx::EdgeManager::SetIsExternal ( FaceManager const *const  faceManager)

Set external edges.

external edges are the edges on the faces which are external

Parameters
[in]faceManagerthe face manager to obtain external face

◆ SplitEdge()

void geosx::EdgeManager::SplitEdge ( const localIndex  indexToSplit,
const localIndex  parentNodeIndex,
const localIndex  childNodeIndex[2],
array1d< SortedArray< localIndex > > &  nodesToEdges 
)

Split an edge (separate its two extremity nodes)

Parameters
[in]indexToSplitIndex of the edge to split
[in]parentNodeIndexindex of the parent node
[in]childNodeIndexindex of the child node
[in]nodesToEdgesarray of nodes-to-edges list

◆ UnpackUpDownMaps()

virtual localIndex geosx::EdgeManager::UnpackUpDownMaps ( buffer_unit_type const *&  buffer,
localIndex_array packList,
bool const  overwriteUpMaps,
bool const  overwriteDownMaps 
)
overridevirtual

Unpack a buffer to an array of indices that has been packed.

Packed data are meant to be communicated to other MPI ranks

Parameters
[in]bufferbuffer containing the packed indices
[in,out]packListthe array of local index to be unpacked
[in]overwriteUpMapsboolean to state if the Up maps should be overwritten
[in]overwriteDownMapsboolean to state if the Downs maps should be overwritten
Returns
The size of the unpacked array

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