Implements a generic linear solver abstraction. More...

#include <parallelbicgstabbackend.hh>

Inheritance diagram for Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >:

Public Member Functions
	ParallelBiCGStabSolverBackend (const Simulator &simulator)

void	eraseMatrix ()
	Causes the solve() method to discared the structure of the linear system of equations the next time it is called. More...

void	prepare (const SparseMatrixAdapter &M, const Vector &)
	Set up the internal data structures required for the linear solver. More...

void	setResidual (const Vector &b)
	Assign values to the internal data structure for the residual vector. More...

void	getResidual (Vector &b) const
	Retrieve the synchronized internal residual vector. More...

void	setMatrix (const SparseMatrixAdapter &M)
	Sets the values of the residual's Jacobian matrix. More...

bool	solve (Vector &x)
	Actually solve the linear system of equations. More...

size_t	iterations () const
	Return number of iterations used during last solve. More...

Static Public Member Functions
static void	registerParameters ()

Protected Types
enum	{ dimWorld = GridView::dimensionworld }

using	Implementation = GetPropType< TypeTag, Properties::LinearSolverBackend >

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

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

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

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

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

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

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

using	SequentialPreconditioner = typename PreconditionerWrapper::SequentialPreconditioner

Protected Member Functions
std::shared_ptr< RawLinearSolver >	prepareSolver_ (ParallelOperator &parOperator, ParallelScalarProduct &parScalarProduct, ParallelPreconditioner &parPreCond)

std::pair< bool, int >	runSolver_ (std::shared_ptr< RawLinearSolver > solver)

void	cleanupSolver_ ()

Implementation &	asImp_ ()

const Implementation &	asImp_ () const

void	cleanup_ ()

std::shared_ptr< ParallelPreconditioner >	preparePreconditioner_ ()

void	cleanupPreconditioner_ ()

void	writeOverlapToVTK_ ()

Protected Attributes
friend	ParentType

std::unique_ptr< ConvergenceCriterion< OverlappingVector > >	convCrit_

const Simulator &	simulator_

int	gridSequenceNumber_

size_t	lastIterations_

OverlappingMatrix *	overlappingMatrix_

OverlappingVector *	overlappingb_

OverlappingVector *	overlappingx_

PreconditionerWrapper	precWrapper_

Detailed Description

template<class TypeTag>
class Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >

Implements a generic linear solver abstraction.

Chosing the preconditioner works by setting the "PreconditionerWrapper" property:

template<class TypeTag>
struct PreconditionerWrapper<TypeTag, TTag::YourTypeTag>
{ using type = Opm::Linear::PreconditionerWrapper$PRECONDITIONER<TypeTag>; };

Where the choices possible for '$PRECONDITIONER' are:

Jacobi: A Jacobi preconditioner
GaussSeidel: A Gauss-Seidel preconditioner
SSOR: A symmetric successive overrelaxation (SSOR) preconditioner
SOR: A successive overrelaxation (SOR) preconditioner
ILUn: An ILU(n) preconditioner
ILU0: An ILU(0) preconditioner. The results of this preconditioner are the same as setting the PreconditionerOrder property to 0 and using the ILU(n) preconditioner. The reason for the existence of ILU0 is that it is computationally cheaper because it does not need to consider things which are only required for higher orders

Member Typedef Documentation

◆ BorderListCreator

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::BorderListCreator = GetPropType<TypeTag, Properties::BorderListCreator>

protectedinherited

◆ GridView

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::GridView = GetPropType<TypeTag, Properties::GridView>

protectedinherited

◆ Implementation

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::Implementation = GetPropType<TypeTag, Properties::LinearSolverBackend>

protectedinherited

◆ LinearSolverScalar

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::LinearSolverScalar = GetPropType<TypeTag, Properties::LinearSolverScalar>

protectedinherited

◆ Overlap

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::Overlap = GetPropType<TypeTag, Properties::Overlap>

protectedinherited

◆ OverlappingMatrix

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::OverlappingMatrix = GetPropType<TypeTag, Properties::OverlappingMatrix>

protectedinherited

◆ PreconditionerWrapper

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::PreconditionerWrapper = GetPropType<TypeTag, Properties::PreconditionerWrapper>

protectedinherited

◆ SequentialPreconditioner

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::SequentialPreconditioner = typename PreconditionerWrapper::SequentialPreconditioner

protectedinherited

◆ Vector

template<class TypeTag >

using Opm::Linear::ParallelBaseBackend< TypeTag >::Vector = GetPropType<TypeTag, Properties::GlobalEqVector>

protectedinherited

Member Enumeration Documentation

◆ anonymous enum

template<class TypeTag >

anonymous enum

protectedinherited

Enumerator
dimWorld

Constructor & Destructor Documentation

◆ ParallelBiCGStabSolverBackend()

template<class TypeTag >

Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >::ParallelBiCGStabSolverBackend ( const Simulator & simulator )

inline

Member Function Documentation

◆ asImp_() [1/2]

template<class TypeTag >

Implementation & Opm::Linear::ParallelBaseBackend< TypeTag >::asImp_ ( )

inlineprotectedinherited

Referenced by Opm::Linear::ParallelBaseBackend< TypeTag >::prepare(), and Opm::Linear::ParallelBaseBackend< TypeTag >::solve().

◆ asImp_() [2/2]

template<class TypeTag >

const Implementation & Opm::Linear::ParallelBaseBackend< TypeTag >::asImp_ ( ) const

inlineprotectedinherited

◆ cleanup_()

template<class TypeTag >

void Opm::Linear::ParallelBaseBackend< TypeTag >::cleanup_ ( )

inlineprotectedinherited

References Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingb_, Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingMatrix_, and Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingx_.

Referenced by Opm::Linear::ParallelBaseBackend< TypeTag >::eraseMatrix(), and Opm::Linear::ParallelBaseBackend< TypeTag >::~ParallelBaseBackend().

◆ cleanupPreconditioner_()

template<class TypeTag >

void Opm::Linear::ParallelBaseBackend< TypeTag >::cleanupPreconditioner_ ( )

inlineprotectedinherited

References Opm::Linear::ParallelBaseBackend< TypeTag >::precWrapper_.

◆ cleanupSolver_()

template<class TypeTag >

void Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >::cleanupSolver_ ( )

inlineprotected

◆ eraseMatrix()

template<class TypeTag >

void Opm::Linear::ParallelBaseBackend< TypeTag >::eraseMatrix ( )

inlineinherited

Causes the solve() method to discared the structure of the linear system of equations the next time it is called.

References Opm::Linear::ParallelBaseBackend< TypeTag >::cleanup_().

◆ getResidual()

template<class TypeTag >

void Opm::Linear::ParallelBaseBackend< TypeTag >::getResidual ( Vector & b ) const

inlineinherited

Retrieve the synchronized internal residual vector.

This only deals with entries which are local to the current process.

References Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingb_.

◆ iterations()

template<class TypeTag >

size_t Opm::Linear::ParallelBaseBackend< TypeTag >::iterations ( ) const

inlineinherited

Return number of iterations used during last solve.

References Opm::Linear::ParallelBaseBackend< TypeTag >::lastIterations_.

◆ prepare()

template<class TypeTag >

void Opm::Linear::ParallelBaseBackend< TypeTag >::prepare	(	const SparseMatrixAdapter &	M,
		const Vector &
	)

inlineinherited

Set up the internal data structures required for the linear solver.

This only specified the topology of the linear system of equations; it does does not assign the values of the residual vector and its Jacobian matrix.

References Opm::Linear::ParallelBaseBackend< TypeTag >::asImp_(), Opm::Linear::ParallelBaseBackend< TypeTag >::gridSequenceNumber_, Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingb_, Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingMatrix_, Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingx_, and Opm::Linear::ParallelBaseBackend< TypeTag >::simulator_.

◆ preparePreconditioner_()

template<class TypeTag >

std::shared_ptr< ParallelPreconditioner > Opm::Linear::ParallelBaseBackend< TypeTag >::preparePreconditioner_ ( )

inlineprotectedinherited

References Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingMatrix_, Opm::Linear::ParallelBaseBackend< TypeTag >::precWrapper_, and Opm::Linear::ParallelBaseBackend< TypeTag >::simulator_.

◆ prepareSolver_()

template<class TypeTag >

std::shared_ptr< RawLinearSolver > Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >::prepareSolver_	(	ParallelOperator &	parOperator,
		ParallelScalarProduct &	parScalarProduct,
		ParallelPreconditioner &	parPreCond
	)