#include <NonlinearSystemCompositional.hpp>

Inheritance diagram for Opm::NonlinearSystemCompositional< TypeTag >:

Public Types
using	ParentType = NonlinearSystem< TypeTag >

using	Simulator = typename ParentType::Simulator

using	Grid = typename ParentType::Grid

using	FluidSystem = typename ParentType::FluidSystem

using	Indices = typename ParentType::Indices

using	Scalar = typename ParentType::Scalar

using	ComponentName = typename ParentType::ComponentName

using	SparseMatrixAdapter = GetPropType< TypeTag, Properties::SparseMatrixAdapter >

using	ModelParameters = BlackoilModelParameters< Scalar >

using	VectorBlockType = Dune::FieldVector< Scalar, numEq >

using	BVector = Dune::BlockVector< VectorBlockType >

using	GlobalEqVector = GetPropType< TypeTag, Properties::GlobalEqVector >

using	WellModel = GetPropType< TypeTag, Properties::WellModel >

Public Member Functions
	NonlinearSystemCompositional (Simulator &simulator, const ModelParameters &param, CompWellModel< TypeTag > &wellModel, bool terminalOutput)

SimulatorReportSingle	prepareStep (const SimulatorTimerInterface &timer)

void	initialLinearization (SimulatorReportSingle &report, int minIter, int maxIter, const SimulatorTimerInterface &timer) override

template<class NonlinearSolverType >
SimulatorReportSingle	nonlinearIteration (const SimulatorTimerInterface &timer, NonlinearSolverType &nonlinearSolver)

template<class NonlinearSolverType >
SimulatorReportSingle	nonlinearIterationNewton (const SimulatorTimerInterface &timer, NonlinearSolverType &nonlinearSolver)

Scalar	relativeChange () const

int	linearIterationsLastSolve () const

void	solveJacobianSystem (BVector &x)

bool	hasNlddSolver () const

const SimulatorReport &	localAccumulatedReports () const

const std::vector< SimulatorReport > &	domainAccumulatedReports () const

void	writeNonlinearIterationsPerCell (const std::filesystem::path &) const

template<class T >
std::vector< std::vector< Scalar > >	computeFluidInPlace (const T &, const std::vector< int > &fipnum) const

std::vector< std::vector< Scalar > >	computeFluidInPlace (const std::vector< int > &) const

void	writePartitions (const std::filesystem::path &) const

bool	isParallel () const

const Simulator &	simulator () const

Simulator &	simulator ()

bool	terminalOutputEnabled () const

int	numPhases () const

const SimulatorReportSingle &	failureReport () const

const std::vector< StepReport > &	stepReports () const

const ComponentName &	compNames () const

const ModelParameters &	param () const

WellModel &	wellModel ()

const WellModel &	wellModel () const

void	beginReportStep ()

void	endReportStep ()

SimulatorReportSingle	assembleReservoir (const SimulatorTimerInterface &timer)

void	updateTUNING (const Tuning &tuning)

void	updateTUNINGDP (const TuningDp &tuning_dp)

void	updateSolution (const GlobalEqVector &dx)

template<class LogFailure >
void	addReservoirConvergenceMetrics (ConvergenceReport &report, const int componentIdx, const std::string_view componentName, const std::span< const Scalar > residuals, const std::span< const ConvergenceReport::ReservoirFailure::Type > types, const std::span< const Scalar > tolerances, const Scalar maxResidualAllowed, LogFailure &&logFailure) const

Static Public Attributes
static constexpr int	numEq = Indices::numEq

Protected Member Functions
template<class WellModelType >
SimulatorReportSingle	assembleReservoir (WellModelType &wellModel)

virtual bool	shouldStoreSolutionUpdate () const

virtual void	prepareSolutionUpdate ()

virtual void	storeSolutionUpdate (const GlobalEqVector &)

template<class ModelParametersType >
void	applyTUNING (ModelParametersType &param, const Tuning &tuning)

template<class ModelParametersType >
void	applyTUNINGDP (ModelParametersType &param, const TuningDp &tuning_dp)

template<class ValueType >
std::tuple< ValueType, ValueType >	convergenceReduction (Parallel::Communication comm, const ValueType primaryVolumeLocal, const ValueType secondaryVolumeLocal, std::vector< ValueType > &sumValues, std::vector< ValueType > &maxValues, std::vector< ValueType > &averagedValues)

void	popLastStepReport ()

Protected Attributes
Simulator &	simulator_

const Grid &	grid_

bool	terminal_output_

ModelParameters	param_

WellModel &	well_model_

SimulatorReportSingle	failureReport_

std::vector< StepReport >	convergence_reports_

ComponentName	compNames_ {}

std::vector< std::vector< Scalar > >	residual_norms_history_

Scalar	current_relaxation_

GlobalEqVector	dx_old_

Member Typedef Documentation

◆ BVector

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::BVector = Dune::BlockVector<VectorBlockType>

◆ ComponentName

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::ComponentName = typename ParentType::ComponentName

◆ FluidSystem

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::FluidSystem = typename ParentType::FluidSystem

◆ GlobalEqVector

template<class TypeTag >

using Opm::NonlinearSystem< TypeTag >::GlobalEqVector = GetPropType<TypeTag, Properties::GlobalEqVector>

inherited

◆ Grid

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::Grid = typename ParentType::Grid

◆ Indices

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::Indices = typename ParentType::Indices

◆ ModelParameters

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::ModelParameters = BlackoilModelParameters<Scalar>

◆ ParentType

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::ParentType = NonlinearSystem<TypeTag>

◆ Scalar

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::Scalar = typename ParentType::Scalar

◆ Simulator

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::Simulator = typename ParentType::Simulator

◆ SparseMatrixAdapter

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::SparseMatrixAdapter = GetPropType<TypeTag, Properties::SparseMatrixAdapter>

◆ VectorBlockType

template<class TypeTag >

using Opm::NonlinearSystemCompositional< TypeTag >::VectorBlockType = Dune::FieldVector<Scalar, numEq>

◆ WellModel

template<class TypeTag >

using Opm::NonlinearSystem< TypeTag >::WellModel = GetPropType<TypeTag, Properties::WellModel>

inherited

Constructor & Destructor Documentation

◆ NonlinearSystemCompositional()

template<class TypeTag >

Opm::NonlinearSystemCompositional< TypeTag >::NonlinearSystemCompositional	(	Simulator &	simulator,
		const ModelParameters &	param,
		CompWellModel< TypeTag > &	wellModel,
		bool	terminalOutput
	)

References Opm::NonlinearSystem< TypeTag >::convergence_reports_.

Member Function Documentation

◆ addReservoirConvergenceMetrics()

template<class TypeTag >

template<class LogFailure >

void Opm::NonlinearSystem< TypeTag >::addReservoirConvergenceMetrics	(	ConvergenceReport &	report,
		const int	componentIdx,
		const std::string_view	componentName,
		const std::span< const Scalar >	residuals,
		const std::span< const ConvergenceReport::ReservoirFailure::Type >	types,
		const std::span< const Scalar >	tolerances,
		const Scalar	maxResidualAllowed,
		LogFailure &&	logFailure
	)		const

inherited

References Opm::ConvergenceReport::setReservoirConvergenceMetric(), and Opm::ConvergenceReport::setReservoirFailed().

◆ applyTUNING()

template<class TypeTag >

template<class ModelParametersType >

void Opm::NonlinearSystem< TypeTag >::applyTUNING	(	ModelParametersType &	param,
		const Tuning &	tuning
	)

protectedinherited

◆ applyTUNINGDP()

template<class TypeTag >

template<class ModelParametersType >

void Opm::NonlinearSystem< TypeTag >::applyTUNINGDP	(	ModelParametersType &	param,
		const TuningDp &	tuning_dp
	)

protectedinherited

◆ assembleReservoir() [1/2]

template<class TypeTag >

SimulatorReportSingle Opm::NonlinearSystem< TypeTag >::assembleReservoir ( const SimulatorTimerInterface & timer )

inherited

◆ assembleReservoir() [2/2]

template<class TypeTag >

template<class WellModelType >

SimulatorReportSingle Opm::NonlinearSystem< TypeTag >::assembleReservoir ( WellModelType & wellModel )

protectedinherited

◆ beginReportStep()

template<class TypeTag >

void Opm::NonlinearSystem< TypeTag >::beginReportStep ( )

inlineinherited

References Opm::NonlinearSystem< TypeTag >::simulator_.

◆ compNames()

template<class TypeTag >

const ComponentName & Opm::NonlinearSystem< TypeTag >::compNames ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::compNames_.

◆ computeFluidInPlace() [1/2]

template<class TypeTag >

std::vector< std::vector< Scalar > > Opm::NonlinearSystemCompositional< TypeTag >::computeFluidInPlace ( const std::vector< int > & ) const

inline

◆ computeFluidInPlace() [2/2]

template<class TypeTag >

template<class T >

std::vector< std::vector< Scalar > > Opm::NonlinearSystemCompositional< TypeTag >::computeFluidInPlace	(	const T &	,
		const std::vector< int > &	fipnum
	)		const

inline

References Opm::NonlinearSystemCompositional< TypeTag >::computeFluidInPlace().

Referenced by Opm::NonlinearSystemCompositional< TypeTag >::computeFluidInPlace().

◆ convergenceReduction()

template<class TypeTag >

template<class ValueType >

std::tuple< ValueType, ValueType > Opm::NonlinearSystem< TypeTag >::convergenceReduction	(	Parallel::Communication	comm,
		const ValueType	primaryVolumeLocal,
		const ValueType	secondaryVolumeLocal,
		std::vector< ValueType > &	sumValues,
		std::vector< ValueType > &	maxValues,
		std::vector< ValueType > &	averagedValues
	)

protectedinherited

◆ domainAccumulatedReports()

template<class TypeTag >

const std::vector< SimulatorReport > & Opm::NonlinearSystemCompositional< TypeTag >::domainAccumulatedReports ( ) const

inline

◆ endReportStep()

template<class TypeTag >

void Opm::NonlinearSystem< TypeTag >::endReportStep ( )

inlineinherited

References Opm::NonlinearSystem< TypeTag >::simulator_.

◆ failureReport()

template<class TypeTag >

const SimulatorReportSingle & Opm::NonlinearSystem< TypeTag >::failureReport ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::failureReport_.

◆ hasNlddSolver()

template<class TypeTag >

bool Opm::NonlinearSystemCompositional< TypeTag >::hasNlddSolver ( ) const

inline

◆ initialLinearization()

template<class TypeTag >

void Opm::NonlinearSystemCompositional< TypeTag >::initialLinearization	(	SimulatorReportSingle &	report,
		int	minIter,
		int	maxIter,
		const SimulatorTimerInterface &	timer
	)

overridevirtual

Reimplemented from Opm::NonlinearSystem< TypeTag >.

References Opm::ConvergenceReport::ReservoirFailure::MassBalance, and Opm::SimulatorTimerInterface::simulationTimeElapsed().

◆ isParallel()

template<class TypeTag >

bool Opm::NonlinearSystem< TypeTag >::isParallel ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::grid_.

◆ linearIterationsLastSolve()

template<class TypeTag >

int Opm::NonlinearSystemCompositional< TypeTag >::linearIterationsLastSolve ( ) const

inline

References Opm::NonlinearSystem< TypeTag >::simulator_.

◆ localAccumulatedReports()

template<class TypeTag >

const SimulatorReport & Opm::NonlinearSystemCompositional< TypeTag >::localAccumulatedReports ( ) const

inline

◆ nonlinearIteration()

template<class TypeTag >

template<class NonlinearSolverType >

SimulatorReportSingle Opm::NonlinearSystemCompositional< TypeTag >::nonlinearIteration	(	const SimulatorTimerInterface &	timer,
		NonlinearSolverType &	nonlinearSolver
	)

References Opm::SimulatorTimerInterface::currentStepNum(), and Opm::SimulatorTimerInterface::reportStepNum().

◆ nonlinearIterationNewton()

template<class TypeTag >

template<class NonlinearSolverType >

SimulatorReportSingle Opm::NonlinearSystemCompositional< TypeTag >::nonlinearIterationNewton	(	const SimulatorTimerInterface &	timer,
		NonlinearSolverType &	nonlinearSolver
	)

References Opm::SimulatorReportSingle::converged, Opm::SimulatorReportSingle::linear_solve_setup_time, Opm::SimulatorReportSingle::linear_solve_time, Opm::to_string(), Opm::SimulatorReportSingle::total_linear_iterations, Opm::SimulatorReportSingle::total_newton_iterations, and Opm::SimulatorReportSingle::update_time.

◆ numPhases()

template<class TypeTag >

int Opm::NonlinearSystem< TypeTag >::numPhases ( ) const

inlineinherited

◆ param()

template<class TypeTag >

const ModelParameters & Opm::NonlinearSystem< TypeTag >::param ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::param_.

◆ popLastStepReport()

template<class TypeTag >

void Opm::NonlinearSystem< TypeTag >::popLastStepReport ( )

inlineprotectedinherited

References Opm::NonlinearSystem< TypeTag >::convergence_reports_.

Referenced by Opm::NonlinearSystemBlackOilReservoir< TypeTag >::popLastConvergenceReport().

◆ prepareSolutionUpdate()

template<class TypeTag >

virtual void Opm::NonlinearSystem< TypeTag >::prepareSolutionUpdate ( )

inlineprotectedvirtualinherited

Reimplemented in Opm::NonlinearSystemBlackOilReservoir< TypeTag >.

◆ prepareStep()

template<class TypeTag >

SimulatorReportSingle Opm::NonlinearSystemCompositional< TypeTag >::prepareStep ( const SimulatorTimerInterface & timer )

References Opm::SimulatorTimerInterface::currentStepLength(), Opm::SimulatorTimerInterface::lastStepFailed(), Opm::SimulatorReportSingle::pre_post_time, and Opm::SimulatorTimerInterface::simulationTimeElapsed().

◆ relativeChange()

template<class TypeTag >

NonlinearSystemCompositional< TypeTag >::Scalar Opm::NonlinearSystemCompositional< TypeTag >::relativeChange

◆ shouldStoreSolutionUpdate()

template<class TypeTag >

virtual bool Opm::NonlinearSystem< TypeTag >::shouldStoreSolutionUpdate ( ) const

inlineprotectedvirtualinherited

Reimplemented in Opm::NonlinearSystemBlackOilReservoir< TypeTag >.

◆ simulator() [1/2]

template<class TypeTag >

Simulator & Opm::NonlinearSystem< TypeTag >::simulator ( )

inlineinherited

References Opm::NonlinearSystem< TypeTag >::simulator_.

◆ simulator() [2/2]

template<class TypeTag >

const Simulator & Opm::NonlinearSystem< TypeTag >::simulator ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::simulator_.

◆ solveJacobianSystem()

template<class TypeTag >

void Opm::NonlinearSystemCompositional< TypeTag >::solveJacobianSystem ( BVector & x )

◆ stepReports()

template<class TypeTag >

const std::vector< StepReport > & Opm::NonlinearSystem< TypeTag >::stepReports ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::convergence_reports_.

◆ storeSolutionUpdate()

template<class TypeTag >

virtual void Opm::NonlinearSystem< TypeTag >::storeSolutionUpdate ( const GlobalEqVector & )

inlineprotectedvirtualinherited

Reimplemented in Opm::NonlinearSystemBlackOilReservoir< TypeTag >.

◆ terminalOutputEnabled()

template<class TypeTag >

bool Opm::NonlinearSystem< TypeTag >::terminalOutputEnabled ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::terminal_output_.

◆ updateSolution()

template<class TypeTag >

void Opm::NonlinearSystem< TypeTag >::updateSolution ( const GlobalEqVector & dx )

inherited

◆ updateTUNING()

template<class TypeTag >

void Opm::NonlinearSystem< TypeTag >::updateTUNING ( const Tuning & tuning )

inherited

◆ updateTUNINGDP()

template<class TypeTag >

void Opm::NonlinearSystem< TypeTag >::updateTUNINGDP ( const TuningDp & tuning_dp )

inherited

◆ wellModel() [1/2]

template<class TypeTag >

WellModel & Opm::NonlinearSystem< TypeTag >::wellModel ( )

inlineinherited

References Opm::NonlinearSystem< TypeTag >::well_model_.

Referenced by Opm::NonlinearSystemNldd< TypeTag >::NonlinearSystemNldd().

◆ wellModel() [2/2]

template<class TypeTag >

const WellModel & Opm::NonlinearSystem< TypeTag >::wellModel ( ) const

inlineinherited

References Opm::NonlinearSystem< TypeTag >::well_model_.

◆ writeNonlinearIterationsPerCell()

template<class TypeTag >

void Opm::NonlinearSystemCompositional< TypeTag >::writeNonlinearIterationsPerCell ( const std::filesystem::path & ) const

inline

◆ writePartitions()

template<class TypeTag >

void Opm::NonlinearSystemCompositional< TypeTag >::writePartitions ( const std::filesystem::path & ) const

inline

Member Data Documentation

◆ compNames_

template<class TypeTag >

ComponentName Opm::NonlinearSystem< TypeTag >::compNames_ {}

protectedinherited

Referenced by Opm::NonlinearSystem< TypeTag >::compNames().

◆ convergence_reports_

template<class TypeTag >

std::vector<StepReport> Opm::NonlinearSystem< TypeTag >::convergence_reports_

protectedinherited

Referenced by Opm::NonlinearSystemBlackOilReservoir< TypeTag >::NonlinearSystemBlackOilReservoir(), Opm::NonlinearSystemCompositional< TypeTag >::NonlinearSystemCompositional(), Opm::NonlinearSystem< TypeTag >::popLastStepReport(), and Opm::NonlinearSystem< TypeTag >::stepReports().

◆ current_relaxation_

template<class TypeTag >

Scalar Opm::NonlinearSystem< TypeTag >::current_relaxation_

protectedinherited

◆ dx_old_

template<class TypeTag >

GlobalEqVector Opm::NonlinearSystem< TypeTag >::dx_old_

protectedinherited

◆ failureReport_

template<class TypeTag >

SimulatorReportSingle Opm::NonlinearSystem< TypeTag >::failureReport_

protectedinherited

Referenced by Opm::NonlinearSystem< TypeTag >::failureReport().

◆ grid_

template<class TypeTag >

const Grid& Opm::NonlinearSystem< TypeTag >::grid_

protectedinherited

Referenced by Opm::NonlinearSystem< TypeTag >::isParallel(), and Opm::NonlinearSystemBlackOilReservoir< TypeTag >::NonlinearSystemBlackOilReservoir().

◆ numEq

template<class TypeTag >

constexpr int Opm::NonlinearSystemCompositional< TypeTag >::numEq = Indices::numEq

staticconstexpr

◆ param_

template<class TypeTag >

ModelParameters Opm::NonlinearSystem< TypeTag >::param_

protectedinherited

Referenced by Opm::NonlinearSystemBlackOilReservoir< TypeTag >::NonlinearSystemBlackOilReservoir(), and Opm::NonlinearSystem< TypeTag >::param().

◆ residual_norms_history_

template<class TypeTag >

std::vector<std::vector<Scalar> > Opm::NonlinearSystem< TypeTag >::residual_norms_history_

protectedinherited

Referenced by Opm::NonlinearSystemBlackOilReservoir< TypeTag >::popLastConvergenceReport().

◆ simulator_

template<class TypeTag >

Simulator& Opm::NonlinearSystem< TypeTag >::simulator_

protectedinherited

◆ terminal_output_

template<class TypeTag >

bool Opm::NonlinearSystem< TypeTag >::terminal_output_

protectedinherited

Referenced by Opm::NonlinearSystem< TypeTag >::terminalOutputEnabled().

◆ well_model_

template<class TypeTag >

WellModel& Opm::NonlinearSystem< TypeTag >::well_model_

protectedinherited

Referenced by Opm::NonlinearSystem< TypeTag >::wellModel().

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ BVector

◆ ComponentName

◆ FluidSystem

◆ GlobalEqVector

◆ Grid

◆ Indices

◆ ModelParameters

◆ ParentType

◆ Scalar

◆ Simulator

◆ SparseMatrixAdapter

◆ VectorBlockType

◆ WellModel

Constructor & Destructor Documentation

◆ NonlinearSystemCompositional()

Member Function Documentation

◆ addReservoirConvergenceMetrics()

◆ applyTUNING()

◆ applyTUNINGDP()

◆ assembleReservoir() [1/2]

◆ assembleReservoir() [2/2]

◆ beginReportStep()

◆ compNames()

◆ computeFluidInPlace() [1/2]

◆ computeFluidInPlace() [2/2]

◆ convergenceReduction()

◆ domainAccumulatedReports()

◆ endReportStep()

◆ failureReport()

◆ hasNlddSolver()

◆ initialLinearization()

◆ isParallel()

◆ linearIterationsLastSolve()

◆ localAccumulatedReports()

◆ nonlinearIteration()

◆ nonlinearIterationNewton()

◆ numPhases()

◆ param()

◆ popLastStepReport()

◆ prepareSolutionUpdate()

◆ prepareStep()

◆ relativeChange()

◆ shouldStoreSolutionUpdate()

◆ simulator() [1/2]

◆ simulator() [2/2]

◆ solveJacobianSystem()

◆ stepReports()

◆ storeSolutionUpdate()

◆ terminalOutputEnabled()

◆ updateSolution()

◆ updateTUNING()

◆ updateTUNINGDP()

◆ wellModel() [1/2]

◆ wellModel() [2/2]

◆ writeNonlinearIterationsPerCell()

◆ writePartitions()

Member Data Documentation

◆ compNames_

◆ convergence_reports_

◆ current_relaxation_

◆ dx_old_

◆ failureReport_

◆ grid_

◆ numEq

◆ param_

◆ residual_norms_history_

◆ simulator_

◆ terminal_output_

◆ well_model_