Black oil model for coupling Flow simulations with TPSA geomechanics. More...

#include <BlackoilModelTPSA.hpp>

Inheritance diagram for Opm::BlackoilModelTPSA< TypeTag >:

Public Types
using	ModelParameters = typename ParentType::ModelParameters

Public Types inherited from Opm::BlackoilModel< TypeTag >
enum	DebugFlags { STRICT = 0, RELAXED = 1, TUNINGDP = 2 }

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

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

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

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

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

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

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

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

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

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

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

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

using	ModelParameters = BlackoilModelParameters< Scalar >

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

using	MatrixBlockType = typename SparseMatrixAdapter::MatrixBlock

using	Mat = typename SparseMatrixAdapter::IstlMatrix

using	BVector = Dune::BlockVector< VectorBlockType >

using	ComponentName = ::Opm::ComponentName< FluidSystem, Indices >

Public Member Functions
	BlackoilModelTPSA (Simulator &simulator, const ModelParameters &param, BlackoilWellModel< TypeTag > &well_model, const bool terminal_output)
	Constructor. More...

template<class NonlinearSolverType >
SimulatorReportSingle	nonlinearIteration (const SimulatorTimerInterface &timer, NonlinearSolverType &nonlinear_solver)
	Perform a nonlinear iteration updating Flow and TPSA geomechanics. More...

template<class NonlinearSolverType >
SimulatorReportSingle	nonlinearIterationFixedStressTPSA (const SimulatorTimerInterface &timer, NonlinearSolverType &nonlinear_solver)
	Perform a nonlinear iteration updating Flow and TPSA geomechanics in a fixed-stress, iterative loop. More...

template<class NonlinearSolverType >
SimulatorReportSingle	nonlinearIterationLaggedTPSA (const SimulatorTimerInterface &timer, NonlinearSolverType &nonlinear_solver)
	Perform a nonlinear iteration updating Flow and TPSA geomechanics in a lagged scheme. More...

bool	solveTpsaEquations ()
	Solve TPSA geomechanics equations. More...

Public Member Functions inherited from Opm::BlackoilModel< TypeTag >
	BlackoilModel (Simulator &simulator, const ModelParameters &param, BlackoilWellModel< TypeTag > &well_model, const bool terminal_output)
	Construct the model. More...

bool	isParallel () const

const EclipseState &	eclState () const

SimulatorReportSingle	prepareStep (const SimulatorTimerInterface &timer)
	Called once before each time step. More...

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

template<class NonlinearSolverType >
SimulatorReportSingle	nonlinearIteration (const SimulatorTimerInterface &timer, NonlinearSolverType &nonlinear_solver)
	Called once per nonlinear iteration. More...

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

SimulatorReportSingle	assembleReservoir (const SimulatorTimerInterface &timer)
	Assemble the residual and Jacobian of the nonlinear system.

Scalar	relativeChange () const

int	linearIterationsLastSolve () const
	Number of linear iterations used in last call to solveJacobianSystem().

double &	linearSolveSetupTime ()

void	solveJacobianSystem (BVector &x)
	Solve the Jacobian system Jx = r where J is the Jacobian and r is the residual. More...

void	updateSolution (const BVector &dx)
	Apply an update to the primary variables.

void	prepareStoringSolutionUpdate ()
	Get solution update vector as a PrimaryVariable.

void	storeSolutionUpdate (const BVector &dx)

MaxSolutionUpdateData	getMaxSolutionUpdate (const std::vector< unsigned > &ixCells)

bool	terminalOutputEnabled () const
	Return true if output to cout is wanted.

std::tuple< Scalar, Scalar >	convergenceReduction (Parallel::Communication comm, const Scalar pvSumLocal, const Scalar numAquiferPvSumLocal, std::vector< Scalar > &R_sum, std::vector< Scalar > &maxCoeff, std::vector< Scalar > &B_avg)

std::pair< Scalar, Scalar >	localConvergenceData (std::vector< Scalar > &R_sum, std::vector< Scalar > &maxCoeff, std::vector< Scalar > &B_avg, std::vector< int > &maxCoeffCell)
	Get reservoir quantities on this process needed for convergence calculations. More...

CnvPvSplitData	characteriseCnvPvSplit (const std::vector< Scalar > &B_avg, const double dt)
	Compute pore-volume/cell count split among "converged", "relaxed converged", "unconverged" cells based on CNV point measures. More...

void	convergencePerCell (const std::vector< Scalar > &B_avg, const double dt, const double tol_cnv, const double tol_cnv_energy)
	Compute the number of Newtons required by each cell in order to satisfy the solution change convergence criteria at the last time step. More...

void	updateTUNING (const Tuning &tuning)

void	updateTUNINGDP (const TuningDp &tuning_dp)

ConvergenceReport	getReservoirConvergence (const double reportTime, const double dt, const int maxIter, std::vector< Scalar > &B_avg, std::vector< Scalar > &residual_norms)

ConvergenceReport	getConvergence (const SimulatorTimerInterface &timer, const int maxIter, std::vector< Scalar > &residual_norms)
	Compute convergence based on total mass balance (tol_mb) and maximum residual mass balance (tol_cnv). More...

int	numPhases () const
	The number of active fluid phases in the model.

template<class T >
std::vector< std::vector< Scalar > >	computeFluidInPlace (const T &, const std::vector< int > &fipnum) const
	Wrapper required due to not following generic API.

std::vector< std::vector< Scalar > >	computeFluidInPlace (const std::vector< int > &) const
	Should not be called.

const Simulator &	simulator () const

Simulator &	simulator ()

const SimulatorReportSingle &	failureReport () const
	return the statistics if the nonlinearIteration() method failed

const SimulatorReport &	localAccumulatedReports () const
	return the statistics of local solves accumulated for this rank

const std::vector< SimulatorReport > &	domainAccumulatedReports () const
	return the statistics of local solves accumulated for each domain on this rank

void	writeNonlinearIterationsPerCell (const std::filesystem::path &odir) const
	Write the number of nonlinear iterations per cell to a file in ResInsight compatible format.

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

void	popLastConvergenceReport ()
	Remove the last convergence report entry and residual norms history entry.

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

BlackoilWellModel< TypeTag > &	wellModel ()
	return the StandardWells object

const BlackoilWellModel< TypeTag > &	wellModel () const

void	beginReportStep ()

void	endReportStep ()

template<class FluidState , class Residual >
void	getMaxCoeff (const unsigned cell_idx, const IntensiveQuantities &intQuants, const FluidState &fs, const Residual &modelResid, const Scalar pvValue, std::vector< Scalar > &B_avg, std::vector< Scalar > &R_sum, std::vector< Scalar > &maxCoeff, std::vector< int > &maxCoeffCell)

const ModelParameters &	param () const
	Returns const reference to model parameters.

const ComponentName &	compNames () const
	Returns const reference to component names.

bool	hasNlddSolver () const
	Returns true if an NLDD solver exists.

Additional Inherited Members
Static Public Attributes inherited from Opm::BlackoilModel< TypeTag >
static constexpr bool	enableSaltPrecipitation = getPropValue<TypeTag, Properties::EnableSaltPrecipitation>()

static constexpr int	numEq = Indices::numEq

static constexpr int	contiSolventEqIdx = Indices::contiSolventEqIdx

static constexpr int	contiZfracEqIdx = Indices::contiZfracEqIdx

static constexpr int	contiPolymerEqIdx = Indices::contiPolymerEqIdx

static constexpr int	contiEnergyEqIdx = Indices::contiEnergyEqIdx

static constexpr int	contiPolymerMWEqIdx = Indices::contiPolymerMWEqIdx

static constexpr int	contiFoamEqIdx = Indices::contiFoamEqIdx

static constexpr int	contiBrineEqIdx = Indices::contiBrineEqIdx

static constexpr int	contiMicrobialEqIdx = Indices::contiMicrobialEqIdx

static constexpr int	contiOxygenEqIdx = Indices::contiOxygenEqIdx

static constexpr int	contiUreaEqIdx = Indices::contiUreaEqIdx

static constexpr int	contiBiofilmEqIdx = Indices::contiBiofilmEqIdx

static constexpr int	contiCalciteEqIdx = Indices::contiCalciteEqIdx

static constexpr int	solventSaturationIdx = Indices::solventSaturationIdx

static constexpr int	zFractionIdx = Indices::zFractionIdx

static constexpr int	polymerConcentrationIdx = Indices::polymerConcentrationIdx

static constexpr int	polymerMoleWeightIdx = Indices::polymerMoleWeightIdx

static constexpr int	temperatureIdx = Indices::temperatureIdx

static constexpr int	foamConcentrationIdx = Indices::foamConcentrationIdx

static constexpr int	saltConcentrationIdx = Indices::saltConcentrationIdx

static constexpr int	microbialConcentrationIdx = Indices::microbialConcentrationIdx

static constexpr int	oxygenConcentrationIdx = Indices::oxygenConcentrationIdx

static constexpr int	ureaConcentrationIdx = Indices::ureaConcentrationIdx

static constexpr int	biofilmVolumeFractionIdx = Indices::biofilmVolumeFractionIdx

static constexpr int	calciteVolumeFractionIdx = Indices::calciteVolumeFractionIdx

Protected Attributes inherited from Opm::BlackoilModel< TypeTag >
Simulator &	simulator_

const Grid &	grid_

ModelParameters	param_

SimulatorReportSingle	failureReport_

BlackoilWellModel< TypeTag > &	well_model_

bool	terminal_output_
	Whether we print something to std::cout.

long int	global_nc_
	The number of cells of the global grid.

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

Scalar	current_relaxation_

BVector	dx_old_

SolutionVector	solUpd_

std::vector< StepReport >	convergence_reports_

ComponentName	compNames_ {}

std::unique_ptr< BlackoilModelNldd< TypeTag > >	nlddSolver_
	Non-linear DD solver.

BlackoilModelConvergenceMonitor< Scalar >	conv_monitor_

Static Protected Attributes inherited from Opm::BlackoilModel< TypeTag >
static constexpr bool	has_solvent_ = getPropValue<TypeTag, Properties::EnableSolvent>()

static constexpr bool	has_extbo_ = getPropValue<TypeTag, Properties::EnableExtbo>()

static constexpr bool	has_polymer_ = getPropValue<TypeTag, Properties::EnablePolymer>()

static constexpr bool	has_polymermw_ = getPropValue<TypeTag, Properties::EnablePolymerMW>()

static constexpr bool	has_energy_ = getPropValue<TypeTag, Properties::EnergyModuleType>() == EnergyModules::FullyImplicitThermal

static constexpr bool	has_foam_ = getPropValue<TypeTag, Properties::EnableFoam>()

static constexpr bool	has_brine_ = getPropValue<TypeTag, Properties::EnableBrine>()

static constexpr bool	has_bioeffects_ = getPropValue<TypeTag, Properties::EnableBioeffects>()

static constexpr bool	has_micp_ = Indices::enableMICP

Detailed Description

template<class TypeTag>
class Opm::BlackoilModelTPSA< TypeTag >

Black oil model for coupling Flow simulations with TPSA geomechanics.

Constructor & Destructor Documentation

◆ BlackoilModelTPSA()

template<class TypeTag >

Opm::BlackoilModelTPSA< TypeTag >::BlackoilModelTPSA	(	Simulator &	simulator,
		const ModelParameters &	param,
		BlackoilWellModel< TypeTag > &	well_model,
		const bool	terminal_output
	)

inlineexplicit

Constructor.

Parameters

simulator	Reference to simulator object
param	Reference to parameters for model
well_model	Refenerence to well model
terminal_output	Bool for terminal output

Member Function Documentation

◆ nonlinearIteration()

template<class TypeTag >

template<class NonlinearSolverType >

SimulatorReportSingle Opm::BlackoilModelTPSA< TypeTag >::nonlinearIteration	(	const SimulatorTimerInterface &	timer,
		NonlinearSolverType &	nonlinear_solver
	)

inline

Perform a nonlinear iteration updating Flow and TPSA geomechanics.

Parameters

timer	Simulation timer
nonlinear_solver	Nonlinear solver type

Returns: Report for simulator performance

Note

Strategies of coupling Flow and TPSA currently implemented:

fixed-stress: fixed-stress algorithm, i.e. iteratively solving Flow and TPSA equations in sequence
lagged: one-way coupling where Flow is solved with TPSA info from previous time step

◆ nonlinearIterationFixedStressTPSA()

template<class TypeTag >

template<class NonlinearSolverType >

SimulatorReportSingle Opm::BlackoilModelTPSA< TypeTag >::nonlinearIterationFixedStressTPSA	(	const SimulatorTimerInterface &	timer,
		NonlinearSolverType &	nonlinear_solver
	)

inline

Perform a nonlinear iteration updating Flow and TPSA geomechanics in a fixed-stress, iterative loop.

Parameters

timer	Simulation timer
nonlinear_solver	Nonlinear solver type

Returns: Report for simulator performance

◆ nonlinearIterationLaggedTPSA()

template<class TypeTag >

template<class NonlinearSolverType >

SimulatorReportSingle Opm::BlackoilModelTPSA< TypeTag >::nonlinearIterationLaggedTPSA	(	const SimulatorTimerInterface &	timer,
		NonlinearSolverType &	nonlinear_solver
	)

inline

Perform a nonlinear iteration updating Flow and TPSA geomechanics in a lagged scheme.

Parameters

iteration	Flow nonlinear iteration
timer	Simulation timer
nonlinear_solver	Nonlinear solver type

Returns: Report for simulator performance

◆ solveTpsaEquations()

template<class TypeTag >

bool Opm::BlackoilModelTPSA< TypeTag >::solveTpsaEquations ( )

inline

Solve TPSA geomechanics equations.

Returns: Bool indicating TPSA convergence

Note: Calls Newton method for TPSA

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

opm/simulators/flow/BlackoilModelTPSA.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class TypeTag> class Opm::BlackoilModelTPSA< TypeTag >

Constructor & Destructor Documentation

◆ BlackoilModelTPSA()

Member Function Documentation

◆ nonlinearIteration()

◆ nonlinearIterationFixedStressTPSA()

◆ nonlinearIterationLaggedTPSA()

◆ solveTpsaEquations()

template<class TypeTag>
class Opm::BlackoilModelTPSA< TypeTag >