GEOSX
Public Member Functions | List of all members
geos::MeshLevel Class Reference

Class facilitating the representation of a multi-level discretization of a MeshBody. More...

#include <MeshLevel.hpp>

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

Public Member Functions

 MeshLevel (string const &name, Group *const parent)
 Constructor for the MeshLevel object. More...
 
 MeshLevel (string const &name, Group *const parent, MeshLevel &source)
 Constructor to create a shallow MeshLevel. More...
 
 MeshLevel (string const &name, Group *const parent, MeshLevel const &source, int const order)
 Constructor for the MeshLevel object. More...
 
void generateSets ()
 Generate the sets for the objects within a MeshLevel.
 
void generateAdjacencyLists (arrayView1d< localIndex const > const &seedNodeList, localIndex_array &nodeAdjacencyList, localIndex_array &edgeAdjacencyList, localIndex_array &faceAdjacencyList, ElementRegionManager::ElementViewAccessor< ReferenceWrapper< localIndex_array > > &elementAdjacencyList, integer const depth)
 Collects the nodes, edges, faces, and elements that are adjacent to a given list of nodes. More...
 
virtual void initializePostInitialConditionsPostSubGroups () override
 Called by InitializePostInitialConditions() after to initializing sub-Groups.
 
Getters / Setters
const NodeManagergetNodeManager () const
 Get the node manager. More...
 
NodeManagergetNodeManager ()
 Get the node manager. More...
 
const ParticleManagergetParticleManager () const
 Get the particle manager. More...
 
ParticleManagergetParticleManager ()
 Get the particle manager. More...
 
const EdgeManagergetEdgeManager () const
 Get the edge manager. More...
 
EdgeManagergetEdgeManager ()
 Get the edge manager. More...
 
const FaceManagergetFaceManager () const
 Get the face manager. More...
 
FaceManagergetFaceManager ()
 Get the face manager. More...
 
const ElementRegionManagergetElemManager () const
 Get the element region manager. More...
 
ElementRegionManagergetElemManager ()
 Get the element region manager. More...
 
const EmbeddedSurfaceNodeManagergetEmbSurfNodeManager () const
 Get the node Manager of the embedded surfaces grid. More...
 
EmbeddedSurfaceNodeManagergetEmbSurfNodeManager ()
 Get the node Manager of the embedded surfaces grid. More...
 
const EdgeManagergetEmbSurfEdgeManager () const
 Get the edge Manager related to the embedded surfaces grid. More...
 
EdgeManagergetEmbSurfEdgeManager ()
 Get the edge Manager related to the embedded surfaces grid. More...
 
Timestamp getModificationTimestamp () const
 Getter for the modification timestamp. More...
 
void modified ()
 Increment the modification timestamp if the mesh has been modified.
 
bool isShallowCopy () const
 
bool isShallowCopyOf (MeshLevel const &comparisonLevel) const
 Determines if this->MeshLevel is a shallow copy of the input. More...
 
const MeshLevelgetShallowParent () const
 If this is a shallow clone of another MeshLevel, then return the source MeshLevel. More...
 
MeshLevelgetShallowParent ()
 If this is a shallow clone of another MeshLevel, then return the source MeshLevel. More...
 
- Public Member Functions inherited from geos::dataRepository::Group
virtual bool registerCallback (void *func, const std::type_info &funcType)
 Register a callback function on the group. More...
 
virtual void reinit ()
 Performs re-initialization of certain variable depending on the solver being used.
 
 Group (string const &name, Group *const parent)
 Constructor. More...
 
 Group (string const &name, conduit::Node &rootNode)
 Constructor. More...
 
 Group (Group &&source)=default
 Move constructor. More...
 
virtual ~Group ()
 Destructor, deletes all Groups and Wrappers owned by this Group.
 
 Group ()=delete
 Deleted default constructor.
 
 Group (Group const &)=delete
 Deleted copy constructor.
 
Groupoperator= (Group const &)=delete
 Deleted copy assignment operator. More...
 
Groupoperator= (Group &&)=delete
 Deleted move assignment operator. More...
 
void printDataHierarchy (integer indent=0) const
 Prints the data hierarchy recursively. More...
 
string dumpInputOptions () const
 
string dumpSubGroupsNames () const
 
string dumpWrappersNames () const
 
template<typename T = Group>
T & registerGroup (string const &name, std::unique_ptr< T > newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name, T *newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (subGroupMap::KeyIndex const &keyIndex)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group, typename TBASE = Group>
T & registerGroup (string const &name, string const &catalogName)
 Register a new Group as a sub-group of current Group. More...
 
void deregisterGroup (string const &name)
 Removes a child group from this group. More...
 
virtual GroupcreateChild (string const &childKey, string const &childName)
 Creates a new sub-Group using the ObjectCatalog functionality. More...
 
template<typename T = Group, typename KEY = void>
T * getGroupPointer (KEY const &key)
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
const T * getGroupPointer (KEY const &key) const
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T & getGroup (KEY const &key)
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
const T & getGroup (KEY const &key) const
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group>
T & getGroupByPath (string const &path)
 Retrieve a group from the hierarchy using a path. More...
 
template<typename T = Group>
const T & getGroupByPath (string const &path) const
 Retrieve a group from the hierarchy using a path. More...
 
subGroupMapgetSubGroups ()
 Get the subgroups object. More...
 
const subGroupMapgetSubGroups () const
 Get the subgroups object. More...
 
localIndex numSubGroups () const
 return the number of sub groups in this Group More...
 
std::vector< stringgetSubGroupsNames () const
 
template<typename T = Group>
bool hasGroup (string const &name) const
 Check whether a sub-group exists. More...
 
template<typename T >
bool hasSubGroupOfType () const
 Check whether a sub-group exists by type. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
virtual void initialize_postMeshGeneration ()
 initialization post generation of the mesh.
 
void initialize ()
 Run initialization functions on this and all subgroups. More...
 
virtual void initializationOrder (string_array &order)
 Sets the initialization order for sub-Groups. More...
 
void initializePostInitialConditions ()
 Initialization routine to be called after calling ApplyInitialConditions(). More...
 
void postRestartInitializationRecursive ()
 Initialization routine to be called after calling reading a restart file. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
 Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when Include nodes are encountered. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
 Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...
 
void postProcessInputRecursive ()
 Recursively call postProcessInput() to apply post processing after reading input values.
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
 Create and register a Wrapper around a new object. More...
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
 Create and register a Wrapper around a new object. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, std::unique_ptr< T > newObject)
 Register a Wrapper around a given object and take ownership. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, T *newObject)
 Register a Wrapper around an existing object, does not take ownership of the object. More...
 
WrapperBaseregisterWrapper (std::unique_ptr< WrapperBase > wrapper)
 Register and take ownership of an existing Wrapper. More...
 
void deregisterWrapper (string const &name)
 Removes a Wrapper from this group. More...
 
void generateDataStructureSkeleton (integer const level)
 Build a complete datastructure for schema generation. More...
 
virtual void expandObjectCatalogs ()
 Expand any catalogs in the data structure.
 
virtual void setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
 Inform the schema generator of any deviations between the xml and GEOS data structures. More...
 
virtual void registerDataOnMeshRecursive (Group &meshBodies)
 Calls RegisterDataOnMesh() recursively. More...
 
virtual void registerDataOnMesh (Group &meshBodies)
 Register data on mesh entities. More...
 
virtual localIndex packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of wrappers. More...
 
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 >
const WrapperBasegetWrapperBase (KEY const &key) const
 Return a reference to a WrapperBase stored in this group. More...
 
template<typename KEY >
WrapperBasegetWrapperBase (KEY const &key)
 Return a reference to a WrapperBase stored in this group. More...
 
indexType getWrapperIndex (string const &name) const
 
const wrapperMapwrappers () const
 Get access to the internal wrapper storage. More...
 
wrapperMapwrappers ()
 Get access to the internal wrapper storage. More...
 
indexType numWrappers () const
 Return the number of wrappers. More...
 
std::vector< stringgetWrappersNames () const
 
template<typename LOOKUP_TYPE >
bool hasWrapper (LOOKUP_TYPE const &lookup) const
 Check if a wrapper exists. More...
 
template<typename T , typename LOOKUP_TYPE >
const Wrapper< T > & getWrapper (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > & getWrapper (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
const Wrapper< T > * getWrapperPointer (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > * getWrapperPointer (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
GEOS_DECLTYPE_AUTO_RETURN getReference (LOOKUP_TYPE const &lookup) const
 Look up a wrapper and get reference to wrapped object. More...
 
template<typename T , typename LOOKUP_TYPE >
T & getReference (LOOKUP_TYPE const &lookup)
 Look up a wrapper and get reference to wrapped object. More...
 
virtual void resize (localIndex const newSize)
 Resize the group and all contained wrappers that resize with parent. More...
 
virtual void reserve (indexType const newsize)
 Set the new capacity and reserve it in all wrappers that resize with parent. More...
 
localIndex capacity () const
 Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...
 
localIndex size () const
 Get the "size" of the group, which determines the number of elements in resizable wrappers. More...
 
const stringgetName () const
 Get group name. More...
 
string getPath () const
 Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...
 
const DataContextgetDataContext () const
 
template<typename KEY >
const DataContextgetWrapperDataContext (KEY key) const
 
GroupgetParent ()
 Access the group's parent. More...
 
const GroupgetParent () const
 Access the group's parent. More...
 
bool hasParent () const
 
localIndex getIndexInParent () const
 Get the group's index within its parent group. More...
 
localIndex getSubGroupIndex (keyType const &key) const
 Get the index of a sub-Group within this group. More...
 
int sizedFromParent () const
 Check whether this Group is resized when its parent is resized. More...
 
GroupsetSizedFromParent (int val)
 Set whether this wrapper is resized when its parent is resized. More...
 
RestartFlags getRestartFlags () const
 Get flags that control restart output of this group. More...
 
void setRestartFlags (RestartFlags flags)
 Set flags that control restart output of this group. More...
 
InputFlags getInputFlags () const
 Get input flags for schema generation. More...
 
void setInputFlags (InputFlags flags)
 Set input flags for schema generation. More...
 
conduit::Node & getConduitNode ()
 Return the Conduit node object associated with this group. More...
 
const conduit::Node & getConduitNode () const
 Return the Conduit node object associated with this group. More...
 
void prepareToWrite ()
 Register the group and its wrappers with Conduit.
 
void finishWriting ()
 Write the group and its wrappers into Conduit.
 
void loadFromConduit ()
 Read the group and its wrappers from Conduit.
 
void enableLogLevelInput ()
 Enable verbosity input for object.
 
void setLogLevel (integer const logLevel)
 Set verbosity level. More...
 
integer getLogLevel () const
 

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::CatalogTypegetCatalog ()
 Get the singleton catalog for this class. More...
 
- Protected Member Functions inherited from geos::dataRepository::Group
virtual void postProcessInput ()
 
virtual void initializePreSubGroups ()
 Called by Initialize() prior to initializing sub-Groups.
 
virtual void initializePostSubGroups ()
 Called by Initialize() after to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPreSubGroups ()
 Called by InitializePostInitialConditions() prior to initializing sub-Groups.
 
virtual void postRestartInitialization ()
 Performs initialization required after reading from a restart file.
 

Detailed Description

Class facilitating the representation of a multi-level discretization of a MeshBody.

This contains the main components that compose a discretized mesh in GEOSX (nodes, faces, elements). In current practice, the code utilizes a single MeshLevel until such time as we implement a proper multi-level mesh capability.

Definition at line 40 of file MeshLevel.hpp.

Constructor & Destructor Documentation

◆ MeshLevel() [1/3]

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

Constructor for the MeshLevel object.

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

◆ MeshLevel() [2/3]

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

Constructor to create a shallow MeshLevel.

Parameters
[in]namethe name of the MeshLevel object in the repository
[in]parentthe parent group of the MeshLevel object being constructed
[in]sourceThe MeshLevel to make a shallow copy of.

◆ MeshLevel() [3/3]

geos::MeshLevel::MeshLevel ( string const &  name,
Group *const  parent,
MeshLevel const &  source,
int const  order 
)

Constructor for the MeshLevel object.

Parameters
[in]namethe name of the MeshLevel object in the repository
[in]parentthe parent group of the MeshLevel object being constructed
[in]sourceThe source MeshLevel to build the new one from
[in]orderThe order of the MeshLevel

Member Function Documentation

◆ generateAdjacencyLists()

void geos::MeshLevel::generateAdjacencyLists ( arrayView1d< localIndex const > const &  seedNodeList,
localIndex_array nodeAdjacencyList,
localIndex_array edgeAdjacencyList,
localIndex_array faceAdjacencyList,
ElementRegionManager::ElementViewAccessor< ReferenceWrapper< localIndex_array > > &  elementAdjacencyList,
integer const  depth 
)

Collects the nodes, edges, faces, and elements that are adjacent to a given list of nodes.

Parameters
[in]seedNodeListthe input nodes
[out]nodeAdjacencyListthe nodes adjacent to the input nodes of seedNodeList
[out]edgeAdjacencyListthe edges adjacent to the input nodes of seedNodeList
[out]faceAdjacencyListthe faces adjacent to the input nodes of seedNodeList
[out]elementAdjacencyListthe elements adjacent to the input nodes of seedNodeList
[in]depththe depth of the search for adjacent quantities (first-order neighbors, neighbors of neighbors, etc)

All the additional information (nodes, edges, faces) connected to the edges, faces, elements that touch the seedNodeList is also collected. For instance, all the nodes, edges and faces that touch an element that relies on a node of the seedNodeList, will be considered. Even if these "second level" geometrical elements do touch seedNodeList themselves. The idea being obviously that any shared geometrical object needs to be fully defined.

◆ getEdgeManager() [1/2]

EdgeManager& geos::MeshLevel::getEdgeManager ( )
inline

Get the edge manager.

Returns
a reference to the edgeManager object

Definition at line 186 of file MeshLevel.hpp.

◆ getEdgeManager() [2/2]

const EdgeManager& geos::MeshLevel::getEdgeManager ( ) const
inline

Get the edge manager.

Returns
a reference to the edgeManager object

Definition at line 180 of file MeshLevel.hpp.

◆ getElemManager() [1/2]

ElementRegionManager& geos::MeshLevel::getElemManager ( )
inline

Get the element region manager.

Returns
a reference to the elementRegionManager object

Definition at line 212 of file MeshLevel.hpp.

◆ getElemManager() [2/2]

const ElementRegionManager& geos::MeshLevel::getElemManager ( ) const
inline

Get the element region manager.

Returns
a reference to the elementRegionManager object

Definition at line 206 of file MeshLevel.hpp.

◆ getEmbSurfEdgeManager() [1/2]

EdgeManager& geos::MeshLevel::getEmbSurfEdgeManager ( )
inline

Get the edge Manager related to the embedded surfaces grid.

Returns
a pointer to the edgeManager related to the embedded surfaces grid

Definition at line 238 of file MeshLevel.hpp.

◆ getEmbSurfEdgeManager() [2/2]

const EdgeManager& geos::MeshLevel::getEmbSurfEdgeManager ( ) const
inline

Get the edge Manager related to the embedded surfaces grid.

Returns
a pointer to the edgeManager related to the embedded surfaces grid

Definition at line 232 of file MeshLevel.hpp.

◆ getEmbSurfNodeManager() [1/2]

EmbeddedSurfaceNodeManager& geos::MeshLevel::getEmbSurfNodeManager ( )
inline

Get the node Manager of the embedded surfaces grid.

Returns
a pointer to the EmbeddedSurfaceNodeManager

Definition at line 225 of file MeshLevel.hpp.

◆ getEmbSurfNodeManager() [2/2]

const EmbeddedSurfaceNodeManager& geos::MeshLevel::getEmbSurfNodeManager ( ) const
inline

Get the node Manager of the embedded surfaces grid.

Returns
a pointer to the EmbeddedSurfaceNodeManager

Definition at line 219 of file MeshLevel.hpp.

◆ getFaceManager() [1/2]

FaceManager& geos::MeshLevel::getFaceManager ( )
inline

Get the face manager.

Returns
a reference to the faceManager object

Definition at line 199 of file MeshLevel.hpp.

◆ getFaceManager() [2/2]

const FaceManager& geos::MeshLevel::getFaceManager ( ) const
inline

Get the face manager.

Returns
a reference to the faceManager object

Definition at line 193 of file MeshLevel.hpp.

◆ getModificationTimestamp()

Timestamp geos::MeshLevel::getModificationTimestamp ( ) const
inline

Getter for the modification timestamp.

Returns
the timestamp of the last modification

Definition at line 245 of file MeshLevel.hpp.

◆ getNodeManager() [1/2]

NodeManager& geos::MeshLevel::getNodeManager ( )
inline

Get the node manager.

Returns
a reference to the nodeManager object

Definition at line 160 of file MeshLevel.hpp.

◆ getNodeManager() [2/2]

const NodeManager& geos::MeshLevel::getNodeManager ( ) const
inline

Get the node manager.

Returns
a reference to the nodeManager object

Definition at line 154 of file MeshLevel.hpp.

◆ getParticleManager() [1/2]

ParticleManager& geos::MeshLevel::getParticleManager ( )
inline

Get the particle manager.

Returns
a reference to the particleManager object

Definition at line 173 of file MeshLevel.hpp.

◆ getParticleManager() [2/2]

const ParticleManager& geos::MeshLevel::getParticleManager ( ) const
inline

Get the particle manager.

Returns
a reference to the particleManager object

Definition at line 167 of file MeshLevel.hpp.

◆ getShallowParent() [1/2]

MeshLevel& geos::MeshLevel::getShallowParent ( )

If this is a shallow clone of another MeshLevel, then return the source MeshLevel.

Returns
MeshLevel const&

◆ getShallowParent() [2/2]

const MeshLevel& geos::MeshLevel::getShallowParent ( ) const

If this is a shallow clone of another MeshLevel, then return the source MeshLevel.

Returns
MeshLevel const&

◆ isShallowCopy()

bool geos::MeshLevel::isShallowCopy ( ) const
inline
Returns
value of m_isShallowCopy.

Definition at line 257 of file MeshLevel.hpp.

◆ isShallowCopyOf()

bool geos::MeshLevel::isShallowCopyOf ( MeshLevel const &  comparisonLevel) const

Determines if this->MeshLevel is a shallow copy of the input.

Parameters
comparisonLevelThe MeshLevel to compare with.
Returns
Whether or not the comparison is true.

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