GEOSX
Public Member Functions | List of all members
geos::WellGeneratorABC Class Referenceabstract

#include <WellGeneratorABC.hpp>

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

Public Member Functions

 WellGeneratorABC (const string &name, Group *const parent)
 Constructor. More...
 
virtual void generateWellGeometry ()=0
 Main function of the class that generates the well geometry.
 
Getters / Setters
virtual globalIndex numElements () const =0
 Get the global number of well elements. More...
 
virtual const array2d< globalIndex > & getSegmentToPolyNodeMap () const =0
 Getter to the Segment to PolyNode mapping. More...
 
virtual globalIndex numNodesPerElement () const =0
 Get the number of nodes per well element. More...
 
virtual const array2d< real64 > & getPolyNodeCoord () const =0
 Get the Coordinates of the polyline nodes. More...
 
virtual real64 getMinSegmentLength () const =0
 
virtual real64 getMinElemLength () const =0
 
virtual const string_arraygetPerforationList () const =0
 
virtual arrayView2d< real64 const > getElemCoords () const =0
 Get the physical location of the centers of well elements. More...
 
virtual arrayView1d< globalIndex const > getNextElemIndex () const =0
 Get the global indices mapping an element to the next. More...
 
virtual arrayView1d< arrayView1d< globalIndex const > const > getPrevElemIndices () const =0
 Get the global indices mapping an element to the previous ones. More...
 
virtual arrayView2d< globalIndex const > getElemToNodesMap () const =0
 Get the global indices of the well nodes nodes connected to each element. More...
 
virtual arrayView1d< real64 const > getElemVolume () const =0
 Get the volume of the well elements. More...
 
virtual real64 getElementRadius () const =0
 Get the radius in the well. More...
 
virtual globalIndex numNodes () const =0
 Get the global number of well nodes. More...
 
virtual arrayView2d< real64 const > getNodeCoords () const =0
 Get the physical location of the centers of well elements. More...
 
virtual globalIndex numPerforations () const =0
 Get the global number of perforations on this well. More...
 
virtual arrayView2d< real64 const > getPerfCoords () const =0
 Get the locations of the perforations. More...
 
virtual arrayView1d< real64 const > getPerfTransmissibility () const =0
 Get the well transmissibility at the perforations. More...
 
virtual arrayView1d< real64 const > getPerfSkinFactor () const =0
 Get the skin factor at a perforation. More...
 
virtual arrayView1d< globalIndex const > getPerfElemIndex () const =0
 Get the global indices of the well elements connected to each perforation. More...
 
virtual int getPhysicalDimensionsNumber () const =0
 
virtual const string getWellRegionName () const =0
 
virtual const string getWellControlsName () const =0
 
- 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 initializePostInitialConditionsPostSubGroups ()
 Called by InitializePostInitialConditions() after to initializing sub-Groups.
 
virtual void postRestartInitialization ()
 Performs initialization required after reading from a restart file.
 

Detailed Description

Abstract base class defining the information provided by any the well generator class.

Definition at line 36 of file WellGeneratorABC.hpp.

Constructor & Destructor Documentation

◆ WellGeneratorABC()

geos::WellGeneratorABC::WellGeneratorABC ( const string name,
Group *const  parent 
)
inline

Constructor.

Parameters
namename of the object in the data hierarchy.
parentpointer to the parent group in the data hierarchy.

Definition at line 45 of file WellGeneratorABC.hpp.

Member Function Documentation

◆ getElemCoords()

virtual arrayView2d< real64 const > geos::WellGeneratorABC::getElemCoords ( ) const
pure virtual

Get the physical location of the centers of well elements.

Returns
list of center locations of the well elements

Implemented in geos::WellGeneratorBase.

◆ getElementRadius()

virtual real64 geos::WellGeneratorABC::getElementRadius ( ) const
pure virtual

Get the radius in the well.

Returns
the radius in the well

Implemented in geos::WellGeneratorBase.

◆ getElemToNodesMap()

virtual arrayView2d< globalIndex const > geos::WellGeneratorABC::getElemToNodesMap ( ) const
pure virtual

Get the global indices of the well nodes nodes connected to each element.

Returns
list providing the global index of the well nodes for each well element

Implemented in geos::WellGeneratorBase.

◆ getElemVolume()

virtual arrayView1d< real64 const > geos::WellGeneratorABC::getElemVolume ( ) const
pure virtual

Get the volume of the well elements.

Returns
list of volumes of the well elements

Implemented in geos::WellGeneratorBase.

◆ getMinElemLength()

virtual real64 geos::WellGeneratorABC::getMinElemLength ( ) const
pure virtual
Returns
The minimum element length

Implemented in geos::WellGeneratorBase.

◆ getMinSegmentLength()

virtual real64 geos::WellGeneratorABC::getMinSegmentLength ( ) const
pure virtual
Returns
The minimum segment length

Implemented in geos::WellGeneratorBase.

◆ getNextElemIndex()

virtual arrayView1d< globalIndex const > geos::WellGeneratorABC::getNextElemIndex ( ) const
pure virtual

Get the global indices mapping an element to the next.

Returns
list providing the global index of the next element for each element

Implemented in geos::WellGeneratorBase.

◆ getNodeCoords()

virtual arrayView2d< real64 const > geos::WellGeneratorABC::getNodeCoords ( ) const
pure virtual

Get the physical location of the centers of well elements.

Returns
list of center locations of the well elements

Implemented in geos::WellGeneratorBase.

◆ getPerfCoords()

virtual arrayView2d< real64 const > geos::WellGeneratorABC::getPerfCoords ( ) const
pure virtual

Get the locations of the perforations.

Returns
list of locations of all the perforations on the well

Implemented in geos::WellGeneratorBase.

◆ getPerfElemIndex()

virtual arrayView1d< globalIndex const > geos::WellGeneratorABC::getPerfElemIndex ( ) const
pure virtual

Get the global indices of the well elements connected to each perforation.

Returns
list providing the global index of the connected well element for each perforation

Implemented in geos::WellGeneratorBase.

◆ getPerforationList()

virtual const string_array& geos::WellGeneratorABC::getPerforationList ( ) const
pure virtual
Returns
The list of perforation names

Implemented in geos::WellGeneratorBase.

◆ getPerfSkinFactor()

virtual arrayView1d< real64 const > geos::WellGeneratorABC::getPerfSkinFactor ( ) const
pure virtual

Get the skin factor at a perforation.

Returns
the skin factor at a perforation

Implemented in geos::WellGeneratorBase.

◆ getPerfTransmissibility()

virtual arrayView1d< real64 const > geos::WellGeneratorABC::getPerfTransmissibility ( ) const
pure virtual

Get the well transmissibility at the perforations.

Returns
list of well transmissibility at all the perforations on the well

Implemented in geos::WellGeneratorBase.

◆ getPhysicalDimensionsNumber()

virtual int geos::WellGeneratorABC::getPhysicalDimensionsNumber ( ) const
pure virtual
Returns
The number of physical dimensions

Implemented in geos::WellGeneratorBase.

◆ getPolyNodeCoord()

virtual const array2d< real64 >& geos::WellGeneratorABC::getPolyNodeCoord ( ) const
pure virtual

Get the Coordinates of the polyline nodes.

Returns
the Coordinates of the polyline nodes

Implemented in geos::WellGeneratorBase.

◆ getPrevElemIndices()

virtual arrayView1d< arrayView1d< globalIndex const > const > geos::WellGeneratorABC::getPrevElemIndices ( ) const
pure virtual

Get the global indices mapping an element to the previous ones.

Returns
list providing the global indices of the previous elements for each element

Implemented in geos::WellGeneratorBase.

◆ getSegmentToPolyNodeMap()

virtual const array2d< globalIndex >& geos::WellGeneratorABC::getSegmentToPolyNodeMap ( ) const
pure virtual

Getter to the Segment to PolyNode mapping.

Returns
The Segment to PolyNode mapping as a 2D array

Implemented in geos::WellGeneratorBase.

◆ getWellControlsName()

virtual const string geos::WellGeneratorABC::getWellControlsName ( ) const
pure virtual

Getter for the associated well control name

Returns
the associated well control name

Implemented in geos::WellGeneratorBase.

◆ getWellRegionName()

virtual const string geos::WellGeneratorABC::getWellRegionName ( ) const
pure virtual

Getter for the associated well region name

Returns
the associated well region name

Implemented in geos::WellGeneratorBase.

◆ numElements()

virtual globalIndex geos::WellGeneratorABC::numElements ( ) const
pure virtual

Get the global number of well elements.

Returns
the global number of elements

Implemented in geos::WellGeneratorBase.

◆ numNodes()

virtual globalIndex geos::WellGeneratorABC::numNodes ( ) const
pure virtual

Get the global number of well nodes.

Returns
the global number of nodes

Implemented in geos::WellGeneratorBase.

◆ numNodesPerElement()

virtual globalIndex geos::WellGeneratorABC::numNodesPerElement ( ) const
pure virtual

Get the number of nodes per well element.

Returns
the number of nodes per well element

Implemented in geos::WellGeneratorBase.

◆ numPerforations()

virtual globalIndex geos::WellGeneratorABC::numPerforations ( ) const
pure virtual

Get the global number of perforations on this well.

Returns
the global number of elements

Implemented in geos::WellGeneratorBase.


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