#include <LineBlock.hpp>

Inheritance diagram for geos::LineBlock:

Public Member Functions
	LineBlock (string const &name, Group *const parent)
	Constructor for this class. More...

Getters / Setters
globalIndex	numElements () const override final
	Get the global number of well elements. More...

void	setNumElements (globalIndex numElems)
	Set the global number of well elements. More...

arrayView2d< real64 const >	getElemCoords () const override final
	Get the physical location of the centers of well elements. More...

void	setElemCoords (arrayView2d< real64 const > elemCenterCoords)
	Set the physical location of the centers of well elements. More...

arrayView1d< globalIndex const >	getNextElemIndex () const override final
	Get the global indices mapping an element to the next. More...

void	setNextElemIndex (arrayView1d< globalIndex const > nextElemId)
	Set the global indices mapping an element to the next. More...

arrayView1d< arrayView1d< globalIndex const > const >	getPrevElemIndices () const override final
	Get the global indices mapping an element to the previous ones. More...

void	setPrevElemIndices (arrayView1d< arrayView1d< globalIndex const > const > prevElemIndices)
	Set the global indices mapping an element to the previous ones. More...

arrayView2d< globalIndex const >	getElemToNodesMap () const override final
	Get the global indices of the well nodes nodes connected to each element. More...

void	setElemToNodesMap (arrayView2d< globalIndex const > elemToNodesMap)
	Set the global indices of the well nodes nodes connected to each element. More...

arrayView1d< real64 const >	getElemVolume () const override final
	Get the volume of the well elements. More...

void	setElemVolume (arrayView1d< real64 const > elemVolume)
	Set the volume of the well elements. More...

real64	getElementRadius () const override final
	Get the radius in the well. More...

void	setElementRadius (real64 radius)
	Set the radius in the well. More...

globalIndex	numNodes () const override final
	Get the global number of well nodes. More...

void	setNumNodes (globalIndex numNodes)
	Set the global number of well nodes. More...

arrayView2d< real64 const >	getNodeCoords () const override final
	Get the physical location of the centers of well elements. More...

void	setNodeCoords (arrayView2d< real64 const > nodeCoords)
	Set the physical location of the centers of well elements. More...

globalIndex	numPerforations () const override final
	Get the global number of perforations on this well. More...

void	setNumPerforations (globalIndex numPerforations)
	Set the global number of perforations on this well. More...

arrayView2d< real64 const >	getPerfCoords () const override final
	Get the locations of the perforations. More...

void	setPerfCoords (arrayView2d< real64 const > perfCoords)
	Set the locations of the perforations. More...

arrayView1d< real64 const >	getPerfTransmissibility () const override final
	Get the well transmissibility at the perforations. More...

void	setPerfTransmissibility (arrayView1d< real64 const > perfTransmissibility)
	Set the well transmissibility at the perforations. More...

arrayView1d< real64 const >	getPerfSkinFactor () const override final
	Get the well skin factor at the perforations. More...

void	setPerfSkinFactor (arrayView1d< real64 const > perfSkinFactor)
	Set the well skin factor at the perforations. More...

arrayView1d< globalIndex const >	getPerfElemIndex () const override final
	Get the global indices of the well elements connected to each perforation. More...

void	setPerfElemIndex (arrayView1d< globalIndex const > perfElemId)
	Set the global indices of the well elements connected to each perforation. More...

void	setWellControlsName (string const &wellControlsName)
	Set the well controls name. More...

const string &	getWellControlsName () const override final
	Get the well controls name. More...

void	setWellGeneratorName (string const &wellGeneratorName)
	Set the well genrator name. More...

const string &	getWellGeneratorName () const override final
	Get the well generator name. More...

Public Member Functions inherited from geos::LineBlockABC
	LineBlockABC (string const &name, Group *const parent)
	Constructor. More...

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.

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>
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...

subGroupMap &	getSubGroups ()
	Get the subgroups object. More...

const subGroupMap &	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	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...

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 >
const WrapperBase &	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

const wrapperMap &	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 >
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 string &	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...

const DataContext &	getDataContext () const

template<typename KEY >
const DataContext &	getWrapperDataContext (KEY key) const

Group &	getParent ()
	Access the group's parent. More...

const Group &	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...

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::CatalogType &	getCatalog ()
	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

Implementation of the LineBlock responsible for modification/creation capabilities.

Definition at line 27 of file LineBlock.hpp.

Constructor & Destructor Documentation

◆ LineBlock()

geos::LineBlock::LineBlock	(	string const &	name,
		Group *const	parent
	)

Constructor for this class.

Parameters

[in]	name	the name of this object manager
[in]	parent	the parent Group

Member Function Documentation

◆ getElemCoords()

arrayView2d< real64 const > geos::LineBlock::getElemCoords ( ) const

inlinefinaloverridevirtual

Get the physical location of the centers of well elements.

Returns: list of center locations of the well elements

Implements geos::LineBlockABC.

Definition at line 52 of file LineBlock.hpp.

◆ getElementRadius()

real64 geos::LineBlock::getElementRadius ( ) const

inlinefinaloverridevirtual

Get the radius in the well.

Returns: the radius in the well

Implements geos::LineBlockABC.

Definition at line 95 of file LineBlock.hpp.

◆ getElemToNodesMap()

arrayView2d< globalIndex const > geos::LineBlock::getElemToNodesMap ( ) const

inlinefinaloverridevirtual

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

Implements geos::LineBlockABC.

Definition at line 77 of file LineBlock.hpp.

◆ getElemVolume()

arrayView1d< real64 const > geos::LineBlock::getElemVolume ( ) const

inlinefinaloverridevirtual

Get the volume of the well elements.

Returns: list of volumes of the well elements

Implements geos::LineBlockABC.

Definition at line 86 of file LineBlock.hpp.

◆ getNextElemIndex()

arrayView1d< globalIndex const > geos::LineBlock::getNextElemIndex ( ) const

inlinefinaloverridevirtual

Get the global indices mapping an element to the next.

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

Implements geos::LineBlockABC.

Definition at line 60 of file LineBlock.hpp.

◆ getNodeCoords()

arrayView2d< real64 const > geos::LineBlock::getNodeCoords ( ) const

inlinefinaloverridevirtual

Get the physical location of the centers of well elements.

Returns: list of center locations of the well elements

Implements geos::LineBlockABC.

Definition at line 115 of file LineBlock.hpp.

◆ getPerfCoords()

arrayView2d< real64 const > geos::LineBlock::getPerfCoords ( ) const

inlinefinaloverridevirtual

Get the locations of the perforations.

Returns: list of locations of all the perforations on the well

Implements geos::LineBlockABC.

Definition at line 136 of file LineBlock.hpp.

◆ getPerfElemIndex()

arrayView1d< globalIndex const > geos::LineBlock::getPerfElemIndex ( ) const

inlinefinaloverridevirtual

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

Implements geos::LineBlockABC.

Definition at line 163 of file LineBlock.hpp.

◆ getPerfSkinFactor()

arrayView1d< real64 const > geos::LineBlock::getPerfSkinFactor ( ) const

inlinefinaloverridevirtual

Get the well skin factor at the perforations.

Returns: list of well skin factor at all the perforations on the well

Implements geos::LineBlockABC.

Definition at line 154 of file LineBlock.hpp.

◆ getPerfTransmissibility()

arrayView1d< real64 const > geos::LineBlock::getPerfTransmissibility ( ) const

inlinefinaloverridevirtual

Get the well transmissibility at the perforations.

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

Implements geos::LineBlockABC.

Definition at line 145 of file LineBlock.hpp.

◆ getPrevElemIndices()

arrayView1d< arrayView1d< globalIndex const > const > geos::LineBlock::getPrevElemIndices ( ) const

inlinefinaloverridevirtual

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

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

Implements geos::LineBlockABC.

Definition at line 68 of file LineBlock.hpp.

◆ getWellControlsName()

const string& geos::LineBlock::getWellControlsName ( ) const

inlinefinaloverridevirtual

Get the well controls name.

Returns: The well controls name

Implements geos::LineBlockABC.

Definition at line 176 of file LineBlock.hpp.

◆ getWellGeneratorName()

const string& geos::LineBlock::getWellGeneratorName ( ) const

inlinefinaloverridevirtual

Get the well generator name.

Returns: The well generator name

Implements geos::LineBlockABC.

Definition at line 183 of file LineBlock.hpp.

◆ numElements()

globalIndex geos::LineBlock::numElements ( ) const

inlinefinaloverridevirtual

Get the global number of well elements.

Returns: the global number of elements

Implements geos::LineBlockABC.

Definition at line 44 of file LineBlock.hpp.

◆ numNodes()

globalIndex geos::LineBlock::numNodes ( ) const

inlinefinaloverridevirtual

Get the global number of well nodes.

Returns: the global number of nodes

Implements geos::LineBlockABC.

Definition at line 106 of file LineBlock.hpp.

◆ numPerforations()

globalIndex geos::LineBlock::numPerforations ( ) const

inlinefinaloverridevirtual

Get the global number of perforations on this well.

Returns: the global number of elements

Implements geos::LineBlockABC.

Definition at line 127 of file LineBlock.hpp.

◆ setElemCoords()

void geos::LineBlock::setElemCoords ( arrayView2d< real64 const > elemCenterCoords )

inline

Set the physical location of the centers of well elements.

Parameters

elemCenterCoords list of center locations of the well elements

Definition at line 58 of file LineBlock.hpp.

◆ setElementRadius()

void geos::LineBlock::setElementRadius ( real64 radius )

inline

Set the radius in the well.

Parameters

radius the radius in the well

Definition at line 102 of file LineBlock.hpp.

◆ setElemToNodesMap()

void geos::LineBlock::setElemToNodesMap ( arrayView2d< globalIndex const > elemToNodesMap )

inline

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

Parameters

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

Definition at line 84 of file LineBlock.hpp.

◆ setElemVolume()

void geos::LineBlock::setElemVolume ( arrayView1d< real64 const > elemVolume )

inline

Set the volume of the well elements.

Parameters

elemVolume list of volumes of the well elements

Definition at line 93 of file LineBlock.hpp.

◆ setNextElemIndex()

void geos::LineBlock::setNextElemIndex ( arrayView1d< globalIndex const > nextElemId )

inline

Set the global indices mapping an element to the next.

Parameters

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

Definition at line 66 of file LineBlock.hpp.

◆ setNodeCoords()

void geos::LineBlock::setNodeCoords ( arrayView2d< real64 const > nodeCoords )

inline

Set the physical location of the centers of well elements.

Parameters

nodeCoords list of center locations of the well elements

Definition at line 121 of file LineBlock.hpp.

◆ setNumElements()

void geos::LineBlock::setNumElements ( globalIndex numElems )

inline

Set the global number of well elements.

Parameters

numElems the global number of elements

Definition at line 50 of file LineBlock.hpp.

◆ setNumNodes()

void geos::LineBlock::setNumNodes ( globalIndex numNodes )

inline

Set the global number of well nodes.

Parameters

numNodes the global number of nodes

Definition at line 113 of file LineBlock.hpp.

◆ setNumPerforations()

void geos::LineBlock::setNumPerforations ( globalIndex numPerforations )

inline

Set the global number of perforations on this well.

Parameters

numPerforations the global number of elements

Definition at line 134 of file LineBlock.hpp.

◆ setPerfCoords()

void geos::LineBlock::setPerfCoords ( arrayView2d< real64 const > perfCoords )

inline

Set the locations of the perforations.

Parameters

perfCoords list of locations of all the perforations on the well

Definition at line 143 of file LineBlock.hpp.

◆ setPerfElemIndex()

void geos::LineBlock::setPerfElemIndex ( arrayView1d< globalIndex const > perfElemId )

inline

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

Parameters

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

Definition at line 169 of file LineBlock.hpp.

◆ setPerfSkinFactor()

void geos::LineBlock::setPerfSkinFactor ( arrayView1d< real64 const > perfSkinFactor )

inline

Set the well skin factor at the perforations.

Parameters

perfSkinFactor list of well skin factor at all the perforations on the well

Definition at line 161 of file LineBlock.hpp.

◆ setPerfTransmissibility()

void geos::LineBlock::setPerfTransmissibility ( arrayView1d< real64 const > perfTransmissibility )

inline

Set the well transmissibility at the perforations.

Parameters

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

Definition at line 152 of file LineBlock.hpp.

◆ setPrevElemIndices()

void geos::LineBlock::setPrevElemIndices ( arrayView1d< arrayView1d< globalIndex const > const > prevElemIndices )

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

Parameters

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

◆ setWellControlsName()

void geos::LineBlock::setWellControlsName ( string const & wellControlsName )

inline

Set the well controls name.

Parameters

wellControlsName The well controls name

Definition at line 175 of file LineBlock.hpp.

◆ setWellGeneratorName()

void geos::LineBlock::setWellGeneratorName ( string const & wellGeneratorName )

inline

Set the well genrator name.

Parameters

wellGeneratorName The well genrator name

Definition at line 182 of file LineBlock.hpp.

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

coreComponents/mesh/generators/LineBlock.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LineBlock()

Member Function Documentation

◆ getElemCoords()

◆ getElementRadius()

◆ getElemToNodesMap()

◆ getElemVolume()

◆ getNextElemIndex()

◆ getNodeCoords()

◆ getPerfCoords()

◆ getPerfElemIndex()

◆ getPerfSkinFactor()

◆ getPerfTransmissibility()

◆ getPrevElemIndices()

◆ getWellControlsName()

◆ getWellGeneratorName()

◆ numElements()

◆ numNodes()

◆ numPerforations()

◆ setElemCoords()

◆ setElementRadius()

◆ setElemToNodesMap()

◆ setElemVolume()

◆ setNextElemIndex()

◆ setNodeCoords()

◆ setNumElements()

◆ setNumNodes()

◆ setNumPerforations()

◆ setPerfCoords()

◆ setPerfElemIndex()

◆ setPerfSkinFactor()

◆ setPerfTransmissibility()

◆ setPrevElemIndices()

◆ setWellControlsName()

◆ setWellGeneratorName()