The VTKWellGenerator class provides a class implementation of VTK generated well. More...
#include <VTKWellGenerator.hpp>
Inheritance diagram for geos::VTKWellGenerator:
Constructor / Destructor | |
| VTKWellGenerator (const string &name, Group *const parent) | |
| Main constructor for VTKWellGenerator base class. More... | |
| static string | catalogName () |
| Return the name of the VTKWellGenerator in object Catalog. More... | |
Additional Inherited Members | |
 Public Types inherited from geos::MeshComponentBase | |
| using | CatalogInterface = dataRepository::CatalogInterface< MeshComponentBase, string const &, Group *const > |
| Type alias for catalog interface used by this class. See CatalogInterface. | |
| 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. | |
| Public Member Functions inherited from geos::WellGeneratorBase | |
| WellGeneratorBase (const string &name, Group *const parent) | |
| Constructor. More... | |
| virtual void | expandObjectCatalogs () override |
| This function is used to expand any catalogs in the data structure. | |
| virtual Group * | createChild (string const &childKey, string const &childName) override |
| Create a new geometric object (box, plane, etc) as a child of this group. More... | |
| void | generateWellGeometry () |
| Main function of the class that generates the well geometry. | |
| globalIndex | numElements () const |
| Get the global number of well elements. More... | |
| const array2d< globalIndex > & | getSegmentToPolyNodeMap () const |
| Getter to the Segment to PolyNode mapping. More... | |
| globalIndex | numNodesPerElement () const |
| Get the number of nodes per well element. More... | |
| const array2d< real64 > & | getPolyNodeCoord () const |
| Get the Coordinates of the polyline nodes. More... | |
| real64 | getMinSegmentLength () const |
| real64 | getMinElemLength () const |
| const string_array & | getPerforationList () const |
| arrayView2d< real64 const > | getElemCoords () const |
| Get the physical location of the centers of well elements. More... | |
| arrayView1d< globalIndex const > | getNextElemIndex () const |
| Get the global indices mapping an element to the next. More... | |
| arrayView1d< arrayView1d< globalIndex const > const > | getPrevElemIndices () const |
| Get the global indices mapping an element to the previous ones. More... | |
| arrayView2d< globalIndex const > | getElemToNodesMap () const |
| Get the global indices of the well nodes nodes connected to each element. More... | |
| arrayView1d< real64 const > | getElemVolume () const |
| Get the volume of the well elements. More... | |
| real64 | getElementRadius () const |
| Get the radius in the well. More... | |
| globalIndex | numNodes () const |
| Get the global number of well nodes. More... | |
| arrayView2d< real64 const > | getNodeCoords () const |
| Get the physical location of the centers of well elements. More... | |
| globalIndex | numPerforations () const |
| Get the global number of perforations on this well. More... | |
| arrayView2d< real64 const > | getPerfCoords () const |
| Get the locations of the perforations. More... | |
| arrayView1d< real64 const > | getPerfTransmissibility () const |
| Get the well transmissibility at the perforations. More... | |
| arrayView1d< real64 const > | getPerfSkinFactor () const |
| Get the skin factor at a perforation. More... | |
| arrayView1d< globalIndex const > | getPerfElemIndex () const |
| Get the global indices of the well elements connected to each perforation. More... | |
| int | getPhysicalDimensionsNumber () const |
| const string | getWellRegionName () const |
| const string | getWellControlsName () const |
| Public Member Functions inherited from geos::MeshComponentBase | |
| MeshComponentBase (string const &name, Group *const parent) | |
| Constructor. More... | |
| virtual | ~MeshComponentBase () |
| Default destructor. | |
| 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... | |
| 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 | 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 |
| Static Public Member Functions inherited from geos::MeshComponentBase | |
| static string | catalogName () |
| Get the catalog name. More... | |
| static CatalogInterface::CatalogType & | getCatalog () |
| Get the singleton catalog for this Group. More... | |
| 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::WellGeneratorBase | |
| void | constructPolylineNodeToSegmentMap () |
| Map each polyline node to the polyline segment(s) it is connected to. | |
| void | findPolylineHeadNodeIndex () |
| Find the head node of the well (i.e., top node of the polyline). | |
| void | discretizePolyline () |
| Discretize the polyline by placing well elements. | |
| void | connectPerforationsToWellElements () |
| Map each perforation to a well element. | |
| void | checkPerforationLocationsValidity () |
| Make sure that the perforation locations are valid: More... | |
| void | mergePerforations (array1d< array1d< localIndex > > const &elemToPerfMap) |
| Merge perforations on the elements with multiple perforations. More... | |
| globalIndex | getNextSegmentIndex (globalIndex topSegId, globalIndex currentNodeId) const |
| At a given node, find the next segment going in the direction of the bottom of the well. More... | |
| void | postInputInitialization () override |
| This function provides capability to post process input values prior to any other initialization operations. | |
| Protected Member Functions inherited from geos::dataRepository::Group | |
| 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. | |
| Protected Attributes inherited from geos::WellGeneratorBase | |
| globalIndex | m_numPerforations |
| Global number of perforations. | |
| string_array | m_perforationList |
| List of perforation names. | |
| array2d< globalIndex > | m_segmentToPolyNodeMap |
| Connectivity between the polyline nodes. | |
| int | m_numElemsPerSegment |
| Number of well elements per polyline interval. | |
| real64 | m_minSegmentLength |
| Min segment length. | |
| real64 | m_minElemLength |
| Min well element length. | |
| real64 | m_radius |
| Radius area of the well (assumed to be valid for the entire well) | |
| string | m_wellRegionName |
| Name of the corresponding well region. | |
| string | m_wellControlsName |
| Name of the constraints associated with this well. | |
| globalIndex | m_numElems |
| Global number of well elements. | |
| array2d< real64 > | m_elemCenterCoords |
| Physical location of the center of the well element. | |
| array1d< globalIndex > | m_nextElemId |
| Global index of the next well element. | |
| array1d< array1d< globalIndex > > | m_prevElemId |
| Global indices of the prev well elements (maybe need multiple prevs for branching) | |
| array2d< globalIndex > | m_elemToNodesMap |
| Connectivity between elements and nodes. | |
| array1d< real64 > | m_elemVolume |
| Volume of well elements. | |
| globalIndex const | m_numNodesPerElem |
| Number of nodes per well element. | |
| globalIndex | m_numNodes |
| Global number of well nodes. | |
| array2d< real64 > | m_nodeCoords |
| Physical location of the nodes. | |
| array2d< real64 > | m_perfCoords |
| Absolute physical location of the perforation. | |
| array1d< real64 > | m_perfTransmissibility |
| Well Peaceman index at the perforation. | |
| array1d< globalIndex > | m_perfElemId |
| Global index of the well element. | |
| const int | m_nDims |
| Number of physical dimensions. | |
| array2d< real64 > | m_polyNodeCoords |
| Coordinates of the polyline nodes. | |
| array1d< SortedArray< globalIndex > > | m_polyNodeToSegmentMap |
| Map from the polyline nodes to the polyline nodes. | |
| globalIndex | m_polylineHeadNodeId |
| Index of the node at the well head. | |
| array1d< real64 > | m_nodeDistFromHead |
| Physical location of the polyline node wrt to well head. | |
| array1d< real64 > | m_perfSkinFactor |
| Skin Factor at the perforation. | |
| array1d< real64 > | m_perfDistFromHead |
| Physical location of the perforation wrt to well head. | |
Detailed Description
The VTKWellGenerator class provides a class implementation of VTK generated well.
Definition at line 39 of file VTKWellGenerator.hpp.
Constructor & Destructor Documentation
◆ VTKWellGenerator()
Main constructor for VTKWellGenerator base class.
- Parameters
-
[in] name of the VTKWellGenerator object [in] parent the parent Group pointer for the WellGenerator object
Member Function Documentation
◆ catalogName()
|
inlinestatic |
Return the name of the VTKWellGenerator in object Catalog.
- Returns
- string that contains the key name to VTKWellGenerator in the Catalog
Definition at line 60 of file VTKWellGenerator.hpp.
The documentation for this class was generated from the following file:
- coreComponents/mesh/generators/VTKWellGenerator.hpp
