ISTLSolParams Class Reference

Class for ISTL solver parameters. More...

#include <ISTLSolParams.h>

Collaboration diagram for ISTLSolParams:

Public Member Functions
	ISTLSolParams (const LinSolParams &spar, const ProcessAdm &padm)
	Constructor. More...
std::tuple< std::unique_ptr< ISTL::InverseOperator >, std::unique_ptr< ISTL::Preconditioner >, std::unique_ptr< ISTL::Operator > >	setupPC (ISTL::Mat &A)
	Setup solver and preconditioner. More...
const LinSolParams &	get () const
	Obtain linear solver parameters.

Protected Member Functions
ISTL::Preconditioner *	setupPCInternal (ISTL::Mat &A, ISTL::Operator &op, size_t block, std::unique_ptr< ISTL::InverseOperator > *solver)
	Internal helper function for setting up a preconditioner. More...

Protected Attributes
const LinSolParams &	solParams
	Reference to linear solver parameters.
const ProcessAdm &	adm
	Reference to process administrator.

Detailed Description

Class for ISTL solver parameters.

It contains information about solver method, preconditioner and convergence criteria.

Constructor & Destructor Documentation

ISTLSolParams()

ISTLSolParams::ISTLSolParams ( const LinSolParams &  spar, const ProcessAdm &  padm  )

inline

Constructor.

Parameters

spar	Linear solver parameters to use
padm	Process administrator to use

Member Function Documentation

setupPC()

std::tuple< std::unique_ptr< ISTL::InverseOperator >, std::unique_ptr< ISTL::Preconditioner >, std::unique_ptr< ISTL::Operator > > ISTLSolParams::setupPC

(

ISTL::Mat &

A

)

Setup solver and preconditioner.

Parameters

A	Matrix to use

Returns

tuple with (solver, preconditioner, op)

References adm, ProcessAdm::dd, ISTL::BlockPreconditioner::getBlock(), ISTL::BlockPreconditioner::getBlockOp(), ISTL::BlockPreconditioner::getBlockPre(), DomainDecomposition::getGlobalEq(), DomainDecomposition::getMLGEQ(), DomainDecomposition::getNoBlocks(), LinSolParams::getNoBlocks(), SettingMap::getStringValue(), ProcessAdm::isParallel(), setupPCInternal(), setupWithPreType(), and solParams.

Referenced by ISTLMatrix::solve().

setupPCInternal()

ISTL::Preconditioner * ISTLSolParams::setupPCInternal ( ISTL::Mat &  A, ISTL::Operator &  op, size_t  block, std::unique_ptr< ISTL::InverseOperator > *  solver  )

protected

Internal helper function for setting up a preconditioner.

Parameters

A	Matrix to construct preconditioner for
op	Matrix adaptor to use (used with AMG)
block	Block to read settings from
solver	Solver object to instance. nullptr to do nothing.

References adm, ProcessAdm::dd, LinSolParams::getBlock(), SettingMap::getIntValue(), ProcessAdm::getNoProcs(), SettingMap::getStringValue(), DomainDecomposition::getSubdomains(), setupAMG2(), setupSolver(), and solParams.

Referenced by setupPC().

---

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

• src/LinAlg/ISTLSolParams.h
• src/LinAlg/ISTLSolParams.C