GEOSX
Static Public Member Functions | Public Attributes | List of all members
geos::WellElementSubRegion::viewKeyStruct Struct Reference

Struct to serve as a container for variable strings and keys. More...

#include <WellElementSubRegion.hpp>

Inheritance diagram for geos::WellElementSubRegion::viewKeyStruct:
Inheritance graph
[legend]

Static Public Member Functions

static constexpr const char * wellControlsString ()
 
static constexpr const char * wellNodeListString ()
 
static constexpr const char * nextWellElementIndexString ()
 
static constexpr const char * nextWellElementIndexGlobalString ()
 
static constexpr const char * topWellElementIndexString ()
 
static constexpr const char * topRankString ()
 
static constexpr const char * radiusString ()
 
- Static Public Member Functions inherited from geos::ElementSubRegionBase::viewKeyStruct
static constexpr const char * numNodesPerElementString ()
 
static constexpr const char * nodeListString ()
 
static constexpr const char * numEdgesPerElementString ()
 
static constexpr const char * edgeListString ()
 
static constexpr const char * numFacesPerElementString ()
 
static constexpr const char * faceListString ()
 
static constexpr const char * elementCenterString ()
 
static constexpr const char * elementVolumeString ()
 
- Static Public Member Functions inherited from geos::ObjectManagerBase::viewKeyStruct
static constexpr const char * adjacencyListString ()
 
static constexpr const char * domainBoundaryIndicatorString ()
 
static constexpr const char * externalSetString ()
 
static constexpr const char * ghostRankString ()
 
static constexpr const char * ghostsToReceiveString ()
 
static constexpr const char * globalToLocalMapString ()
 
static constexpr const char * isExternalString ()
 
static constexpr const char * localToGlobalMapString ()
 

Public Attributes

dataRepository::ViewKey wellControlsName = { wellControlsString() }
 ViewKey for the well control name.
 
dataRepository::ViewKey wellNodeList = { wellNodeListString() }
 ViewKey for the well element-to-node list.
 
dataRepository::ViewKey nextWellElementIndex = { nextWellElementIndexString() }
 ViewKey for the local indices of the next well element (used in solvers)
 
dataRepository::ViewKey nextWellElementIndexGlobal = { nextWellElementIndexGlobalString() }
 ViewKey for the global indices of the next well element (to reconstruct maps)
 
dataRepository::ViewKey topWellElementIndex = { topWellElementIndexString() }
 ViewKey for the top well element index.
 
dataRepository::ViewKey topRank = { topRankString() }
 ViewKey for the rank owning the top element.
 
dataRepository::ViewKey radius = { radiusString() }
 ViewKey for the well radius.
 
- Public Attributes inherited from geos::ObjectManagerBase::viewKeyStruct
dataRepository::ViewKey externalSet = { externalSetString() }
 View key to external set.
 
dataRepository::ViewKey ghostRank = { ghostRankString() }
 View key to ghost ranks.
 
dataRepository::ViewKey globalToLocalMap = { globalToLocalMapString() }
 View key to global->local map.
 
dataRepository::ViewKey localToGlobalMap = { localToGlobalMapString() }
 View key to the local->global map.
 

Detailed Description

Struct to serve as a container for variable strings and keys.

Definition at line 248 of file WellElementSubRegion.hpp.

Member Function Documentation

◆ nextWellElementIndexGlobalString()

static constexpr const char* geos::WellElementSubRegion::viewKeyStruct::nextWellElementIndexGlobalString ( )
inlinestaticconstexpr
Returns
String key for the global indices of the next well element (to reconstruct maps)

Definition at line 257 of file WellElementSubRegion.hpp.

◆ nextWellElementIndexString()

static constexpr const char* geos::WellElementSubRegion::viewKeyStruct::nextWellElementIndexString ( )
inlinestaticconstexpr
Returns
String key for the local indices of the next well element (used in solvers)

Definition at line 255 of file WellElementSubRegion.hpp.

◆ radiusString()

static constexpr const char* geos::WellElementSubRegion::viewKeyStruct::radiusString ( )
inlinestaticconstexpr
Returns
String key for the well radius

Definition at line 263 of file WellElementSubRegion.hpp.

◆ topRankString()

static constexpr const char* geos::WellElementSubRegion::viewKeyStruct::topRankString ( )
inlinestaticconstexpr
Returns
String key for the rank owning the top element

Definition at line 261 of file WellElementSubRegion.hpp.

◆ topWellElementIndexString()

static constexpr const char* geos::WellElementSubRegion::viewKeyStruct::topWellElementIndexString ( )
inlinestaticconstexpr
Returns
String key for the top well element index

Definition at line 259 of file WellElementSubRegion.hpp.

◆ wellControlsString()

static constexpr const char* geos::WellElementSubRegion::viewKeyStruct::wellControlsString ( )
inlinestaticconstexpr
Returns
String key for the well control name

Definition at line 251 of file WellElementSubRegion.hpp.

◆ wellNodeListString()

static constexpr const char* geos::WellElementSubRegion::viewKeyStruct::wellNodeListString ( )
inlinestaticconstexpr
Returns
String key for the well element-to-node list

Definition at line 253 of file WellElementSubRegion.hpp.


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