The class is used to manage mesh body. More...

#include <MeshBody.hpp>

Inheritance diagram for geos::MeshBody:

Classes
struct	groupStructKeys
	Group keys. More...

struct	viewKeysStruct
	Data repository keys. More...

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

MeshLevel &	createMeshLevel (localIndex const newLevel)
	Create a new mesh level. More...

MeshLevel &	createMeshLevel (string const &name)
	Create a new mesh level. More...

MeshLevel &	createMeshLevel (string const &sourceLevelName, string const &newLevelName, int const order)
	Create a new mesh level from a source MeshLevel. More...

MeshLevel &	createShallowMeshLevel (string const &sourceLevelName, string const &newLevelName)
	Creates a mesh level in which the member pointers are set to the allocations from another MeshLevel. More...

Group &	getMeshLevels ()
	Get the meshLevels group. More...

Group const &	getMeshLevels () const
	Get the meshLevels group. More...

template<typename T , std::enable_if_t< std::is_same< T, string >::value\|\|std::is_same< T, const char * >::value, bool > = false>
MeshLevel &	getMeshLevel (T const &level) const
	Get a reference to a MeshLevel. More...

template<typename T , std::enable_if_t< std::is_same< T, string >::value\|\|std::is_same< T, const char * >::value, bool > = false>
MeshLevel &	getMeshLevel (T const &level)
	Get a reference to a MeshLevel. More...

MeshLevel &	getBaseDiscretization ()
	Convenience function to access the baseDiscretization. More...

MeshLevel const &	getBaseDiscretization () const
	Convenience function to access the baseDiscretization. More...

template<typename FUNCTION >
void	forMeshLevels (FUNCTION &&function) const
	Apply the given functor to all meshLevels on this meshBody. More...

template<typename FUNCTION >
void	forMeshLevels (FUNCTION &&function)
	Apply the given functor to all meshLevels on this meshBody. More...

void	setGlobalLengthScale (real64 scale)
	Set mesh length scale used to define an absolute length tolerance. More...

real64	getGlobalLengthScale () const
	Get mesh length scale. More...

bool	hasParticles () const
	Get whether meshbody has particles. More...

void	setHasParticles (bool hasParticles)
	Set whether meshbody has particles. More...

CellBlockManagerABC const &	getCellBlockManager () const
	Get the Abstract representation of the CellBlockManager attached to the MeshBody. More...

void	deregisterCellBlockManager ()
	De register the CellBlockManager from this meshBody.

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

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

std::vector< 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...

virtual void	initialize_postMeshGeneration ()
	initialization post generation of the mesh.

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

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

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

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

void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
	Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when `Include` nodes are encountered. More...

void	processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
	Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...

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

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

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

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

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

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

std::vector< 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	enableLogLevelInput ()

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

integer	getLogLevel () const

Public Attributes
struct geos::MeshBody::viewKeysStruct	viewKeys
	viewKeys

struct geos::MeshBody::groupStructKeys	groupKeys
	groupKeys

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.

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

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 class is used to manage mesh body.

Definition at line 35 of file MeshBody.hpp.

Constructor & Destructor Documentation

◆ MeshBody()

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

Constructor for MeshBody object.

Parameters

[in]	name	the name of this instantiation of MeshBody
[in]	parent	the parent group of this instantiation of MeshBody

Member Function Documentation

◆ createMeshLevel() [1/3]

MeshLevel& geos::MeshBody::createMeshLevel ( localIndex const newLevel )

Create a new mesh level.

Parameters

[in] newLevel index of the new mesh level

Returns: reference to the created MeshLevel

◆ createMeshLevel() [2/3]

MeshLevel& geos::MeshBody::createMeshLevel ( string const & name )

Create a new mesh level.

Parameters

[in] name The name of the new MeshLevel.

Returns: A reference to the new MeshLevel.

◆ createMeshLevel() [3/3]

MeshLevel& geos::MeshBody::createMeshLevel	(	string const &	sourceLevelName,
		string const &	newLevelName,
		int const	order
	)

Create a new mesh level from a source MeshLevel.

Parameters

sourceLevelName	The name of the source MeshLevel.
newLevelName	The name of the new MeshLevel.
order	The order of the new MeshLevel.

Returns: A reference to the new MeshLevel.

◆ createShallowMeshLevel()

MeshLevel& geos::MeshBody::createShallowMeshLevel	(	string const &	sourceLevelName,
		string const &	newLevelName
	)

Creates a mesh level in which the member pointers are set to the allocations from another MeshLevel.

Parameters

sourceLevelName	The MeshLevel to be "copied"
newLevelName	The name of the new shallow copy.

Returns: A reference to the new shallow MeshLevel.

◆ forMeshLevels() [1/2]

template<typename FUNCTION >

void geos::MeshBody::forMeshLevels ( FUNCTION && function )

inline

Apply the given functor to all meshLevels on this meshBody.

Template Parameters

FUNCTION the type of functor to call

Parameters

[in] function the functor to call

Definition at line 150 of file MeshBody.hpp.

◆ forMeshLevels() [2/2]

template<typename FUNCTION >

void geos::MeshBody::forMeshLevels ( FUNCTION && function ) const

inline

Apply the given functor to all meshLevels on this meshBody.

Template Parameters

FUNCTION the type of functor to call

Parameters

[in] function the functor to call

Definition at line 141 of file MeshBody.hpp.

◆ getBaseDiscretization() [1/2]

MeshLevel& geos::MeshBody::getBaseDiscretization ( )

inline

Convenience function to access the baseDiscretization.

Returns: Reference to the base discretization.

Definition at line 121 of file MeshBody.hpp.

◆ getBaseDiscretization() [2/2]

MeshLevel const& geos::MeshBody::getBaseDiscretization ( ) const

inline

Convenience function to access the baseDiscretization.

Returns: Reference to the base discretization.

Definition at line 130 of file MeshBody.hpp.

◆ getCellBlockManager()

CellBlockManagerABC const& geos::MeshBody::getCellBlockManager ( ) const

inline

Get the Abstract representation of the CellBlockManager attached to the MeshBody.

Returns: The CellBlockManager.

Definition at line 189 of file MeshBody.hpp.

◆ getGlobalLengthScale()

real64 geos::MeshBody::getGlobalLengthScale ( ) const

inline

Get mesh length scale.

Returns: value of mesh length scale

Definition at line 165 of file MeshBody.hpp.

◆ getMeshLevel() [1/2]

template<typename T , std::enable_if_t< std::is_same< T, string >::value||std::is_same< T, const char * >::value, bool > = false>

MeshLevel& geos::MeshBody::getMeshLevel ( T const & level )

inline

Get a reference to a MeshLevel.

Template Parameters

T	The type of the lookup key. Function is only implemented for string and const char * key types.

Parameters

[in] level The lookup key of the MeshLevel

Returns: Reference to the MeshLevel

Definition at line 113 of file MeshBody.hpp.

◆ getMeshLevel() [2/2]

template<typename T , std::enable_if_t< std::is_same< T, string >::value||std::is_same< T, const char * >::value, bool > = false>

MeshLevel& geos::MeshBody::getMeshLevel ( T const & level ) const

inline

Get a reference to a MeshLevel.

Template Parameters

T	The type of the lookup key. Function is only implemented for string and const char * key types.

Parameters

[in] level The lookup key of the MeshLevel

Returns: const reference to the MeshLevel

Definition at line 101 of file MeshBody.hpp.

◆ getMeshLevels() [1/2]

Group& geos::MeshBody::getMeshLevels ( )

inline

Get the meshLevels group.

Returns: reference to the meshLevels group.

Definition at line 86 of file MeshBody.hpp.

◆ getMeshLevels() [2/2]

Group const& geos::MeshBody::getMeshLevels ( ) const

inline

Get the meshLevels group.

Returns: reference to the meshLevels group.

Definition at line 90 of file MeshBody.hpp.

◆ hasParticles()

bool geos::MeshBody::hasParticles ( ) const

inline

Get whether meshbody has particles.

Returns: whether meshbody has particles

Definition at line 174 of file MeshBody.hpp.

◆ setGlobalLengthScale()

void geos::MeshBody::setGlobalLengthScale ( real64 scale )

Set mesh length scale used to define an absolute length tolerance.

Parameters

[in] scale length scale

◆ setHasParticles()

void geos::MeshBody::setHasParticles ( bool hasParticles )

Set whether meshbody has particles.

Parameters

hasParticles Boolean indicating whether the meshbody has particles

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

coreComponents/mesh/MeshBody.hpp

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MeshBody()

Member Function Documentation

◆ createMeshLevel() [1/3]

◆ createMeshLevel() [2/3]

◆ createMeshLevel() [3/3]

◆ createShallowMeshLevel()

◆ forMeshLevels() [1/2]

◆ forMeshLevels() [2/2]

◆ getBaseDiscretization() [1/2]

◆ getBaseDiscretization() [2/2]

◆ getCellBlockManager()

◆ getGlobalLengthScale()

◆ getMeshLevel() [1/2]

◆ getMeshLevel() [2/2]

◆ getMeshLevels() [1/2]

◆ getMeshLevels() [2/2]

◆ hasParticles()

◆ setGlobalLengthScale()

◆ setHasParticles()