#include <PetscKrylovSolver.h>

Inheritance diagram for AMP::Solver::PetscKrylovSolver:

Public Types
typedef std::shared_ptr< AMP::Solver::SolverStrategy >	shared_ptr

enum class	SolverStatus { ConvergedOnAbsTol , ConvergedOnRelTol , ConvergedUserCondition , MaxIterations , DivergedLineSearch , DivergedStepSize , DivergedFunctionCount , DivergedOnNan , DivergedNestedSolver , DivergedOther }

Public Member Functions
void	apply (std::shared_ptr< const AMP::LinearAlgebra::Vector > f, std::shared_ptr< AMP::LinearAlgebra::Vector > u) override

AMP::Scalar	getAbsoluteTolerance () const

bool	getConverged (void) const

SolverStatus	getConvergenceStatus (void) const

std::string	getConvergenceStatusString (void) const

int	getDebugPrintInfoLevel (void)

AMP::Utilities::ExecutionSpace	getExecutionSpace () const

std::shared_ptr< AMP::LinearAlgebra::Vector >	getFunctionScaling ()

virtual AMP::Scalar	getInitialResidual (void) const

virtual const std::vector< int > &	getIterationHistory (void)

virtual int	getIterations (void) const

KSP	getKrylovSolver (void)

int	getMaxIterations (void) const

virtual std::shared_ptr< SolverStrategy >	getNestedSolver (void)

virtual std::shared_ptr< AMP::Operator::Operator >	getOperator (void)

AMP::Scalar	getRelativeTolerance () const

virtual AMP::Scalar	getResidualNorm (void) const

std::shared_ptr< AMP::LinearAlgebra::Vector >	getSolutionScaling ()

int	getTotalNumberOfIterations (void)

void	initialize (std::shared_ptr< const SolverStrategyParameters > parameters) override

	PetscKrylovSolver ()

	PetscKrylovSolver (std::shared_ptr< SolverStrategyParameters > parameters)

virtual void	print (std::ostream &)

virtual void	printConvergenceStatus (SolverStrategy::SolverStatus, std::ostream &=AMP::pout) const

virtual void	printStatistics (std::ostream &os=AMP::pout)

void	registerOperator (std::shared_ptr< AMP::Operator::Operator > op) override

virtual void	registerWriter (std::shared_ptr< AMP::IO::Writer > writer)
	Registers a writer with the solver.

void	reset (std::shared_ptr< AMP::Solver::SolverStrategyParameters >) override

virtual void	reset (std::shared_ptr< SolverStrategyParameters > parameters)

void	resetOperator (std::shared_ptr< const AMP::Operator::OperatorParameters > parameters) override

virtual void	residual (std::shared_ptr< const AMP::LinearAlgebra::Vector > f, std::shared_ptr< const AMP::LinearAlgebra::Vector > u, std::shared_ptr< AMP::LinearAlgebra::Vector > r)

virtual void	setAbsoluteTolerance (AMP::Scalar abs_tol)

void	setComponentScalings (std::shared_ptr< AMP::LinearAlgebra::Vector > s, std::shared_ptr< AMP::LinearAlgebra::Vector > f)
	for multiphysics problems it may be necessary to scale the solution

virtual void	setDebugPrintInfoLevel (int print_level)

void	setExecutionSpace (AMP::Utilities::ExecutionSpace space)

virtual void	setInitialGuess (std::shared_ptr< AMP::LinearAlgebra::Vector > initialGuess)

void	setIsNestedSolver (bool is_nested)
	Tell a solver that it is nested inside some outer solver.

void	setKrylovSolver (KSP *ksp)

virtual void	setMaxIterations (const int max_iterations)

virtual void	setNestedSolver (std::shared_ptr< SolverStrategy > solver)

virtual void	setRelativeTolerance (AMP::Scalar rel_tol)

void	setZeroInitialGuess (bool use_zero_guess) override

std::string	type () const override
	Return the name of the solver.

bool	usesPreconditioner (void)

virtual	~PetscKrylovSolver ()

Static Public Member Functions
static std::unique_ptr< SolverStrategy >	createSolver (std::shared_ptr< SolverStrategyParameters > solverStrategyParameters)
	static create routine that is used by SolverFactory

static std::string	statusToString (SolverStatus status)

Protected Member Functions
virtual bool	checkStoppingCriteria (AMP::Scalar res_norm, bool check_iters=true)

std::shared_ptr< AMP::Operator::Operator >	createPCOperator ()

void	getBaseFromInput (std::shared_ptr< AMP::Database > db)

void	getFromInput (std::shared_ptr< AMP::Database > db)

void	initializePreconditioner (std::shared_ptr< const SolverStrategyParameters > parameters)

void	setupPetscMatInterface (std::shared_ptr< AMP::Operator::Operator > op, Mat &mat)

Protected Attributes
bool	d_bComputeResidual = false

bool	d_bIsNestedSolver = false

bool	d_bUseZeroInitialGuess = true

SolverStatus	d_ConvergenceStatus = SolverStatus::DivergedOther

AMP::Scalar	d_dAbsoluteTolerance = 1.0e-14

std::shared_ptr< AMP::Database >	d_db = nullptr

AMP::Scalar	d_dInitialResidual

AMP::Scalar	d_dRelativeTolerance = 1.0e-09

AMP::Scalar	d_dResidualNorm

AMP::Utilities::ExecutionSpace	d_exec_space = AMP::Utilities::ExecutionSpace::unspecified
	execution space for the solver

std::shared_ptr< AMP::Database >	d_global_db = nullptr

int	d_iDebugPrintInfoLevel = 0

int	d_iMaxIterations = 0

int	d_iNumberIterations = 0

int	d_iObjectId

std::vector< int >	d_iterationHistory
	keeps track of iteration statistics over solver lifetime

AMP::Utilities::MemoryType	d_memory_location = AMP::Utilities::MemoryType::none
	memory storage address space

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_pFunctionScaling

std::shared_ptr< AMP::Solver::SolverStrategy >	d_pNestedSolver = nullptr
	nested solver used by this solver

std::shared_ptr< AMP::Operator::Operator >	d_pOperator = nullptr

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_pSolutionScaling

std::string	d_sName

std::shared_ptr< AMP::IO::Writer >	d_writer = nullptr

Static Protected Attributes
static int	d_iInstanceId

Static Private Member Functions
static PetscErrorCode	applyPreconditioner (PC pc, Vec r, Vec z)

static PetscErrorCode	matVec (Mat mat, Vec x, Vec y)

static PetscErrorCode	setupPreconditioner (PC pc)

Private Attributes
bool	d_bKSPCreatedInternally

bool	d_bMatrixFree = false

bool	d_bUsesPreconditioner = false

AMP_MPI	d_comm

double	d_dDivergenceTolerance

int	d_iMaxKrylovDimension

KSP	d_KrylovSolver

std::string	d_KSPAppendOptionsPrefix

Mat	d_Mat

std::string	d_PcSide

std::shared_ptr< PetscMonitor >	d_PetscMonitor

std::string	d_sGmresOrthogonalizationAlgorithm

std::string	d_sKspType

std::string	d_sPcType

Detailed Description

The PetscKrylovSolver class is a wrapper to the PETSc KSP Krylov solver which provides implementations of Krylov methods. Currently the wrapper has only been tested with the GMRES and FGMRES Krylov methods provided by PETSc.

Definition at line 25 of file PetscKrylovSolver.h.

Member Typedef Documentation

◆ shared_ptr

typedef std::shared_ptr<AMP::Solver::SolverStrategy> AMP::Solver::SolverStrategy::shared_ptr

inherited

Definition at line 30 of file SolverStrategy.h.

Member Enumeration Documentation

◆ SolverStatus

enum class AMP::Solver::SolverStrategy::SolverStatus

stronginherited

Enumerator
ConvergedOnAbsTol
ConvergedOnRelTol
ConvergedUserCondition
MaxIterations
DivergedLineSearch
DivergedStepSize
DivergedFunctionCount
DivergedOnNan
DivergedNestedSolver
DivergedOther

Definition at line 62 of file SolverStrategy.h.

Constructor & Destructor Documentation

◆ PetscKrylovSolver() [1/2]

AMP::Solver::PetscKrylovSolver::PetscKrylovSolver ( )

default constructor, currently only sets a boolean flag d_bKSPCreatedInternally = false

◆ PetscKrylovSolver() [2/2]

AMP::Solver::PetscKrylovSolver::PetscKrylovSolver ( std::shared_ptr< SolverStrategyParameters > parameters )

explicit

main constructor

Parameters

[in] parameters The parameters object contains a database objects containing the following fields:

type: string KSPOptions, optional, default value "", can be used to set KSP solver parameters expected by PETSc, preferred way of passing parameters to PETSc
type: string, name : ksp_type, default value "fgmres" acceptable values ("fgmres", "gmres")
type: double, name : relative_tolerance, default value of $1.0e-9$, relative tolerance for KSP solver acceptable values (non-negative real values)
type: double, name : absolute_tolerance, default value of $1.0e-14$, absolute tolerance for KSP solver acceptable values (non-negative real values)
type: double, name : divergence_tolerance, default value of $1.0e3$, divergence tolerance for KSP solver acceptable values (non-negative real values)
type: string, name : KSPAppendOptionsPrefix, default value "", used to append options for KSP solver acceptable values ()
type: integer, name : max_krylov_dimension, default value $20$, maximum dimension of Krylov space, acceptable values (integer values grater than or equal to 1) active only when ksp_type is "fgmres" or "gmres"
type: string, name : gmres_orthogonalization_algorithm, default value "modifiedgramschmidt", acceptable values ("modifiedgramschmidt", ) active only when ksp_type is "fgmres" or "gmres"
type: bool, name : uses_preconditioner, default value false acceptable values (false, true), side effect: if false sets string pc_type to "none"
type: string, name : pc_type, default "none", acceptable values ("none", "shell", see PETSc documentation for acceptable PETSc values) active only when uses_preconditioner set to true
type: string, name : pc_side, default value "RIGHT", acceptable values ("RIGHT", "LEFT", "SYMMETRIC" ) active only when uses_preconditioner set to true

◆ ~PetscKrylovSolver()

virtual AMP::Solver::PetscKrylovSolver::~PetscKrylovSolver ( )

virtual

Default destructor. Currently destroys the PETSc KSP object if it was created internally.

Member Function Documentation

◆ apply()

void AMP::Solver::PetscKrylovSolver::apply	(	std::shared_ptr< const AMP::LinearAlgebra::Vector >	f,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	u
	)

overridevirtual

Solve the system $Au = 0$.

Parameters

[in]	f	: shared pointer to right hand side vector
[out]	u	: shared pointer to approximate computed solution

Implements AMP::Solver::SolverStrategy.

◆ applyPreconditioner()

static PetscErrorCode AMP::Solver::PetscKrylovSolver::applyPreconditioner	(	PC	pc,
		Vec	r,
		Vec	z
	)

staticprivate

◆ checkStoppingCriteria()

virtual bool AMP::Solver::SolverStrategy::checkStoppingCriteria	(	AMP::Scalar	res_norm,
		bool	check_iters = `true`
	)

protectedvirtualinherited

◆ createPCOperator()

std::shared_ptr< AMP::Operator::Operator > AMP::Solver::PetscKrylovSolver::createPCOperator ( )

protected

◆ createSolver()

static std::unique_ptr< SolverStrategy > AMP::Solver::PetscKrylovSolver::createSolver ( std::shared_ptr< SolverStrategyParameters > solverStrategyParameters )

inlinestatic

static create routine that is used by SolverFactory

Definition at line 92 of file PetscKrylovSolver.h.

◆ getAbsoluteTolerance()

AMP::Scalar AMP::Solver::SolverStrategy::getAbsoluteTolerance ( ) const

inlineinherited

Definition at line 208 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_dAbsoluteTolerance.

◆ getBaseFromInput()

void AMP::Solver::SolverStrategy::getBaseFromInput ( std::shared_ptr< AMP::Database > db )

protectedinherited

◆ getConverged()

bool AMP::Solver::SolverStrategy::getConverged ( void ) const

inlineinherited

Definition at line 225 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::ConvergedUserCondition, and AMP::Solver::SolverStrategy::d_ConvergenceStatus.

◆ getConvergenceStatus()

SolverStatus AMP::Solver::SolverStrategy::getConvergenceStatus ( void ) const

inlineinherited

Definition at line 230 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_ConvergenceStatus.

◆ getConvergenceStatusString()

std::string AMP::Solver::SolverStrategy::getConvergenceStatusString ( void ) const

inlineinherited

Definition at line 232 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_ConvergenceStatus, and AMP::Solver::SolverStrategy::statusToString().

◆ getDebugPrintInfoLevel()

int AMP::Solver::SolverStrategy::getDebugPrintInfoLevel ( void )

inlineinherited

Get level of diagnostic information printed during iterations.

Definition at line 137 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_iDebugPrintInfoLevel.

◆ getExecutionSpace()

AMP::Utilities::ExecutionSpace AMP::Solver::SolverStrategy::getExecutionSpace ( ) const

inlineinherited

Definition at line 269 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_exec_space.

◆ getFromInput()

void AMP::Solver::PetscKrylovSolver::getFromInput ( std::shared_ptr< AMP::Database > db )

protected

◆ getFunctionScaling()

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::Solver::SolverStrategy::getFunctionScaling ( )

inlineinherited

Definition at line 267 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_pFunctionScaling.

◆ getInitialResidual()

virtual AMP::Scalar AMP::Solver::SolverStrategy::getInitialResidual ( void ) const

inlinevirtualinherited

Definition at line 241 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_dInitialResidual.

◆ getIterationHistory()

virtual const std::vector< int > & AMP::Solver::SolverStrategy::getIterationHistory ( void )

inlinevirtualinherited

Definition at line 243 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_iterationHistory.

◆ getIterations()

virtual int AMP::Solver::SolverStrategy::getIterations ( void ) const

inlinevirtualinherited

Return the number of iterations taken by the solver to converge.

Definition at line 142 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_iNumberIterations.

◆ getKrylovSolver()

KSP AMP::Solver::PetscKrylovSolver::getKrylovSolver ( void )

inline

returns the internally stored PETSc KSP object

Definition at line 110 of file PetscKrylovSolver.h.

References d_KrylovSolver.

◆ getMaxIterations()

int AMP::Solver::SolverStrategy::getMaxIterations ( void ) const

inlineinherited

Definition at line 218 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_iMaxIterations.

◆ getNestedSolver()

virtual std::shared_ptr< SolverStrategy > AMP::Solver::SolverStrategy::getNestedSolver ( void )

inlinevirtualinherited

Return a nested solver (eg preconditioner) if it exists. By default return a nullptr

Reimplemented in AMP::Solver::PetscSNESSolver.

Definition at line 172 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_pNestedSolver.

◆ getOperator()

virtual std::shared_ptr< AMP::Operator::Operator > AMP::Solver::SolverStrategy::getOperator ( void )

virtualinherited

Return a shared pointer to the operator registered with the solver.

◆ getRelativeTolerance()

AMP::Scalar AMP::Solver::SolverStrategy::getRelativeTolerance ( ) const

inlineinherited

Definition at line 212 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_dRelativeTolerance.

◆ getResidualNorm()

virtual AMP::Scalar AMP::Solver::SolverStrategy::getResidualNorm ( void ) const

inlinevirtualinherited

Definition at line 239 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_dResidualNorm.

◆ getSolutionScaling()

std::shared_ptr< AMP::LinearAlgebra::Vector > AMP::Solver::SolverStrategy::getSolutionScaling ( )

inlineinherited

Definition at line 266 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_pSolutionScaling.

◆ getTotalNumberOfIterations()

int AMP::Solver::SolverStrategy::getTotalNumberOfIterations ( void )

inherited

◆ initialize()

void AMP::Solver::PetscKrylovSolver::initialize ( std::shared_ptr< const SolverStrategyParameters > parameters )

overridevirtual

Initialize the PetscKrylovSolver. Should not be necessary for the user to call in general.

Parameters

parameters

Reimplemented from AMP::Solver::SolverStrategy.

◆ initializePreconditioner()

void AMP::Solver::PetscKrylovSolver::initializePreconditioner ( std::shared_ptr< const SolverStrategyParameters > parameters )

protected

◆ matVec()

static PetscErrorCode AMP::Solver::PetscKrylovSolver::matVec	(	Mat	mat,
		Vec	x,
		Vec	y
	)

staticprivate

◆ print()

virtual void AMP::Solver::SolverStrategy::print ( std::ostream & )

inlinevirtualinherited

Definition at line 237 of file SolverStrategy.h.

◆ printConvergenceStatus()

virtual void AMP::Solver::SolverStrategy::printConvergenceStatus	(	SolverStrategy::SolverStatus	,
		std::ostream &	= `AMP::pout`
	)		const

inlinevirtualinherited

Reimplemented in AMP::Solver::PetscSNESSolver.

Definition at line 251 of file SolverStrategy.h.

◆ printStatistics()

virtual void AMP::Solver::SolverStrategy::printStatistics ( std::ostream & os = AMP::pout )

inlinevirtualinherited

Reimplemented in AMP::Solver::NonlinearKrylovAccelerator< T >.

Definition at line 220 of file SolverStrategy.h.

◆ registerOperator()

void AMP::Solver::PetscKrylovSolver::registerOperator ( std::shared_ptr< AMP::Operator::Operator > op )

overridevirtual

Register the operator that the solver will use during solves

Parameters

[in] op shared pointer to operator $A()$ for equation $A(u) = f$

Reimplemented from AMP::Solver::SolverStrategy.

◆ registerWriter()

virtual void AMP::Solver::SolverStrategy::registerWriter ( std::shared_ptr< AMP::IO::Writer > writer )

inlinevirtualinherited

Registers a writer with the solver.

This function will register a writer with the solver. The solver may then register any vector components it "owns" with the writer.

Parameters

writer The writer to register

Definition at line 186 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_writer.

◆ reset() [1/2]

void AMP::Solver::PetscKrylovSolver::reset ( std::shared_ptr< AMP::Solver::SolverStrategyParameters > )

override

◆ reset() [2/2]

virtual void AMP::Solver::SolverStrategy::reset ( std::shared_ptr< SolverStrategyParameters > parameters )

virtualinherited

Resets the solver internally with new parameters if necessary

Parameters

parameters SolverStrategyParameters object that is NULL by default

Reimplemented in AMP::Solver::TrilinosNOXSolver, AMP::Solver::BandedSolver, AMP::Solver::BoomerAMGSolver, AMP::Solver::HypreBiCGSTABSolver, AMP::Solver::HypreGMRESSolver, AMP::Solver::HyprePCGSolver, AMP::Solver::HypreSolver, AMP::Solver::TrilinosMLSolver, AMP::Solver::TrilinosMueLuSolver, AMP::Solver::CoupledFlow1DSolver, and AMP::Solver::Flow1DSolver.

◆ resetOperator()

void AMP::Solver::PetscKrylovSolver::resetOperator ( std::shared_ptr< const AMP::Operator::OperatorParameters > parameters )

overridevirtual

Resets the registered operator internally with new parameters if necessary

Parameters

parameters OperatorParameters object that is NULL by default

Reimplemented from AMP::Solver::SolverStrategy.

◆ residual()

virtual void AMP::Solver::SolverStrategy::residual	(	std::shared_ptr< const AMP::LinearAlgebra::Vector >	f,
		std::shared_ptr< const AMP::LinearAlgebra::Vector >	u,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	r
	)

virtualinherited

◆ setAbsoluteTolerance()

virtual void AMP::Solver::SolverStrategy::setAbsoluteTolerance ( AMP::Scalar abs_tol )

inlinevirtualinherited

Definition at line 210 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_dAbsoluteTolerance.

◆ setComponentScalings()

void AMP::Solver::SolverStrategy::setComponentScalings	(	std::shared_ptr< AMP::LinearAlgebra::Vector >	s,
		std::shared_ptr< AMP::LinearAlgebra::Vector >	f
	)

inlineinherited

for multiphysics problems it may be necessary to scale the solution

Definition at line 259 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_pFunctionScaling, and AMP::Solver::SolverStrategy::d_pSolutionScaling.

◆ setDebugPrintInfoLevel()

virtual void AMP::Solver::SolverStrategy::setDebugPrintInfoLevel ( int print_level )

inlinevirtualinherited

Specify level of diagnostic information printed during iterations.

Parameters

[in] print_level integer level value with permissible values 0 and higher. Setting to zero should provide minimial debugging information with higher values resulting in increasingly verbose information being printed out.

Definition at line 132 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_iDebugPrintInfoLevel.

◆ setExecutionSpace()

void AMP::Solver::SolverStrategy::setExecutionSpace ( AMP::Utilities::ExecutionSpace space )

inlineinherited

Definition at line 270 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_exec_space.

◆ setInitialGuess()

virtual void AMP::Solver::SolverStrategy::setInitialGuess ( std::shared_ptr< AMP::LinearAlgebra::Vector > initialGuess )

virtualinherited

Provide the initial guess for the solver. This is a pure virtual function that the derived classes need to provide an implementation of.

Parameters

[in] initialGuess shared pointer to the initial guess vector.

Reimplemented in AMP::Solver::ColumnSolver, AMP::Solver::CoupledFlow1DSolver, AMP::Solver::Flow1DSolver, AMP::Solver::PetscSNESSolver, and AMP::Solver::TrilinosNOXSolver.

◆ setIsNestedSolver()

void AMP::Solver::SolverStrategy::setIsNestedSolver ( bool is_nested )

inlineinherited

Tell a solver that it is nested inside some outer solver.

Definition at line 166 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_bIsNestedSolver.

◆ setKrylovSolver()

void AMP::Solver::PetscKrylovSolver::setKrylovSolver ( KSP * ksp )

sets the PETSc KSP object

Parameters

[in] ksp pointer to KSP object

◆ setMaxIterations()

virtual void AMP::Solver::SolverStrategy::setMaxIterations ( const int max_iterations )

inlinevirtualinherited

Definition at line 216 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_iMaxIterations.

◆ setNestedSolver()

virtual void AMP::Solver::SolverStrategy::setNestedSolver ( std::shared_ptr< SolverStrategy > solver )

inlinevirtualinherited

Set a nested solver, eg, Krylov for Newton, preconditioner for Krylov etc. Null op in base class

Definition at line 159 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_pNestedSolver.

◆ setRelativeTolerance()

virtual void AMP::Solver::SolverStrategy::setRelativeTolerance ( AMP::Scalar rel_tol )

inlinevirtualinherited

Definition at line 214 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_dRelativeTolerance.

◆ setupPetscMatInterface()

void AMP::Solver::PetscKrylovSolver::setupPetscMatInterface	(	std::shared_ptr< AMP::Operator::Operator >	op,
		Mat &	mat
	)

protected

◆ setupPreconditioner()

static PetscErrorCode AMP::Solver::PetscKrylovSolver::setupPreconditioner ( PC pc )

staticprivate

◆ setZeroInitialGuess()

void AMP::Solver::PetscKrylovSolver::setZeroInitialGuess ( bool use_zero_guess )

overridevirtual

Tells the solver to use an initial guess of zero and not try to copy an initial guess into the solution vector

Parameters

[in] use_zero_guess boolean to specify whether zero initial guess should be used or not.

Reimplemented from AMP::Solver::SolverStrategy.

◆ statusToString()

static std::string AMP::Solver::SolverStrategy::statusToString ( SolverStatus status )

inlinestaticinherited

Definition at line 75 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::ConvergedOnAbsTol, AMP::Solver::SolverStrategy::ConvergedOnRelTol, AMP::Solver::SolverStrategy::ConvergedUserCondition, AMP::Solver::SolverStrategy::DivergedFunctionCount, AMP::Solver::SolverStrategy::DivergedLineSearch, AMP::Solver::SolverStrategy::DivergedNestedSolver, AMP::Solver::SolverStrategy::DivergedOnNan, AMP::Solver::SolverStrategy::DivergedStepSize, and AMP::Solver::SolverStrategy::MaxIterations.

Referenced by AMP::Solver::SolverStrategy::getConvergenceStatusString().

◆ type()

std::string AMP::Solver::PetscKrylovSolver::type ( ) const

inlineoverridevirtual

Return the name of the solver.

Implements AMP::Solver::SolverStrategy.

Definition at line 88 of file PetscKrylovSolver.h.

◆ usesPreconditioner()

bool AMP::Solver::PetscKrylovSolver::usesPreconditioner ( void )

inline

Definition at line 137 of file PetscKrylovSolver.h.

References d_bUsesPreconditioner.

Member Data Documentation

◆ d_bComputeResidual

bool AMP::Solver::SolverStrategy::d_bComputeResidual = false

protectedinherited

Definition at line 295 of file SolverStrategy.h.

◆ d_bIsNestedSolver

bool AMP::Solver::SolverStrategy::d_bIsNestedSolver = false

protectedinherited

Definition at line 294 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::setIsNestedSolver().

◆ d_bKSPCreatedInternally

bool AMP::Solver::PetscKrylovSolver::d_bKSPCreatedInternally

private

Definition at line 162 of file PetscKrylovSolver.h.

◆ d_bMatrixFree

bool AMP::Solver::PetscKrylovSolver::d_bMatrixFree = false

private

Definition at line 165 of file PetscKrylovSolver.h.

◆ d_bUsesPreconditioner

bool AMP::Solver::PetscKrylovSolver::d_bUsesPreconditioner = false

private

Definition at line 164 of file PetscKrylovSolver.h.

Referenced by usesPreconditioner().

◆ d_bUseZeroInitialGuess

bool AMP::Solver::SolverStrategy::d_bUseZeroInitialGuess = true

protectedinherited

Definition at line 292 of file SolverStrategy.h.

Referenced by AMP::Solver::OnePointSolver::apply(), and AMP::Solver::SolverStrategy::setZeroInitialGuess().

◆ d_comm

AMP_MPI AMP::Solver::PetscKrylovSolver::d_comm

private

Definition at line 156 of file PetscKrylovSolver.h.

◆ d_ConvergenceStatus

SolverStatus AMP::Solver::SolverStrategy::d_ConvergenceStatus = SolverStatus::DivergedOther

protectedinherited

Definition at line 276 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getConverged(), AMP::Solver::SolverStrategy::getConvergenceStatus(), and AMP::Solver::SolverStrategy::getConvergenceStatusString().

◆ d_dAbsoluteTolerance

AMP::Scalar AMP::Solver::SolverStrategy::d_dAbsoluteTolerance = 1.0e-14

protectedinherited

Definition at line 287 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getAbsoluteTolerance(), and AMP::Solver::SolverStrategy::setAbsoluteTolerance().

◆ d_db

std::shared_ptr<AMP::Database> AMP::Solver::SolverStrategy::d_db = nullptr

protectedinherited

Definition at line 304 of file SolverStrategy.h.

◆ d_dDivergenceTolerance

double AMP::Solver::PetscKrylovSolver::d_dDivergenceTolerance

private

Definition at line 160 of file PetscKrylovSolver.h.

◆ d_dInitialResidual

AMP::Scalar AMP::Solver::SolverStrategy::d_dInitialResidual

protectedinherited

Definition at line 285 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getInitialResidual().

◆ d_dRelativeTolerance

AMP::Scalar AMP::Solver::SolverStrategy::d_dRelativeTolerance = 1.0e-09

protectedinherited

Definition at line 288 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getRelativeTolerance(), and AMP::Solver::SolverStrategy::setRelativeTolerance().

◆ d_dResidualNorm

AMP::Scalar AMP::Solver::SolverStrategy::d_dResidualNorm

protectedinherited

Definition at line 284 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getResidualNorm().

◆ d_exec_space

AMP::Utilities::ExecutionSpace AMP::Solver::SolverStrategy::d_exec_space = AMP::Utilities::ExecutionSpace::unspecified

protectedinherited

execution space for the solver

Definition at line 324 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getExecutionSpace(), and AMP::Solver::SolverStrategy::setExecutionSpace().

◆ d_global_db

std::shared_ptr<AMP::Database> AMP::Solver::SolverStrategy::d_global_db = nullptr

protectedinherited

Pointer to global database This is temporary fix and eventually either d_global_db or d_db should go away This is introduced to allow for solver factories to access databases in the global database for the construction of nested solvers

Definition at line 311 of file SolverStrategy.h.

◆ d_iDebugPrintInfoLevel

int AMP::Solver::SolverStrategy::d_iDebugPrintInfoLevel = 0

protectedinherited

Definition at line 290 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getDebugPrintInfoLevel(), and AMP::Solver::SolverStrategy::setDebugPrintInfoLevel().

◆ d_iInstanceId

int AMP::Solver::SolverStrategy::d_iInstanceId

staticprotectedinherited

Definition at line 299 of file SolverStrategy.h.

◆ d_iMaxIterations

int AMP::Solver::SolverStrategy::d_iMaxIterations = 0

protectedinherited

Definition at line 282 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getMaxIterations(), and AMP::Solver::SolverStrategy::setMaxIterations().

◆ d_iMaxKrylovDimension

int AMP::Solver::PetscKrylovSolver::d_iMaxKrylovDimension

private

Definition at line 173 of file PetscKrylovSolver.h.

◆ d_iNumberIterations

int AMP::Solver::SolverStrategy::d_iNumberIterations = 0

protectedinherited

Definition at line 280 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getIterations().

◆ d_iObjectId

int AMP::Solver::SolverStrategy::d_iObjectId

protectedinherited

Definition at line 297 of file SolverStrategy.h.

◆ d_iterationHistory

std::vector<int> AMP::Solver::SolverStrategy::d_iterationHistory

protectedinherited

keeps track of iteration statistics over solver lifetime

Definition at line 302 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getIterationHistory().

◆ d_KrylovSolver

KSP AMP::Solver::PetscKrylovSolver::d_KrylovSolver

private

Definition at line 178 of file PetscKrylovSolver.h.

Referenced by getKrylovSolver().

◆ d_KSPAppendOptionsPrefix

std::string AMP::Solver::PetscKrylovSolver::d_KSPAppendOptionsPrefix

private

Definition at line 168 of file PetscKrylovSolver.h.

◆ d_Mat

Mat AMP::Solver::PetscKrylovSolver::d_Mat

private

Definition at line 180 of file PetscKrylovSolver.h.

◆ d_memory_location

AMP::Utilities::MemoryType AMP::Solver::SolverStrategy::d_memory_location = AMP::Utilities::MemoryType::none

protectedinherited

memory storage address space

Definition at line 327 of file SolverStrategy.h.

◆ d_PcSide

std::string AMP::Solver::PetscKrylovSolver::d_PcSide

private

Definition at line 170 of file PetscKrylovSolver.h.

◆ d_PetscMonitor

std::shared_ptr<PetscMonitor> AMP::Solver::PetscKrylovSolver::d_PetscMonitor

private

Definition at line 176 of file PetscKrylovSolver.h.

◆ d_pFunctionScaling

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Solver::SolverStrategy::d_pFunctionScaling

protectedinherited

Definition at line 314 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getFunctionScaling(), and AMP::Solver::SolverStrategy::setComponentScalings().

◆ d_pNestedSolver

std::shared_ptr<AMP::Solver::SolverStrategy> AMP::Solver::SolverStrategy::d_pNestedSolver = nullptr

protectedinherited

nested solver used by this solver

Definition at line 319 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getNestedSolver(), and AMP::Solver::SolverStrategy::setNestedSolver().

◆ d_pOperator

std::shared_ptr<AMP::Operator::Operator> AMP::Solver::SolverStrategy::d_pOperator = nullptr

protectedinherited

Definition at line 316 of file SolverStrategy.h.

◆ d_pSolutionScaling

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Solver::SolverStrategy::d_pSolutionScaling

protectedinherited

Definition at line 313 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::getSolutionScaling(), and AMP::Solver::SolverStrategy::setComponentScalings().

◆ d_sGmresOrthogonalizationAlgorithm

std::string AMP::Solver::PetscKrylovSolver::d_sGmresOrthogonalizationAlgorithm

private

Definition at line 174 of file PetscKrylovSolver.h.

◆ d_sKspType

std::string AMP::Solver::PetscKrylovSolver::d_sKspType

private

Definition at line 158 of file PetscKrylovSolver.h.

◆ d_sName

std::string AMP::Solver::SolverStrategy::d_sName

protectedinherited

Definition at line 278 of file SolverStrategy.h.

◆ d_sPcType

std::string AMP::Solver::PetscKrylovSolver::d_sPcType

private

Definition at line 167 of file PetscKrylovSolver.h.

◆ d_writer

std::shared_ptr<AMP::IO::Writer> AMP::Solver::SolverStrategy::d_writer = nullptr

protectedinherited

Definition at line 321 of file SolverStrategy.h.

Referenced by AMP::Solver::SolverStrategy::registerWriter().

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

src/solvers/petsc/PetscKrylovSolver.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ shared_ptr

Member Enumeration Documentation

◆ SolverStatus

Constructor & Destructor Documentation

◆ PetscKrylovSolver() [1/2]

◆ PetscKrylovSolver() [2/2]

◆ ~PetscKrylovSolver()

Member Function Documentation

◆ apply()

◆ applyPreconditioner()

◆ checkStoppingCriteria()

◆ createPCOperator()

◆ createSolver()

◆ getAbsoluteTolerance()

◆ getBaseFromInput()

◆ getConverged()

◆ getConvergenceStatus()

◆ getConvergenceStatusString()

◆ getDebugPrintInfoLevel()

◆ getExecutionSpace()

◆ getFromInput()

◆ getFunctionScaling()

◆ getInitialResidual()

◆ getIterationHistory()

◆ getIterations()

◆ getKrylovSolver()

◆ getMaxIterations()

◆ getNestedSolver()

◆ getOperator()

◆ getRelativeTolerance()

◆ getResidualNorm()

◆ getSolutionScaling()

◆ getTotalNumberOfIterations()

◆ initialize()

◆ initializePreconditioner()

◆ matVec()

◆ print()

◆ printConvergenceStatus()

◆ printStatistics()

◆ registerOperator()

◆ registerWriter()

◆ reset() [1/2]

◆ reset() [2/2]

◆ resetOperator()

◆ residual()

◆ setAbsoluteTolerance()

◆ setComponentScalings()

◆ setDebugPrintInfoLevel()

◆ setExecutionSpace()

◆ setInitialGuess()

◆ setIsNestedSolver()

◆ setKrylovSolver()

◆ setMaxIterations()

◆ setNestedSolver()

◆ setRelativeTolerance()

◆ setupPetscMatInterface()

◆ setupPreconditioner()

◆ setZeroInitialGuess()

◆ statusToString()

◆ type()

◆ usesPreconditioner()

Member Data Documentation

◆ d_bComputeResidual

◆ d_bIsNestedSolver

◆ d_bKSPCreatedInternally

◆ d_bMatrixFree

◆ d_bUsesPreconditioner

◆ d_bUseZeroInitialGuess

◆ d_comm

◆ d_ConvergenceStatus