PetscKrylovSolver.h

Go to the documentation of this file.

#ifndef included_AMP_PetscKrylovSolver
#define included_AMP_PetscKrylovSolver
 
#include "AMP/solvers/SolverStrategy.h"
#include "AMP/solvers/petsc/PetscMonitor.h"
#include "AMP/utils/AMP_MPI.h"
#include "AMP/vectors/petsc/PetscHelpers.h"
 
 
// Forward declare a few types for PETSc
typedef int PetscErrorCode;
typedef struct _p_SNES *SNES;
typedef struct _p_KSP *KSP;
typedef struct _p_PC *PC;
 
 
namespace AMP::Solver {
 
class PetscKrylovSolver : public SolverStrategy
{
public:
    PetscKrylovSolver();
 
    explicit PetscKrylovSolver( std::shared_ptr<SolverStrategyParameters> parameters );
 
    virtual ~PetscKrylovSolver();
 
    std::string type() const override { return "PetscKrylovSolver"; }
 
    static std::unique_ptr<SolverStrategy>
    createSolver( std::shared_ptr<SolverStrategyParameters> solverStrategyParameters )
    {
        return std::make_unique<PetscKrylovSolver>( solverStrategyParameters );
    }
 
    void apply( std::shared_ptr<const AMP::LinearAlgebra::Vector> f,
                std::shared_ptr<AMP::LinearAlgebra::Vector> u ) override;
 
    void reset( std::shared_ptr<AMP::Solver::SolverStrategyParameters> ) override;
 
    inline KSP getKrylovSolver( void ) { return d_KrylovSolver; }
 
    void setKrylovSolver( KSP *ksp );
 
    void initialize( std::shared_ptr<const SolverStrategyParameters> parameters ) override;
 
    void registerOperator( std::shared_ptr<AMP::Operator::Operator> op ) override;
 
    void
    resetOperator( std::shared_ptr<const AMP::Operator::OperatorParameters> parameters ) override;
 
    bool usesPreconditioner( void ) { return d_bUsesPreconditioner; }
 
    void setZeroInitialGuess( bool use_zero_guess ) override;
 
protected:
    void getFromInput( std::shared_ptr<AMP::Database> db );
    void initializePreconditioner( std::shared_ptr<const SolverStrategyParameters> parameters );
    std::shared_ptr<AMP::Operator::Operator> createPCOperator();
    void setupPetscMatInterface( std::shared_ptr<AMP::Operator::Operator> op, Mat &mat );
 
private:
    // static functions to interface with PETSc
    // the signatures of these functions currently vary depending on whether the dev or release
    // release version of PETSc is being used
 
    static PetscErrorCode setupPreconditioner( PC pc );
    static PetscErrorCode applyPreconditioner( PC pc, Vec r, Vec z );
    static PetscErrorCode matVec( Mat mat, Vec x, Vec y );
 
    AMP_MPI d_comm;
 
    std::string d_sKspType;
 
    double d_dDivergenceTolerance;
 
    bool d_bKSPCreatedInternally;
 
    bool d_bUsesPreconditioner = false;
    bool d_bMatrixFree         = false;
 
    std::string d_sPcType;
    std::string d_KSPAppendOptionsPrefix;
 
    std::string d_PcSide;
 
    // FGMRES specific options
    int d_iMaxKrylovDimension;
    std::string d_sGmresOrthogonalizationAlgorithm;
 
    std::shared_ptr<PetscMonitor> d_PetscMonitor;
 
    KSP d_KrylovSolver;
 
    Mat d_Mat;
};
} // namespace AMP::Solver
 
#endif