MFEM
v4.0
Finite element discretization library
|
Abstract class for PETSc's preconditioners. More...
#include <petsc.hpp>
Public Member Functions | |
PetscPreconditioner (MPI_Comm comm, const std::string &prefix=std::string()) | |
PetscPreconditioner (PetscParMatrix &A, const std::string &prefix=std::string()) | |
PetscPreconditioner (MPI_Comm comm, Operator &op, const std::string &prefix=std::string()) | |
virtual | ~PetscPreconditioner () |
virtual void | SetOperator (const Operator &op) |
Set/update the solver for the given operator. More... | |
virtual void | Mult (const Vector &b, Vector &x) const |
Application of the preconditioner. More... | |
operator PC () const | |
Conversion function to PETSc's PC type. More... | |
![]() | |
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... | |
MPI_Comm | GetComm () const |
Get the associated MPI communicator. More... | |
void | SetTol (double tol) |
void | SetRelTol (double tol) |
void | SetAbsTol (double tol) |
void | SetMaxIter (int max_iter) |
void | SetPrintLevel (int plev) |
![]() | |
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... | |
![]() | |
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 MemoryClass | GetMemoryClass () const |
Return the MemoryClass preferred by the Operator. 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 Operator & | GetGradient (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 Operator * | GetProlongation () const |
Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More... | |
virtual const Operator * | GetRestriction () 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 | |
![]() | |
enum | Type { ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC } |
Enumeration defining IDs for some classes derived from Operator. More... | |
![]() | |
bool | iterative_mode |
If true, use the second argument of Mult() as an initial guess. More... | |
![]() | |
void | CreatePrivateContext () |
void | FreePrivateContext () |
![]() | |
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... | |
PetscParVector * | B |
Right-hand side and solution vector. More... | |
PetscParVector * | X |
PetscBCHandler * | bchandler |
Handler for boundary conditions. More... | |
void * | private_ctx |
Private context for solver. More... | |
bool | operatorset |
Boolean to handle SetOperator calls. More... | |
![]() | |
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... | |
mfem::PetscPreconditioner::PetscPreconditioner | ( | MPI_Comm | comm, |
const std::string & | prefix = std::string() |
||
) |
mfem::PetscPreconditioner::PetscPreconditioner | ( | PetscParMatrix & | A, |
const std::string & | prefix = std::string() |
||
) |
mfem::PetscPreconditioner::PetscPreconditioner | ( | MPI_Comm | comm, |
Operator & | op, | ||
const std::string & | prefix = std::string() |
||
) |
|
virtual |
Application of the preconditioner.
Implements mfem::Operator.
|
inline |
|
virtual |
Set/update the solver for the given operator.
Implements mfem::Solver.