CGSolver.h

Go to the documentation of this file.

#ifndef included_AMP_CGSolver
#define included_AMP_CGSolver
 
#include "AMP/solvers/SolverStrategy.h"
#include "AMP/solvers/SolverStrategyParameters.h"
#include "AMP/utils/AMP_MPI.h"
 
#include <string>
 
namespace AMP::Solver {
 
template<typename T = double>
class CGSolver : public SolverStrategy
{
public:
    CGSolver() = default;
 
    explicit CGSolver( std::shared_ptr<SolverStrategyParameters> params );
 
    static std::unique_ptr<SolverStrategy>
    createSolver( std::shared_ptr<SolverStrategyParameters> params )
    {
        return std::make_unique<CGSolver<T>>( params );
    }
 
    virtual ~CGSolver() = default;
 
    std::string type() const override { return "CGSolver"; }
 
    void apply( std::shared_ptr<const AMP::LinearAlgebra::Vector> f,
                std::shared_ptr<AMP::LinearAlgebra::Vector> u ) override;
 
    void initialize( std::shared_ptr<const SolverStrategyParameters> params ) override;
 
    void registerOperator( std::shared_ptr<AMP::Operator::Operator> op ) override;
 
protected:
    void getFromInput( std::shared_ptr<AMP::Database> db );
    void allocateScratchVectors( std::shared_ptr<const AMP::LinearAlgebra::Vector> u );
 
private:
    T d_dDivergenceTolerance = 1e3;
 
    std::vector<T> d_gamma;
 
    bool d_bUsesPreconditioner = false;
 
    bool d_bFlexibleCG = false;
 
    int d_max_dimension = 0;
 
    std::string d_sVariant = "pcg";
 
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_r;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_p;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_w;
    std::shared_ptr<AMP::LinearAlgebra::Vector> d_z;
 
    std::vector<std::shared_ptr<AMP::LinearAlgebra::Vector>> d_vDirs;
};
} // namespace AMP::Solver
 
#endif