Base class for all physics solvers. More...

#include <WellNewtonSolver.hpp>

Inheritance diagram for geos::WellNewtonSolver:

Classes
struct	groupKeyStruct
	Structure to hold scoped key names. More...

struct	viewKeyStruct
	Structure to hold scoped key names. More...

Public Types
enum class	StatsOutputType : integer { none , iteration , convergence , all }
	Type of the stat output.

using	CatalogInterface = dataRepository::CatalogInterface< WellNewtonSolver, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

Public Types inherited from geos::dataRepository::Group
using	subGroupMap = MappedVector< Group, Group *, keyType, indexType >
	The template specialization of MappedVector to use for the collection of sub-Group objects.

using	wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
	The template specialization of MappedVector to use for the collection wrappers objects.

using	CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
	Type alias for catalog interface used by this class. See CatalogInterface.

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

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

virtual	~WellNewtonSolver () override
	Destructor for WellNewtonSolver.

	WellNewtonSolver ()=delete
	Deleted constructor.

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

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

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

void	generateMeshTargetsFromTargetRegions (Group const &meshBodies)
	Generate mesh targets from target regions. 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...

template<typename T >
void	setupSystem (T &well, DomainPartition &domain, std::string const &meshBodyName, MeshLevel const &meshLevel, WellElementRegion &wellElementRegion, bool const setSparsity=true)

template<typename T >
bool	solveNonlinearSystem (T &well, real64 const &time_n, real64 const &stepDt, integer const cycleNumber, DomainPartition &domain, MeshLevel &mesh, ElementRegionManager &elemManager, WellElementSubRegion &subRegion)

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

virtual void	setSparsityPattern (DomainPartition &domain, DofManager &dofManager, CRSMatrix< real64, globalIndex > &localMatrix, SparsityPattern< globalIndex > &pattern)
	Set up the linear system (DOF indices and sparsity patterns) More...

virtual std::unique_ptr< PreconditionerBase< LAInterface > >	createPreconditioner (DomainPartition &domain) const
	Create a preconditioner for this solver's linear 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	updateAndWriteConvergenceStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, integer const iteration)
	Update the convergence information and write then into a CSV file. 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 Group *	createChild (string const &childKey, string const &childName) override
	creates a child group of of this WellNewtonSolver instantiation More...

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

void	setSystemSetupTimestamp (Timestamp timestamp)
	set the timestamp of the system setup 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 ()
	synchronize the nonlinear solver parameters.

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

string_array const &	getTargetRegionNames () const
	return the list of target regions More...

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

IterationsStatistics &	getIterationStats ()

IterationsStatistics const &	getIterationStats () const

ConvergenceStatistics &	getConvergenceStats ()

ConvergenceStatistics const &	getConvergenceStats () const

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

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

bool	detectOscillations () const
	Detect oscillations in the solution. More...

void	enableThermalEffects (bool enable)
	Set thermal effects enable. More...

bool	thermalEffectsEnabled () const
	Are thermal effects enabled. More...

bool	isoThermalEstimatorEnabled () const
	Is isoThermalEstimator enabled. More...

bool	getNumActiveCoupledIterations () const

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

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

static CatalogInterface::CatalogType &	getCatalog ()
	Get the singleton catalog for WellNewtonSolver. 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...

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

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.

Protected Attributes
integer	m_allowNonConvergedLinearSolverSolution
	behavior in case of linear solver failure

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.

ParallelVector	m_scaling
	Diagonal scaling vector D (Ahat = D * A * D, bhat = D * b, x = D * xhat)

integer	m_usePhysicsScaling
	Flag to decide whether to apply physics-based scaling to the linear system.

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

std::unique_ptr< LinearSolverBase< LAInterface > >	m_linearSolver
	Custom linear solver for the "native" solver type.

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

StatsOutputType	m_writeStatisticsCSV
	Parameter for outputing statistics information.

LinearSolverParametersInput	m_linearSolverParameters
	Linear solver parameters.

LinearSolverResult	m_linearSolverResult
	Result of the last linear solver.

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.

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

ArrayOfArrays< real64 >	m_solutionHistory
	History of the solution vector, used for oscillation detection.

Detailed Description

Base class for all physics solvers.

This class provides the base interface for all physics solvers. It provides the basic functionality for setting up and solving a linear system, as well as the interface for performing a timestep.

Definition at line 55 of file WellNewtonSolver.hpp.

Constructor & Destructor Documentation

◆ WellNewtonSolver()

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

explicit

Constructor for WellNewtonSolver.

Parameters

name	the name of this instantiation of WellNewtonSolver
parent	the parent group of this instantiation of WellNewtonSolver

Member Function Documentation

◆ catalogName()

static string geos::WellNewtonSolver::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 109 of file WellNewtonSolver.hpp.

◆ createChild()

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

overridevirtual

creates a child group of of this WellNewtonSolver instantiation

Parameters

childKey	the key of the child type
childName	the name of the child

Returns: a pointer to the child group

◆ createPreconditioner()

virtual std::unique_ptr< PreconditionerBase< LAInterface > > geos::WellNewtonSolver::createPreconditioner ( DomainPartition & domain ) const

virtual

Create a preconditioner for this solver's linear system.

Parameters

domain the domain containing the mesh and fields

Returns: the newly created preconditioner object

◆ debugOutputSolution()

void geos::WellNewtonSolver::debugOutputSolution	(	real64 const &	time,
		integer const	cycleNumber,
		integer const	nonlinearIteration,
		ParallelVector const &	solution
	)		const

Output the linear system solution for debug purposes.

Parameters

time	beginning-of-step time
cycleNumber	event cycle number
nonlinearIteration	current nonlinear iteration number
solution	system solution vector

◆ debugOutputSystem()

void geos::WellNewtonSolver::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.

Parameters

time	beginning-of-step time
cycleNumber	event cycle number
nonlinearIteration	current nonlinear iteration number
matrix	system matrix
rhs	system right-hand side vector

◆ detectOscillations()

bool geos::WellNewtonSolver::detectOscillations ( ) const

Detect oscillations in the solution.

Returns: true if oscillations are detected, false otherwise

◆ enableThermalEffects()

void geos::WellNewtonSolver::enableThermalEffects ( bool enable )

inline

Set thermal effects enable.

Parameters

[in] true/false

Definition at line 524 of file WellNewtonSolver.hpp.

◆ generateMeshTargetsFromTargetRegions()

void geos::WellNewtonSolver::generateMeshTargetsFromTargetRegions ( Group const & meshBodies )

Generate mesh targets from target regions.

Parameters

meshBodies the group of mesh bodies

◆ getCatalog()

static CatalogInterface::CatalogType& geos::WellNewtonSolver::getCatalog ( )

static

Get the singleton catalog for WellNewtonSolver.

Returns: reference to the catalog object

◆ getConvergenceStats() [1/2]

ConvergenceStatistics& geos::WellNewtonSolver::getConvergenceStats ( )

inline

Returns: A ConvergenceStatistics for all sub-solvers

Definition at line 487 of file WellNewtonSolver.hpp.

◆ getConvergenceStats() [2/2]

ConvergenceStatistics const& geos::WellNewtonSolver::getConvergenceStats ( ) const

inline

Returns: A ConvergenceStatistics for all sub-solvers (const version)

Definition at line 494 of file WellNewtonSolver.hpp.

◆ getDofManager() [1/2]

DofManager& geos::WellNewtonSolver::getDofManager ( )

inline

Getter for degree-of-freedom manager.

Returns: a reference to degree-of-freedom manager of this solver

Definition at line 161 of file WellNewtonSolver.hpp.

◆ getDofManager() [2/2]

DofManager const& geos::WellNewtonSolver::getDofManager ( ) const

inline

Getter for degree-of-freedom manager.

Returns: a reference to degree-of-freedom manager of this solver

Definition at line 167 of file WellNewtonSolver.hpp.

◆ getIterationStats() [1/2]

IterationsStatistics& geos::WellNewtonSolver::getIterationStats ( )

inline

Returns: An IterationsStatistics for the "root" solver. Otherwise return an empty IterationsStatistics

Definition at line 471 of file WellNewtonSolver.hpp.

◆ getIterationStats() [2/2]

IterationsStatistics const& geos::WellNewtonSolver::getIterationStats ( ) const

inline

Returns: An IterationsStatistics for the "root" solver. Otherwise return an empty IterationsStatistics (const version)

Definition at line 480 of file WellNewtonSolver.hpp.

◆ getLinearSolverParameters() [1/2]

LinearSolverParameters& geos::WellNewtonSolver::getLinearSolverParameters ( )

inline

accessor for the linear solver parameters.

Returns: the linear solver parameter list

Definition at line 403 of file WellNewtonSolver.hpp.

◆ getLinearSolverParameters() [2/2]

LinearSolverParameters const& geos::WellNewtonSolver::getLinearSolverParameters ( ) const

inline

const accessor for the linear solver parameters.

Returns: the linear solver parameter list

Definition at line 412 of file WellNewtonSolver.hpp.

◆ getLocalMatrix() [1/2]

CRSMatrix< real64, globalIndex >& geos::WellNewtonSolver::getLocalMatrix ( )

inline

Getter for local matrix.

Returns: a reference to linear system matrix of this solver

Definition at line 173 of file WellNewtonSolver.hpp.

◆ getLocalMatrix() [2/2]

CRSMatrixView< real64 const, globalIndex const > geos::WellNewtonSolver::getLocalMatrix ( ) const

inline

Getter for local matrix.

Returns: a reference to linear system matrix of this solver

Definition at line 179 of file WellNewtonSolver.hpp.

◆ getNonlinearSolverParameters() [1/2]

NonlinearSolverParameters& geos::WellNewtonSolver::getNonlinearSolverParameters ( )

inline

accessor for the nonlinear solver parameters.

Returns: the nonlinear solver parameter list

Definition at line 421 of file WellNewtonSolver.hpp.

◆ getNonlinearSolverParameters() [2/2]

NonlinearSolverParameters const& geos::WellNewtonSolver::getNonlinearSolverParameters ( ) const

inline

const accessor for the nonlinear solver parameters.

Returns: the nonlinear solver parameter list

Definition at line 430 of file WellNewtonSolver.hpp.

◆ getSolverStatistics() [1/2]

SolverStatistics& geos::WellNewtonSolver::getSolverStatistics ( )

inline

accessor for the solver statistics.

Returns: reference to m_solverStatistics

Definition at line 503 of file WellNewtonSolver.hpp.

◆ getSolverStatistics() [2/2]

SolverStatistics const& geos::WellNewtonSolver::getSolverStatistics ( ) const

inline

const accessor for the solver statistics.

Returns: reference to m_solverStatistics

Definition at line 509 of file WellNewtonSolver.hpp.

◆ getSystemMatrix() [1/2]

ParallelMatrix& geos::WellNewtonSolver::getSystemMatrix ( )

inline

Getter for system matrix.

Returns: a reference to linear system matrix of this solver

Definition at line 125 of file WellNewtonSolver.hpp.

◆ getSystemMatrix() [2/2]

ParallelMatrix const& geos::WellNewtonSolver::getSystemMatrix ( ) const

inline

Getter for system rhs vector.

Returns: a reference to linear system right-hand side of this solver

Definition at line 131 of file WellNewtonSolver.hpp.

◆ getSystemRhs() [1/2]

ParallelVector& geos::WellNewtonSolver::getSystemRhs ( )

inline

Getter for system rhs vector.

Returns: a reference to linear system right-hand side of this solver

Definition at line 137 of file WellNewtonSolver.hpp.

◆ getSystemRhs() [2/2]

ParallelVector const& geos::WellNewtonSolver::getSystemRhs ( ) const

inline

Getter for system rhs vector.

Returns: a reference to linear system right-hand side of this solver

Definition at line 143 of file WellNewtonSolver.hpp.

◆ getSystemSetupTimestamp()

Timestamp geos::WellNewtonSolver::getSystemSetupTimestamp ( ) const

inline

getter for the timestamp of the system setup

Returns: the timestamp of the last time systemSetup was called

Definition at line 389 of file WellNewtonSolver.hpp.

◆ getSystemSolution() [1/2]

ParallelVector& geos::WellNewtonSolver::getSystemSolution ( )

inline

Getter for system solution vector.

Returns: a reference to solution vector of this solver

Definition at line 149 of file WellNewtonSolver.hpp.

◆ getSystemSolution() [2/2]

ParallelVector const& geos::WellNewtonSolver::getSystemSolution ( ) const

inline

Getter for system solution vector.

Returns: a reference to solution vector of this solver

Definition at line 155 of file WellNewtonSolver.hpp.

◆ getTargetRegionNames()

string_array const& geos::WellNewtonSolver::getTargetRegionNames ( ) const

inline

return the list of target regions

Returns: the array of region names

Definition at line 453 of file WellNewtonSolver.hpp.

◆ isoThermalEstimatorEnabled()

bool geos::WellNewtonSolver::isoThermalEstimatorEnabled ( ) const

inline

Is isoThermalEstimator enabled.

Returns: true if isoThermalEstimator is enabled, false otherwise

Definition at line 536 of file WellNewtonSolver.hpp.

◆ postInputInitialization()

virtual void geos::WellNewtonSolver::postInputInitialization ( )

overrideprotectedvirtual

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

Reimplemented from geos::dataRepository::Group.

◆ registerCallback()

virtual bool geos::WellNewtonSolver::registerCallback	(	void *	func,
		const std::type_info &	funcType
	)

finaloverridevirtual

function to set the value of m_assemblyCallback

Parameters

func	the function to set m_assemblyCallback to
funcType	the type of the function

Returns: true if the function was successfully set, false otherwise

This is used to provide a callback function for to be called in the assembly step.

Reimplemented from geos::dataRepository::Group.

◆ setSparsityPattern()

virtual void geos::WellNewtonSolver::setSparsityPattern	(	DomainPartition &	domain,
		DofManager &	dofManager,
		CRSMatrix< real64, globalIndex > &	localMatrix,
		SparsityPattern< globalIndex > &	pattern
	)

virtual

Set up the linear system (DOF indices and sparsity patterns)

Parameters

domain	the domain containing the mesh and fields
dofManager	degree-of-freedom manager associated with the linear system
localMatrix	the system matrix
rhs	the system right-hand side vector
solution	the solution vector
setSparsity	flag to indicate if the sparsity pattern should be set

Note: While the function is virtual, the base class implementation should be sufficient for most single-physics solvers.

Set the sparsity pattern of the linear system matrix

Parameters

domain	the domain containing the mesh and fields
dofManager	degree-of-freedom manager associated with the linear system
localMatrix	the system matrix
pattern	the sparsity pattern to be filled

◆ setSystemSetupTimestamp()

void geos::WellNewtonSolver::setSystemSetupTimestamp ( Timestamp timestamp )

set the timestamp of the system setup

Parameters

[in] timestamp the new timestamp of system setup

◆ setupDofs()

virtual void geos::WellNewtonSolver::setupDofs	(	DomainPartition const &	domain,
		DofManager &	dofManager
	)		const

virtual

Populate degree-of-freedom manager with fields relevant to this solver.

Parameters

domain	the domain containing the mesh and fields
dofManager	degree-of-freedom manager associated with the linear system

◆ solveLinearSystem()

virtual void geos::WellNewtonSolver::solveLinearSystem	(	DofManager const &	dofManager,
		ParallelMatrix &	matrix,
		ParallelVector &	rhs,
		ParallelVector &	solution
	)

virtual

function to apply a linear system solver to the assembled system.

Parameters

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

This function calls the linear solver package to perform a single linear solve on the block system. The derived physics solver is required to specify the call, as no default is provided.

Note: This function must be overridden in the derived physics solver in order to use an implict solution method such as LinearImplicitStep() or NonlinearImplicitStep().

◆ targetRegionIndex()

localIndex geos::WellNewtonSolver::targetRegionIndex ( string const & regionName ) const

Get position of a given region within solver's target region list.

Parameters

regionName the region name to find

Returns: index within target regions list

◆ thermalEffectsEnabled()

bool geos::WellNewtonSolver::thermalEffectsEnabled ( ) const

inline

Are thermal effects enabled.

Returns: true if thermal effects are enabled, false otherwise

Definition at line 530 of file WellNewtonSolver.hpp.

◆ updateAndWriteConvergenceStep()

virtual void geos::WellNewtonSolver::updateAndWriteConvergenceStep	(	real64 const &	time_n,
		real64 const &	dt,
		integer const	cycleNumber,
		integer const	iteration
	)

virtual

Update the convergence information and write then into a CSV file.

Parameters

time_n	the time at the beginning of the step
dt	the desired timestep
cycleNumber	event cycle number
iteration	current iteration

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

coreComponents/physicsSolvers/fluidFlow/wells/WellNewtonSolver.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WellNewtonSolver()

Member Function Documentation

◆ catalogName()

◆ createChild()

◆ createPreconditioner()

◆ debugOutputSolution()

◆ debugOutputSystem()

◆ detectOscillations()

◆ enableThermalEffects()

◆ generateMeshTargetsFromTargetRegions()

◆ getCatalog()

◆ getConvergenceStats() [1/2]

◆ getConvergenceStats() [2/2]

◆ getDofManager() [1/2]

◆ getDofManager() [2/2]

◆ getIterationStats() [1/2]

◆ getIterationStats() [2/2]

◆ getLinearSolverParameters() [1/2]

◆ getLinearSolverParameters() [2/2]

◆ getLocalMatrix() [1/2]

◆ getLocalMatrix() [2/2]

◆ getNonlinearSolverParameters() [1/2]

◆ getNonlinearSolverParameters() [2/2]

◆ getSolverStatistics() [1/2]

◆ getSolverStatistics() [2/2]

◆ getSystemMatrix() [1/2]

◆ getSystemMatrix() [2/2]

◆ getSystemRhs() [1/2]

◆ getSystemRhs() [2/2]

◆ getSystemSetupTimestamp()

◆ getSystemSolution() [1/2]

◆ getSystemSolution() [2/2]

◆ getTargetRegionNames()

◆ isoThermalEstimatorEnabled()

◆ postInputInitialization()

◆ registerCallback()

◆ setSparsityPattern()

◆ setSystemSetupTimestamp()

◆ setupDofs()

◆ solveLinearSystem()

◆ targetRegionIndex()

◆ thermalEffectsEnabled()

◆ updateAndWriteConvergenceStep()