The CellBlockManager class provides an interface to ObjectManagerBase in order to manage CellBlock data. More...

#include <CellBlockManager.hpp>

Inheritance diagram for geos::CellBlockManager:

Public Member Functions
	CellBlockManager (string const &name, Group *const parent)
	Constructor for CellBlockManager object. More...

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

array2d< real64, nodes::REFERENCE_POSITION_PERM >	getNodePositions () const override
	Returns the node coordinates in a (numNodes, 3) 2d array. More...

arrayView2d< real64, nodes::REFERENCE_POSITION_USD >	getNodePositions ()
	Returns a view to the vector holding the nodes coordinates. More...

ArrayOfArrays< localIndex >	getNodeToEdges () const override
	Returns the node to edges mapping. More...

ArrayOfArrays< localIndex >	getNodeToFaces () const override
	Returns the face to nodes mappings. More...

ToCellRelation< ArrayOfArrays< localIndex > >	getNodeToElements () const override
	Returns the node to elements mapping. More...

array2d< localIndex >	getEdgeToNodes () const override
	Returns the edge to nodes mapping. More...

ArrayOfArrays< localIndex >	getEdgeToFaces () const override
	Returns the edge to faces mapping. More...

ArrayOfArrays< localIndex >	getFaceToNodes () const override
	Returns the face to nodes mapping. More...

ArrayOfArrays< localIndex >	getFaceToEdges () const override
	Returns the face to edges mapping. More...

ToCellRelation< array2d< localIndex > >	getFaceToElements () const override
	Returns the face to elements mapping. More...

array1d< globalIndex >	getNodeLocalToGlobal () const override
	The node to global mapping for nodes. More...

arrayView1d< globalIndex >	getNodeLocalToGlobal ()
	Returns a view to the vector holding the node to global mapping. More...

std::map< string, SortedArray< localIndex > > const &	getNodeSets () const override
	Returns the node sets. Key of the map is the name of the set. More...

std::map< string, SortedArray< localIndex > > &	getNodeSets ()
	Returns a mutable reference to the node sets. More...

void	setNumNodes (localIndex numNodes)
	Defines the number of nodes and resizes some underlying arrays appropriately. More...

void	generateHighOrderMaps (localIndex const order, globalIndex const maxVertexGlobalID, globalIndex const maxEdgeGlobalID, globalIndex const maxFaceGlobalID, arrayView1d< globalIndex const > const edgeLocalToGlobal, arrayView1d< globalIndex const > const faceLocalToGlobal) override
	Generates in place the high-order maps for this cell block manager. More...

localIndex	numNodes () const override
	Total number of nodes across all the cell blocks. More...

localIndex	numEdges () const override
	Total number of edges across all the cell blocks. More...

localIndex	numFaces () const override
	Total number of faces across all the cell blocks. More...

void	resize (integer_array const &numElements, string_array const &regionNames)
	Set the number of elements for a set of element regions. More...

void	buildMaps ()
	Trigger the computation of all the mappings. More...

CellBlock &	getCellBlock (string const &name)
	Get cell block by name. More...

const Group &	getCellBlocks () const override
	Returns a group containing the cell blocks as CellBlockABC instances. More...

Group &	getCellBlocks () override
	Returns a group containing the cell blocks as `CellBlockABC` instances. More...

std::map< integer, std::set< string > > const &	getRegionAttributesCellBlocks () const override

Group const &	getFaceBlocks () const override
	Returns a group containing the face blocks as FaceBlockABC instances. More...

Group &	getFaceBlocks () override
	Returns a group containing the face blocks as `FaceBlockABC` instances. More...

LineBlockABC const &	getLineBlock (string name) const override
	Returns LineBlockABC corresponding to the given identifier. More...

CellBlock &	registerCellBlock (string const &name)
	Registers and returns a cell block of name `name`. More...

CellBlock &	registerCellBlock (string const &cellBlockName, integer regionAttribute)
	Registers and returns a cell block of name `name`. More...

FaceBlock &	registerFaceBlock (string const &name)
	Registers and returns a face block of name `name`. More...

LineBlock &	registerLineBlock (string const &name)
	Registers and returns a line block of name `name`. More...

template<typename LAMBDA >
void	forElementSubRegions (LAMBDA lambda)
	Launch kernel function over all the sub-regions. More...

real64	getGlobalLength () const override
	Getter for the global length. More...

void	setGlobalLength (real64 globalLength)
	Setter for the global length. More...

real64	getGlobalOffset () const override
	Getter for the global offset. More...

void	setGlobalOffset (real64 globalOffset)
	Setter for the global offset. More...

virtual void	resize (localIndex const newSize)
	Resize the group and all contained wrappers that resize with parent. More...

Public Member Functions inherited from geos::CellBlockManagerABC
	CellBlockManagerABC (string const &name, Group *const parent)
	Constructor. More...

Public Member Functions inherited from geos::dataRepository::Group
template<typename LOG_LEVEL_INFO >
std::enable_if_t< geos::is_log_level_info< LOG_LEVEL_INFO >, void >	addLogLevel ()
	Append a levelCondition and a log description to the description of the wrapped object given a log info struct. Must be called in constructor. More...

virtual bool	registerCallback (void *func, const std::type_info &funcType)
	Register a callback function on the group. More...

virtual void	reinit ()
	Performs re-initialization of certain variable depending on the solver being used.

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

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

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

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

	Group ()=delete
	Deleted default constructor.

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

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

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

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

string	dumpInputOptions () const

string	dumpSubGroupsNames () const

string	dumpWrappersNames () const

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

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

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

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

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

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

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

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

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

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

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

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

stdVector< string >	getSubGroupsNames () const

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

template<typename T >
bool	hasSubGroupOfType () const
	Check whether a sub-group exists by type. More...

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

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

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

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

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

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

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

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

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

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

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

template<typename T , typename TBASE = T>
Wrapper< TBASE > &	registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
	Create and register a Wrapper around a new object. More...

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

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

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

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

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

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

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

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

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

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

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

localIndex	packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Get the size required to pack a list of indices for all registered wrappers. More...

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

virtual localIndex	pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices within a list of wrappers. More...

localIndex	pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
	Pack a list of indices for all registered wrappers. More...

virtual localIndex	unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE)
	Unpack 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...

stdVector< string >	getWrappersNames () const

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

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

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

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

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

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

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

virtual void	resize (localIndex const newSize)
	Resize the group and all contained wrappers that resize with parent. More...

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

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

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

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

string	getPath () const
	Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...

DataContext const &	getDataContext () const

template<typename KEY >
DataContext const &	getWrapperDataContext (KEY key) const

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

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

bool	hasParent () const

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

localIndex	getSubGroupIndex (keyType const &key) const
	Get the index of a sub-Group within this group. More...

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

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

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

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

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

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

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

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

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

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

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

void	setLogLevel (integer const logLevel)
	Set verbosity level. More...

integer	getLogLevel () const

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 &targetNodePos)
	Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...

void	postInputInitializationRecursive ()
	Recursively call postInputInitialization() to apply post processing after reading input values.

Static Public Member Functions
static constexpr int	maxNodesPerFace ()
	Maximum number of nodes allowed (in memory) per each face. More...

Static Public Member Functions inherited from geos::CellBlockManagerABC
static constexpr localIndex	edgeMapExtraSpacePerNode ()
	Extra space for node to edges mapping. More...

static constexpr localIndex	faceMapExtraSpacePerNode ()
	Extra space for node to faces mapping. More...

static constexpr localIndex	elemMapExtraSpacePerNode ()
	Extra space for node to elements mapping. More...

static constexpr localIndex	nodeMapExtraSpacePerFace ()
	Extra space for extra nodes. More...

static constexpr localIndex	edgeMapExtraSpacePerFace ()
	Extra space for extra faces. More...

static constexpr localIndex	faceMapExtraSpacePerEdge ()
	Extra space for extra edges. More...

Static Public Member Functions inherited from geos::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool	applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
	Apply a given functor to a container if the container can be cast to one of the specified types. More...

static CatalogInterface::CatalogType &	getCatalog ()
	Get the singleton catalog for this Group. More...

static string	processInputName (xmlWrapper::xmlNode const &targetNode, xmlWrapper::xmlNodePos const &targetNodePos, string_view parentNodeName, xmlWrapper::xmlNodePos const &parentNodePos, std::set< string > &siblingNames)

Additional Inherited Members
Public Types inherited from geos::dataRepository::Group
using	subGroupMap = MappedVector< Group, Group *, keyType, indexType >
	The template specialization of MappedVector to use for the collection of sub-Group objects.

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

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

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

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

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

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

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

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

Detailed Description

The CellBlockManager class provides an interface to ObjectManagerBase in order to manage CellBlock data.

Definition at line 38 of file CellBlockManager.hpp.

Constructor & Destructor Documentation

◆ CellBlockManager()

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

Constructor for CellBlockManager object.

Parameters

name	name of this instantiation of CellBlockManager
parent	pointer to the parent Group of this instantiation of CellBlockManager

Member Function Documentation

◆ buildMaps()

void geos::CellBlockManager::buildMaps ( )

Trigger the computation of all the mappings.

Call this member function to compute all the mappings. Computations could be done lazily when calling getters. But this is not yet implemented.

◆ createChild()

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

overridevirtual

Creates a new sub-Group using the ObjectCatalog functionality.

Parameters

[in]	childKey	The name of the new object type's key in the ObjectCatalog.
[in]	childName	The name of the new object in the collection of sub-Groups.

Returns: A pointer to the new Group created by this function.

Reimplemented from geos::dataRepository::Group.

◆ forElementSubRegions()

template<typename LAMBDA >

void geos::CellBlockManager::forElementSubRegions ( LAMBDA lambda )

inline

Launch kernel function over all the sub-regions.

Template Parameters

LAMBDA type of the user-provided function

Parameters

lambda kernel function

Definition at line 204 of file CellBlockManager.hpp.

◆ generateHighOrderMaps()

void geos::CellBlockManager::generateHighOrderMaps	(	localIndex const	order,
		globalIndex const	maxVertexGlobalID,
		globalIndex const	maxEdgeGlobalID,
		globalIndex const	maxFaceGlobalID,
		arrayView1d< globalIndex const > const	edgeLocalToGlobal,
		arrayView1d< globalIndex const > const	faceLocalToGlobal
	)

overridevirtual

Generates in place the high-order maps for this cell block manager.

Parameters

[in]	order	The order of the discretization.
[in]	maxVertexGlobalID	maximum globalID for nodes
[in]	maxEdgeGlobalID	maximum globalID for edges
[in]	maxFaceGlobalID	maximum globalID for faces
[in]	edgeLocalToGlobal	The local to global map for edges.
[in]	faceLocalToGlobal	The local to global map for faces.

Implements geos::CellBlockManagerABC.

◆ getCellBlock()

CellBlock& geos::CellBlockManager::getCellBlock ( string const & name )

inline

Get cell block by name.

Parameters

[in] name Name of the cell block.

Returns: Reference to the cell block instance.

Definition at line 152 of file CellBlockManager.hpp.

◆ getCellBlocks() [1/2]

const Group& geos::CellBlockManager::getCellBlocks ( ) const

overridevirtual

Returns a group containing the cell blocks as CellBlockABC instances.

Returns: Const reference to the Group instance.

Implements geos::CellBlockManagerABC.

◆ getCellBlocks() [2/2]

Group& geos::CellBlockManager::getCellBlocks ( )

overridevirtual

Returns a group containing the cell blocks as CellBlockABC instances.

Returns: Mutable reference to the cell blocks group.

Note: It should probably be better not to expose a non-const accessor here.

Implements geos::CellBlockManagerABC.

◆ getEdgeToFaces()

ArrayOfArrays< localIndex > geos::CellBlockManager::getEdgeToFaces ( ) const

overridevirtual

Returns the edge to faces mapping.

Returns: A one to many relationship.

Implements geos::CellBlockManagerABC.

◆ getEdgeToNodes()

array2d< localIndex > geos::CellBlockManager::getEdgeToNodes ( ) const

overridevirtual

Returns the edge to nodes mapping.

Returns: A 1 to 2 relationship. The result is meant to have size (numEdges, 2).

Implements geos::CellBlockManagerABC.

◆ getFaceBlocks() [1/2]

Group const& geos::CellBlockManager::getFaceBlocks ( ) const

overridevirtual

Returns a group containing the face blocks as FaceBlockABC instances.

Returns: Const reference to the Group instance.

Implements geos::CellBlockManagerABC.

◆ getFaceBlocks() [2/2]

Group& geos::CellBlockManager::getFaceBlocks ( )

overridevirtual

Returns a group containing the face blocks as FaceBlockABC instances.

Returns: Mutable reference to the face blocks group.

Note: It should probably be better not to expose a non-const accessor here.

Implements geos::CellBlockManagerABC.

◆ getFaceToEdges()

ArrayOfArrays< localIndex > geos::CellBlockManager::getFaceToEdges ( ) const

overridevirtual

Returns the face to edges mapping.

Returns: A one to many relationship.

Implements geos::CellBlockManagerABC.

◆ getFaceToElements()

ToCellRelation< array2d< localIndex > > geos::CellBlockManager::getFaceToElements ( ) const

overridevirtual

Returns the face to elements mapping.

Returns: A 1 to 2 relationship. The result is meant to have size (numFaces, 2).

In case the face only belongs to one single element, the second value of the table is -1.

Implements geos::CellBlockManagerABC.

◆ getFaceToNodes()

ArrayOfArrays< localIndex > geos::CellBlockManager::getFaceToNodes ( ) const

overridevirtual

Returns the face to nodes mapping.

Returns: The one to many relationship.

Implements geos::CellBlockManagerABC.

◆ getGlobalLength()

real64 geos::CellBlockManager::getGlobalLength ( ) const

inlineoverridevirtual

Getter for the global length.

Returns: the global length of the mesh

Implements geos::CellBlockManagerABC.

Definition at line 209 of file CellBlockManager.hpp.

◆ getGlobalOffset()

real64 geos::CellBlockManager::getGlobalOffset ( ) const

inlineoverridevirtual

Getter for the global offset.

Returns: the global offset of the mesh

Implements geos::CellBlockManagerABC.

Definition at line 217 of file CellBlockManager.hpp.

◆ getLineBlock()

LineBlockABC const& geos::CellBlockManager::getLineBlock ( string name ) const

overridevirtual

Returns LineBlockABC corresponding to the given identifier.

Parameters

name	the name of the required LineBlockABC

Returns: The LineBlockABC associated with the given name

Implements geos::CellBlockManagerABC.

◆ getNodeLocalToGlobal() [1/2]

arrayView1d< globalIndex > geos::CellBlockManager::getNodeLocalToGlobal ( )

Returns a view to the vector holding the node to global mapping.

Returns: The reference

Note: This is meant to be used as a values setter.

◆ getNodeLocalToGlobal() [2/2]

array1d< globalIndex > geos::CellBlockManager::getNodeLocalToGlobal ( ) const

overridevirtual

The node to global mapping for nodes.

Returns: The mapping as an array of size numNodes.

Implements geos::CellBlockManagerABC.

◆ getNodePositions() [1/2]

arrayView2d< real64, nodes::REFERENCE_POSITION_USD > geos::CellBlockManager::getNodePositions ( )

Returns a view to the vector holding the nodes coordinates.

Returns: The reference

Note: This is meant to be used as a values setter.

◆ getNodePositions() [2/2]

array2d< real64, nodes::REFERENCE_POSITION_PERM > geos::CellBlockManager::getNodePositions ( ) const

overridevirtual

Returns the node coordinates in a (numNodes, 3) 2d array.

Returns: A const view to the array.

Implements geos::CellBlockManagerABC.

◆ getNodeSets() [1/2]

std::map< string, SortedArray< localIndex > >& geos::CellBlockManager::getNodeSets ( )

Returns a mutable reference to the node sets.

Returns: A reference to the mapping.

The key of the map is the name of the set. While the values are sorted arrays which sizes are meant to be managed by the client code. This member function is meant to be used like a setter.

◆ getNodeSets() [2/2]

std::map< string, SortedArray< localIndex > > const& geos::CellBlockManager::getNodeSets ( ) const

overridevirtual

Returns the node sets. Key of the map is the name of the set.

Returns: A reference to constant map.

Implements geos::CellBlockManagerABC.

◆ getNodeToEdges()

ArrayOfArrays< localIndex > geos::CellBlockManager::getNodeToEdges ( ) const

overridevirtual

Returns the node to edges mapping.

Returns: The one to many relationship.

Implements geos::CellBlockManagerABC.

◆ getNodeToElements()

ToCellRelation< ArrayOfArrays< localIndex > > geos::CellBlockManager::getNodeToElements ( ) const

overridevirtual

Returns the node to elements mapping.

Returns: A one to many relationship.

Implements geos::CellBlockManagerABC.

◆ getNodeToFaces()

ArrayOfArrays< localIndex > geos::CellBlockManager::getNodeToFaces ( ) const

overridevirtual

Returns the face to nodes mappings.

Returns: The one to many relationship.

Implements geos::CellBlockManagerABC.

◆ getRegionAttributesCellBlocks()

std::map< integer, std::set< string > > const& geos::CellBlockManager::getRegionAttributesCellBlocks ( ) const

inlineoverridevirtual

Returns: A map of the cellblocks list for each region attribute values.

Implements geos::CellBlockManagerABC.

Definition at line 161 of file CellBlockManager.hpp.

◆ maxNodesPerFace()

static constexpr int geos::CellBlockManager::maxNodesPerFace ( )

inlinestaticconstexpr

Maximum number of nodes allowed (in memory) per each face.

Returns: The number as an integer.

Definition at line 55 of file CellBlockManager.hpp.

◆ numEdges()

localIndex geos::CellBlockManager::numEdges ( ) const

overridevirtual

Total number of edges across all the cell blocks.

Returns: The total number of edges.

Implements geos::CellBlockManagerABC.

◆ numFaces()

localIndex geos::CellBlockManager::numFaces ( ) const

overridevirtual

Total number of faces across all the cell blocks.

Returns: The total number of faces.

Implements geos::CellBlockManagerABC.

◆ numNodes()

localIndex geos::CellBlockManager::numNodes ( ) const

overridevirtual

Total number of nodes across all the cell blocks.

Returns: The total number of nodes.

Nodes shared by multiple cell blocks are counted only once.

Implements geos::CellBlockManagerABC.

◆ registerCellBlock() [1/2]

CellBlock& geos::CellBlockManager::registerCellBlock	(	string const &	cellBlockName,
		integer	regionAttribute
	)

Registers and returns a cell block of name name.

Parameters

cellBlockName	The name of the created cell block.
regionAttribute	The region attribute of the created cell block.

Returns: A reference to the new cell block. The CellBlockManager owns this new instance.

◆ registerCellBlock() [2/2]

CellBlock& geos::CellBlockManager::registerCellBlock ( string const & name )

Registers and returns a cell block of name name.

Parameters

name	The name of the created cell block.

Returns: A reference to the new cell block. The CellBlockManager owns this new instance.

◆ registerFaceBlock()

FaceBlock& geos::CellBlockManager::registerFaceBlock ( string const & name )

Registers and returns a face block of name name.

Parameters

name	The name of the created face block.

Returns: A reference to the new face block. The CellBlockManager owns this new instance.

◆ registerLineBlock()

LineBlock& geos::CellBlockManager::registerLineBlock ( string const & name )

Registers and returns a line block of name name.

Parameters

name	The name of the created line block.

Returns: A reference to the new line block. The CellBlockManager owns this new instance.

◆ resize() [1/2]

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

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

Parameters

[in]	numElements	list of the new element numbers
[in]	regionNames	list of the element region names

◆ resize() [2/2]

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

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

Parameters

newSize the new size of the group

◆ setGlobalLength()

void geos::CellBlockManager::setGlobalLength ( real64 globalLength )

inline

Setter for the global length.

Parameters

globalLength the global length

Definition at line 215 of file CellBlockManager.hpp.

◆ setGlobalOffset()

void geos::CellBlockManager::setGlobalOffset ( real64 globalOffset )

inline

Setter for the global offset.

Parameters

globalOffset the global offset

Definition at line 223 of file CellBlockManager.hpp.

◆ setNumNodes()

void geos::CellBlockManager::setNumNodes ( localIndex numNodes )

Defines the number of nodes and resizes some underlying arrays appropriately.

Parameters

[in] numNodes The number of nodes on the MPI rank (that is per domain). Nodes are not duplicated along subregion interfaces.

The nodes coordinates and nodes local to global mappings get resized to numNodes.

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

coreComponents/mesh/generators/CellBlockManager.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CellBlockManager()

Member Function Documentation

◆ buildMaps()

◆ createChild()

◆ forElementSubRegions()

◆ generateHighOrderMaps()

◆ getCellBlock()

◆ getCellBlocks() [1/2]

◆ getCellBlocks() [2/2]

◆ getEdgeToFaces()

◆ getEdgeToNodes()

◆ getFaceBlocks() [1/2]

◆ getFaceBlocks() [2/2]

◆ getFaceToEdges()

◆ getFaceToElements()

◆ getFaceToNodes()

◆ getGlobalLength()

◆ getGlobalOffset()

◆ getLineBlock()

◆ getNodeLocalToGlobal() [1/2]

◆ getNodeLocalToGlobal() [2/2]

◆ getNodePositions() [1/2]

◆ getNodePositions() [2/2]

◆ getNodeSets() [1/2]

◆ getNodeSets() [2/2]

◆ getNodeToEdges()

◆ getNodeToElements()

◆ getNodeToFaces()

◆ getRegionAttributesCellBlocks()

◆ maxNodesPerFace()

◆ numEdges()

◆ numFaces()

◆ numNodes()

◆ registerCellBlock() [1/2]

◆ registerCellBlock() [2/2]

◆ registerFaceBlock()

◆ registerLineBlock()

◆ resize() [1/2]

◆ resize() [2/2]

◆ setGlobalLength()

◆ setGlobalOffset()

◆ setNumNodes()