Classes
struct	alignment_of

struct	BlockExtractor
	Wrapping struct holding types used for block-level data extraction. More...

struct	Extractor
	Wrapping struct holding types used for element-level data extraction. More...

struct	FlexibleSolverInfo

struct	GpuSolverInfo

struct	InterpData

struct	is_alignment_constant

struct	is_multi_type_block_vector

struct	is_multi_type_block_vector< Dune::MultiTypeBlockVector< Args... > >

struct	max_align

struct	max_count_of

struct	min_size

struct	NoReorderer

struct	offset_object

class	ParallelFileMerger
	A functor that merges multiple files of a parallel run to one file. More...

struct	RealReorderer

struct	Reorderer

struct	VFPEvaluation

Typedefs
template<class K >
using	FMat4 = Dune::FieldMatrix< K, 4, 4 >

template<class M >
using	FieldFunct = std::function< typename M::field_type(const typename M::field_type &)>

Functions
constexpr bool	is_alignment (std::size_t value) noexcept

template<class GridView >
std::size_t	countLocalInteriorCellsGridView (const GridView &gridView)
	Get the number of local interior cells in a grid view. More...

template<class Grid >
std::size_t	countLocalInteriorCells (const Grid &grid)
	Get the number of local interior cells in a grid. More...

template<class Grid >
std::size_t	countGlobalCells (const Grid &grid)
	Get the number of cells of a global grid. More...

void	checkAllMPIProcesses ()

void	mergeParallelLogFiles (std::string_view output_dir, std::string_view deck_filename, bool enableLoggingFalloutWarning)

void	handleExtraConvergenceOutput (const SimulatorReport &report, std::string_view option, std::string_view optionName, std::string_view output_dir, std::string_view base_name)

template<class Scalar >
void	hideUnusedParameters ()
	Hides unused runtime parameters. More...

int	eclPositionalParameter (std::function< void(const std::string &, const std::string &)> addKey, std::set< std::string > &seenParams, std::string &errorMsg, const char **argv, int paramIdx)

template<class Scalar >
void	detectOscillations (const std::vector< std::vector< Scalar > > &residualHistory, const int it, const int numPhases, const Scalar relaxRelTol, const int minimumOscillatingPhases, bool &oscillate, bool &stagnate)
	Detect oscillation or stagnation in a given residual history. More...

template<class BVector , class Scalar >
void	stabilizeNonlinearUpdate (BVector &dx, BVector &dxOld, const Scalar omega, NonlinearRelaxType relaxType)

template<typename... T>
constexpr void	ignoreUnused (T &&...) noexcept
	Utility to silence "unused variable" warnings in lambdas. More...

void	registerSimulatorParameters ()

void	logTuning (const Tuning &tuning)
	Log tuning parameters. More...

template<class Grid , class CartMapper , class W >
void	setWellConnections (const Grid &grid, const CartMapper &cartMapper, const W &wells, const std::unordered_map< std::string, std::set< int > > &possibleFutureConnections, bool useWellConn, std::vector< std::set< int > > &wellGraph, int numJacobiBlocks)
	Find cell IDs for wells contained in local grid. More...

template<class Grid , class Mapper >
void	findOverlapAndInterior (const Grid &grid, const Mapper &mapper, std::vector< int > &overlapRows, std::vector< int > &interiorRows)
	Find the rows corresponding to overlap cells. More...

template<class Grid >
std::size_t	numMatrixRowsToUseInSolver (const Grid &grid, bool ownerFirst)
	If ownerFirst=true, returns the number of interior cells in grid, else just numCells(). More...

void	copyParValues (std::any &parallelInformation, std::size_t size, Dune::OwnerOverlapCopyCommunication< int, int > &comm)
	Copy values in parallel. More...

template<class Matrix >
void	makeOverlapRowsInvalid (Matrix &matrix, const std::vector< int > &overlapRows)

template<class Matrix , class Grid >
std::unique_ptr< Matrix >	blockJacobiAdjacency (const Grid &grid, const std::vector< int > &cell_part, std::size_t nonzeroes, const std::vector< std::set< int > > &wellConnectionsGraph)

template<typename K , int m, int n>
static void	invertMatrix (Dune::FieldMatrix< K, m, n > &matrix)

template<typename K >
static void	invertMatrix (Dune::FieldMatrix< K, 1, 1 > &matrix)

template<typename K >
static void	invertMatrix (Dune::FieldMatrix< K, 2, 2 > &matrix)

template<typename K >
static void	invertMatrix (Dune::FieldMatrix< K, 3, 3 > &matrix)

template<template< class K > class Matrix, typename K >
static K	adjugateMatrix4 (const Matrix< K > &matrix, Matrix< K > &inverse)

template<template< class K > class Matrix, typename K >
static K	invertMatrix4 (const Matrix< K > &matrix, Matrix< K > &inverse)

template<typename K >
static void	invertMatrix (Dune::FieldMatrix< K, 4, 4 > &matrix)

template<typename K >
static void	invertMatrix (Dune::DynamicMatrix< K > &matrix)

template<typename T >
T	identityFunctor (const T &)

template<typename T >
T	oneFunctor (const T &)

template<typename T >
T	signFunctor (const T &)

template<typename T >
T	isPositiveFunctor (const T &)

template<typename T >
T	absFunctor (const T &)

template<typename M >
void	milu0_decomposition (M &A, FieldFunct< M > absFunctor=signFunctor< typename M::field_type >, FieldFunct< M > signFunctor=oneFunctor< typename M::field_type >, std::vector< typename M::block_type > *diagonal=nullptr)

template<class M >
void	milu0_decomposition (M &A, std::vector< typename M::block_type > *diagonal)

template<class M >
void	milun_decomposition (const M &A, int n, MILU_VARIANT milu, M &ILU, Reorderer &ordering, Reorderer &inverseOrdering)

template<class M >
void	ghost_last_bilu0_decomposition (M &A, std::size_t interiorSize)
	Compute Blocked ILU0 decomposition, when we know junk ghost rows are located at the end of A. More...

template<class M , class CRS , class InvVector >
void	convertToCRS (const M &A, CRS &lower, CRS &upper, InvVector &inv)
	compute ILU decomposition of A. A is overwritten by its decomposition More...

template<class PI >
size_t	set_interiorSize (size_t N, size_t interiorSize, const PI &comm)

template<>
size_t	set_interiorSize (size_t N, size_t interiorSize, const Dune::OwnerOverlapCopyCommunication< int, int > &comm)

void	writeJsonToStream (const Opm::PropertyTree &prm, std::ostream &os)
	Write a single property tree in JSON format to the stream. More...

void	writeJsonToStream (const std::vector< Opm::PropertyTree > &prms, std::ostream &os)
	Write a vector of property trees in JSON format to the stream. More...

template<class VectorOrSingle , class Comm >
void	printLinearSolverParameters (const FlowLinearSolverParameters &parameters, const VectorOrSingle &prm, const Comm &comm)
	Print the linear solver parameters to the log if requested. More...

template<class Comm >
void	printLinearSolverParameters (const std::vector< FlowLinearSolverParameters > &parameters, int activeSolverNum, const std::vector< Opm::PropertyTree > &prm, const Comm &comm)
	Print the linear solver parameters to the log if requested. More...

template<class TA , class TB , class TC , class PositiveSign >
static void	multMatrixImpl (const TA &A, const TB &B, TC &ret, const PositiveSign)
	calculates ret = A * B More...

template<class TA , class TB , class TC , class PositiveSign >
static void	multMatrixTransposedImpl (const TA &A, const TB &B, TC &ret, const PositiveSign)

template<class DenseMatrixA , class DenseMatrixB , class DenseMatrixC >
static void	multMatrixTransposed (const DenseMatrixA &A, const DenseMatrixB &B, DenseMatrixC &ret)
	calculates ret = A^T * B More...

template<class DenseMatrixA , class DenseMatrixB , class DenseMatrixC >
static void	negativeMultMatrixTransposed (const DenseMatrixA &A, const DenseMatrixB &B, DenseMatrixC &ret)
	calculates ret = -A^T * B More...

template<class K >
static Dune::DynamicMatrix< K >	multMatrix (const Dune::DynamicMatrix< K > &A, const Dune::DynamicMatrix< K > &B)
	calculates ret = A * B More...

void	logTimer (const AdaptiveSimulatorTimer &substep_timer)

std::set< std::string >	consistentlyFailingWells (const std::vector< StepReport > &sr, bool requireRepeatedFailures)

void	registerAdaptiveParameters ()

std::tuple< TimeStepControlType, std::unique_ptr< TimeStepControlInterface >, bool >	createController (const UnitSystem &unitSystem)

template<class Scalar >
Scalar	pressureAverage (const Scalar pressurePvHydrocarbon, const Scalar pvHydrocarbon, const Scalar pressurePv, const Scalar pv, const bool hydrocarbon)
	Calculates average pressure value. More...

template<class Scalar >
std::vector< Scalar >	pressureAverage (const std::vector< Scalar > &pressurePvHydrocarbon, const std::vector< Scalar > &pvHydrocarbon, const std::vector< Scalar > &pressurePv, const std::vector< Scalar > &pv, const bool hydrocarbon)
	Calculates average pressure value for a vector. More...

template<class Scalar >
VFPEvaluation< Scalar >	operator+ (VFPEvaluation< Scalar > lhs, const VFPEvaluation< Scalar > &rhs)

template<class Scalar >
VFPEvaluation< Scalar >	operator- (VFPEvaluation< Scalar > lhs, const VFPEvaluation< Scalar > &rhs)

template<class Scalar >
VFPEvaluation< Scalar >	operator* (Scalar lhs, const VFPEvaluation< Scalar > &rhs)

template<typename T >
T	getFlo (const VFPProdTable &table, const T &aqua, const T &liquid, const T &vapour)

template<typename T >
T	getFlo (const VFPInjTable &table, const T &aqua, const T &liquid, const T &vapour)

template<typename T >
T	getWFR (const VFPProdTable &table, const T &aqua, const T &liquid, const T &vapour)

template<typename T >
T	getGFR (const VFPProdTable &table, const T &aqua, const T &liquid, const T &vapour)

template<typename T >
const T &	getTable (const std::map< int, std::reference_wrapper< const T > > &tables, int table_id)

template<typename T >
bool	hasTable (const std::map< int, std::reference_wrapper< const T > > &tables, int table_id)

template<typename TYPE , typename TABLE >
TYPE	getType (const TABLE &table)

Variables
template<typename T >
constexpr bool	is_multi_type_block_vector_v = is_multi_type_block_vector<T>::value

Typedef Documentation

◆ FieldFunct

template<class M >

using Opm::detail::FieldFunct = typedef std::function<typename M::field_type(const typename M::field_type&)>

◆ FMat4

template<class K >

using Opm::detail::FMat4 = typedef Dune::FieldMatrix<K,4,4>

Function Documentation

◆ absFunctor()

template<typename T >

T Opm::detail::absFunctor ( const T & )

◆ adjugateMatrix4()

template<template< class K > class Matrix, typename K >

static K Opm::detail::adjugateMatrix4	(	const Matrix< K > &	matrix,
		Matrix< K > &	inverse
	)

inlinestatic

Compute the adjugate of a 4x4 matrix and return its determinant. The inverse of the matrix is the adjugate divided by the determinant.

◆ blockJacobiAdjacency()

template<class Matrix , class Grid >

std::unique_ptr< Matrix > Opm::detail::blockJacobiAdjacency	(	const Grid &	grid,
		const std::vector< int > &	cell_part,
		std::size_t	nonzeroes,
		const std::vector< std::set< int > > &	wellConnectionsGraph
	)

Create sparsity pattern for block-Jacobi matrix based on partitioning of grid. Do not initialize the values, that is done in copyMatToBlockJac()

◆ checkAllMPIProcesses()

void Opm::detail::checkAllMPIProcesses ( )

◆ consistentlyFailingWells()

std::set< std::string > Opm::detail::consistentlyFailingWells	(	const std::vector< StepReport > &	sr,
		bool	requireRepeatedFailures
	)

◆ convertToCRS()

template<class M , class CRS , class InvVector >

void Opm::detail::convertToCRS	(	const M &	A,
		CRS &	lower,
		CRS &	upper,
		InvVector &	inv
	)

compute ILU decomposition of A. A is overwritten by its decomposition

References convertToCRS().

Referenced by convertToCRS(), and Opm::ParallelOverlappingILU0< Matrix, Domain, Range, ParallelInfoT >::update().

◆ copyParValues()

void Opm::detail::copyParValues	(	std::any &	parallelInformation,
		std::size_t	size,
		Dune::OwnerOverlapCopyCommunication< int, int > &	comm
	)

Copy values in parallel.

Referenced by Opm::ISTLSolver< TypeTag >::initialize(), Opm::ISTLSolverTPSA< TypeTag >::initialize(), and Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::ISTLSolverGPUISTL().

◆ countGlobalCells()

template<class Grid >

std::size_t Opm::detail::countGlobalCells ( const Grid & grid )

Get the number of cells of a global grid.

In a parallel run this is the number of cells that a grid would have if the whole grid was stored on one process only.

Template Parameters

Grid	Type of DUNE grid.

Parameters

[in] grid Grid for which to count global cells.

Returns: The global number of cells.

References countLocalInteriorCellsGridView().

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

◆ countLocalInteriorCells()

template<class Grid >

std::size_t Opm::detail::countLocalInteriorCells ( const Grid & grid )

Get the number of local interior cells in a grid.

Template Parameters

Grid	Type of DUNE grid.

Parameters

[in] grid Grid for which to count interior cells.

Returns: The number of interior cells in the partition of the grid stored on this process.

References countLocalInteriorCellsGridView().

◆ countLocalInteriorCellsGridView()

template<class GridView >

std::size_t Opm::detail::countLocalInteriorCellsGridView ( const GridView & gridView )

Get the number of local interior cells in a grid view.

Template Parameters

GridView Type of DUNE grid view.

Parameters

[in] gridView Grid view for which to count the number of interior cells.

Returns: The number of interior cell in the partition of the grid stored on this process.

Referenced by countGlobalCells(), countLocalInteriorCells(), and Opm::EclWriter< TypeTag, OutputModule >::writeInitialFIPReport().

◆ createController()

std::tuple< TimeStepControlType, std::unique_ptr< TimeStepControlInterface >, bool > Opm::detail::createController ( const UnitSystem & unitSystem )

Referenced by Opm::AdaptiveTimeStepping< TypeTag >::init_().

◆ detectOscillations()

template<class Scalar >

void Opm::detail::detectOscillations	(	const std::vector< std::vector< Scalar > > &	residualHistory,
		const int	it,
		const int	numPhases,
		const Scalar	relaxRelTol,
		const int	minimumOscillatingPhases,
		bool &	oscillate,
		bool &	stagnate
	)

Detect oscillation or stagnation in a given residual history.

Referenced by Opm::NonlinearSolver< TypeTag, PhysicalModel >::detectOscillations().

◆ eclPositionalParameter()

int Opm::detail::eclPositionalParameter	(	std::function< void(const std::string &, const std::string &)>	addKey,
		std::set< std::string > &	seenParams,
		std::string &	errorMsg,
		const char **	argv,
		int	paramIdx
	)

Referenced by Opm::FlowProblem< TypeTag >::handlePositionalParameter().

◆ findOverlapAndInterior()

template<class Grid , class Mapper >

void Opm::detail::findOverlapAndInterior	(	const Grid &	grid,
		const Mapper &	mapper,
		std::vector< int > &	overlapRows,
		std::vector< int > &	interiorRows
	)

Find the rows corresponding to overlap cells.

Loop over grid and store cell ids of rows corresponding to overlap cells.

Template Parameters

The	type of the DUNE grid.

Parameters

grid	The grid where we look for overlap cells.
overlapRows	List where overlap rows are stored.
interiorRows	List where overlap rows are stored.

Referenced by Opm::TemperatureModel< TypeTag, enableTempV >::init(), Opm::ISTLSolver< TypeTag >::initialize(), Opm::ISTLSolverTPSA< TypeTag >::initialize(), and Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::ISTLSolverGPUISTL().

◆ getFlo() [1/2]

template<typename T >

T Opm::detail::getFlo	(	const VFPInjTable &	table,
		const T &	aqua,
		const T &	liquid,
		const T &	vapour
	)

Computes the flo parameter according to the flo_type_ for injection tables

Returns: Production rate of oil, gas or liquid.

◆ getFlo() [2/2]

template<typename T >

T Opm::detail::getFlo	(	const VFPProdTable &	table,
		const T &	aqua,
		const T &	liquid,
		const T &	vapour
	)

Computes the flo parameter according to the flo_type_ for production tables

Returns: Production rate of oil, gas or liquid.

◆ getGFR()

template<typename T >

T Opm::detail::getGFR	(	const VFPProdTable &	table,
		const T &	aqua,
		const T &	liquid,
		const T &	vapour
	)

Computes the gfr parameter according to the gfr_type_

Returns: Production rate of oil, gas or liquid.

Referenced by Opm::VFPProperties< Scalar, IndexTraits >::getExplicitGFR().

◆ getTable()

template<typename T >

const T & Opm::detail::getTable	(	const std::map< int, std::reference_wrapper< const T > > &	tables,
		int	table_id
	)

Returns the table from the map if found, or throws an exception

◆ getType()

template<typename TYPE , typename TABLE >

TYPE Opm::detail::getType ( const TABLE & table )

Returns the type variable for FLO/GFR/WFR for production tables

Referenced by Opm::Mpi::detail::Packing< true, T >::pack(), Opm::Mpi::detail::Packing< true, T >::packSize(), and Opm::Mpi::detail::Packing< true, T >::unpack().

◆ getWFR()

template<typename T >

T Opm::detail::getWFR	(	const VFPProdTable &	table,
		const T &	aqua,
		const T &	liquid,
		const T &	vapour
	)

Computes the wfr parameter according to the wfr_type_

Returns: Production rate of oil, gas or liquid.

Referenced by Opm::VFPProperties< Scalar, IndexTraits >::getExplicitWFR().

◆ ghost_last_bilu0_decomposition()

template<class M >

void Opm::detail::ghost_last_bilu0_decomposition	(	M &	A,
		std::size_t	interiorSize
	)

Compute Blocked ILU0 decomposition, when we know junk ghost rows are located at the end of A.

Referenced by Opm::ParallelOverlappingILU0< Matrix, Domain, Range, ParallelInfoT >::update().

◆ handleExtraConvergenceOutput()

void Opm::detail::handleExtraConvergenceOutput	(	const SimulatorReport &	report,
		std::string_view	option,
		std::string_view	optionName,
		std::string_view	output_dir,
		std::string_view	base_name
	)

◆ hasTable()

template<typename T >

bool Opm::detail::hasTable	(	const std::map< int, std::reference_wrapper< const T > > &	tables,
		int	table_id
	)

Check whether we have a table with the table number

◆ hideUnusedParameters()

template<class Scalar >

void Opm::detail::hideUnusedParameters ( )

Hides unused runtime parameters.

◆ identityFunctor()

template<typename T >

T Opm::detail::identityFunctor ( const T & )

◆ ignoreUnused()

template<typename... T>

constexpr void Opm::detail::ignoreUnused ( T && ... )

constexprnoexcept

Utility to silence "unused variable" warnings in lambdas.

◆ invertMatrix() [1/6]

template<typename K >

static void Opm::detail::invertMatrix ( Dune::DynamicMatrix< K > & matrix )

inlinestatic

References invertMatrix4().

Referenced by invertMatrix().

◆ invertMatrix() [2/6]

template<typename K >

static void Opm::detail::invertMatrix ( Dune::FieldMatrix< K, 1, 1 > & matrix )

inlinestatic

References invertMatrix().

◆ invertMatrix() [3/6]

template<typename K >

static void Opm::detail::invertMatrix ( Dune::FieldMatrix< K, 2, 2 > & matrix )

inlinestatic

References invertMatrix().

◆ invertMatrix() [4/6]

template<typename K >

static void Opm::detail::invertMatrix ( Dune::FieldMatrix< K, 3, 3 > & matrix )

inlinestatic

References invertMatrix().

◆ invertMatrix() [5/6]

template<typename K >

static void Opm::detail::invertMatrix ( Dune::FieldMatrix< K, 4, 4 > & matrix )

inlinestatic

◆ invertMatrix() [6/6]

template<typename K , int m, int n>

static void Opm::detail::invertMatrix ( Dune::FieldMatrix< K, m, n > & matrix )

inlinestatic

Referenced by Opm::MatrixBlock< Scalar, n, m >::invert().

◆ invertMatrix4()

template<template< class K > class Matrix, typename K >

static K Opm::detail::invertMatrix4	(	const Matrix< K > &	matrix,
		Matrix< K > &	inverse
	)

inlinestatic

invert 4x4 Matrix without changing the original matrix

The cofactor expansion is used by default. It is branch free and roughly an order of magnitude faster than a pivoted LU at this size, which matters because every diagonal block of the ILU decomposition goes through here.

Its determinant is however the product of the four column scales, so it underflows for blocks whose residuals are insensitive to some of the primary variables - a cell in which a phase is absent or immobile - even though those blocks are perfectly well invertible. Dividing the adjugate by such a determinant is unreliable, so fall back to Dune's invert(), which uses Gaussian elimination with partial pivoting and reports a matrix as singular only when a pivot is exactly zero. Block sizes 5 and above already use that routine.

Referenced by invertMatrix().

◆ is_alignment()

constexpr bool Opm::detail::is_alignment ( std::size_t value )

inlineconstexprnoexcept

Referenced by Opm::aligned_alloc().

◆ isPositiveFunctor()

template<typename T >

T Opm::detail::isPositiveFunctor ( const T & )

◆ logTimer()

void Opm::detail::logTimer ( const AdaptiveSimulatorTimer & substep_timer )

◆ logTuning()

void Opm::detail::logTuning ( const Tuning & tuning )

Log tuning parameters.

Parameters

tuning Tuning values to log

Logs warnings if unsupported values are provided.

Referenced by Opm::SimulatorFullyImplicit< TypeTag >::updateTUNING().

◆ makeOverlapRowsInvalid()

template<class Matrix >

void Opm::detail::makeOverlapRowsInvalid	(	Matrix &	matrix,
		const std::vector< int > &	overlapRows
	)

Zero out off-diagonal blocks on rows corresponding to overlap cells Diagonal blocks on ovelap rows are set to diag(1.0).

Referenced by Opm::ISTLSolver< TypeTag >::initPrepare(), Opm::ISTLSolverTPSA< TypeTag >::initPrepare(), and Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::prepare().

◆ mergeParallelLogFiles()

void Opm::detail::mergeParallelLogFiles	(	std::string_view	output_dir,
		std::string_view	deck_filename,
		bool	enableLoggingFalloutWarning
	)

◆ milu0_decomposition() [1/2]

template<typename M >

void Opm::detail::milu0_decomposition	(	M &	A,
		FieldFunct< M >	absFunctor = `signFunctor< typename M::field_type >`,
		FieldFunct< M >	signFunctor = `oneFunctor< typename M::field_type >`,
		std::vector< typename M::block_type > *	diagonal = `nullptr`
	)

Referenced by milu0_decomposition(), and Opm::ParallelOverlappingILU0< Matrix, Domain, Range, ParallelInfoT >::update().

◆ milu0_decomposition() [2/2]

template<class M >

void Opm::detail::milu0_decomposition	(	M &	A,
		std::vector< typename M::block_type > *	diagonal
	)

References milu0_decomposition().

◆ milun_decomposition()

template<class M >

void Opm::detail::milun_decomposition	(	const M &	A,
		int	n,
		MILU_VARIANT	milu,
		M &	ILU,
		Reorderer &	ordering,
		Reorderer &	inverseOrdering
	)

Referenced by Opm::ParallelOverlappingILU0< Matrix, Domain, Range, ParallelInfoT >::update().

◆ multMatrix()

template<class K >

static Dune::DynamicMatrix< K > Opm::detail::multMatrix	(	const Dune::DynamicMatrix< K > &	A,
		const Dune::DynamicMatrix< K > &	B
	)

inlinestatic

calculates ret = A * B

◆ multMatrixImpl()

template<class TA , class TB , class TC , class PositiveSign >

static void Opm::detail::multMatrixImpl	(	const TA &	A,
		const TB &	B,
		TC &	ret,
		const	PositiveSign
	)

inlinestatic

calculates ret = A * B

◆ multMatrixTransposed()

template<class DenseMatrixA , class DenseMatrixB , class DenseMatrixC >

static void Opm::detail::multMatrixTransposed	(	const DenseMatrixA &	A,
		const DenseMatrixB &	B,
		DenseMatrixC &	ret
	)

inlinestatic

calculates ret = A^T * B

References multMatrixTransposedImpl().

◆ multMatrixTransposedImpl()

template<class TA , class TB , class TC , class PositiveSign >

static void Opm::detail::multMatrixTransposedImpl	(	const TA &	A,
		const TB &	B,
		TC &	ret,
		const	PositiveSign
	)

inlinestatic

calculates ret = sign * (A^T * B) TA, TB, and TC are not necessarily FieldMatrix, but those should follow the Dune::DenseMatrix interface.

Referenced by multMatrixTransposed(), and negativeMultMatrixTransposed().

◆ negativeMultMatrixTransposed()

template<class DenseMatrixA , class DenseMatrixB , class DenseMatrixC >

static void Opm::detail::negativeMultMatrixTransposed	(	const DenseMatrixA &	A,
		const DenseMatrixB &	B,
		DenseMatrixC &	ret
	)

inlinestatic

calculates ret = -A^T * B

References multMatrixTransposedImpl().

◆ numMatrixRowsToUseInSolver()

template<class Grid >

std::size_t Opm::detail::numMatrixRowsToUseInSolver	(	const Grid &	grid,
		bool	ownerFirst
	)

If ownerFirst=true, returns the number of interior cells in grid, else just numCells().

If cells in grid is ordered so that interior/owner cells come before overlap/copy cells, the method returns the number of interior cells numInterior. In the linear solver only the first numInterior rows of the matrix are needed.

Referenced by Opm::ISTLSolver< TypeTag >::initialize(), and Opm::ISTLSolverTPSA< TypeTag >::initialize().

◆ oneFunctor()

template<typename T >

T Opm::detail::oneFunctor ( const T & )

◆ operator*()

template<class Scalar >

VFPEvaluation< Scalar > Opm::detail::operator*	(	Scalar	lhs,
		const VFPEvaluation< Scalar > &	rhs
	)

◆ operator+()

template<class Scalar >

VFPEvaluation< Scalar > Opm::detail::operator+	(	VFPEvaluation< Scalar >	lhs,
		const VFPEvaluation< Scalar > &	rhs
	)

◆ operator-()

template<class Scalar >

VFPEvaluation< Scalar > Opm::detail::operator-	(	VFPEvaluation< Scalar >	lhs,
		const VFPEvaluation< Scalar > &	rhs
	)

◆ pressureAverage() [1/2]

template<class Scalar >

Scalar Opm::detail::pressureAverage	(	const Scalar	pressurePvHydrocarbon,
		const Scalar	pvHydrocarbon,
		const Scalar	pressurePv,
		const Scalar	pv,
		const bool	hydrocarbon
	)

Calculates average pressure value.

◆ pressureAverage() [2/2]

template<class Scalar >

std::vector< Scalar > Opm::detail::pressureAverage	(	const std::vector< Scalar > &	pressurePvHydrocarbon,
		const std::vector< Scalar > &	pvHydrocarbon,
		const std::vector< Scalar > &	pressurePv,
		const std::vector< Scalar > &	pv,
		const bool	hydrocarbon
	)

Calculates average pressure value for a vector.

◆ printLinearSolverParameters() [1/2]

template<class VectorOrSingle , class Comm >

void Opm::detail::printLinearSolverParameters	(	const FlowLinearSolverParameters &	parameters,
		const VectorOrSingle &	prm,
		const Comm &	comm
	)

Print the linear solver parameters to the log if requested.

Parameters

parameters	The linear solver parameters.
prm	The property tree containing the parameters.
comm	The communication object to check if we are on the IO rank.

This function will only print the parameters if the linear_solver_print_json_definition_ flag is set to true in parameters. It will print the prm in JSON format.

Template Parameters

Comm	The type of the communication object, which should support `rank()` method.

References Opm::FlowLinearSolverParameters::linear_solver_print_json_definition_, and writeJsonToStream().

Referenced by Opm::ISTLSolver< TypeTag >::initialize(), Opm::ISTLSolverTPSA< TypeTag >::initialize(), Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::ISTLSolverGPUISTL(), and printLinearSolverParameters().

◆ printLinearSolverParameters() [2/2]

template<class Comm >

void Opm::detail::printLinearSolverParameters	(	const std::vector< FlowLinearSolverParameters > &	parameters,
		int	activeSolverNum,
		const std::vector< Opm::PropertyTree > &	prm,
		const Comm &	comm
	)

Print the linear solver parameters to the log if requested.

Parameters

parameters	The vector of linear solver parameters.
activeSolverNum	The index of the active solver.
prm	The vector property tree containing the parameters.
comm	The communication object to check if we are on the IO rank.

This function will only print the parameters if the linear_solver_print_json_definition_ flag is set to true for the active solver. It will print the prm in JSON format.

Template Parameters

Comm	The type of the communication object, which should support `rank()` method.

References printLinearSolverParameters().

◆ registerAdaptiveParameters()

void Opm::detail::registerAdaptiveParameters ( )

Referenced by Opm::AdaptiveTimeStepping< TypeTag >::registerParameters().

◆ registerSimulatorParameters()

void Opm::detail::registerSimulatorParameters ( )

Referenced by Opm::SimulatorFullyImplicit< TypeTag >::registerParameters().

◆ set_interiorSize() [1/2]

template<>

size_t Opm::detail::set_interiorSize	(	size_t	N,
		size_t	interiorSize,
		const Dune::OwnerOverlapCopyCommunication< int, int > &	comm
	)

◆ set_interiorSize() [2/2]

template<class PI >

size_t Opm::detail::set_interiorSize	(	size_t	N,
		size_t	interiorSize,
		const PI &	comm
	)

Referenced by Opm::ParallelOverlappingILU0< Matrix, Domain, Range, ParallelInfoT >::update().

◆ setWellConnections()

template<class Grid , class CartMapper , class W >

void Opm::detail::setWellConnections	(	const Grid &	grid,
		const CartMapper &	cartMapper,
		const W &	wells,
		const std::unordered_map< std::string, std::set< int > > &	possibleFutureConnections,
		bool	useWellConn,
		std::vector< std::set< int > > &	wellGraph,
		int	numJacobiBlocks
	)

Find cell IDs for wells contained in local grid.

Cell IDs of wells stored in a graph, so it can be used to create an adjacency pattern. Only relevant when the UseWellContribusion option is set to true

Template Parameters

The	type of the DUNE grid.
Well	vector type

Parameters

grid	The grid where we look for overlap cells.
wells	List of wells contained in grid.
useWellConn	Boolean that is true when UseWellContribusion is true
wellGraph	Cell IDs of well cells stored in a graph.

◆ signFunctor()

template<typename T >

T Opm::detail::signFunctor ( const T & )

◆ stabilizeNonlinearUpdate()

template<class BVector , class Scalar >

void Opm::detail::stabilizeNonlinearUpdate	(	BVector &	dx,
		BVector &	dxOld,
		const Scalar	omega,
		NonlinearRelaxType	relaxType
	)

Apply a stabilization to dx, depending on dxOld and relaxation parameters. Implemention for Dune block vectors.

Referenced by Opm::NonlinearSolver< TypeTag, PhysicalModel >::stabilizeNonlinearUpdate().

◆ writeJsonToStream() [1/2]

void Opm::detail::writeJsonToStream	(	const Opm::PropertyTree &	prm,
		std::ostream &	os
	)

inline

Write a single property tree in JSON format to the stream.

Note: Helper function to write a property tree in JSON format to the log.

References Opm::PropertyTree::write_json().

Referenced by printLinearSolverParameters(), and writeJsonToStream().

◆ writeJsonToStream() [2/2]

void Opm::detail::writeJsonToStream	(	const std::vector< Opm::PropertyTree > &	prms,
		std::ostream &	os
	)

inline

Write a vector of property trees in JSON format to the stream.

Note: Helper function to write a property tree in JSON format to the log.

References writeJsonToStream().

Variable Documentation

◆ is_multi_type_block_vector_v

template<typename T >

constexpr bool Opm::detail::is_multi_type_block_vector_v = is_multi_type_block_vector<T>::value

inlineconstexpr

Classes

Typedefs

Functions

Variables

Typedef Documentation

◆ FieldFunct

◆ FMat4

Function Documentation

◆ absFunctor()

◆ adjugateMatrix4()

◆ blockJacobiAdjacency()

◆ checkAllMPIProcesses()

◆ consistentlyFailingWells()

◆ convertToCRS()

◆ copyParValues()

◆ countGlobalCells()

◆ countLocalInteriorCells()

◆ countLocalInteriorCellsGridView()

◆ createController()

◆ detectOscillations()

◆ eclPositionalParameter()

◆ findOverlapAndInterior()

◆ getFlo() [1/2]

◆ getFlo() [2/2]

◆ getGFR()

◆ getTable()

◆ getType()

◆ getWFR()

◆ ghost_last_bilu0_decomposition()

◆ handleExtraConvergenceOutput()

◆ hasTable()

◆ hideUnusedParameters()

◆ identityFunctor()

◆ ignoreUnused()

◆ invertMatrix() [1/6]

◆ invertMatrix() [2/6]

◆ invertMatrix() [3/6]

◆ invertMatrix() [4/6]

◆ invertMatrix() [5/6]

◆ invertMatrix() [6/6]

◆ invertMatrix4()

◆ is_alignment()

◆ isPositiveFunctor()

◆ logTimer()

◆ logTuning()

◆ makeOverlapRowsInvalid()

◆ mergeParallelLogFiles()

◆ milu0_decomposition() [1/2]

◆ milu0_decomposition() [2/2]

◆ milun_decomposition()

◆ multMatrix()

◆ multMatrixImpl()

◆ multMatrixTransposed()

◆ multMatrixTransposedImpl()

◆ negativeMultMatrixTransposed()

◆ numMatrixRowsToUseInSolver()

◆ oneFunctor()

◆ operator*()

◆ operator+()

◆ operator-()

◆ pressureAverage() [1/2]

◆ pressureAverage() [2/2]

◆ printLinearSolverParameters() [1/2]

◆ printLinearSolverParameters() [2/2]

◆ registerAdaptiveParameters()

◆ registerSimulatorParameters()

◆ set_interiorSize() [1/2]

◆ set_interiorSize() [2/2]

◆ setWellConnections()

◆ signFunctor()

◆ stabilizeNonlinearUpdate()

◆ writeJsonToStream() [1/2]

◆ writeJsonToStream() [2/2]

Variable Documentation

◆ is_multi_type_block_vector_v