MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::PetscNonlinearSolver Class Reference

Abstract class for PETSc's nonlinear solvers. More...

#include <petsc.hpp>

Inheritance diagram for mfem::PetscNonlinearSolver:
[legend]
Collaboration diagram for mfem::PetscNonlinearSolver:
[legend]

Public Member Functions

 PetscNonlinearSolver (MPI_Comm comm, const std::string &prefix=std::string())
 
 PetscNonlinearSolver (MPI_Comm comm, Operator &op, const std::string &prefix=std::string())
 
virtual ~PetscNonlinearSolver ()
 
virtual void SetOperator (const Operator &op)
 Specification of the nonlinear operator.
 
void SetJacobianType (Operator::Type type)
 
virtual void Mult (const Vector &b, Vector &x) const
 Application of the solver.
 
void SetObjective (void(*obj)(Operator *op, const Vector &x, real_t *f))
 Specification of an objective function to be used for line search.
 
void SetPostCheck (void(*post)(Operator *op, const Vector &X, Vector &Y, Vector &W, bool &changed_y, bool &changed_w))
 
void SetUpdate (void(*update)(Operator *op, int it, const Vector &F, const Vector &X, const Vector &D, const Vector &P))
 
 operator petsc::SNES () const
 Conversion function to PETSc's SNES type.
 
- Public Member Functions inherited from mfem::PetscSolver
 PetscSolver ()
 Construct an empty PetscSolver. Initialize protected objects to NULL.
 
virtual ~PetscSolver ()
 Destroy the PetscParVectors allocated (if any).
 
void Customize (bool customize=true) const
 Customize object with options set.
 
int GetConverged ()
 
int GetNumIterations ()
 
real_t GetFinalNorm ()
 
void SetMonitor (PetscSolverMonitor *ctx)
 Sets user-defined monitoring routine.
 
void SetBCHandler (PetscBCHandler *bch)
 Sets the object to handle essential boundary conditions.
 
void SetPreconditionerFactory (PetscPreconditionerFactory *factory)
 Sets the object for the creation of the preconditioner.
 
 operator PetscObject () const
 Conversion function to PetscObject.
 
MPI_Comm GetComm () const
 Get the associated MPI communicator.
 
void SetTol (real_t tol)
 
void SetRelTol (real_t tol)
 
void SetAbsTol (real_t 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.
 
 Solver (int h, int w, bool iter_mode=false)
 Initialize a Solver with height h and width w.
 
- Public Member Functions inherited from mfem::Operator
void InitTVectors (const Operator *Po, const Operator *Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
 Initializes memory for true vectors of linear system.
 
 Operator (int s=0)
 Construct a square Operator with given size s (default 0).
 
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size).
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows().
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height().
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols().
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width().
 
virtual MemoryClass GetMemoryClass () const
 Return the MemoryClass preferred by the Operator.
 
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.
 
virtual void AddMult (const Vector &x, Vector &y, const real_t a=1.0) const
 Operator application: y+=A(x) (default) or y+=a*A(x).
 
virtual void AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const
 Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x).
 
virtual void ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Operator application on a matrix: Y=A(X).
 
virtual void ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
 Action of the transpose operator on a matrix: Y=A^t(X).
 
virtual void ArrayAddMult (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
 Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X).
 
virtual void ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
 Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X).
 
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.
 
virtual void AssembleDiagonal (Vector &diag) const
 Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed.
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity.
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity.
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.
 
virtual const OperatorGetOutputRestriction () const
 Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity.
 
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.
 
void FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
 Form a column-constrained linear system using a matrix-free approach.
 
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() or Operator::FormRectangularLinearSystem().
 
void FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this square operator.
 
void FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator (including constraints).
 
void FormDiscreteOperator (Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator.
 
void PrintMatlab (std::ostream &out, int n, int m=0) const
 Prints operator with input size n and output size m in Matlab format.
 
virtual void PrintMatlab (std::ostream &out) const
 Prints operator in Matlab format.
 
virtual ~Operator ()
 Virtual destructor.
 
Type GetType () const
 Return the type ID of the Operator class.
 

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  DiagonalPolicy { DIAG_ZERO , DIAG_ONE , DIAG_KEEP }
 Defines operator diagonal policy upon elimination of rows and/or columns. More...
 
enum  Type {
  ANY_TYPE , MFEM_SPARSEMAT , Hypre_ParCSR , PETSC_MATAIJ ,
  PETSC_MATIS , PETSC_MATSHELL , PETSC_MATNEST , PETSC_MATHYPRE ,
  PETSC_MATGENERIC , Complex_Operator , MFEM_ComplexSparseMat , Complex_Hypre_ParCSR ,
  Complex_DenseMat , MFEM_Block_Matrix , MFEM_Block_Operator
}
 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.
 
- Protected Member Functions inherited from mfem::PetscSolver
void CreatePrivateContext ()
 
void FreePrivateContext ()
 
- Protected Member Functions inherited from mfem::Operator
void FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
 see FormSystemOperator()
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator()
 
OperatorSetupRAP (const Operator *Pi, const Operator *Po)
 Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt".
 
- Protected Attributes inherited from mfem::PetscSolver
bool clcustom
 Boolean to handle SetFromOptions calls.
 
PetscObject obj
 The actual PETSc object (KSP, PC, SNES or TS).
 
PetscClassId cid
 The class id of the actual PETSc object.
 
PetscParVectorB
 Right-hand side and solution vector.
 
PetscParVectorX
 
PetscBCHandlerbchandler
 Handler for boundary conditions.
 
void * private_ctx
 Private context for solver.
 
bool operatorset
 Boolean to handle SetOperator calls.
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix.
 
int width
 Dimension of the input / number of columns in the matrix.
 

Detailed Description

Abstract class for PETSc's nonlinear solvers.

Definition at line 906 of file petsc.hpp.

Constructor & Destructor Documentation

◆ PetscNonlinearSolver() [1/2]

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

Definition at line 3971 of file petsc.cpp.

◆ PetscNonlinearSolver() [2/2]

mfem::PetscNonlinearSolver::PetscNonlinearSolver ( MPI_Comm comm,
Operator & op,
const std::string & prefix = std::string() )

Definition at line 3986 of file petsc.cpp.

◆ ~PetscNonlinearSolver()

mfem::PetscNonlinearSolver::~PetscNonlinearSolver ( )
virtual

Definition at line 4003 of file petsc.cpp.

Member Function Documentation

◆ Mult()

void mfem::PetscNonlinearSolver::Mult ( const Vector & b,
Vector & x ) const
virtual

Application of the solver.

Implements mfem::Operator.

Definition at line 4117 of file petsc.cpp.

◆ operator petsc::SNES()

mfem::PetscNonlinearSolver::operator petsc::SNES ( ) const
inline

Conversion function to PETSc's SNES type.

Definition at line 944 of file petsc.hpp.

◆ SetJacobianType()

void mfem::PetscNonlinearSolver::SetJacobianType ( Operator::Type type)

Specifies the desired format of the Jacobian in case a PetscParMatrix is not returned by the GetGradient method.

Definition at line 4073 of file petsc.cpp.

◆ SetObjective()

void mfem::PetscNonlinearSolver::SetObjective ( void(* obj )(Operator *op, const Vector &x, real_t *f))

Specification of an objective function to be used for line search.

Definition at line 4079 of file petsc.cpp.

◆ SetOperator()

void mfem::PetscNonlinearSolver::SetOperator ( const Operator & op)
virtual

Specification of the nonlinear operator.

Implements mfem::Solver.

Definition at line 4011 of file petsc.cpp.

◆ SetPostCheck()

void mfem::PetscNonlinearSolver::SetPostCheck ( void(* post )(Operator *op, const Vector &X, Vector &Y, Vector &W, bool &changed_y, bool &changed_w))

User-defined routine to be applied after a successful line search step. The user can change the current direction Y and/or the updated solution W (with W = X - lambda * Y) but not the previous solution X. If Y or W have been changed, the corresponding booleans need to updated.

Definition at line 4090 of file petsc.cpp.

◆ SetUpdate()

void mfem::PetscNonlinearSolver::SetUpdate ( void(* update )(Operator *op, int it, const Vector &F, const Vector &X, const Vector &D, const Vector &P))

General purpose update function to be called at the beginning of each step it is the current nonlinear iteration number F is the current function value, X the current solution D the previous step taken, and P the previous solution

Definition at line 4104 of file petsc.cpp.


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