MFEM  v3.4
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
mfem::PetscPCGSolver Class Reference

#include <petsc.hpp>

Inheritance diagram for mfem::PetscPCGSolver:
Collaboration diagram for mfem::PetscPCGSolver:

Public Member Functions

 PetscPCGSolver (MPI_Comm comm, const std::string &prefix=std::string())
 PetscPCGSolver (PetscParMatrix &A, const std::string &prefix=std::string())
 PetscPCGSolver (HypreParMatrix &A, bool wrap=true, const std::string &prefix=std::string())
- Public Member Functions inherited from mfem::PetscLinearSolver
 PetscLinearSolver (MPI_Comm comm, const std::string &prefix=std::string(), bool wrap=false)
 PetscLinearSolver (const PetscParMatrix &A, const std::string &prefix=std::string())
 PetscLinearSolver (const HypreParMatrix &A, bool wrap=true, const std::string &prefix=std::string())
 Constructs a solver using a HypreParMatrix. More...
virtual ~PetscLinearSolver ()
virtual void SetOperator (const Operator &op)
 Set/update the solver for the given operator. More...
void SetOperator (const Operator &op, const Operator &pop)
void SetPreconditioner (Solver &precond)
 Sets the solver to perform preconditioning. More...
virtual void Mult (const Vector &b, Vector &x) const
 Application of the solver. More...
 operator KSP () const
 Conversion function to PETSc's KSP type. More...
- Public Member Functions inherited from mfem::PetscSolver
 PetscSolver ()
 Construct an empty PetscSolver. Initialize protected objects to NULL. More...
virtual ~PetscSolver ()
 Destroy the PetscParVectors allocated (if any). More...
void Customize (bool customize=true) const
 Customize object with options set. More...
int GetConverged ()
int GetNumIterations ()
double GetFinalNorm ()
void SetMonitor (PetscSolverMonitor *ctx)
 Sets user-defined monitoring routine. More...
void SetBCHandler (PetscBCHandler *bch)
 Sets the object to handle essential boundary conditions. More...
void SetPreconditionerFactory (PetscPreconditionerFactory *factory)
 Sets the object for the creation of the preconditioner. More...
 operator PetscObject () const
 Conversion function to PetscObject. More...
void SetTol (double tol)
void SetRelTol (double tol)
void SetAbsTol (double tol)
void SetMaxIter (int max_iter)
void SetPrintLevel (int plev)
- Public Member Functions inherited from mfem::Solver
 Solver (int s=0, bool iter_mode=false)
 Initialize a square Solver with size s. More...
 Solver (int h, int w, bool iter_mode=false)
 Initialize a Solver with height h and width w. More...
- Public Member Functions inherited from mfem::Operator
 Operator (int s=0)
 Construct a square Operator with given size s (default 0). More...
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size). More...
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows(). More...
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height(). More...
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols(). More...
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width(). More...
virtual void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error. More...
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
void FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
 Form a constrained linear system using a matrix-free approach. More...
virtual void RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
 Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem(). More...
void PrintMatlab (std::ostream &out, int n=0, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
virtual ~Operator ()
 Virtual destructor. More...
Type GetType () const
 Return the type ID of the Operator class. More...

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  Type {
 Enumeration defining IDs for some classes derived from Operator. More...
- Public Attributes inherited from mfem::Solver
bool iterative_mode
 If true, use the second argument of Mult() as an initial guess. More...
- Protected Member Functions inherited from mfem::PetscSolver
void CreatePrivateContext ()
void FreePrivateContext ()
- Protected Attributes inherited from mfem::PetscSolver
bool clcustom
 Boolean to handle SetFromOptions calls. More...
PetscObject obj
 The actual PETSc object (KSP, PC, SNES or TS). More...
PetscClassId cid
 The class id of the actual PETSc object. More...
 Right-hand side and solution vector. More...
 Handler for boundary conditions. More...
void * private_ctx
 Private context for solver. More...
bool operatorset
 Boolean to handle SetOperator calls. More...
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix. More...
int width
 Dimension of the input / number of columns in the matrix. More...

Detailed Description

Definition at line 512 of file petsc.hpp.

Constructor & Destructor Documentation

mfem::PetscPCGSolver::PetscPCGSolver ( MPI_Comm  comm,
const std::string &  prefix = std::string() 

Definition at line 2086 of file petsc.cpp.

mfem::PetscPCGSolver::PetscPCGSolver ( PetscParMatrix A,
const std::string &  prefix = std::string() 

Definition at line 2095 of file petsc.cpp.

mfem::PetscPCGSolver::PetscPCGSolver ( HypreParMatrix A,
bool  wrap = true,
const std::string &  prefix = std::string() 

Definition at line 2104 of file petsc.cpp.

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