#include <NonlinearKrylovAccelerator.h>

Inheritance diagram for AMP::Solver::NonlinearKrylovAccelerator< T >:

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

void	correction (std::shared_ptr< AMP::LinearAlgebra::Vector > f)

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

int	getMaxFunctionEvaluations () const

int	getMaxIterations (void) const

int	getMaxNonlinearIterations () 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 AMP::Solver::SolverStrategyParameters > parameters) override

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

	NonlinearKrylovAccelerator (std::shared_ptr< AMP::Solver::SolverStrategyParameters > params)

virtual void	print (std::ostream &)

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

void	printStatistics (std::ostream &os) override

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

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

void	relax (void)

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

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

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

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)

void	restart (void)

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	setMaxFunctionEvaluations (int max_feval)

virtual void	setMaxIterations (const int max_iterations)

void	setMaxNonlinearIterations (int max_nli)

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

virtual void	setRelativeTolerance (AMP::Scalar rel_tol)

virtual void	setZeroInitialGuess (bool use_zero_guess)

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

	~NonlinearKrylovAccelerator ()

Static Public Member Functions
static std::unique_ptr< AMP::Solver::SolverStrategy >	createSolver (std::shared_ptr< AMP::Solver::SolverStrategyParameters > solverStrategyParameters)

static std::string	statusToString (SolverStatus status)

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

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

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

Private Member Functions
std::shared_ptr< AMP::Operator::Operator >	createPreconditionerOperator (std::shared_ptr< AMP::Operator::Operator > op)

void	factorizeNormalMatrix (void)

std::vector< T >	forwardbackwardSolve (std::shared_ptr< AMP::LinearAlgebra::Vector > f)
	forward backward solve for Cholesky

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

void	initialize (std::shared_ptr< AMP::LinearAlgebra::Vector > solution_vector)

	NonlinearKrylovAccelerator ()=delete

	NonlinearKrylovAccelerator (const NonlinearKrylovAccelerator &)=delete

	NonlinearKrylovAccelerator (NonlinearKrylovAccelerator &&)=delete

NonlinearKrylovAccelerator &	operator= (const NonlinearKrylovAccelerator &)=delete

Private Attributes
bool	d_adaptive_damping = false
	whether to use damping

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_correction_vector
	correction vectors

int	d_current_correction = 0

T	d_eta = 1.0
	keeps track of the number of function applications

int	d_first = 0
	matrix of w vector inner products

int	d_free = 0
	index of last subspace vector

bool	d_freeze_pc = true
	whether the solver uses a preconditioner or not

int	d_function_apply_count = 0
	keeps track of the number of preconditioner applications

T **	d_h
	function difference vectors

int	d_last = 0
	index of first subspace vector

int	d_maximum_function_evals = 0
	previous index link field in doubly-linked subspace v

int	d_mvec = 0
	use qr factorization to solve the least squares problem

std::vector< int >	d_next
	index of the initial vector in free storage linked list

bool	d_pending = false
	boolean: a nonempty subspace

int	d_preconditioner_apply_count

std::vector< int >	d_prev
	next index link field

bool	d_print_residuals = false
	flag determining whether the preconditioner is frozen or not

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_residual_vector
	correction vectors

std::shared_ptr< AMP::LinearAlgebra::Vector >	d_solution_vector
	vector drop tolerance

bool	d_solver_initialized = false
	whether to print the residuals

bool	d_subspace = false

bool	d_use_damping = false

bool	d_use_qr = false
	contains pending vectors – boolean

bool	d_uses_preconditioner = false
	damping factor

std::vector< std::shared_ptr< AMP::LinearAlgebra::Vector > >	d_v
	correction vectors

T	d_vtol = 0.0
	maximum number of subspace vectors

std::vector< std::shared_ptr< AMP::LinearAlgebra::Vector > >	d_w
	correction vectors

Detailed Description

template<typename T = double>
class AMP::Solver::NonlinearKrylovAccelerator< T >

Definition at line 17 of file NonlinearKrylovAccelerator.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

◆ NonlinearKrylovAccelerator() [1/4]

template<typename T = double>

AMP::Solver::NonlinearKrylovAccelerator< T >::NonlinearKrylovAccelerator ( std::shared_ptr< AMP::Solver::SolverStrategyParameters > params )

explicit

◆ ~NonlinearKrylovAccelerator()

template<typename T = double>

AMP::Solver::NonlinearKrylovAccelerator< T >::~NonlinearKrylovAccelerator ( )

◆ NonlinearKrylovAccelerator() [2/4]

template<typename T = double>

AMP::Solver::NonlinearKrylovAccelerator< T >::NonlinearKrylovAccelerator ( )

privatedelete

◆ NonlinearKrylovAccelerator() [3/4]

template<typename T = double>

AMP::Solver::NonlinearKrylovAccelerator< T >::NonlinearKrylovAccelerator ( const NonlinearKrylovAccelerator< T > & )

privatedelete

◆ NonlinearKrylovAccelerator() [4/4]

template<typename T = double>

AMP::Solver::NonlinearKrylovAccelerator< T >::NonlinearKrylovAccelerator ( NonlinearKrylovAccelerator< T > && )

privatedelete

Member Function Documentation

◆ apply()

template<typename T = double>

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

overridevirtual

Solve the system \(A(u) = f\). The solution \(u\) and the right hand side \(f\) are specified via vectors on the patch hierarchy. This function returns zero if the solver converged within the specified tolerances and nonzero otherwise. Member functions getIterations() and getRelativeNorm() return the iterations and relative norm, respectively, from the solver.

Parameters

f	vector for right hand side, can be nullptr
u	vector for solution variables

Implements AMP::Solver::SolverStrategy.

◆ checkStoppingCriteria()

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

protectedvirtualinherited

◆ correction()

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::correction ( std::shared_ptr< AMP::LinearAlgebra::Vector > f )

◆ createPreconditionerOperator()

template<typename T = double>

std::shared_ptr< AMP::Operator::Operator > AMP::Solver::NonlinearKrylovAccelerator< T >::createPreconditionerOperator ( std::shared_ptr< AMP::Operator::Operator > op )

private

◆ createSolver()

template<typename T = double>

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

inlinestatic

Definition at line 27 of file NonlinearKrylovAccelerator.h.

◆ factorizeNormalMatrix()

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::factorizeNormalMatrix ( void )

private

◆ forwardbackwardSolve()

template<typename T = double>

std::vector< T > AMP::Solver::NonlinearKrylovAccelerator< T >::forwardbackwardSolve ( std::shared_ptr< AMP::LinearAlgebra::Vector > f )

private

forward backward solve for Cholesky

◆ 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()

template<typename T = double>

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

private

◆ 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.

◆ getMaxFunctionEvaluations()

template<typename T = double>

int AMP::Solver::NonlinearKrylovAccelerator< T >::getMaxFunctionEvaluations ( ) const

Get maximum function evaluations by nonlinear solver.

◆ getMaxIterations()

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

inlineinherited

Definition at line 218 of file SolverStrategy.h.

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

◆ getMaxNonlinearIterations()

template<typename T = double>

int AMP::Solver::NonlinearKrylovAccelerator< T >::getMaxNonlinearIterations ( ) const

Get maximum iterations for nonlinear solver.

◆ 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() [1/3]

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::initialize ( std::shared_ptr< AMP::LinearAlgebra::Vector > solution_vector )

private

◆ initialize() [2/3]

template<typename T = double>

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

override

◆ initialize() [3/3]

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

virtualinherited

Initialize the solution vector and potentially create internal vectors needed for solution

Parameters

[in] parameters The parameters object contains a database object. Currently there are no required fields for the database object.

◆ operator=()

template<typename T = double>

NonlinearKrylovAccelerator & AMP::Solver::NonlinearKrylovAccelerator< T >::operator= ( const NonlinearKrylovAccelerator< T > & )

privatedelete

◆ 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()

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::printStatistics ( std::ostream & os )

overridevirtual

Reimplemented from AMP::Solver::SolverStrategy.

◆ registerOperator()

template<typename T = double>

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

finaloverridevirtual

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.

◆ relax()

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::relax ( void )

◆ reset() [1/2]

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::reset ( std::shared_ptr< AMP::Solver::SolverStrategyParameters > parameters )

override

Resets the solver internally with new parameters if necessary

Parameters

parameters SolverStrategyParameters object that is NULL by default

◆ 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()

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

virtualinherited

Resets the operator registered with the solver with new parameters if necessary

Parameters

parameters OperatorParameters object that is NULL by default

Reimplemented in AMP::Solver::PetscKrylovSolver, AMP::Solver::BandedSolver, AMP::Solver::ColumnSolver, AMP::Solver::HypreSolver, AMP::Solver::CoupledFlow1DSolver, AMP::Solver::Flow1DSolver, AMP::Solver::PelletStackMechanicsSolver, AMP::Solver::TrilinosMLSolver, and AMP::Solver::TrilinosMueLuSolver.

◆ 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

◆ restart()

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::restart ( void )

◆ 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.

◆ setMaxFunctionEvaluations()

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::setMaxFunctionEvaluations ( int max_feval )

Set maximum function evaluations in nonlinear solver.

◆ 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.

◆ setMaxNonlinearIterations()

template<typename T = double>

void AMP::Solver::NonlinearKrylovAccelerator< T >::setMaxNonlinearIterations ( int max_nli )

Set maximum iterations for nonlinear solver.

◆ 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.

◆ setZeroInitialGuess()

virtual void AMP::Solver::SolverStrategy::setZeroInitialGuess ( bool use_zero_guess )

inlinevirtualinherited

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 in AMP::Solver::PetscKrylovSolver.

Definition at line 150 of file SolverStrategy.h.

References AMP::Solver::SolverStrategy::d_bUseZeroInitialGuess.

◆ 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()

template<typename T = double>

std::string AMP::Solver::NonlinearKrylovAccelerator< T >::type ( ) const

inlineoverridevirtual

Return the name of the solver.

Implements AMP::Solver::SolverStrategy.

Definition at line 32 of file NonlinearKrylovAccelerator.h.

Member Data Documentation

◆ d_adaptive_damping

template<typename T = double>

bool AMP::Solver::NonlinearKrylovAccelerator< T >::d_adaptive_damping = false

private

whether to use damping

Definition at line 144 of file NonlinearKrylovAccelerator.h.

◆ 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_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_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_correction_vector

template<typename T = double>

std::shared_ptr<AMP::LinearAlgebra::Vector> AMP::Solver::NonlinearKrylovAccelerator< T >::d_correction_vector

private

correction vectors

Definition at line 117 of file NonlinearKrylovAccelerator.h.

◆ d_current_correction

template<typename T = double>

int AMP::Solver::NonlinearKrylovAccelerator< T >::d_current_correction = 0

private

Definition at line 131 of file NonlinearKrylovAccelerator.h.

◆ 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_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_eta

template<typename T = double>

T AMP::Solver::NonlinearKrylovAccelerator< T >::d_eta = 1.0

private

keeps track of the number of function applications

Definition at line 137 of file NonlinearKrylovAccelerator.h.

◆ 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_first

template<typename T = double>

int AMP::Solver::NonlinearKrylovAccelerator< T >::d_first = 0

private

matrix of w vector inner products

Definition at line 124 of file NonlinearKrylovAccelerator.h.

◆ d_free

template<typename T = double>

int AMP::Solver::NonlinearKrylovAccelerator< T >::d_free = 0

private

index of last subspace vector

Definition at line 126 of file NonlinearKrylovAccelerator.h.

◆ d_freeze_pc

template<typename T = double>

bool AMP::Solver::NonlinearKrylovAccelerator< T >::d_freeze_pc = true

private

whether the solver uses a preconditioner or not

Definition at line 140 of file NonlinearKrylovAccelerator.h.

◆ d_function_apply_count

template<typename T = double>

int AMP::Solver::NonlinearKrylovAccelerator< T >::d_function_apply_count = 0

private

keeps track of the number of preconditioner applications

Definition at line 135 of file NonlinearKrylovAccelerator.h.

◆ 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.