Provides a linear solver backend using the parallel algebraic multi-grid (AMG) linear solver from DUNE-ISTL. More...

#include <parallelamgbackend.hh>

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

Public Member Functions
	ParallelAmgBackend (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	BorderListCreator = GetPropType< TypeTag, Properties::BorderListCreator >

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

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

using	SequentialPreconditioner = typename PreconditionerWrapper::SequentialPreconditioner

Protected Member Functions
std::shared_ptr< AMG >	preparePreconditioner_ ()

void	cleanupPreconditioner_ ()

std::shared_ptr< RawLinearSolver >	prepareSolver_ (ParallelOperator &parOperator, ParallelScalarProduct &parScalarProduct, AMG &parPreCond)

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

void	cleanupSolver_ ()

template<class ParallelIndexSet >
void	setupAmgIndexSet_ (const Overlap &overlap, ParallelIndexSet &istlIndices)

template<typename C >
auto	setUseFixedOrder (C criterion, bool booleanValue) -> decltype(criterion.setUseFixedOrder(booleanValue))

template<typename C >
void	setUseFixedOrder (C,...)

void	setupAmg_ ()

Implementation &	asImp_ ()

const Implementation &	asImp_ () const

void	cleanup_ ()

void	writeOverlapToVTK_ ()

Protected Attributes
friend	ParentType

std::unique_ptr< ConvergenceCriterion< OverlappingVector > >	convCrit_

std::shared_ptr< FineOperator >	fineOperator_

std::shared_ptr< AMG >	amg_

std::shared_ptr< OwnerOverlapCopyCommunication >	istlComm_

const Simulator &	simulator_

int	gridSequenceNumber_

size_t	lastIterations_

OverlappingMatrix *	overlappingMatrix_

OverlappingVector *	overlappingb_

OverlappingVector *	overlappingx_

PreconditionerWrapper	precWrapper_

Detailed Description

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

Provides a linear solver backend using the parallel algebraic multi-grid (AMG) linear solver from DUNE-ISTL.

Member Typedef Documentation

◆ BorderListCreator

template<class TypeTag >

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

protectedinherited

◆ Implementation

template<class TypeTag >

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

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

Member Enumeration Documentation

◆ anonymous enum

template<class TypeTag >

anonymous enum

protectedinherited

Enumerator
dimWorld

Constructor & Destructor Documentation

◆ ParallelAmgBackend()

template<class TypeTag >

Opm::Linear::ParallelAmgBackend< TypeTag >::ParallelAmgBackend ( 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::ParallelAmgBackend< TypeTag >::cleanupPreconditioner_ ( )

inlineprotected

◆ cleanupSolver_()

template<class TypeTag >

void Opm::Linear::ParallelAmgBackend< 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< AMG > Opm::Linear::ParallelAmgBackend< TypeTag >::preparePreconditioner_ ( )

inlineprotected

References Opm::Linear::ParallelAmgBackend< TypeTag >::amg_, Opm::Linear::ParallelAmgBackend< TypeTag >::fineOperator_, Opm::Linear::ParallelAmgBackend< TypeTag >::istlComm_, Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingMatrix_, Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmg_(), and Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmgIndexSet_().

◆ prepareSolver_()

template<class TypeTag >

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

inlineprotected

References Opm::Linear::ParallelAmgBackend< TypeTag >::convCrit_, Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingb_, and Opm::Linear::ParallelBaseBackend< TypeTag >::simulator_.

◆ registerParameters()

template<class TypeTag >

static void Opm::Linear::ParallelAmgBackend< TypeTag >::registerParameters ( )

inlinestatic

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

◆ runSolver_()

template<class TypeTag >

std::pair< bool, int > Opm::Linear::ParallelAmgBackend< TypeTag >::runSolver_ ( std::shared_ptr< RawLinearSolver > solver )

inlineprotected

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

◆ setMatrix()

template<class TypeTag >

void Opm::Linear::ParallelBaseBackend< TypeTag >::setMatrix ( const SparseMatrixAdapter & M )

inlineinherited

Sets the values of the residual's Jacobian matrix.

This method also synchronizes the data structure across the processes which are involved in the simulation run.

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

◆ setResidual()

template<class TypeTag >

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

inlineinherited

Assign values to the internal data structure for the residual vector.

This method also cares about synchronizing that vector with the peer processes.

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

◆ setupAmg_()

template<class TypeTag >

void Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmg_ ( )

inlineprotected

References Opm::Linear::ParallelAmgBackend< TypeTag >::amg_, Opm::Linear::ParallelAmgBackend< TypeTag >::fineOperator_, Opm::Linear::ParallelAmgBackend< TypeTag >::istlComm_, Opm::Linear::ParallelAmgBackend< TypeTag >::setUseFixedOrder(), and Opm::Linear::ParallelBaseBackend< TypeTag >::simulator_.

Referenced by Opm::Linear::ParallelAmgBackend< TypeTag >::preparePreconditioner_().

◆ setupAmgIndexSet_()

template<class TypeTag >

template<class ParallelIndexSet >

void Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmgIndexSet_	(	const Overlap &	overlap,
		ParallelIndexSet &	istlIndices
	)

inlineprotected

Referenced by Opm::Linear::ParallelAmgBackend< TypeTag >::preparePreconditioner_().

◆ setUseFixedOrder() [1/2]

template<class TypeTag >

template<typename C >

auto Opm::Linear::ParallelAmgBackend< TypeTag >::setUseFixedOrder	(	C	criterion,
		bool	booleanValue
	)		-> decltype(criterion.setUseFixedOrder(booleanValue))

inlineprotected

Referenced by Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmg_().

◆ setUseFixedOrder() [2/2]

template<class TypeTag >

template<typename C >

void Opm::Linear::ParallelAmgBackend< TypeTag >::setUseFixedOrder	(	C	,
			...
	)

inlineprotected

◆ solve()

template<class TypeTag >

bool Opm::Linear::ParallelBaseBackend< TypeTag >::solve ( Vector & x )

inlineinherited

Actually solve the linear system of equations.

Returns: true if the residual reduction could be achieved, else false.

References Opm::Linear::ParallelBaseBackend< TypeTag >::asImp_(), Opm::Linear::ParallelBaseBackend< TypeTag >::lastIterations_, Opm::make_guard(), Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingMatrix_, and Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingx_.

◆ writeOverlapToVTK_()

template<class TypeTag >

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

inlineprotectedinherited

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

Member Data Documentation

◆ amg_

template<class TypeTag >

std::shared_ptr<AMG> Opm::Linear::ParallelAmgBackend< TypeTag >::amg_

protected

Referenced by Opm::Linear::ParallelAmgBackend< TypeTag >::preparePreconditioner_(), and Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmg_().

◆ convCrit_

template<class TypeTag >

std::unique_ptr<ConvergenceCriterion<OverlappingVector> > Opm::Linear::ParallelAmgBackend< TypeTag >::convCrit_

protected

Referenced by Opm::Linear::ParallelAmgBackend< TypeTag >::prepareSolver_().

◆ fineOperator_

template<class TypeTag >

std::shared_ptr<FineOperator> Opm::Linear::ParallelAmgBackend< TypeTag >::fineOperator_

protected

Referenced by Opm::Linear::ParallelAmgBackend< TypeTag >::preparePreconditioner_(), and Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmg_().

◆ gridSequenceNumber_

template<class TypeTag >

int Opm::Linear::ParallelBaseBackend< TypeTag >::gridSequenceNumber_

protectedinherited

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

◆ istlComm_

template<class TypeTag >

std::shared_ptr<OwnerOverlapCopyCommunication> Opm::Linear::ParallelAmgBackend< TypeTag >::istlComm_

protected

Referenced by Opm::Linear::ParallelAmgBackend< TypeTag >::preparePreconditioner_(), and Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmg_().

◆ lastIterations_

template<class TypeTag >

size_t Opm::Linear::ParallelBaseBackend< TypeTag >::lastIterations_

protectedinherited

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

◆ overlappingb_

template<class TypeTag >

OverlappingVector* Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingb_

protectedinherited

Referenced by Opm::Linear::ParallelBaseBackend< TypeTag >::cleanup_(), Opm::Linear::ParallelBaseBackend< TypeTag >::getResidual(), Opm::Linear::ParallelBaseBackend< TypeTag >::ParallelBaseBackend(), Opm::Linear::ParallelBaseBackend< TypeTag >::prepare(), Opm::Linear::ParallelAmgBackend< TypeTag >::prepareSolver_(), Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >::prepareSolver_(), Opm::Linear::ParallelIstlSolverBackend< TypeTag >::runSolver_(), and Opm::Linear::ParallelBaseBackend< TypeTag >::setResidual().

◆ overlappingMatrix_

template<class TypeTag >

OverlappingMatrix* Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingMatrix_

protectedinherited

◆ overlappingx_

template<class TypeTag >

OverlappingVector* Opm::Linear::ParallelBaseBackend< TypeTag >::overlappingx_

protectedinherited

Referenced by Opm::Linear::ParallelBaseBackend< TypeTag >::cleanup_(), Opm::Linear::ParallelBaseBackend< TypeTag >::ParallelBaseBackend(), Opm::Linear::ParallelBaseBackend< TypeTag >::prepare(), Opm::Linear::ParallelAmgBackend< TypeTag >::runSolver_(), Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >::runSolver_(), Opm::Linear::ParallelIstlSolverBackend< TypeTag >::runSolver_(), and Opm::Linear::ParallelBaseBackend< TypeTag >::solve().

◆ ParentType

template<class TypeTag >

friend Opm::Linear::ParallelAmgBackend< TypeTag >::ParentType

protected

◆ precWrapper_

template<class TypeTag >

PreconditionerWrapper Opm::Linear::ParallelBaseBackend< TypeTag >::precWrapper_

protectedinherited

Referenced by Opm::Linear::ParallelBaseBackend< TypeTag >::cleanupPreconditioner_(), and Opm::Linear::ParallelBaseBackend< TypeTag >::preparePreconditioner_().

◆ simulator_

template<class TypeTag >

const Simulator& Opm::Linear::ParallelBaseBackend< TypeTag >::simulator_

protectedinherited

Referenced by Opm::Linear::ParallelBaseBackend< TypeTag >::prepare(), Opm::Linear::ParallelBaseBackend< TypeTag >::preparePreconditioner_(), Opm::Linear::ParallelAmgBackend< TypeTag >::prepareSolver_(), Opm::Linear::ParallelBiCGStabSolverBackend< TypeTag >::prepareSolver_(), Opm::Linear::ParallelAmgBackend< TypeTag >::setupAmg_(), and Opm::Linear::ParallelBaseBackend< TypeTag >::writeOverlapToVTK_().

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

parallelamgbackend.hh

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BorderListCreator

◆ Implementation

◆ OverlappingMatrix

◆ PreconditionerWrapper

◆ SequentialPreconditioner

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ParallelAmgBackend()

Member Function Documentation

◆ asImp_() [1/2]

◆ asImp_() [2/2]

◆ cleanup_()

◆ cleanupPreconditioner_()

◆ cleanupSolver_()

◆ eraseMatrix()

◆ getResidual()

◆ iterations()

◆ prepare()

◆ preparePreconditioner_()

◆ prepareSolver_()

◆ registerParameters()

◆ runSolver_()

◆ setMatrix()

◆ setResidual()

◆ setupAmg_()

◆ setupAmgIndexSet_()

◆ setUseFixedOrder() [1/2]

◆ setUseFixedOrder() [2/2]

◆ solve()

◆ writeOverlapToVTK_()

Member Data Documentation

◆ amg_

◆ convCrit_

◆ fineOperator_

◆ gridSequenceNumber_

◆ istlComm_

◆ lastIterations_

◆ overlappingb_

◆ overlappingMatrix_

◆ overlappingx_

◆ ParentType

◆ precWrapper_

◆ simulator_