The FaceManager class provides an interface to ObjectManagerBase in order to manage face data. More...

#include <FaceManager.hpp>

Inheritance diagram for geosx::FaceManager:

Classes
struct	viewKeyStruct

Public Types
using	NodeMapType = InterObjectRelation< ArrayOfArrays< localIndex > >
	FaceToNode map type.

using	EdgeMapType = InterObjectRelation< ArrayOfArrays< localIndex > >
	FaceToEdge map type.

using	ElemMapType = FixedToManyElementRelation
	FaceToElement map type.

Public Types inherited from geosx::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 geosx::dataRepository::Group
using	subGroupMap = MappedVector< Group, Group *, keyType, indexType >
	The template specialization of MappedVector to use for the collection of sub-Group objects.

using	wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
	The template specialization of MappedVector to use for the collection wrappers objects.

using	CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Public Member Functions
virtual void	resize (localIndex const newsize) override
	Extend base class resize method resizing m_nodeList, m_edgeList member containers. More...

void	buildFaces (NodeManager &nodeManager, ElementRegionManager &elemManager)
	Build faces in filling face-to-node and face-to-element mappings. More...

void	computeGeometry (NodeManager const &nodeManager)
	Compute faces center, area and normal. More...

localIndex	getMaxFaceNodes () const
	Return the number of nodes of the faces with the greatest number of nodes. More...

void	sortAllFaceNodes (NodeManager const &nodeManager, ElementRegionManager const &elemManager)
	Sort all faces nodes counterclockwisely in m_nodeList. More...

void	sortFaceNodes (arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &X, arraySlice1d< real64 const > const elementCenter, localIndex *const faceNodes, localIndex const numFaceNodes)
	Reorder face nodes to be labeled counter-clockwise resulting in outgoing normal. More...

void	setDomainBoundaryObjects (NodeManager &nodeManager)
	Flag face and nodes'face with at least one element on the boundary. More...

void	setIsExternal ()
	Flag faces on boundary or external to the DomainPartition.

void	compressRelationMaps ()
	Compress FaceManager face-to-node and face-to-edge containers so that the values of each array are contiguous with no extra capacity in between. More...

virtual void	enforceStateFieldConsistencyPostTopologyChange (std::set< localIndex > const &targetIndices) override
	Enforce child faces and parent faces to have opposite normals. More...

void	depopulateUpMaps (std::set< localIndex > const &receivedFaces, ElementRegionManager const &elemRegionManager)
	Clean up the mappings from faces to element index, region, subregion on a new (updated) list of faces, in order to keep only relevant mappings. More...

virtual void	extractMapFromObjectForAssignGlobalIndexNumbers (NodeManager const &nodeManager, std::vector< std::vector< globalIndex > > &faceToNodes) override
	Extract a face-to-nodes map with global indexed for boundary faces. More...

Constructors/destructor
	FaceManager (string const &name, Group *const parent)
	Main Constructor for FaceManager. More...

virtual	~FaceManager () override
	Destructor override from ObjectManager.

	FaceManager ()=delete
	Deleted default constructor.

	FaceManager (FaceManager const &)=delete
	Deleted copy constructor.

	FaceManager (FaceManager &&)=delete
	Deleted move constructor.

Packing methods
virtual void	viewPackingExclusionList (SortedArray< localIndex > &exclusionList) const override
	Create an array listing all excluded local face indices values. More...

virtual localIndex	packUpDownMapsSize (arrayView1d< localIndex const > const &packList) const override
	Calculate the size that a list would have if it were packed, but without actually packing it. More...

virtual localIndex	packUpDownMaps (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList) const override
	Pack an array of node indices into 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 node indices. More...

void	fixUpDownMaps (bool const clearIfUnmapped)
	Call fixUpDownMaps for nodes-to-edges and nodes-to-faces maps. More...

Public Member Functions inherited from geosx::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) 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 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 string &newSetName)
	Creates a new set. More...

void	constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, const array2d< localIndex > &map, const string &setName)
	Builds a new set on this instance given another objects set and the map between them. More...

void	constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, const array1d< localIndex_array > &map, const string &setName)
	Builds a new set on this instance given another objects set and the map between them. More...

void	constructSetFromSetAndMap (SortedArrayView< localIndex const > const &inputSet, ArrayOfArraysView< localIndex const > const &map, const string &setName)
	Builds a new set on this instance given another objects set and the map between them. More...

void	constructGlobalToLocalMap ()
	Constructs the global to local map.

void	constructLocalListOfBoundaryObjects (localIndex_array &objectList) const
	Computes the (local) index list that are domain boundaries. More...

void	constructGlobalListOfBoundaryObjects (globalIndex_array &objectList) const
	Computes the (global) index list that are domain boundaries. More...

void	setGhostRankForSenders (int const neighborRank)
	Defines `neighborRank` ownership for ghost objects. More...

localIndex	getNumberOfGhosts () const
	Get the number of ghost objects. More...

localIndex	getNumberOfLocalIndices () const
	Get the number of locally owned objects. More...

integer	splitObject (localIndex const indexToSplit, int const rank, localIndex &newIndex)
	Split object to deal with topology changes. More...

void	inheritGhostRankFromParent (std::set< localIndex > const &indices)
	sets the value of m_ghostRank to the value of the objects parent. More...

void	copyObject (localIndex const source, localIndex const destination)
	Copy object from `source` to @ destination. More...

virtual void	setMaxGlobalIndex ()
	Computes the maximum global index allong all the MPI ranks.

template<typename MESH_DATA_TRAIT >
dataRepository::Wrapper< typename MESH_DATA_TRAIT::type > &	registerExtrinsicData (string const &nameOfRegisteringObject)
	Register data with this ObjectManagerBase using a dataRepository::Wrapper. More...

template<typename MESH_DATA_TRAIT0 , typename MESH_DATA_TRAIT1 , typename ... MESH_DATA_TRAITS>
void	registerExtrinsicData (string const &nameOfRegisteringObject)
	Register a collection of data with this ObjectManagerBase using a dataRepository::Wrapper. More...

template<typename MESH_DATA_TRAIT >
GEOSX_DECLTYPE_AUTO_RETURN	getExtrinsicData () const
	Get a view to the data associated with a trait from this ObjectManagerBase. More...

template<typename MESH_DATA_TRAIT >
GEOSX_DECLTYPE_AUTO_RETURN	getExtrinsicData ()
	Get the data associated with a trait from this ObjectManagerBase. More...

template<typename MESH_DATA_TRAIT >
bool	hasExtrinsicData () const
	Checks if an extrinsic data has been registered. More...

virtual viewKeyStruct &	viewKeys ()
	Get the view keys for Group access. More...

virtual viewKeyStruct const &	viewKeys () const
	Get the view keys for Group access, const version. More...

virtual groupKeyStruct &	groupKeys ()
	Get the group keys for Group access. More...

virtual groupKeyStruct const &	groupKeys () const
	Get the group keys for Group access, const version. More...

Group &	sets ()
	Get the group holding the object sets. More...

Group const &	sets () const
	Get the group holding the object sets, const version. More...

SortedArray< localIndex > &	externalSet ()
	Get the external set. More...

SortedArrayView< localIndex const >	externalSet () const
	Get the external set, const version. More...

void	updateGlobalToLocalMap (localIndex const lid)
	Updates (if needed) the global index for local index `lid`. More...

arrayView1d< globalIndex >	localToGlobalMap ()
	Get local to global map. More...

arrayView1d< globalIndex const >	localToGlobalMap () const
	Get local to global map, const version. More...

unordered_map< globalIndex, localIndex > const &	globalToLocalMap () const
	Get global to local map. More...

localIndex	globalToLocalMap (globalIndex const gid) const
	Retrieves the local index for given global index. More...

array1d< integer > const &	isExternal ()
	Get the locality information of the objects. More...

arrayView1d< integer const >	isExternal () const
	Get the locality information of the objects. More...

array1d< integer > const &	ghostRank ()
	Get the ghost information of each object. More...

arrayView1d< integer const >	ghostRank () const
	Get the ghost information of each object, const version. More...

NeighborData &	getNeighborData (int const rank)
	Get neighbor data for given `rank`. More...

NeighborData const &	getNeighborData (int const rank) const
	Get neighbor data for given `rank`, const version. More...

void	addNeighbor (int const rank)
	Add a neighbor for `rank`. More...

void	removeNeighbor (int const rank)
	Remove neighbor for `rank`. More...

globalIndex	localMaxGlobalIndex () const
	Get the local maximum global index on this rank. More...

globalIndex	maxGlobalIndex () const
	Get the maximum global index of all objects across all rank. See. More...

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

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

Public Member Functions inherited from geosx::dataRepository::Group
virtual bool	registerCallback (void *func, const std::type_info &funcType)
	Register a callback function on the group. More...

	Group (string const &name, Group *const parent)
	Constructor. More...

	Group (string const &name, conduit::Node &rootNode)
	Constructor. More...

	Group (Group &&source)=default
	Move constructor. More...

virtual	~Group ()
	Destructor, deletes all Groups and Wrappers owned by this Group.

	Group ()=delete
	Deleted default constructor.

	Group (Group const &)=delete
	Deleted copy constructor.

Group &	operator= (Group const &)=delete
	Deleted copy assignment operator. More...

Group &	operator= (Group &&)=delete
	Deleted move assignment operator. More...

void	printDataHierarchy (integer indent=0)
	Prints the data hierarchy recursively. More...

string	dumpInputOptions () const

template<typename T = Group>
T &	registerGroup (string const &name, std::unique_ptr< T > newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T &	registerGroup (string const &name, T *newObject)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T &	registerGroup (string const &name)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group>
T &	registerGroup (subGroupMap::KeyIndex const &keyIndex)
	Register a new Group as a sub-group of current Group. More...

template<typename T = Group, typename TBASE = Group>
T &	registerGroup (string const &name, string const &catalogName)
	Register a new Group as a sub-group of current Group. More...

void	deregisterGroup (string const &name)
	Removes a child group from this group. More...

virtual Group *	createChild (string const &childKey, string const &childName)
	Creates a new sub-Group using the ObjectCatalog functionality. More...

template<typename T = Group, typename KEY = void>
T *	getGroupPointer (KEY const &key)
	Return a pointer to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
T const *	getGroupPointer (KEY const &key) const
	Return a pointer to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
T &	getGroup (KEY const &key)
	Return a reference to a sub-group of the current Group. More...

template<typename T = Group, typename KEY = void>
T const &	getGroup (KEY const &key) const
	Return a reference to a sub-group of the current Group. More...

template<typename T = Group>
T &	getGroupByPath (string const &path)
	Retrieve a group from the hierarchy using a path. More...

template<typename T = Group>
T const &	getGroupByPath (string const &path) const
	Retrieve a group from the hierarchy using a path. More...

subGroupMap &	getSubGroups ()
	Get the subgroups object. More...

subGroupMap const &	getSubGroups () const
	Get the subgroups object. More...

localIndex	numSubGroups () const
	return the number of sub groups in this Group More...

template<typename T = Group>
bool	hasGroup (string const &name) const
	Check whether a sub-group exists. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA &&lambda)
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forSubGroups (LAMBDA &&lambda) const
	Apply the given functor to subgroups that can be casted to one of specified types. More...

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda)

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void	forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda) const

template<typename LAMBDA >
void	forWrappers (LAMBDA &&lambda)
	Apply the given functor to wrappers. More...

template<typename LAMBDA >
void	forWrappers (LAMBDA &&lambda) const
	Apply the given functor to wrappers. More...

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA &&lambda)
	Apply the given functor to wrappers that can be cast to one of specified types. More...

template<typename TYPE , typename ... TYPES, typename LAMBDA >
void	forWrappers (LAMBDA &&lambda) const
	Apply the given functor to wrappers that can be cast to one of specified types. More...

void	initialize ()
	Run initialization functions on this and all subgroups. More...

virtual void	initializationOrder (string_array &order)
	Sets the initialization order for sub-Groups. More...

void	initializePostInitialConditions ()
	Initialization routine to be called after calling ApplyInitialConditions(). More...

void	postRestartInitializationRecursive ()
	Initialization routine to be called after calling reading a restart file. More...

void	processInputFileRecursive (xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. More...

void	postProcessInputRecursive ()
	Recursively call postProcessInput() to apply post processing after reading input values.

template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
	Create and register a Wrapper around a new object. More...

template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)

template<typename T >
Wrapper< T > &	registerWrapper (string const &name, std::unique_ptr< T > newObject)
	Register a Wrapper around a given object and take ownership. More...

template<typename T >
Wrapper< T > &	registerWrapper (string const &name, T *newObject)
	Register a Wrapper around an existing object, does not take ownership of the object. More...

WrapperBase &	registerWrapper (string const &name, std::unique_ptr< WrapperBase > wrapper)
	Register and take ownership of an existing Wrapper. More...

void	deregisterWrapper (string const &name)
	Removes a Wrapper from this group. More...

void	generateDataStructureSkeleton (integer const level)
	Build a complete datastructure for schema generation. More...

virtual void	expandObjectCatalogs ()
	Expand any catalogs in the data structure.

virtual void	setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
	Inform the schema generator of any deviations between the xml and GEOS data structures. More...

virtual void	registerDataOnMeshRecursive (Group &meshBodies)
	Calls RegisterDataOnMesh() recursively. More...

virtual void	registerDataOnMesh (Group &meshBodies)
	Register data on mesh entities. More...

virtual localIndex	packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of wrappers. More...

virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of wrappers to a buffer. More...

template<typename KEY >
WrapperBase const &	getWrapperBase (KEY const &key) const
	Return a reference to a WrapperBase stored in this group. More...

template<typename KEY >
WrapperBase &	getWrapperBase (KEY const &key)
	Return a reference to a WrapperBase stored in this group. More...

indexType	getWrapperIndex (string const &name) const

wrapperMap const &	wrappers () const
	Get access to the internal wrapper storage. More...

wrapperMap &	wrappers ()
	Get access to the internal wrapper storage. More...

indexType	numWrappers () const
	Return the number of wrappers. More...

template<typename LOOKUP_TYPE >
bool	hasWrapper (LOOKUP_TYPE const &lookup) const
	Check if a wrapper exists. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const &	getWrapper (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > &	getWrapper (LOOKUP_TYPE const &index)
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const *	getWrapperPointer (LOOKUP_TYPE const &index) const
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
Wrapper< T > *	getWrapperPointer (LOOKUP_TYPE const &index)
	Retrieve a Wrapper stored in this group. More...

template<typename T , typename LOOKUP_TYPE >
GEOSX_DECLTYPE_AUTO_RETURN	getReference (LOOKUP_TYPE const &lookup) const
	Look up a wrapper and get reference to wrapped object. More...

template<typename T , typename LOOKUP_TYPE >
T &	getReference (LOOKUP_TYPE const &lookup)
	Look up a wrapper and get reference to wrapped object. More...

virtual void	reserve (indexType const newsize)
	Set the new capacity and reserve it in all wrappers that resize with parent. More...

localIndex	capacity () const
	Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...

localIndex	size () const
	Get the "size" of the group, which determines the number of elements in resizable wrappers. More...

string const &	getName () const
	Get group name. More...

string	getPath () const
	Return the path of this Group in the data repository. More...

Group &	getParent ()
	Access the group's parent. More...

Group const &	getParent () const
	Access the group's parent. More...

localIndex	getIndexInParent () const
	Get the group's index withing its parent group. More...

integer	sizedFromParent () const
	Check whether this Group is resized when its parent is resized. More...

Group &	setSizedFromParent (int val)
	Set whether this wrapper is resized when its parent is resized. More...

RestartFlags	getRestartFlags () const
	Get flags that control restart output of this group. More...

void	setRestartFlags (RestartFlags flags)
	Set flags that control restart output of this group. More...

InputFlags	getInputFlags () const
	Get input flags for schema generation. More...

void	setInputFlags (InputFlags flags)
	Set input flags for schema generation. More...

conduit::Node &	getConduitNode ()
	Return the Conduit node object associated with this group. More...

conduit::Node const &	getConduitNode () const
	Return the Conduit node object associated with this group. More...

void	prepareToWrite ()
	Register the group and its wrappers with Conduit.

void	finishWriting ()
	Write the group and its wrappers into Conduit.

void	loadFromConduit ()
	Read the group and its wrappers from Conduit.

void	enableLogLevelInput ()
	Enable verbosity input for object.

integer	getLogLevel () const

Static Public Member Functions
static localIndex	nodeMapExtraSpacePerFace ()
	Get the default number of node per face in node list. More...

static localIndex	edgeMapExtraSpacePerFace ()
	Get the default number of edge per face in edge list. 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::CatalogType &	getCatalog ()
	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::CatalogType &	getCatalog ()
	Get the singleton catalog for this class. More...

Public Attributes
viewKeyStruct/groupKeyStruct
geosx::FaceManager::viewKeyStruct	viewKeys
	viewKeys

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 ()
	Return the name of the FaceManager in the object catalog. More...

virtual const string	getCatalogName () const override
	Provide a virtual access to catalogName(). More...

Accessors for FaceManager fixed data
constexpr int	maxFacesPerNode () const
	Get the constant upper limit for number of faces per Node. More...

array1d< real64 > &	faceArea ()
	Get a mutable accessor to a table containing all the face area. More...

arrayView1d< real64 const >	faceArea () const
	Get an immutable accessor to a table containing all the face area. More...

arrayView2d< real64 const >	faceCenter () const
	Get an immutable accessor to a table containing all the face centers. More...

array2d< real64 > const &	faceNormal ()
	Get a mutable accessor to a table containing all the face normals. More...

arrayView2d< real64 const >	faceNormal () const
	Get an immutable accessor to a table containing all the face normals. More...

NodeMapType &	nodeList ()
	Get a mutable accessor to a map containing the list of each nodes for each faces. More...

NodeMapType const &	nodeList () const
	Get an immutable accessor to a map containing the list of each nodes for each faces. More...

EdgeMapType &	edgeList ()
	Get a mutable accessor to a map containing the list of each edges for each faces. More...

EdgeMapType const &	edgeList () const
	Get an immutable accessor to a map containing the list of each edges for each faces. More...

array2d< localIndex > const &	elementRegionList ()
	Get a mutable accessor to the faces-to-ElementRegion relation. More...

arrayView2d< localIndex const >	elementRegionList () const
	Get an immutable accessor to the faces-to-ElementRegion relation. More...

array2d< localIndex > const &	elementSubRegionList ()
	Get a mutable accessor to the faces-to-ElementSubRegion relation. More...

arrayView2d< localIndex const >	elementSubRegionList () const
	Get an immutable accessor to the faces-to-ElementSubRegion relation. More...

array2d< localIndex > const &	elementList ()
	Get a mutable accessor to the faces-to-element-index relation. More...

arrayView2d< localIndex const >	elementList () const
	Get an imutable accessor to the faces-to-element-index relation. More...

ElemMapType &	toElementRelation ()
	Get a mutable accessor to the faces-to-element-index relation. More...

ElemMapType const &	toElementRelation () const
	Get an immutable accessor to the faces-to-element-index relation. More...

Additional Inherited Members
Protected Member Functions inherited from geosx::dataRepository::Group
virtual void	postProcessInput ()

virtual void	initializePreSubGroups ()
	Called by Initialize() prior to initializing sub-Groups.

virtual void	initializePostSubGroups ()
	Called by Initialize() after to initializing sub-Groups.

virtual void	initializePostInitialConditionsPreSubGroups ()
	Called by InitializePostInitialConditions() prior to initializing sub-Groups.

virtual void	initializePostInitialConditionsPostSubGroups ()
	Called by InitializePostInitialConditions() after to initializing sub-Groups.

virtual void	postRestartInitialization ()
	Performs initialization required after reading from a restart file.

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< globalIndex >	m_localToGlobalMap
	Contains the global index of each object.

unordered_map< globalIndex, localIndex >	m_globalToLocalMap
	Map from object global index to the local index.

array1d< integer >	m_isExternal
	Array that holds if an object is external.

array1d< integer >	m_domainBoundaryIndicator
	Domain boundary indicator: 1 means the "index" is on the boundary.

array1d< integer >	m_ghostRank
	Array that holds the ghost information about each object. More...

unordered_map< int, NeighborData >	m_neighborData
	A map from rank to the associated NeighborData object.

real64	m_overAllocationFactor = 1.1
	Factor by which to overallocate when adding objects.

globalIndex	m_maxGlobalIndex = -1
	The maximum global index of all objects across all rank.

globalIndex	m_localMaxGlobalIndex = -1
	The maximum global index of any object of all objects on this rank.

Detailed Description

The FaceManager class provides an interface to ObjectManagerBase in order to manage face data.

The FaceManager class manages the face data using face indexed or keyed containers. This means that each field is stored in a way where each container entry corresponds to a face.

Definition at line 40 of file FaceManager.hpp.

Constructor & Destructor Documentation

◆ FaceManager()

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

Main Constructor for FaceManager.

Parameters

[in]	name	the name of FaceManager
[in]	parent	the parent Group object of FaceManager

Member Function Documentation

◆ buildFaces()

void geosx::FaceManager::buildFaces	(	NodeManager &	nodeManager,
		ElementRegionManager &	elemManager
	)

Build faces in filling face-to-node and face-to-element mappings.

Parameters

[in]	nodeManager	mesh node manager
[in]	elemManager	element manager

◆ catalogName()

static const string geosx::FaceManager::catalogName ( )

inlinestatic

Return the name of the FaceManager in the object catalog.

Returns: string that contains the catalog name of the FaceManager

Definition at line 62 of file FaceManager.hpp.

◆ compressRelationMaps()

void geosx::FaceManager::compressRelationMaps ( )

Compress FaceManager face-to-node and face-to-edge containers so that the values of each array are contiguous with no extra capacity in between.

Note: The method used here on each arrays (compress) does not free any memory.

◆ computeGeometry()

void geosx::FaceManager::computeGeometry ( NodeManager const & nodeManager )

Compute faces center, area and normal.

Parameters

[in] nodeManager NodeManager associated with the current DomainPartition

◆ depopulateUpMaps()

void geosx::FaceManager::depopulateUpMaps	(	std::set< localIndex > const &	receivedFaces,
		ElementRegionManager const &	elemRegionManager
	)

Clean up the mappings from faces to element index, region, subregion on a new (updated) list of faces, in order to keep only relevant mappings.

Parameters

[in]	receivedFaces	the new list of target node indices
[in]	elemRegionManager	Element Region Manager

◆ edgeList() [1/2]

EdgeMapType& geosx::FaceManager::edgeList ( )

inline

Get a mutable accessor to a map containing the list of each edges for each faces.

Returns: non-const reference to a map containing the list of each edges for each faces

Definition at line 360 of file FaceManager.hpp.

◆ edgeList() [2/2]

EdgeMapType const& geosx::FaceManager::edgeList ( ) const

inline

Get an immutable accessor to a map containing the list of each edges for each faces.

Returns: const reference to a map containing the list of each edges for each faces

Definition at line 366 of file FaceManager.hpp.

◆ edgeMapExtraSpacePerFace()

static localIndex geosx::FaceManager::edgeMapExtraSpacePerFace ( )

inlinestatic

Get the default number of edge per face in edge list.

Returns: the default number of edge per face in edge list

Definition at line 84 of file FaceManager.hpp.

◆ elementList() [1/2]

array2d< localIndex > const& geosx::FaceManager::elementList ( )

inline

Get a mutable accessor to the faces-to-element-index relation.

Returns: non-const reference to faces-to-element-index relation

Definition at line 396 of file FaceManager.hpp.

◆ elementList() [2/2]

arrayView2d< localIndex const > geosx::FaceManager::elementList ( ) const

inline

Get an imutable accessor to the faces-to-element-index relation.

Returns: const reference to faces-to-elements relation

Definition at line 402 of file FaceManager.hpp.

◆ elementRegionList() [1/2]

array2d< localIndex > const& geosx::FaceManager::elementRegionList ( )

inline

Get a mutable accessor to the faces-to-ElementRegion relation.

Returns: non-const reference to faces-to-ElementRegion relation

Definition at line 372 of file FaceManager.hpp.

◆ elementRegionList() [2/2]

arrayView2d< localIndex const > geosx::FaceManager::elementRegionList ( ) const

inline

Get an immutable accessor to the faces-to-ElementRegion relation.

Returns: const reference to nodes-to-ElementRegion relation

Definition at line 378 of file FaceManager.hpp.

◆ elementSubRegionList() [1/2]

array2d< localIndex > const& geosx::FaceManager::elementSubRegionList ( )

inline

Get a mutable accessor to the faces-to-ElementSubRegion relation.

Returns: non-const reference to faces-to-ElementSubRegion relation

Definition at line 384 of file FaceManager.hpp.

◆ elementSubRegionList() [2/2]

arrayView2d< localIndex const > geosx::FaceManager::elementSubRegionList ( ) const

inline

Get an immutable accessor to the faces-to-ElementSubRegion relation.

Returns: const reference to faces-to-ElementSubRegion relation

Definition at line 390 of file FaceManager.hpp.

◆ enforceStateFieldConsistencyPostTopologyChange()

virtual void geosx::FaceManager::enforceStateFieldConsistencyPostTopologyChange ( std::set< localIndex > const & targetIndices )

overridevirtual

Enforce child faces and parent faces to have opposite normals.

Parameters

[in] targetIndices set of face indices for which the enforcement has to be done

Reimplemented from geosx::ObjectManagerBase.

◆ extractMapFromObjectForAssignGlobalIndexNumbers()

virtual void geosx::FaceManager::extractMapFromObjectForAssignGlobalIndexNumbers	(	NodeManager const &	nodeManager,
		std::vector< std::vector< globalIndex > > &	faceToNodes
	)

overridevirtual

Extract a face-to-nodes map with global indexed for boundary faces.

Parameters

[in]	nodeManager	mesh nodeManager
[out]	faceToNodes	face-to-node map

Reimplemented from geosx::ObjectManagerBase.

◆ faceArea() [1/2]

array1d< real64 >& geosx::FaceManager::faceArea ( )

inline

Get a mutable accessor to a table containing all the face area.

this table is mutable so it can be used to compute or modify the face area in this FaceManager

Returns: a table containing all the face area

Definition at line 316 of file FaceManager.hpp.

◆ faceArea() [2/2]

arrayView1d< real64 const > geosx::FaceManager::faceArea ( ) const

inline

Get an immutable accessor to a table containing all the face area.

Returns: an immutable table containing all the face area

Definition at line 322 of file FaceManager.hpp.

◆ faceCenter()

arrayView2d< real64 const > geosx::FaceManager::faceCenter ( ) const

inline

Get an immutable accessor to a table containing all the face centers.

Returns: an immutable table containing all the face centers

Definition at line 328 of file FaceManager.hpp.

◆ faceNormal() [1/2]

array2d< real64 > const& geosx::FaceManager::faceNormal ( )

inline

Get a mutable accessor to a table containing all the face normals.

this table is mutable so it can be used to compute or modify the face normals in this FaceManager

Returns: a table containing all the face normals

Definition at line 336 of file FaceManager.hpp.

◆ faceNormal() [2/2]

arrayView2d< real64 const > geosx::FaceManager::faceNormal ( ) const

inline

Get an immutable accessor to a table containing all the face normals.

Returns: an immutable table containing all the face normals

Definition at line 342 of file FaceManager.hpp.

◆ fixUpDownMaps()

void geosx::FaceManager::fixUpDownMaps ( bool const clearIfUnmapped )

Call fixUpDownMaps for nodes-to-edges and nodes-to-faces maps.

Packed data are meant to be communicated to other MPI ranks

Parameters

[in] clearIfUnmapped boolean: true to remove if it is not mapped

◆ getCatalogName()

virtual const string geosx::FaceManager::getCatalogName ( ) const

inlineoverridevirtual

Provide a virtual access to catalogName().

Returns: string that contains the catalog name of the FaceManager

Implements geosx::ObjectManagerBase.

Definition at line 69 of file FaceManager.hpp.

◆ getMaxFaceNodes()

localIndex geosx::FaceManager::getMaxFaceNodes ( ) const

Return the number of nodes of the faces with the greatest number of nodes.

Returns: the maximum number of nodes a face have

◆ maxFacesPerNode()

constexpr int geosx::FaceManager::maxFacesPerNode ( ) const

inline

Get the constant upper limit for number of faces per Node.

Returns: constant expression of the max number of faces per node

Definition at line 308 of file FaceManager.hpp.

◆ nodeList() [1/2]

NodeMapType& geosx::FaceManager::nodeList ( )

inline

Get a mutable accessor to a map containing the list of each nodes for each faces.

Returns: non-const reference to a map containing the list of each nodes for each faces

Definition at line 348 of file FaceManager.hpp.

◆ nodeList() [2/2]

NodeMapType const& geosx::FaceManager::nodeList ( ) const

inline

Get an immutable accessor to a map containing the list of each nodes for each faces.

Returns: const reference to a map containing the list of each nodes for each faces

Definition at line 354 of file FaceManager.hpp.

◆ nodeMapExtraSpacePerFace()

static localIndex geosx::FaceManager::nodeMapExtraSpacePerFace ( )

inlinestatic

Get the default number of node per face in node list.

Returns: the default number of node per face in node list

Definition at line 77 of file FaceManager.hpp.

◆ packUpDownMaps()

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

overridevirtual

Pack an array of node indices into a buffer.

Packed data are meant to be communicated to other MPI ranks

Parameters

[in,out]	buffer	buffer to pack the node index data into
[in]	packList	the indices of nodes that should be packed

Returns: a localIndex value representing the size of the packed data

Reimplemented from geosx::ObjectManagerBase.

◆ packUpDownMapsSize()

virtual localIndex geosx::FaceManager::packUpDownMapsSize ( arrayView1d< localIndex const > const & packList ) const

overridevirtual

Calculate the size that a list would have if it were packed, but without actually packing it.

Packed data are meant to be communicated to other MPI ranks

Parameters

[in] packList the list of node indices that we wish to get the size of after packing

Returns: the size of packList if it were packed

Note: This function does not perform any packing, it just evaluates and returns the possible packed size.

Reimplemented from geosx::ObjectManagerBase.

◆ resize()

virtual void geosx::FaceManager::resize ( localIndex const newsize )

overridevirtual

Extend base class resize method resizing m_nodeList, m_edgeList member containers.

the newSize of this FaceManager is the number of faces it will contain

Parameters

[in] newsize new size the FaceManager.

Reimplemented from geosx::dataRepository::Group.

◆ setDomainBoundaryObjects()

void geosx::FaceManager::setDomainBoundaryObjects ( NodeManager & nodeManager )

Flag face and nodes'face with at least one element on the boundary.

Parameters

[in] nodeManager manager of mesh nodes

◆ sortAllFaceNodes()

void geosx::FaceManager::sortAllFaceNodes	(	NodeManager const &	nodeManager,
		ElementRegionManager const &	elemManager
	)

Sort all faces nodes counterclockwisely in m_nodeList.

Parameters

[in]	nodeManager	node manager allowing access to face nodes coordinates
[in]	elemManager	element manager allowing access to the cell elements

◆ sortFaceNodes()

void geosx::FaceManager::sortFaceNodes	(	arrayView2d< real64 const, nodes::REFERENCE_POSITION_USD > const &	X,
		arraySlice1d< real64 const > const	elementCenter,
		localIndex *const	faceNodes,
		localIndex const	numFaceNodes
	)

Reorder face nodes to be labeled counter-clockwise resulting in outgoing normal.

Parameters

[in]	X	array view of mesh nodes coordinates
[in]	elementCenter	coordinate of the element center
[in,out]	faceNodes	reordered local label list of nodes
[in]	numFaceNodes	number of nodes for the face

◆ toElementRelation() [1/2]

ElemMapType& geosx::FaceManager::toElementRelation ( )

inline

Get a mutable accessor to the faces-to-element-index relation.

The returned ElemMapType gives access, for one face to the element index, the element sub region, and the element region.

Returns: non-const reference to faces-to-element-index relation

Definition at line 410 of file FaceManager.hpp.

◆ toElementRelation() [2/2]

ElemMapType const& geosx::FaceManager::toElementRelation ( ) const

inline

Get an immutable accessor to the faces-to-element-index relation.

The returned ElemMapType gives access, for one face to the element index, the element sub region, and the element region.

Returns: non-const reference to faces-to-element-index relation

Definition at line 418 of file FaceManager.hpp.

◆ unpackUpDownMaps()

virtual localIndex geosx::FaceManager::unpackUpDownMaps	(	buffer_unit_type const *&	buffer,
		localIndex_array &	packList,
		bool const	overwriteUpMaps,
		bool const	overwriteDownMaps
	)

overridevirtual

Unpack a buffer to an array of node indices.

Packed data are meant to be communicated to other MPI ranks

Parameters

[in]	buffer	buffer with the packed data
[in,out]	packList	an array of localIndex values that we wish to unpack to
[in]	overwriteUpMaps	boolean: true to overwrite the previous Up maps
[in]	overwriteDownMaps	boolean: true to overwrite the previous Down maps

Returns: a localIndex value representing the size of the unpacked list

◆ viewPackingExclusionList()

virtual void geosx::FaceManager::viewPackingExclusionList ( SortedArray< localIndex > & exclusionList ) const

overridevirtual

Create an array listing all excluded local face indices values.

Parameters

[in,out] exclusionList Sorted array with excluded local faces indices

Reimplemented from geosx::ObjectManagerBase.

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

coreComponents/mesh/FaceManager.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Factory Catalog Functions

Accessors for FaceManager fixed data

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FaceManager()

Member Function Documentation

◆ buildFaces()

◆ catalogName()

◆ compressRelationMaps()

◆ computeGeometry()

◆ depopulateUpMaps()

◆ edgeList() [1/2]

◆ edgeList() [2/2]

◆ edgeMapExtraSpacePerFace()

◆ elementList() [1/2]

◆ elementList() [2/2]

◆ elementRegionList() [1/2]

◆ elementRegionList() [2/2]

◆ elementSubRegionList() [1/2]

◆ elementSubRegionList() [2/2]

◆ enforceStateFieldConsistencyPostTopologyChange()

◆ extractMapFromObjectForAssignGlobalIndexNumbers()

◆ faceArea() [1/2]

◆ faceArea() [2/2]

◆ faceCenter()

◆ faceNormal() [1/2]

◆ faceNormal() [2/2]

◆ fixUpDownMaps()

◆ getCatalogName()

◆ getMaxFaceNodes()

◆ maxFacesPerNode()

◆ nodeList() [1/2]

◆ nodeList() [2/2]

◆ nodeMapExtraSpacePerFace()

◆ packUpDownMaps()

◆ packUpDownMapsSize()

◆ resize()

◆ setDomainBoundaryObjects()

◆ sortAllFaceNodes()

◆ sortFaceNodes()

◆ toElementRelation() [1/2]

◆ toElementRelation() [2/2]

◆ unpackUpDownMaps()

◆ viewPackingExclusionList()