This class describes the controls used to operate a well. More...

#include <WellControls.hpp>

Inheritance diagram for geos::WellControls:

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

Public Types
enum class	Type : integer { PRODUCER , INJECTOR }

enum class	Status : integer { OPEN , CLOSED }

enum class	Control : integer { BHP , PHASEVOLRATE , TOTALVOLRATE , MASSRATE , UNINITIALIZED }

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

virtual void	expandObjectCatalogs () override
	Expand catalog for schema generation.

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forInjectionConstraints (LAMBDA &&lambda) const

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forInjectionConstraints (LAMBDA &&lambda)

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forProductionConstraints (LAMBDA &&lambda) const

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void	forProductionConstraints (LAMBDA &&lambda)

template<typename ConstraintType >
void	createConstraint (string const &constraintName)
	Create a constraint. More...

MinimumBHPConstraint *	getMinBHPConstraint ()
	Getters for constraints.

MinimumBHPConstraint *	getMinBHPConstraint () const

MaximumBHPConstraint *	getMaxBHPConstraint ()

MaximumBHPConstraint *	getMaxBHPConstraint () const

std::vector< WellConstraintBase * >	getProdRateConstraints ()

std::vector< WellConstraintBase * >	getProdRateConstraints () const

std::vector< WellConstraintBase * >	getInjRateConstraints ()

std::vector< WellConstraintBase * >	getInjRateConstraints () const

Constructor / Destructor
	WellControls (string const &name, dataRepository::Group *const parent)
	Constructor for WellControls Objects. More...

	~WellControls () override
	Default destructor.

	WellControls ()=delete
	Deleted default constructor.

	WellControls (WellControls const &)=delete
	Deleted copy constructor.

	WellControls (WellControls &&)=delete
	Deleted move constructor.

WellControls &	operator= (WellControls const &)=delete
	Deleted assignment operator. More...

WellControls &	operator= (WellControls &&)=delete
	Deleted move operator. More...

Getters / Setters
Control	getControl () const
	Get the control type for the well. More...

void	setControl (Control const &newControl)
	Set the control type for the well. More...

integer	estimateSolution () const
	getter for esitmator switch More...

real64	getReferenceGravityCoef () const
	Getter for the reference gravity coefficient. More...

void	setReferenceGravityCoef (real64 const &refGravCoef)
	Setter for the reference gravity.

real64	getTargetBHP (real64 const &targetTime) const
	Returns the target bottom hole pressure value. More...

real64	getInjectionTemperature () const
	Const accessor for the temperature of the injection stream. More...

arrayView1d< real64 const >	getInjectionStream () const
	Const accessor for the injection stream. More...

integer	getConstraintPhaseIndex () const
	Const accessor for the phase constraint index. More...

real64	getReferenceElevation () const
	Return the reference elvation where pressure constraint is measured. More...

integer	useSurfaceConditions () const
	Getter for the flag specifying whether we check rates at surface or reservoir conditions. More...

string	referenceReservoirRegion () const
	Getter for the reservoir region associated with reservoir volume constraint. More...

const real64 &	getSurfacePressure () const
	Getter for the surface pressure when m_useSurfaceConditions == 1. More...

const real64 &	getSurfaceTemperature () const
	Getter for the surface temperature when m_useSurfaceConditions == 1. More...

bool	isInjector () const
	Is the well an injector? More...

bool	isProducer () const
	Is the well a producer? More...

bool	isWellOpen () const
	Is the well open (or shut) at currentTime, status initalized in WellSolverBase::implicitStepSetup. More...

void	setWellState (bool open)

bool	getWellState () const

void	setConstraintSwitch (bool constraintSwitch)

bool	getConstraintSwitch () const

void	setCurrentConstraint (WellConstraintBase *currentConstraint)

WellConstraintBase *	getCurrentConstraint ()

WellConstraintBase const *	getCurrentConstraint () const

bool	isCrossflowEnabled () const
	Getter for the flag to enable crossflow. More...

real64	getInitialPressureCoefficient () const
	Getter for the initial pressure coefficient. More...

void	setNextDtFromTables (real64 const &currentTime, real64 &nextDt)
	set next time step based on tables intervals More...

void	setFluidSeparator (std::unique_ptr< constitutive::ConstitutiveBase > fluidSeparatorPtr)
	setter for multi fluid separator More...

constitutive::MultiFluidBase &	getMultiFluidSeparator ()
	Getter for multi fluid separator. More...

constitutive::SingleFluidBase &	getSingleFluidSeparator ()
	Getter for single fluid separator. More...

real64	getRegionAveragePressure () const
	Getter for the reservoir average pressure when m_useSurfaceConditions == 0. More...

void	setRegionAveragePressure (real64 regionAveragePressure)
	Set the reservoir average pressure when m_useSurfaceConditions == 0. More...

real64	getRegionAverageTemperature () const
	Getter for the reservoir average temperature when m_useSurfaceConditions == 0. More...

void	setRegionAverageTemperature (real64 regionAverageTemperature)
	Set the reservoir average temperature when m_useSurfaceConditions == 0. More...

void	setWellStatus (real64 const &currentTime, WellControls::Status status)
	Set well status from time and internal action, eg. all perfs closed. More...

WellControls::Status	getWellStatus () const
	Is the well open (or shut) based on internal action. 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...

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

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

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

stdVector< 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	setLogLevel (integer const logLevel)
	Set verbosity level. More...

integer	getLogLevel () const

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 &targetNodePos)
	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.

Static Public Member Functions
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...

template<typename CONTAINERTYPE , typename LAMBDA >
static bool	applyLambdaToContainer (CONTAINERTYPE, LAMBDA &&)

template<typename T0 , typename CONTAINERTYPE , typename LAMBDA >
static bool	applyLambdaToContainer (CONTAINERTYPE container, LAMBDA &&lambda)

static void	setNextDtFromTable (TableFunction const *table, real64 const currentTime, real64 &nextDt)

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

static string	processInputName (xmlWrapper::xmlNode const &targetNode, xmlWrapper::xmlNodePos const &targetNodePos, string_view parentNodeName, xmlWrapper::xmlNodePos const &parentNodePos, std::set< string > &siblingNames)

Public Attributes
struct geos::WellControls::viewKeyStruct	viewKeysWellControls
	ViewKey struct for the WellControls class.

Protected Member Functions
virtual void	postInputInitialization () override

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.

Detailed Description

This class describes the controls used to operate a well.

Definition at line 53 of file WellControls.hpp.

Member Enumeration Documentation

◆ Control

enum geos::WellControls::Control : integer

strong

Types of well controls Used to specifiy a well's operating conditions

Enumerator
BHP	The well operates at a specified bottom hole pressure (BHP)
PHASEVOLRATE	The well operates at a specified phase volumetric flow rate
TOTALVOLRATE	The well operates at a specified total volumetric flow rate
MASSRATE	The well operates at a specified mass rate
UNINITIALIZED	This is the current well control before postInputInitialization (needed to restart from file properly)

Definition at line 78 of file WellControls.hpp.

◆ Status

enum geos::WellControls::Status : integer

strong

Status of wells Either open or closed

Enumerator
OPEN	flowing well
CLOSED	shutin well

Definition at line 69 of file WellControls.hpp.

◆ Type

enum geos::WellControls::Type : integer

strong

Type of wells Either producer or injector.

Enumerator
PRODUCER	A production well
INJECTOR	An injection well

Definition at line 60 of file WellControls.hpp.

Constructor & Destructor Documentation

◆ WellControls()

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

explicit

Constructor for WellControls Objects.

Parameters

[in]	name	the name of this instantiation of WellControls in the repository
[in]	parent	the parent group of this instantiation of WellControls

Member Function Documentation

◆ applyLambdaToContainer()

template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >

static bool geos::WellControls::applyLambdaToContainer	(	CONTAINERTYPE	container,
		LAMBDA &&	lambda
	)

inlinestatic

Apply a given functor to a container if the container can be cast to one of the specified types.

Template Parameters

CASTTYPE	the first type that will be used in the attempted casting of container
CASTTYPES	a variadic list of types that will be used in the attempted casting of container
CONTAINERTYPE	the type of container
LAMBDA	the type of lambda function to call in the function

Parameters

[in]	container	a pointer to the container which will be passed to the lambda function
[in]	lambda	the lambda function to call in the function

Returns: a boolean to indicate whether the lambda was successfully applied to the container.

Definition at line 158 of file WellControls.hpp.

◆ createChild()

virtual Group* geos::WellControls::createChild	(	string const &	childKey,
		string const &	childName
	)

overridevirtual

Create a new geometric object (box, plane, etc) as a child of this group.

Parameters

childKey	the catalog key of the new geometric object to create
childName	the name of the new geometric object in the repository

Returns: the group child

Reimplemented from geos::dataRepository::Group.

◆ createConstraint()

template<typename ConstraintType >

void geos::WellControls::createConstraint ( string const & constraintName )

Create a constraint.

Template Parameters

ConstraintType the type of constraint to create

Parameters

[in] constraintName name to assign to the constraint

◆ estimateSolution()

integer geos::WellControls::estimateSolution ( ) const

inline

getter for esitmator switch

Returns: True if estimate well solution

Definition at line 274 of file WellControls.hpp.

◆ forInjectionConstraints()

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >

void geos::WellControls::forInjectionConstraints ( LAMBDA && lambda ) const

inline

Definition at line 202 of file WellControls.hpp.

◆ forProductionConstraints()

template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >

void geos::WellControls::forProductionConstraints ( LAMBDA && lambda ) const

inline

Definition at line 229 of file WellControls.hpp.

◆ getConstraintPhaseIndex()

integer geos::WellControls::getConstraintPhaseIndex ( ) const

Const accessor for the phase constraint index.

Returns: phase index associated with phase constraint

◆ getControl()

Control geos::WellControls::getControl ( ) const

inline

Get the control type for the well.

Returns: the Control enum enforced at the well

Definition at line 262 of file WellControls.hpp.

◆ getInitialPressureCoefficient()

real64 geos::WellControls::getInitialPressureCoefficient ( ) const

inline

Getter for the initial pressure coefficient.

Returns: the initial pressure coefficient

Definition at line 386 of file WellControls.hpp.

◆ getInjectionStream()

arrayView1d< real64 const > geos::WellControls::getInjectionStream ( ) const

Const accessor for the injection stream.

Returns: the injection stream

◆ getInjectionTemperature()

real64 geos::WellControls::getInjectionTemperature ( ) const

Const accessor for the temperature of the injection stream.

Returns: the temperature of the injection stream

◆ getMultiFluidSeparator()

constitutive::MultiFluidBase& geos::WellControls::getMultiFluidSeparator ( )

inline

Getter for multi fluid separator.

Returns: reference to separator

Definition at line 405 of file WellControls.hpp.

◆ getReferenceElevation()

real64 geos::WellControls::getReferenceElevation ( ) const

Return the reference elvation where pressure constraint is measured.

Returns: vertical location of constraint

◆ getReferenceGravityCoef()

real64 geos::WellControls::getReferenceGravityCoef ( ) const

inline

Getter for the reference gravity coefficient.

Returns: the reference gravity coefficient

Definition at line 280 of file WellControls.hpp.

◆ getRegionAveragePressure()

real64 geos::WellControls::getRegionAveragePressure ( ) const

inline

Getter for the reservoir average pressure when m_useSurfaceConditions == 0.

Returns: the pressure

Definition at line 418 of file WellControls.hpp.

◆ getRegionAverageTemperature()

real64 geos::WellControls::getRegionAverageTemperature ( ) const

inline

Getter for the reservoir average temperature when m_useSurfaceConditions == 0.

Returns: the temperature

Definition at line 430 of file WellControls.hpp.

◆ getSingleFluidSeparator()

constitutive::SingleFluidBase& geos::WellControls::getSingleFluidSeparator ( )

inline

Getter for single fluid separator.

Returns: reference to separator

Definition at line 411 of file WellControls.hpp.

◆ getSurfacePressure()

const real64& geos::WellControls::getSurfacePressure ( ) const

inline

Getter for the surface pressure when m_useSurfaceConditions == 1.

Returns: the surface pressure

Definition at line 338 of file WellControls.hpp.

◆ getSurfaceTemperature()

const real64& geos::WellControls::getSurfaceTemperature ( ) const

inline

Getter for the surface temperature when m_useSurfaceConditions == 1.

Returns: the surface temperature

Definition at line 344 of file WellControls.hpp.

◆ getTargetBHP()

real64 geos::WellControls::getTargetBHP ( real64 const & targetTime ) const

Returns the target bottom hole pressure value.

Parameters

[in] targetTime time at which to evaluate the constraint

Returns: the injector maximum bottom hole pressure or producer minimum bottom hole pressure

◆ getWellStatus()

WellControls::Status geos::WellControls::getWellStatus ( ) const

inline

Is the well open (or shut) based on internal action.

Returns: a Status

Definition at line 449 of file WellControls.hpp.

◆ isCrossflowEnabled()

bool geos::WellControls::isCrossflowEnabled ( ) const

inline

Getter for the flag to enable crossflow.

Returns: the flag deciding whether crossflow is allowed or not

Definition at line 380 of file WellControls.hpp.

◆ isInjector()

bool geos::WellControls::isInjector ( ) const

inline

Is the well an injector?

Returns: a boolean

Definition at line 350 of file WellControls.hpp.

◆ isProducer()

bool geos::WellControls::isProducer ( ) const

inline

Is the well a producer?

Returns: a boolean

Definition at line 356 of file WellControls.hpp.

◆ isWellOpen()

bool geos::WellControls::isWellOpen ( ) const

Is the well open (or shut) at currentTime, status initalized in WellSolverBase::implicitStepSetup.

Returns: a boolean

◆ operator=() [1/2]

WellControls& geos::WellControls::operator= ( WellControls && )

delete

Deleted move operator.

Returns: a reference to a perforation object

◆ operator=() [2/2]

WellControls& geos::WellControls::operator= ( WellControls const & )

delete

Deleted assignment operator.

Returns: a reference to a perforation object

◆ postInputInitialization()

virtual void geos::WellControls::postInputInitialization ( )

overrideprotectedvirtual

This function provides capability to post process input values prior to any other initialization operations.

Reimplemented from geos::dataRepository::Group.

◆ referenceReservoirRegion()

string geos::WellControls::referenceReservoirRegion ( ) const

inline

Getter for the reservoir region associated with reservoir volume constraint.

Returns: name of reservoir region

Definition at line 332 of file WellControls.hpp.

◆ setControl()

void geos::WellControls::setControl ( Control const & newControl )

inline

Set the control type for the well.

Parameters

[in] newControl type

Definition at line 268 of file WellControls.hpp.

◆ setFluidSeparator()

void geos::WellControls::setFluidSeparator ( std::unique_ptr< constitutive::ConstitutiveBase > fluidSeparatorPtr )

inline

setter for multi fluid separator

Parameters

[in] fluidSeparatorPtr single or multiphase separator

Definition at line 400 of file WellControls.hpp.

◆ setNextDtFromTables()

void geos::WellControls::setNextDtFromTables	(	real64 const &	currentTime,
		real64 &	nextDt
	)

set next time step based on tables intervals

Parameters

[in]	currentTime	the current time
[in,out]	nextDt	the time step

◆ setRegionAveragePressure()

void geos::WellControls::setRegionAveragePressure ( real64 regionAveragePressure )

inline

Set the reservoir average pressure when m_useSurfaceConditions == 0.

Parameters

[in] regionAveragePressure value for pressure

Definition at line 424 of file WellControls.hpp.

◆ setRegionAverageTemperature()

void geos::WellControls::setRegionAverageTemperature ( real64 regionAverageTemperature )

inline

Set the reservoir average temperature when m_useSurfaceConditions == 0.

Parameters

[in] regionAverageTemperature value for temperature

Definition at line 436 of file WellControls.hpp.

◆ setWellStatus()

void geos::WellControls::setWellStatus	(	real64 const &	currentTime,
		WellControls::Status	status
	)

Set well status from time and internal action, eg. all perfs closed.

Parameters

[in]	currentTime	the current time
[in]	status

◆ useSurfaceConditions()

integer geos::WellControls::useSurfaceConditions ( ) const

inline

Getter for the flag specifying whether we check rates at surface or reservoir conditions.

Returns: 1 if we use surface conditions, and 0 otherwise

Definition at line 326 of file WellControls.hpp.

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

coreComponents/physicsSolvers/fluidFlow/wells/WellControls.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Control

◆ Status

◆ Type

Constructor & Destructor Documentation

◆ WellControls()

Member Function Documentation

◆ applyLambdaToContainer()

◆ createChild()

◆ createConstraint()

◆ estimateSolution()

◆ forInjectionConstraints()

◆ forProductionConstraints()

◆ getConstraintPhaseIndex()

◆ getControl()

◆ getInitialPressureCoefficient()

◆ getInjectionStream()

◆ getInjectionTemperature()

◆ getMultiFluidSeparator()

◆ getReferenceElevation()

◆ getReferenceGravityCoef()

◆ getRegionAveragePressure()

◆ getRegionAverageTemperature()

◆ getSingleFluidSeparator()

◆ getSurfacePressure()

◆ getSurfaceTemperature()

◆ getTargetBHP()

◆ getWellStatus()

◆ isCrossflowEnabled()

◆ isInjector()

◆ isProducer()

◆ isWellOpen()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ postInputInitialization()

◆ referenceReservoirRegion()

◆ setControl()

◆ setFluidSeparator()

◆ setNextDtFromTables()

◆ setRegionAveragePressure()

◆ setRegionAverageTemperature()

◆ setWellStatus()

◆ useSurfaceConditions()