#include <CompositionalMultiphaseWell.hpp>

Inheritance diagram for geos::CompositionalMultiphaseWell:

[legend]

Classes
struct	viewKeyStruct

Public Member Functions
	CompositionalMultiphaseWell (const string &name, Group *const parent)
	main constructor for Group Objects More...

	CompositionalMultiphaseWell ()=delete
	deleted default constructor

	CompositionalMultiphaseWell (CompositionalMultiphaseWell const &)=delete
	deleted copy constructor

	CompositionalMultiphaseWell (CompositionalMultiphaseWell &&)=default
	default move constructor

CompositionalMultiphaseWell &	operator= (CompositionalMultiphaseWell const &)=delete
	deleted assignment operator

CompositionalMultiphaseWell &	operator= (CompositionalMultiphaseWell &&)=delete
	deleted move operator

virtual	~CompositionalMultiphaseWell () override=default
	default destructor

string	getCatalogName () const override

virtual void	registerDataOnMesh (Group &meshBodies) override
	Register wrappers that contain data on the mesh objects. More...

virtual real64	calculateResidualNorm (real64 const &time_n, real64 const &dt, DomainPartition const &domain, DofManager const &dofManager, arrayView1d< real64 const > const &localRhs) override
	calculate the norm of the global system residual More...

virtual real64	scalingForSystemSolution (DomainPartition &domain, DofManager const &dofManager, arrayView1d< real64 const > const &localSolution) override
	Function to determine if the solution vector should be scaled back in order to maintain a known constraint. More...

virtual bool	checkSystemSolution (DomainPartition &domain, DofManager const &dofManager, arrayView1d< real64 const > const &localSolution, real64 const scalingFactor) override
	Function to check system solution for physical consistency and constraint violation. More...

virtual void	applySystemSolution (DofManager const &dofManager, arrayView1d< real64 const > const &localSolution, real64 const scalingFactor, real64 const dt, DomainPartition &domain) override
	Function to apply the solution vector to the state. More...

virtual void	resetStateToBeginningOfStep (DomainPartition &domain) override
	reset state of physics back to the beginning of the step. More...

virtual void	implicitStepSetup (real64 const &time, real64 const &dt, DomainPartition &domain) override
	function to perform setup for implicit timestep More...

virtual void	implicitStepComplete (real64 const &time, real64 const &dt, DomainPartition &domain) override
	perform cleanup for implicit timestep More...

void	updateGlobalComponentFraction (WellElementSubRegion &subRegion) const
	Recompute global component fractions from primary variables (component densities) More...

void	updateVolRatesForConstraint (WellElementSubRegion &subRegion)
	Recompute the volumetric rates that are used in the well constraints. More...

void	updateBHPForConstraint (WellElementSubRegion &subRegion)
	Recompute the current BHP pressure. More...

void	updateFluidModel (WellElementSubRegion &subRegion)
	Update all relevant fluid models using current values of pressure and composition. More...

real64	updatePhaseVolumeFraction (WellElementSubRegion &subRegion) const
	Recompute phase volume fractions (saturations) from constitutive and primary variables. More...

void	updateTotalMassDensity (WellElementSubRegion &subRegion) const
	Recompute total mass densities from mass density and phase volume fractions. More...

virtual void	computePerforationRates (real64 const &time_n, real64 const &dt, DomainPartition &domain) override
	Recompute the perforation rates for all the wells. More...

virtual void	updateState (DomainPartition &domain) override
	Recompute all dependent quantities from primary variables (including constitutive models) More...

virtual real64	updateSubRegionState (WellElementSubRegion &subRegion) override
	Recompute all dependent quantities from primary variables (including constitutive models) More...

virtual string	wellElementDofName () const override
	get the name of DOF defined on well elements More...

virtual string	resElementDofName () const override
	get the name of DOF defined on well elements More...

virtual localIndex	numFluidComponents () const override
	const getter for the number of fluid components More...

virtual localIndex	numFluidPhases () const override
	Get the number of fluid phases. More...

integer	useTotalMassEquation () const

virtual void	assembleFluxTerms (real64 const &time_n, real64 const &dt, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs) override
	assembles the flux terms for all connections between well elements More...

virtual void	assembleAccumulationTerms (real64 const &time_n, real64 const &dt, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs) override
	assembles the accumulation term for all the well elements More...

virtual void	assemblePressureRelations (real64 const &time_n, real64 const &dt, DomainPartition const &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs) override
	assembles the pressure relations at all connections between well elements except at the well head More...

void	chopNegativeDensities (DomainPartition &domain)
	Sets all the negative component densities (if any) to zero. More...

arrayView1d< string const >	relPermModelNames () const

Public Member Functions inherited from geos::WellSolverBase
	WellSolverBase (const string &name, Group *const parent)
	main constructor for Group Objects More...

virtual	~WellSolverBase () override
	default destructor

	WellSolverBase ()=delete
	deleted default constructor

	WellSolverBase (WellSolverBase const &)=delete
	deleted copy constructor

	WellSolverBase (WellSolverBase &&)=default
	default move constructor

WellSolverBase &	operator= (WellSolverBase const &)=delete
	deleted assignment operator

WellSolverBase &	operator= (WellSolverBase &&)=delete
	deleted move operator

virtual Group *	createChild (string const &childKey, string const &childName) override
	creates a child group of of this PhysicsSolverBase instantiation More...

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

void	setFlowSolverName (string const &name)
	setter for the name of the flow solver (needed to use the flow kernels like UpdateFluid) More...

string const &	getFlowSolverName () const
	getter for the name of the flow solver (used in UpdateState) More...

localIndex	numDofPerWellElement () const
	getter for the number of degrees of freedom per well element More...

localIndex	numDofPerResElement () const
	getter for the number of degrees of freedom per mesh element More...

integer	isThermal () const
	getter for iso/thermal switch More...

WellControls &	getWellControls (WellElementSubRegion const &subRegion)
	getter for the well controls associated to this well subRegion More...

WellControls const &	getWellControls (WellElementSubRegion const &subRegion) const
	const getter for the well controls associated to this well subRegion More...

virtual void	setupDofs (DomainPartition const &domain, DofManager &dofManager) const override
	Populate degree-of-freedom manager with fields relevant to this solver. More...

virtual void	implicitStepComplete (real64 const &GEOS_UNUSED_PARAM(time_n), real64 const &GEOS_UNUSED_PARAM(dt), DomainPartition &GEOS_UNUSED_PARAM(domain)) override

virtual void	applyBoundaryConditions (real64 const GEOS_UNUSED_PARAM(time_n), real64 const GEOS_UNUSED_PARAM(dt), DomainPartition &GEOS_UNUSED_PARAM(domain), DofManager const &GEOS_UNUSED_PARAM(dofManager), CRSMatrixView< real64, globalIndex const > const &GEOS_UNUSED_PARAM(localMatrix), arrayView1d< real64 > const &GEOS_UNUSED_PARAM(localRhs)) override

virtual void	assembleSystem (real64 const time, real64 const dt, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs) override
	function to assemble the linear system matrix and rhs More...

void	setKeepVariablesConstantDuringInitStep (bool const keepVariablesConstantDuringInitStep)
	Utility function to keep the well variables during a time step (used in poromechanics simulations) More...

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

	PhysicsSolverBase (PhysicsSolverBase &&)=default
	Move constructor for PhysicsSolverBase.

virtual	~PhysicsSolverBase () override
	Destructor for PhysicsSolverBase.

	PhysicsSolverBase ()=delete
	Deleted constructor.

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

PhysicsSolverBase &	operator= (PhysicsSolverBase const &)=delete
	Deleted copy assignment operator.

PhysicsSolverBase &	operator= (PhysicsSolverBase &&)=delete
	Deleted move assignment operator.

virtual void	initialize_postMeshGeneration () override
	Initialization tasks after mesh generation is completed.

void	generateMeshTargetsFromTargetRegions (Group const &meshBodies)
	Generate mesh targets from target regions. More...

virtual void	cleanup (real64 const time_n, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Called as the code exits the main run loop. More...

virtual bool	execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...

ParallelMatrix &	getSystemMatrix ()
	Getter for system matrix. More...

ParallelMatrix const &	getSystemMatrix () const
	Getter for system rhs vector. More...

ParallelVector &	getSystemRhs ()
	Getter for system rhs vector. More...

ParallelVector const &	getSystemRhs () const
	Getter for system rhs vector. More...

ParallelVector &	getSystemSolution ()
	Getter for system solution vector. More...

ParallelVector const &	getSystemSolution () const
	Getter for system solution vector. More...

DofManager &	getDofManager ()
	Getter for degree-of-freedom manager. More...

DofManager const &	getDofManager () const
	Getter for degree-of-freedom manager. More...

CRSMatrix< real64, globalIndex > &	getLocalMatrix ()
	Getter for local matrix. More...

CRSMatrixView< real64 const, globalIndex const >	getLocalMatrix () const
	Getter for local matrix. More...

virtual real64	solverStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain)
	entry function to perform a solver step More...

virtual real64	setNextDt (real64 const &currentDt, DomainPartition &domain)
	function to set the next time step size More...

virtual real64	setNextDtBasedOnNewtonIter (real64 const &currentDt)
	function to set the next time step size based on Newton convergence More...

virtual real64	setNextDtBasedOnStateChange (real64 const &currentDt, DomainPartition &domain)
	function to set the next dt based on state change More...

virtual real64	setNextDtBasedOnCFL (real64 const &currentDt, DomainPartition &domain)
	function to set the next dt based on state change More...

virtual real64	explicitStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain)
	Entry function for an explicit time integration step. More...

virtual real64	nonlinearImplicitStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain)
	Function for a nonlinear implicit integration step. More...

virtual bool	lineSearch (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, ParallelVector &rhs, ParallelVector &solution, real64 const scaleFactor, real64 &lastResidual)
	Function to perform line search. More...

virtual bool	lineSearchWithParabolicInterpolation (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, ParallelVector &rhs, ParallelVector &solution, real64 const scaleFactor, real64 &lastResidual, real64 &residualNormT)
	Function to perform line search using a parabolic interpolation to find the scaling factor. More...

virtual real64	linearImplicitStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain)
	Function for a linear implicit integration step. More...

virtual void	setupSystem (DomainPartition &domain, DofManager &dofManager, CRSMatrix< real64, globalIndex > &localMatrix, ParallelVector &rhs, ParallelVector &solution, bool const setSparsity=true)
	Set up the linear system (DOF indices and sparsity patterns) More...

virtual void	applyBoundaryConditions (real64 const time, real64 const dt, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs)
	apply boundary condition to system More...

void	debugOutputSystem (real64 const &time, integer const cycleNumber, integer const nonlinearIteration, ParallelMatrix const &matrix, ParallelVector const &rhs) const
	Output the assembled linear system for debug purposes. More...

void	debugOutputSolution (real64 const &time, integer const cycleNumber, integer const nonlinearIteration, ParallelVector const &solution) const
	Output the linear system solution for debug purposes. More...

virtual void	solveLinearSystem (DofManager const &dofManager, ParallelMatrix &matrix, ParallelVector &rhs, ParallelVector &solution)
	function to apply a linear system solver to the assembled system. More...

virtual bool	updateConfiguration (DomainPartition &domain)
	updates the configuration (if needed) based on the state after a converged Newton loop. More...

virtual void	outputConfigurationStatistics (DomainPartition const &domain) const

virtual void	resetConfigurationToBeginningOfStep (DomainPartition &domain)
	resets the configuration to the beginning of the time-step. More...

virtual bool	resetConfigurationToDefault (DomainPartition &domain) const
	resets the configuration to the default value. More...

virtual real64	getTimestepRequest (real64 const) override
	getter for the next timestep size More...

real64	getTimestepRequest ()
	getter for the next timestep size More...

Timestamp	getSystemSetupTimestamp () const
	getter for the timestamp of the system setup More...

Timestamp	getMeshModificationTimestamp (DomainPartition &domain) const
	getter for the timestamp of the mesh modification on the mesh levels More...

void	setSystemSetupTimestamp (Timestamp timestamp)
	set the timestamp of the system setup More...

R1Tensor const	gravityVector () const
	return the value of the gravity vector specified in PhysicsSolverManager More...

virtual bool	checkSequentialSolutionIncrements (DomainPartition &domain) const
	Check if the solution increments are ok to use. More...

virtual void	saveSequentialIterationState (DomainPartition &domain)
	Save the state of the solver for sequential iteration. More...

LinearSolverParameters &	getLinearSolverParameters ()
	accessor for the linear solver parameters. More...

LinearSolverParameters const &	getLinearSolverParameters () const
	const accessor for the linear solver parameters. More...

NonlinearSolverParameters &	getNonlinearSolverParameters ()
	accessor for the nonlinear solver parameters. More...

NonlinearSolverParameters const &	getNonlinearSolverParameters () const
	const accessor for the nonlinear solver parameters. More...

virtual void	synchronizeNonlinearSolverParameters ()
	syncronize the nonlinear solver parameters.

localIndex	targetRegionIndex (string const &regionName) const
	Get position of a given region within solver's target region list. More...

template<typename LAMBDA >
void	forDiscretizationOnMeshTargets (Group const &meshBodies, LAMBDA &&lambda) const
	Loop over the target discretization on all mesh targets and apply callback. More...

template<typename LAMBDA >
void	forDiscretizationOnMeshTargets (Group &meshBodies, LAMBDA &&lambda) const
	Loop over the target discretization on all mesh targets and apply callback. More...

string	getDiscretizationName () const
	return the name of the discretization object More...

virtual bool	registerCallback (void *func, const std::type_info &funcType) final override
	function to set the value of m_assemblyCallback More...

SolverStatistics &	getSolverStatistics ()
	accessor for the solver statistics. More...

SolverStatistics const &	getSolverStatistics () const
	const accessor for the solver statistics. More...

map< std::pair< string, string >, array1d< string > > const &	getMeshTargets () const
	accessor for m_meshTargets More...

Public Member Functions inherited from geos::ExecutableGroup
virtual void	signalToPrepareForExecution (real64 const time_n, real64 const dt, integer const cycle, DomainPartition &domain)
	Inform the object that it expects to execute during the next timestep. More...

void	setTimesteppingBehavior (TimesteppingBehavior const timesteppingBehavior)
	Set the timestep behavior for a target. More...

TimesteppingBehavior	getTimesteppingBehavior () const
	Get the target's time step behavior. 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 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...

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 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
static string	catalogName ()
	name of the node manager in the object catalog More...

Static Public Member Functions inherited from geos::WellSolverBase
static string	coupledSolverAttributePrefix ()
	String used to form the solverName used to register single-physics solvers in CoupledSolver.

Static Public Member Functions inherited from geos::PhysicsSolverBase
static CatalogInterface::CatalogType &	getCatalog ()
	Get the singleton catalog for PhysicsSolverBase. 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...

Public Attributes
geos::CompositionalMultiphaseWell::viewKeyStruct	viewKeysCompMultiphaseWell

Protected Member Functions
virtual void	postInputInitialization () override

virtual void	initializePostSubGroups () override
	Called by Initialize() after to initializing sub-Groups.

virtual void	initializePostInitialConditionsPreSubGroups () override
	Called by InitializePostInitialConditions() prior to initializing sub-Groups.

void	validateConstitutiveModels (DomainPartition const &domain) const

void	validateWellControlsForFluid (WellControls const &wellControls, constitutive::MultiFluidBase const &fluid) const
	Checks if the WellControls parameters are within the fluid tables ranges. More...

void	validateInjectionStreams (WellElementSubRegion const &subRegion) const
	Checks injection streams for validity (compositions sum to one) More...

virtual void	validateWellConstraints (real64 const &time_n, real64 const &dt, WellElementSubRegion const &subRegion) override
	Make sure that the well constraints are compatible. More...

void	printRates (real64 const &time_n, real64 const &dt, DomainPartition &domain) override

Protected Member Functions inherited from geos::PhysicsSolverBase
real64	eisenstatWalker (real64 const newNewtonNorm, real64 const oldNewtonNorm, LinearSolverParameters::Krylov const &krylovParams)
	Eisenstat-Walker adaptive tolerance. More...

Protected Member Functions inherited from geos::dataRepository::Group
virtual void	initializePreSubGroups ()
	Called by Initialize() 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.

Additional Inherited Members
Public Types inherited from geos::PhysicsSolverBase
using	CatalogInterface = dataRepository::CatalogInterface< PhysicsSolverBase, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Public Types inherited from geos::ExecutableGroup
enum class	TimesteppingBehavior : integer { DeterminesTimeStepSize , DoesNotDetermineTimeStepSize }
	Timestepping type. More...

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 Protected Member Functions inherited from geos::PhysicsSolverBase
template<typename CONSTITUTIVE_BASE_TYPE >
static string	getConstitutiveName (ElementSubRegionBase const &subRegion)
	Get the Constitutive Name object. More...

template<typename CONSTITUTIVE_BASE_TYPE >
static string	getConstitutiveName (ParticleSubRegionBase const &subRegion)
	Get the Constitutive Name object. More...

template<typename BASETYPE = constitutive::ConstitutiveBase, typename LOOKUP_TYPE >
static BASETYPE const &	getConstitutiveModel (dataRepository::Group const &dataGroup, LOOKUP_TYPE const &key)
	Get the Constitutive Model object. More...

template<typename BASETYPE = constitutive::ConstitutiveBase, typename LOOKUP_TYPE >
static BASETYPE &	getConstitutiveModel (dataRepository::Group &dataGroup, LOOKUP_TYPE const &key)
	Get the Constitutive Model object. More...

Protected Attributes inherited from geos::WellSolverBase
string	m_flowSolverName
	name of the flow solver

integer	m_numPhases
	the max number of fluid phases

integer	m_numComponents
	the number of fluid components

integer	m_numDofPerWellElement
	the number of Degrees of Freedom per well element

integer	m_numDofPerResElement
	the number of Degrees of Freedom per reservoir element

integer	m_isThermal
	flag indicating whether thermal formulation is used

integer	m_writeCSV
	rates output

string const	m_ratesOutputDir

integer	m_keepVariablesConstantDuringInitStep
	flag to freeze the initial state during initialization in coupled problems

string	m_referenceFluidModelName
	name of the fluid constitutive model used as a reference for component/phase description

Protected Attributes inherited from geos::PhysicsSolverBase
real64	m_cflFactor
	Courant–Friedrichs–Lewy factor for the timestep.

real64	m_maxStableDt
	maximum stable time step

real64	m_nextDt
	timestep of the next cycle

integer	m_numTimestepsSinceLastDtCut
	Number of cycles since last timestep cut.

string	m_discretizationName
	name of the FV discretization object in the data repository

DofManager	m_dofManager
	Data structure to handle degrees of freedom.

ParallelMatrix	m_matrix
	System matrix.

ParallelVector	m_rhs
	System right-hand side vector.

ParallelVector	m_solution
	System solution vector.

CRSMatrix< real64, globalIndex >	m_localMatrix
	Local system matrix and rhs.

std::unique_ptr< PreconditionerBase< LAInterface > >	m_precond
	Custom preconditioner for the "native" iterative solver.

integer	m_writeLinearSystem
	flag for debug output of matrix, rhs, and solution

LinearSolverParametersInput	m_linearSolverParameters
	Linear solver parameters.

LinearSolverResult	m_linearSolverResult
	Result of the last linear solve.

NonlinearSolverParameters	m_nonlinearSolverParameters
	Nonlinear solver parameters.

SolverStatistics	m_solverStatistics
	Solver statistics.

Timestamp	m_systemSetupTimestamp
	Timestamp of the last call to setup system.

std::function< void(CRSMatrix< real64, globalIndex >, array1d< real64 >) >	m_assemblyCallback
	Callback function for assembly step.

std::map< std::string, std::chrono::system_clock::duration >	m_timers
	Timers for the aggregate profiling of the solver.

Detailed Description

A compositional multiphase well solver

Definition at line 40 of file CompositionalMultiphaseWell.hpp.

Constructor & Destructor Documentation

◆ CompositionalMultiphaseWell()

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

main constructor for Group Objects

Parameters

name	the name of this instantiation of Group in the repository
parent	the parent group of this instantiation of Group

Member Function Documentation

◆ assembleAccumulationTerms()

virtual void geos::CompositionalMultiphaseWell::assembleAccumulationTerms	(	real64 const &	time_n,
		real64 const &	dt,
		DomainPartition &	domain,
		DofManager const &	dofManager,
		CRSMatrixView< real64, globalIndex const > const &	localMatrix,
		arrayView1d< real64 > const &	localRhs
	)

overridevirtual

assembles the accumulation term for all the well elements

Parameters

domain	the physical domain object
dofManager	degree-of-freedom manager associated with the linear system
matrix	the system matrix
rhs	the system right-hand side vector

Implements geos::WellSolverBase.

◆ assembleFluxTerms()

virtual void geos::CompositionalMultiphaseWell::assembleFluxTerms	(	real64 const &	time_n,
		real64 const &	dt,
		DomainPartition &	domain,
		DofManager const &	dofManager,
		CRSMatrixView< real64, globalIndex const > const &	localMatrix,
		arrayView1d< real64 > const &	localRhs
	)

overridevirtual

assembles the flux terms for all connections between well elements

Parameters

time_n	previous time value
dt	time step
domain	the physical domain object
dofManager	degree-of-freedom manager associated with the linear system
matrix	the system matrix
rhs	the system right-hand side vector

Implements geos::WellSolverBase.

◆ assemblePressureRelations()

virtual void geos::CompositionalMultiphaseWell::assemblePressureRelations	(	real64 const &	time_n,
		real64 const &	dt,
		DomainPartition const &	domain,
		DofManager const &	dofManager,
		CRSMatrixView< real64, globalIndex const > const &	localMatrix,
		arrayView1d< real64 > const &	localRhs
	)

overridevirtual

assembles the pressure relations at all connections between well elements except at the well head

Parameters

time_n	time at the beginning of the time step
dt	the time step size
domain	the physical domain object
dofManager	degree-of-freedom manager associated with the linear system
matrix	the system matrix
rhs	the system right-hand side vector

Implements geos::WellSolverBase.

◆ catalogName()

static string geos::CompositionalMultiphaseWell::catalogName ( )

inlinestatic

name of the node manager in the object catalog

Returns: string that contains the catalog name to generate a new NodeManager object through the object catalog.

Definition at line 76 of file CompositionalMultiphaseWell.hpp.

◆ chopNegativeDensities()

void geos::CompositionalMultiphaseWell::chopNegativeDensities ( DomainPartition & domain )

Sets all the negative component densities (if any) to zero.

Parameters

domain the physical domain object

◆ computePerforationRates()

virtual void geos::CompositionalMultiphaseWell::computePerforationRates	(	real64 const &	time_n,
		real64 const &	dt,
		DomainPartition &	domain
	)

overridevirtual

Recompute the perforation rates for all the wells.

Parameters

domain the domain containing the mesh and fields

Implements geos::WellSolverBase.

◆ getCatalogName()

string geos::CompositionalMultiphaseWell::getCatalogName ( ) const

inlineoverridevirtual

Returns: Get the final class Catalog name

Implements geos::PhysicsSolverBase.

Definition at line 80 of file CompositionalMultiphaseWell.hpp.

◆ numFluidComponents()

virtual localIndex geos::CompositionalMultiphaseWell::numFluidComponents ( ) const

inlineoverridevirtual

const getter for the number of fluid components

Returns: the number of fluid components

Implements geos::WellSolverBase.

Definition at line 192 of file CompositionalMultiphaseWell.hpp.

◆ numFluidPhases()

virtual localIndex geos::CompositionalMultiphaseWell::numFluidPhases ( ) const

inlineoverridevirtual

Get the number of fluid phases.

Returns: the number of phases

Implements geos::WellSolverBase.

Definition at line 194 of file CompositionalMultiphaseWell.hpp.

◆ postInputInitialization()

virtual void geos::CompositionalMultiphaseWell::postInputInitialization ( )

overrideprotectedvirtual

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

Reimplemented from geos::WellSolverBase.

◆ registerDataOnMesh()

virtual void geos::CompositionalMultiphaseWell::registerDataOnMesh ( Group & MeshBodies )

overridevirtual

Register wrappers that contain data on the mesh objects.

Parameters

MeshBodies the group of mesh bodies

Reimplemented from geos::WellSolverBase.

◆ resElementDofName()

virtual string geos::CompositionalMultiphaseWell::resElementDofName ( ) const

inlineoverridevirtual

get the name of DOF defined on well elements

Returns: name of the DOF field used by derived solver type

Implements geos::WellSolverBase.

Definition at line 190 of file CompositionalMultiphaseWell.hpp.

◆ updateBHPForConstraint()

void geos::CompositionalMultiphaseWell::updateBHPForConstraint ( WellElementSubRegion & subRegion )

Recompute the current BHP pressure.

Parameters

subRegion	the well subregion containing all the primary and dependent fields
targetIndex	the targetIndex of the subRegion

◆ updateFluidModel()

void geos::CompositionalMultiphaseWell::updateFluidModel ( WellElementSubRegion & subRegion )

Update all relevant fluid models using current values of pressure and composition.

Parameters

subRegion	the well subregion containing all the primary and dependent fields
targetIndex	the targetIndex of the subRegion

◆ updateGlobalComponentFraction()

void geos::CompositionalMultiphaseWell::updateGlobalComponentFraction ( WellElementSubRegion & subRegion ) const

Recompute global component fractions from primary variables (component densities)

Parameters

subRegion the well subregion containing all the primary and dependent fields

◆ updatePhaseVolumeFraction()

real64 geos::CompositionalMultiphaseWell::updatePhaseVolumeFraction ( WellElementSubRegion & subRegion ) const

Recompute phase volume fractions (saturations) from constitutive and primary variables.

Parameters

subRegion	the well subregion containing all the primary and dependent fields
targetIndex	the targetIndex of the subRegion

◆ updateState()

virtual void geos::CompositionalMultiphaseWell::updateState ( DomainPartition & domain )

overridevirtual

Recompute all dependent quantities from primary variables (including constitutive models)

Parameters

subRegion the well subregion containing all the primary and dependent fields

Reimplemented from geos::WellSolverBase.

◆ updateSubRegionState()

virtual real64 geos::CompositionalMultiphaseWell::updateSubRegionState ( WellElementSubRegion & subRegion )

overridevirtual

Recompute all dependent quantities from primary variables (including constitutive models)

Parameters

subRegion the well subRegion containing the well elements and their associated fields

Implements geos::WellSolverBase.

◆ updateTotalMassDensity()

void geos::CompositionalMultiphaseWell::updateTotalMassDensity ( WellElementSubRegion & subRegion ) const

Recompute total mass densities from mass density and phase volume fractions.

Parameters

subRegion the well subregion containing all the primary and dependent fields

◆ updateVolRatesForConstraint()

void geos::CompositionalMultiphaseWell::updateVolRatesForConstraint ( WellElementSubRegion & subRegion )

Recompute the volumetric rates that are used in the well constraints.

Parameters

subRegion	the well subregion containing all the primary and dependent fields
targetIndex	the targetIndex of the subRegion

◆ validateInjectionStreams()

void geos::CompositionalMultiphaseWell::validateInjectionStreams ( WellElementSubRegion const & subRegion ) const

protected

Checks injection streams for validity (compositions sum to one)

Parameters

subRegion the well subRegion

◆ validateWellConstraints()

virtual void geos::CompositionalMultiphaseWell::validateWellConstraints	(	real64 const &	time_n,
		real64 const &	dt,
		WellElementSubRegion const &	subRegion
	)

overrideprotectedvirtual

Make sure that the well constraints are compatible.

Parameters

time_n	the time at the beginning of the time step
dt	the time step dt
subRegion	the well subRegion

Implements geos::WellSolverBase.

◆ validateWellControlsForFluid()

void geos::CompositionalMultiphaseWell::validateWellControlsForFluid	(	WellControls const &	wellControls,
		constitutive::MultiFluidBase const &	fluid
	)		const

protected

Checks if the WellControls parameters are within the fluid tables ranges.

Parameters

fluid the fluid to check

◆ wellElementDofName()

virtual string geos::CompositionalMultiphaseWell::wellElementDofName ( ) const

inlineoverridevirtual

get the name of DOF defined on well elements

Returns: name of the DOF field used by derived solver type

Implements geos::WellSolverBase.

Definition at line 188 of file CompositionalMultiphaseWell.hpp.

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

coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.hpp

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CompositionalMultiphaseWell()

Member Function Documentation

◆ assembleAccumulationTerms()

◆ assembleFluxTerms()

◆ assemblePressureRelations()

◆ catalogName()

◆ chopNegativeDensities()

◆ computePerforationRates()

◆ getCatalogName()

◆ numFluidComponents()

◆ numFluidPhases()

◆ postInputInitialization()

◆ registerDataOnMesh()

◆ resElementDofName()

◆ updateBHPForConstraint()

◆ updateFluidModel()

◆ updateGlobalComponentFraction()

◆ updatePhaseVolumeFraction()

◆ updateState()

◆ updateSubRegionState()

◆ updateTotalMassDensity()

◆ updateVolRatesForConstraint()

◆ validateInjectionStreams()

◆ validateWellConstraints()

◆ validateWellControlsForFluid()

◆ wellElementDofName()