GEOS
|
Block of 2d elements (geometrical surfaces in 3d). More...
#include <FaceBlockABC.hpp>
Public Member Functions | |
FaceBlockABC (string const &name, Group *const parent) | |
Constructor. More... | |
virtual localIndex | num2dElements () const =0 |
Get the number of 2d elements (geometrical surfaces in 3d). More... | |
virtual localIndex | num2dFaces () const =0 |
Get the number of 2d faces (geometrical segments in 3d). More... | |
virtual ArrayOfArrays< localIndex > | get2dElemToNodes () const =0 |
Get the nodes of each 2d element (geometrical surfaces in 3d). More... | |
virtual ArrayOfArrays< localIndex > | get2dElemToEdges () const =0 |
Get the 3d edges of each 2d element (geometrical surfaces in 3d). More... | |
virtual ArrayOfArrays< localIndex > | get2dElemToFaces () const =0 |
Get the 3d faces (of the volumic mesh) that are aside each 2d element (geometrical surfaces in 3d) of the FaceBlockABC . More... | |
virtual ToCellRelation< ArrayOfArrays< localIndex > > | get2dElemToElems () const =0 |
Get the 3d elements that are aside each 2d element (geometrical surfaces in 3d) of the FaceBlockABC . More... | |
virtual ArrayOfArrays< array1d< globalIndex > > | get2dElemsToCollocatedNodesBuckets () const =0 |
Returns the collocated nodes for each node of each 2d element of the FaceBlockABC . More... | |
virtual array1d< localIndex > | get2dFaceToEdge () const =0 |
Get one 3d edge equivalent for each 2d faces (geometrical edges in 3d). More... | |
virtual ArrayOfArrays< localIndex > | get2dFaceTo2dElems () const =0 |
Get the 2d element(s) (geometrical surfaces in 3d) connected to each 2d face (geometrical 3d segment). More... | |
virtual array1d< globalIndex > | localToGlobalMap () const =0 |
Get local to global map for the 2d elements. 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 | 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 |
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. | |
Block of 2d elements (geometrical surfaces in 3d).
The FaceBlockABC
represents a zone of 2d (i.e. surfacic) elements. Unlike its volumic equivalent CellBlockABC
, FaceBlockABC
is not homogeneous and may hold 2d elements of multiple types (triangles, quadrangles...).
In this class, we'll use the term 2d element for the elements of the FaceBlockABC
, which are geometrical surfaces (in 3d). In the same way, we'll use the wording 2d face to refer to the 2d boundaries of the 2d elements. The 2d face are geometrical segments (in 3d).
Definition at line 38 of file FaceBlockABC.hpp.
Constructor.
name | The name of this Group. |
parent | The parent Group. |
Definition at line 46 of file FaceBlockABC.hpp.
|
pure virtual |
Returns the collocated nodes for each node of each 2d element of the FaceBlockABC
.
FaceBlockABC
. The size of the first dimension is equal to num2dElements
. The size of the second dimension is the number of nodes in the 2d element (e.g. 3 for a triangle).Each node of the FaceBlockABC
is pointing to other nodes which are collocated. Those other nodes are meant to be nodes of neighboring 3d cells. All the collocated nodes of each node of each 2d element of the FaceBlockABC
are gathered in the same bucket.
Implemented in geos::FaceBlock.
|
pure virtual |
Get the 3d edges of each 2d element (geometrical surfaces in 3d).
num2dElements
. Second dimension depends on the number of edges of each 2d element. Element numbering is local to the FaceBlockABC
. Edges numbering is local to the rank.On faults and fractures, because nodes are duplicated (and collocated), there are two collocated 3d edges as well. But the returned mapping only refers to one unique 3d edge; the other one is simply not provided.
get2dFaceToEdge
mapping. That is, when one 3d edge gets selected over its collocated twin, it's guaranteed that the same 3d edge will always be selected over the ignored one, in all the mappings provided by this FaceBlockABC
. There is no particular rule to define which of the two 3d edges is going to be selected, but this rule is consistently used throughout the different mapping computations. Implemented in geos::FaceBlock.
|
pure virtual |
Get the 3d elements that are aside each 2d element (geometrical surfaces in 3d) of the FaceBlockABC
.
num2dElements
* 2. 2d element numbering is local to the FaceBlockABC
. 3d element numbering is local to the CellBlockABC
.Mesh is supposed to be conformal, so each 2d element touches two 3d elements (or only one on boundaries). In the case where the 2d element lies on a boundary, the second mapped value will be -1
.
get2dElemToFaces
and get2dElemToElems
are consistent. For the same given 2d element, the 3d face at index 0 (or 1) in the get2dElemToFaces
mapping will be part of the boundary of the 3d element at the same index 0 (or 1) in the get2dElemToElems
mapping. Implemented in geos::FaceBlock.
|
pure virtual |
Get the 3d faces (of the volumic mesh) that are aside each 2d element (geometrical surfaces in 3d) of the FaceBlockABC
.
num2dFaces
* 2 (each 2d element matches two 3d faces). Element numbering is local to the FaceBlockABC
. Faces numbering is local to the rank.Mesh is supposed to be conformal, so each 2d element touches two 3d faces (or only one on boundaries). In the case where the 2d element lies on a boundary, the second mapped value will be -1
.
get2dElemToFaces
and get2dElemToElems
are consistent. For the same given 2d element, the 3d face at index 0 (or 1) in the get2dElemToFaces
mapping will be part of the boundary of the 3d element at the same index 0 (or 1) in the get2dElemToElems
mapping. Implemented in geos::FaceBlock.
|
pure virtual |
Get the nodes of each 2d element (geometrical surfaces in 3d).
num2dElements
. Second dimension depends on the number of nodes of each 2d element. Element numbering is local to the FaceBlockABC. Node numbering is local to the rank.Mesh is supposed to be conformal, so each 2d element touches two 3d faces (or only one on boundaries). The returned mapping provides all the nodes of all those 3d faces, in no particular order. For example, a triangular 2d element will provide 6 nodes.
Implemented in geos::FaceBlock.
|
pure virtual |
Get the 2d element(s) (geometrical surfaces in 3d) connected to each 2d face (geometrical 3d segment).
num2dFaces
. 2d face and 2d element numberings are both local to the FaceBlockABC
. Implemented in geos::FaceBlock.
|
pure virtual |
Get one 3d edge equivalent for each 2d faces (geometrical edges in 3d).
num2dFaces
. 2d face numbering is local to the FaceBlockABC. 3d edge numbering is local to the rank.The current FaceBlockABC
has its own 2d faces (which are segments in terms of 3d geometry). Those segments are edges in the volumic mesh. The returned mapping tells which 3d edge is the geometrical equivalent of the 2d face of the FaceBlockABC
. There can be two collocated 3d edges (because for faults and fractures situations, nodes are duplicated). But the returned mapping only refers to one unique 3d edge; the other is simply not provided.
get2dElemToEdges
and get2dFaceToEdge
are consistent. When one 3d edge gets selected over its collocated twin, it's guaranteed that the same 3d edge will always be selected and the same always ignored, in all the mappings provided by the FaceBlockABC
. There is no particular rule to define which of the two edges is going to be selected, but this rule is consistently used throughout the different mapping computations. Implemented in geos::FaceBlock.
|
pure virtual |
Get local to global map for the 2d elements.
Implemented in geos::FaceBlock.
|
pure virtual |
Get the number of 2d elements (geometrical surfaces in 3d).
Implemented in geos::FaceBlock.
|
pure virtual |
Get the number of 2d faces (geometrical segments in 3d).
Implemented in geos::FaceBlock.