MFEM  v4.6.0
Finite element discretization library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::PetscSolver Class Reference

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

#include <petsc.hpp>

Inheritance diagram for mfem::PetscSolver:
Collaboration diagram for mfem::PetscSolver:

Public Member Functions

 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...
Update of PETSc options.

The following Set methods can be used to update the internal PETSc options.

They will be overwritten by the options in the input PETSc file.
void SetTol (double tol)
void SetRelTol (double tol)
void SetAbsTol (double tol)
void SetMaxIter (int max_iter)
void SetPrintLevel (int plev)

Protected Member Functions

void CreatePrivateContext ()
void FreePrivateContext ()

Protected Attributes

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...

Detailed Description

Abstract class for PETSc's solvers.

Definition at line 672 of file petsc.hpp.

Constructor & Destructor Documentation

◆ PetscSolver()

mfem::PetscSolver::PetscSolver ( )

Construct an empty PetscSolver. Initialize protected objects to NULL.

Definition at line 2351 of file petsc.cpp.

◆ ~PetscSolver()

mfem::PetscSolver::~PetscSolver ( )

Destroy the PetscParVectors allocated (if any).

Definition at line 2361 of file petsc.cpp.

Member Function Documentation

◆ CreatePrivateContext()

void mfem::PetscSolver::CreatePrivateContext ( )

These two methods handle creation and destructions of private data for the Solver objects

Definition at line 2749 of file petsc.cpp.

◆ Customize()

void mfem::PetscSolver::Customize ( bool  customize = true) const

Customize object with options set.

If customize is false, it disables any options customization.

Definition at line 2625 of file petsc.cpp.

◆ FreePrivateContext()

void mfem::PetscSolver::FreePrivateContext ( )

Definition at line 2781 of file petsc.cpp.

◆ GetComm()

MPI_Comm mfem::PetscSolver::GetComm ( ) const

Get the associated MPI communicator.

Definition at line 2530 of file petsc.cpp.

◆ GetConverged()

int mfem::PetscSolver::GetConverged ( )

Definition at line 2658 of file petsc.cpp.

◆ GetFinalNorm()

double mfem::PetscSolver::GetFinalNorm ( )

Definition at line 2724 of file petsc.cpp.

◆ GetNumIterations()

int mfem::PetscSolver::GetNumIterations ( )

Definition at line 2691 of file petsc.cpp.

◆ operator PetscObject()

mfem::PetscSolver::operator PetscObject ( ) const

Conversion function to PetscObject.

Definition at line 732 of file petsc.hpp.

◆ SetAbsTol()

void mfem::PetscSolver::SetAbsTol ( double  tol)

Definition at line 2398 of file petsc.cpp.

◆ SetBCHandler()

void mfem::PetscSolver::SetBCHandler ( PetscBCHandler bch)

Sets the object to handle essential boundary conditions.

Definition at line 2565 of file petsc.cpp.

◆ SetMaxIter()

void mfem::PetscSolver::SetMaxIter ( int  max_iter)

Definition at line 2423 of file petsc.cpp.

◆ SetMonitor()

void mfem::PetscSolver::SetMonitor ( PetscSolverMonitor ctx)

Sets user-defined monitoring routine.

Definition at line 2535 of file petsc.cpp.

◆ SetPreconditionerFactory()

void mfem::PetscSolver::SetPreconditionerFactory ( PetscPreconditionerFactory factory)

Sets the object for the creation of the preconditioner.

Definition at line 2584 of file petsc.cpp.

◆ SetPrintLevel()

void mfem::PetscSolver::SetPrintLevel ( int  plev)

Definition at line 2450 of file petsc.cpp.

◆ SetRelTol()

void mfem::PetscSolver::SetRelTol ( double  tol)

Definition at line 2373 of file petsc.cpp.

◆ SetTol()

void mfem::PetscSolver::SetTol ( double  tol)

Definition at line 2368 of file petsc.cpp.

Member Data Documentation

◆ B

PetscParVector* mfem::PetscSolver::B

Right-hand side and solution vector.

Definition at line 685 of file petsc.hpp.

◆ bchandler

PetscBCHandler* mfem::PetscSolver::bchandler

Handler for boundary conditions.

Definition at line 688 of file petsc.hpp.

◆ cid

PetscClassId mfem::PetscSolver::cid

The class id of the actual PETSc object.

Definition at line 682 of file petsc.hpp.

◆ clcustom

bool mfem::PetscSolver::clcustom

Boolean to handle SetFromOptions calls.

Definition at line 676 of file petsc.hpp.

◆ obj

PetscObject mfem::PetscSolver::obj

The actual PETSc object (KSP, PC, SNES or TS).

Definition at line 679 of file petsc.hpp.

◆ operatorset

bool mfem::PetscSolver::operatorset

Boolean to handle SetOperator calls.

Definition at line 694 of file petsc.hpp.

◆ private_ctx

void* mfem::PetscSolver::private_ctx

Private context for solver.

Definition at line 691 of file petsc.hpp.

◆ X

PetscParVector * mfem::PetscSolver::X

Definition at line 685 of file petsc.hpp.

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