GEOS
|
#include <CellBlock.hpp>
Public Member Functions | |
Constructor / Destructor | |
CellBlock (string const &name, Group *const parent) | |
Constructor for this class. More... | |
Getters / Setters | |
void | setElementType (ElementType elementType) |
Defines the underlying element type (hex, tet...) More... | |
ElementType | getElementType () const override |
Get the type of element in this subregion. More... | |
localIndex | numNodesPerElement () const override |
Get the number of nodes per element. More... | |
localIndex | numEdgesPerElement () const override |
Get the number of edges per element. More... | |
localIndex | numFacesPerElement () const override |
Get the number of faces per element. More... | |
localIndex | numElements () const override |
Get the number of elements. More... | |
localIndex | maxNodesPerFace () const |
Get the maximum number of nodes comprising a face. More... | |
localIndex | getFaceNodes (localIndex const cellIndex, localIndex const faceNum, Span< localIndex > nodesInFace) const |
Puts the nodes of face faceNum of element cellIndex inside vector nodesInFaces . More... | |
arrayView2d< localIndex, cells::NODE_MAP_USD > | getElemToNode () |
Get the element to nodes mapping, non-const version. More... | |
arrayView2d< localIndex const, cells::NODE_MAP_USD > | getElemToNode () const |
Get the element to nodes mapping, const version. More... | |
array2d< localIndex, cells::NODE_MAP_PERMUTATION > | getElemToNodes () const override |
Get the element-to-nodes map. More... | |
array2d< localIndex > | getElemToEdges () const override |
Get the element-to-edges map. More... | |
array2d< localIndex > | getElemToFaces () const override |
Get the element-to-faces map. More... | |
arrayView2d< localIndex const > | getElemToFacesConstView () const |
Get the element-to-faces map. More... | |
void | setElementToFaces (localIndex const cellIndex, localIndex const faceNum, localIndex const faceIndex) |
Sets an entry in the element to faces mapping. More... | |
void | setElementToEdges (localIndex const cellIndex, localIndex const edgeNum, localIndex const edgeIndex) |
Sets an entry in the element to edges mapping. More... | |
bool | hasElementToEdges (localIndex const cellIndex, localIndex const edgeNum, localIndex const edgeIndex) const |
Checks if edge edgeIndex of element cellIndex has been defined. More... | |
arrayView1d< globalIndex > | localToGlobalMap () |
Get local to global map, non-const version. More... | |
array1d< globalIndex > | localToGlobalMap () const override |
Get local to global map. More... | |
arrayView1d< globalIndex const > | localToGlobalMapConstView () const |
Get local to global map, const view version. More... | |
void | resize (dataRepository::indexType const numElements) override final |
Resize the cell block to hold numElements . More... | |
void | resizeNumNodes (dataRepository::indexType const numNodes) |
Resize the cell block to hold numnodes . More... | |
Public Member Functions inherited from geos::CellBlockABC | |
CellBlockABC (string const &name, Group *const parent) | |
Constructor. More... | |
template<typename LAMBDA > | |
void | forExternalProperties (LAMBDA &&lambda) const |
Helper function to apply a lambda function over all the external properties of the subregion. 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... | |
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 | 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 |
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. | |
This implementation of CellBlockABC mainly use the cell patterns/shapes to build all the element to nodes, faces and edges mappings.
Definition at line 30 of file CellBlock.hpp.
Constructor for this class.
[in] | name | the name of this object manager |
[in] | parent | the parent Group |
|
inlineoverridevirtual |
Get the type of element in this subregion.
See class FiniteElementBase for possible element type.
Implements geos::CellBlockABC.
Definition at line 67 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get the element-to-edges map.
Implements geos::CellBlockABC.
Definition at line 123 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get the element-to-faces map.
Implements geos::CellBlockABC.
Definition at line 126 of file CellBlock.hpp.
|
inline |
Get the element-to-faces map.
Definition at line 133 of file CellBlock.hpp.
|
inline |
Get the element to nodes mapping, non-const version.
Definition at line 110 of file CellBlock.hpp.
|
inline |
Get the element to nodes mapping, const version.
Definition at line 117 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get the element-to-nodes map.
Implements geos::CellBlockABC.
Definition at line 120 of file CellBlock.hpp.
localIndex geos::CellBlock::getFaceNodes | ( | localIndex const | cellIndex, |
localIndex const | faceNum, | ||
Span< localIndex > | nodesInFace | ||
) | const |
Puts the nodes of face faceNum
of element cellIndex
inside vector nodesInFaces
.
[in] | cellIndex | The element index. |
[in] | faceNum | the face number within an element |
[out] | nodesInFace | space for result, must have enough space to fit all nodes |
nodesInFace
nodesInFaces
is sorted from lower to larger node indices values. nodesInFaces
is exactly the size of the number of nodes.
|
inline |
Checks if edge edgeIndex
of element cellIndex
has been defined.
[in] | cellIndex | Index of the element |
[in] | edgeNum | Index of the edge of the element cellIndex (typically from 0 to 11 for an hexahedron). |
[in] | edgeIndex | The edge index. |
Definition at line 172 of file CellBlock.hpp.
|
inline |
Get local to global map, non-const version.
Definition at line 186 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get local to global map.
Implements geos::CellBlockABC.
Definition at line 189 of file CellBlock.hpp.
|
inline |
Get local to global map, const view version.
Definition at line 196 of file CellBlock.hpp.
|
inline |
Get the maximum number of nodes comprising a face.
Definition at line 86 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get the number of edges per element.
Implements geos::CellBlockABC.
Definition at line 73 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get the number of elements.
Implements geos::CellBlockABC.
Definition at line 79 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get the number of faces per element.
Implements geos::CellBlockABC.
Definition at line 76 of file CellBlock.hpp.
|
inlineoverridevirtual |
Get the number of nodes per element.
Implements geos::CellBlockABC.
Definition at line 70 of file CellBlock.hpp.
|
finaloverridevirtual |
Resize the cell block to hold numElements
.
numElements | The new number of elements. |
Reimplemented from geos::dataRepository::Group.
void geos::CellBlock::resizeNumNodes | ( | dataRepository::indexType const | numNodes | ) |
Resize the cell block to hold numnodes
.
numNodes | The new number of nodes. |
|
inline |
Sets an entry in the element to edges mapping.
[in] | cellIndex | Index of the element. |
[in] | edgeNum | Local index of the edge of the element iElement (typically from 0 to 11 for an hexahedron). |
[in] | edgeIndex | Index of the edge. |
In the element to edges mapping, element iElement
has a given number of edges (typically 12 for a hexahedron). Then edge edgeNum
of this local indexing (typically 0 to 11) is meant to have global indexing of edgeIndex
.
Definition at line 158 of file CellBlock.hpp.
|
inline |
Sets an entry in the element to faces mapping.
[in] | cellIndex | Index of the element |
[in] | faceNum | Local index of the face of the element iElement (typically from 0 to 5 for an hexahedron). |
[in] | faceIndex | The face index. |
Definition at line 142 of file CellBlock.hpp.
void geos::CellBlock::setElementType | ( | ElementType | elementType | ) |
Defines the underlying element type (hex, tet...)
[in] | elementType | the element type |