AMP::Solver::AMG::Relaxation Struct Reference

#include <Relaxation.h>

Inheritance diagram for AMP::Solver::AMG::Relaxation:

Public Types
enum class	Direction { forward , backward }
typedef std::shared_ptr< AMP::Solver::SolverStrategy >	shared_ptr
enum class	SolverStatus {   ConvergedOnAbsTol , ConvergedOnRelTol , ConvergedUserCondition , MaxIterations ,   DivergedLineSearch , DivergedStepSize , DivergedFunctionCount , DivergedOnNan ,   DivergedNestedSolver , DivergedOther }
enum class	Sweep { forward , backward , symmetric }

Public Member Functions
virtual void	apply (std::shared_ptr< const AMP::LinearAlgebra::Vector > f, std::shared_ptr< AMP::LinearAlgebra::Vector > u)=0
void	apply (std::shared_ptr< const LinearAlgebra::Vector > b, std::shared_ptr< LinearAlgebra::Vector > x) 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
void	getFromInput (std::shared_ptr< AMP::Database >)
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	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)
virtual void	initialize (std::shared_ptr< const 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)
virtual void	registerOperator (std::shared_ptr< AMP::Operator::Operator > op)
virtual void	registerWriter (std::shared_ptr< AMP::IO::Writer > writer)
	Registers a writer with the solver.
	Relaxation (std::shared_ptr< const SolverStrategyParameters > params, const std::string &name_, const std::string &short_name_)
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)
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	setLevel (size_t lvl)
virtual void	setMaxIterations (const int max_iterations)
virtual void	setNestedSolver (std::shared_ptr< SolverStrategy > solver)
virtual void	setRelativeTolerance (AMP::Scalar rel_tol)
virtual void	setZeroInitialGuess (bool use_zero_guess)
virtual std::string	type () const override
	Return the name of the solver.

Static Public Member Functions
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)
virtual void	relax_visit (std::shared_ptr< const LinearAlgebra::Vector > b, std::shared_ptr< LinearAlgebra::Vector > x)=0

Protected Attributes
bool	d_bComputeResidual = false
bool	d_bIsNestedSolver = false
bool	d_bUseZeroInitialGuess = true
size_t	d_caller_lvl
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
std::shared_ptr< AMP::LinearAlgebra::Matrix >	d_matrix
AMP::Utilities::MemoryType	d_memory_location = AMP::Utilities::MemoryType::none
	memory storage address space
size_t	d_num_sweeps
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
Sweep	d_sweep
std::shared_ptr< AMP::IO::Writer >	d_writer = nullptr
const std::string	name
bool	need_norms
const std::string	short_name

Static Protected Attributes
static int	d_iInstanceId

Detailed Description

Definition at line 26 of file Relaxation.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

Direction

enum class AMP::Solver::AMG::Relaxation::Direction

strong

Enumerator
forward
backward

Definition at line 29 of file Relaxation.h.

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.

Sweep

enum class AMP::Solver::AMG::Relaxation::Sweep

strong

Enumerator
forward
backward
symmetric

Definition at line 28 of file Relaxation.h.

Constructor & Destructor Documentation

Relaxation()

AMP::Solver::AMG::Relaxation::Relaxation ( std::shared_ptr< const SolverStrategyParameters >  params, const std::string &  name_, const std::string &  short_name_  )

explicit

Member Function Documentation

apply() [1/2]

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

pure virtualinherited

Solve the system \(A(u) = f\). This is a pure virtual function that the derived classes need to provide an implementation of.

Parameters

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

Implemented in AMP::Solver::BDFRadDifOpPJacOpSplitPrec, AMP::Solver::AMG::UASolver, AMP::Solver::BandedSolver, AMP::Solver::BiCGSTABSolver< T >, AMP::Solver::CGSolver< T >, AMP::Solver::ColumnSolver, AMP::Solver::ConstraintsEliminationSolver, AMP::Solver::DiagonalSolver< T >, AMP::Solver::BoomerAMGSolver, AMP::Solver::HypreSolver, AMP::Solver::CoupledFlow1DSolver, AMP::Solver::Flow1DSolver, AMP::Solver::PelletStackMechanicsSolver, AMP::Solver::NonlinearKrylovAccelerator< T >, AMP::Solver::OnePointSolver, AMP::Solver::PetscKrylovSolver, AMP::Solver::PetscSNESSolver, AMP::Solver::QMRCGSTABSolver< T >, AMP::Solver::TFQMRSolver< T >, AMP::Solver::TrilinosMLSolver, AMP::Solver::TrilinosMueLuSolver, and AMP::Solver::TrilinosNOXSolver.

apply() [2/2]

void AMP::Solver::AMG::Relaxation::apply ( std::shared_ptr< const LinearAlgebra::Vector >  b, std::shared_ptr< LinearAlgebra::Vector >  x  )

override

checkStoppingCriteria()

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

protectedvirtualinherited

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::AMG::Relaxation::getFromInput

(

std::shared_ptr< AMP::Database >

)

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.

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

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.

Reimplemented in AMP::Solver::BoomerAMGSolver, AMP::Solver::HypreBiCGSTABSolver, AMP::Solver::HypreGMRESSolver, AMP::Solver::HyprePCGSolver, AMP::Solver::HypreSolver, AMP::Solver::Flow1DSolver, AMP::Solver::PetscKrylovSolver, AMP::Solver::TrilinosMLSolver, AMP::Solver::TrilinosMueLuSolver, AMP::Solver::TrilinosNOXSolver, AMP::Solver::BiCGSTABSolver< T >, AMP::Solver::CGSolver< T >, AMP::Solver::DiagonalSolver< T >, AMP::Solver::GMRESRSolver< T >, AMP::Solver::GMRESSolver< T >, AMP::Solver::QMRCGSTABSolver< T >, and AMP::Solver::TFQMRSolver< T >.

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

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

virtualinherited

Register the operator that the solver will use during solves

Parameters

[in]

op

shared pointer to operator \(A()\) for equation \(A(u) = f\)

Reimplemented in AMP::Solver::BiCGSTABSolver< T >, AMP::Solver::CGSolver< T >, AMP::Solver::DiagonalSolver< T >, AMP::Solver::GMRESSolver< T >, AMP::Solver::HypreSolver, AMP::Solver::PetscKrylovSolver, AMP::Solver::TFQMRSolver< T >, AMP::Solver::TrilinosMLSolver, AMP::Solver::TrilinosMueLuSolver, AMP::Solver::NonlinearKrylovAccelerator< T >, AMP::Solver::AMG::HybridGS, AMP::Solver::AMG::JacobiL1, and AMP::Solver::AMG::UASolver.

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

virtual void AMP::Solver::AMG::Relaxation::relax_visit ( std::shared_ptr< const LinearAlgebra::Vector >  b, std::shared_ptr< LinearAlgebra::Vector >  x  )

protectedpure virtual

Implemented in AMP::Solver::AMG::HybridGS, and AMP::Solver::AMG::JacobiL1.

reset()

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

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.

setLevel()

void AMP::Solver::AMG::Relaxation::setLevel ( size_t  lvl )

inline

Definition at line 41 of file Relaxation.h.

References d_caller_lvl.

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.

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

virtual std::string AMP::Solver::AMG::Relaxation::type ( ) const

inlineoverridevirtual

Return the name of the solver.

Implements AMP::Solver::SolverStrategy.

Reimplemented in AMP::Solver::AMG::HybridGS, and AMP::Solver::AMG::JacobiL1.

Definition at line 34 of file Relaxation.h.

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_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_caller_lvl

size_t AMP::Solver::AMG::Relaxation::d_caller_lvl

protected

Definition at line 53 of file Relaxation.h.

Referenced by setLevel().

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_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_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_matrix

std::shared_ptr<AMP::LinearAlgebra::Matrix> AMP::Solver::AMG::Relaxation::d_matrix

protected

Definition at line 51 of file Relaxation.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_num_sweeps

size_t AMP::Solver::AMG::Relaxation::d_num_sweeps

protected

Definition at line 50 of file Relaxation.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_sName

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

protectedinherited

Definition at line 278 of file SolverStrategy.h.

d_sweep

Sweep AMP::Solver::AMG::Relaxation::d_sweep

protected

Definition at line 49 of file Relaxation.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().

name

const std::string AMP::Solver::AMG::Relaxation::name

protected

Definition at line 47 of file Relaxation.h.

need_norms

bool AMP::Solver::AMG::Relaxation::need_norms

protected

Definition at line 48 of file Relaxation.h.

short_name

const std::string AMP::Solver::AMG::Relaxation::short_name

protected

Definition at line 47 of file Relaxation.h.

---

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

• src/solvers/amg/Relaxation.h