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

Abstract base class for Multigrid solvers. More...

#include <multigrid.hpp>

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

Public Types

enum  CycleType { CycleType::VCYCLE, CycleType::WCYCLE }
 
- 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 Member Functions

 MultigridBase ()
 Constructs an empty multigrid hierarchy. More...
 
 MultigridBase (const Array< Operator *> &operators_, const Array< Solver *> &smoothers_, const Array< bool > &ownedOperators_, const Array< bool > &ownedSmoothers_)
 Constructs a multigrid hierarchy from the given inputs. More...
 
virtual ~MultigridBase ()
 Destructor. More...
 
void AddLevel (Operator *op, Solver *smoother, bool ownOperator, bool ownSmoother)
 Adds a level to the multigrid operator hierarchy. More...
 
int NumLevels () const
 Returns the number of levels. More...
 
int GetFinestLevelIndex () const
 Returns the index of the finest level. More...
 
const OperatorGetOperatorAtLevel (int level) const
 Returns operator at given level. More...
 
OperatorGetOperatorAtLevel (int level)
 
const OperatorGetOperatorAtFinestLevel () const
 Returns operator at finest level. More...
 
OperatorGetOperatorAtFinestLevel ()
 
const SolverGetSmootherAtLevel (int level) const
 Returns smoother at given level. More...
 
SolverGetSmootherAtLevel (int level)
 
void SetCycleType (CycleType cycleType_, int preSmoothingSteps_, int postSmoothingSteps_)
 Set cycle type and number of pre- and post-smoothing steps used by Mult. More...
 
virtual void Mult (const Vector &x, Vector &y) const override
 Application of the multigrid as a preconditioner. More...
 
virtual void ArrayMult (const Array< const Vector *> &X_, Array< Vector *> &Y_) const override
 Operator application on a matrix: Y=A(X). More...
 
virtual void SetOperator (const Operator &op) override
 Not supported for multigrid. More...
 
- 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
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. 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 void AddMult (const Vector &x, Vector &y, const double a=1.0) const
 Operator application: y+=A(x) (default) or y+=a*A(x). More...
 
virtual void AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const
 Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x). More...
 
virtual void ArrayMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y) const
 Action of the transpose operator on a matrix: Y=A^t(X). More...
 
virtual void ArrayAddMult (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X). More...
 
virtual void ArrayAddMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X). 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 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. 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...
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...
 
virtual const OperatorGetOutputRestriction () const
 Restriction operator from output 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...
 
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. 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() or Operator::FormRectangularLinearSystem(). More...
 
void FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
 Return in A a parallel (on truedofs) version of this square operator. More...
 
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). More...
 
void FormDiscreteOperator (Operator *&A)
 Return in A a parallel (on truedofs) version of this rectangular operator. More...
 
void PrintMatlab (std::ostream &out, int n, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual void PrintMatlab (std::ostream &out) const
 Prints operator in Matlab format. More...
 
virtual ~Operator ()
 Virtual destructor. More...
 
Type GetType () const
 Return the type ID of the Operator class. More...
 

Protected Attributes

Array< Operator * > operators
 
Array< Solver * > smoothers
 
Array< bool > ownedOperators
 
Array< bool > ownedSmoothers
 
CycleType cycleType
 
int preSmoothingSteps
 
int postSmoothingSteps
 
Array2D< Vector * > X
 
Array2D< Vector * > Y
 
Array2D< Vector * > R
 
Array2D< Vector * > Z
 
int nrhs
 
- 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...
 

Additional Inherited Members

- 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::Operator
void FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
 see FormSystemOperator() More...
 
void FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
 see FormRectangularSystemOperator() More...
 
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". More...
 

Detailed Description

Abstract base class for Multigrid solvers.

Definition at line 25 of file multigrid.hpp.

Member Enumeration Documentation

◆ CycleType

Enumerator
VCYCLE 
WCYCLE 

Definition at line 28 of file multigrid.hpp.

Constructor & Destructor Documentation

◆ MultigridBase() [1/2]

mfem::MultigridBase::MultigridBase ( )

Constructs an empty multigrid hierarchy.

Definition at line 17 of file multigrid.cpp.

◆ MultigridBase() [2/2]

mfem::MultigridBase::MultigridBase ( const Array< Operator *> &  operators_,
const Array< Solver *> &  smoothers_,
const Array< bool > &  ownedOperators_,
const Array< bool > &  ownedSmoothers_ 
)

Constructs a multigrid hierarchy from the given inputs.

Inputs include operators and smoothers on all levels, and ownership of the given operators and smoothers

Definition at line 22 of file multigrid.cpp.

◆ ~MultigridBase()

mfem::MultigridBase::~MultigridBase ( )
virtual

Destructor.

Definition at line 36 of file multigrid.cpp.

Member Function Documentation

◆ AddLevel()

void mfem::MultigridBase::AddLevel ( Operator op,
Solver smoother,
bool  ownOperator,
bool  ownSmoother 
)

Adds a level to the multigrid operator hierarchy.

The ownership of the operators and solvers/smoothers may be transferred to the Multigrid by setting the according boolean variables

Definition at line 87 of file multigrid.cpp.

◆ ArrayMult()

void mfem::MultigridBase::ArrayMult ( const Array< const Vector *> &  X,
Array< Vector *> &  Y 
) const
overridevirtual

Operator application on a matrix: Y=A(X).

Reimplemented from mfem::Operator.

Definition at line 115 of file multigrid.cpp.

◆ GetFinestLevelIndex()

int mfem::MultigridBase::GetFinestLevelIndex ( ) const
inline

Returns the index of the finest level.

Definition at line 72 of file multigrid.hpp.

◆ GetOperatorAtFinestLevel() [1/2]

const Operator* mfem::MultigridBase::GetOperatorAtFinestLevel ( ) const
inline

Returns operator at finest level.

Definition at line 85 of file multigrid.hpp.

◆ GetOperatorAtFinestLevel() [2/2]

Operator* mfem::MultigridBase::GetOperatorAtFinestLevel ( )
inline

Definition at line 89 of file multigrid.hpp.

◆ GetOperatorAtLevel() [1/2]

const Operator* mfem::MultigridBase::GetOperatorAtLevel ( int  level) const
inline

Returns operator at given level.

Definition at line 75 of file multigrid.hpp.

◆ GetOperatorAtLevel() [2/2]

Operator* mfem::MultigridBase::GetOperatorAtLevel ( int  level)
inline

Definition at line 79 of file multigrid.hpp.

◆ GetSmootherAtLevel() [1/2]

const Solver* mfem::MultigridBase::GetSmootherAtLevel ( int  level) const
inline

Returns smoother at given level.

Definition at line 95 of file multigrid.hpp.

◆ GetSmootherAtLevel() [2/2]

Solver* mfem::MultigridBase::GetSmootherAtLevel ( int  level)
inline

Definition at line 99 of file multigrid.hpp.

◆ Mult()

void mfem::MultigridBase::Mult ( const Vector x,
Vector y 
) const
overridevirtual

Application of the multigrid as a preconditioner.

Implements mfem::Operator.

Definition at line 106 of file multigrid.cpp.

◆ NumLevels()

int mfem::MultigridBase::NumLevels ( ) const
inline

Returns the number of levels.

Definition at line 69 of file multigrid.hpp.

◆ SetCycleType()

void mfem::MultigridBase::SetCycleType ( CycleType  cycleType_,
int  preSmoothingSteps_,
int  postSmoothingSteps_ 
)

Set cycle type and number of pre- and post-smoothing steps used by Mult.

Definition at line 98 of file multigrid.cpp.

◆ SetOperator()

virtual void mfem::MultigridBase::SetOperator ( const Operator op)
inlineoverridevirtual

Not supported for multigrid.

Implements mfem::Solver.

Reimplemented in mfem::ceed::AlgebraicMultigrid.

Definition at line 114 of file multigrid.hpp.

Member Data Documentation

◆ cycleType

CycleType mfem::MultigridBase::cycleType
protected

Definition at line 40 of file multigrid.hpp.

◆ nrhs

int mfem::MultigridBase::nrhs
mutableprotected

Definition at line 45 of file multigrid.hpp.

◆ operators

Array<Operator*> mfem::MultigridBase::operators
protected

Definition at line 35 of file multigrid.hpp.

◆ ownedOperators

Array<bool> mfem::MultigridBase::ownedOperators
protected

Definition at line 37 of file multigrid.hpp.

◆ ownedSmoothers

Array<bool> mfem::MultigridBase::ownedSmoothers
protected

Definition at line 38 of file multigrid.hpp.

◆ postSmoothingSteps

int mfem::MultigridBase::postSmoothingSteps
protected

Definition at line 42 of file multigrid.hpp.

◆ preSmoothingSteps

int mfem::MultigridBase::preSmoothingSteps
protected

Definition at line 41 of file multigrid.hpp.

◆ R

Array2D<Vector*> mfem::MultigridBase::R
mutableprotected

Definition at line 44 of file multigrid.hpp.

◆ smoothers

Array<Solver*> mfem::MultigridBase::smoothers
protected

Definition at line 36 of file multigrid.hpp.

◆ X

Array2D<Vector*> mfem::MultigridBase::X
mutableprotected

Definition at line 44 of file multigrid.hpp.

◆ Y

Array2D<Vector*> mfem::MultigridBase::Y
mutableprotected

Definition at line 44 of file multigrid.hpp.

◆ Z

Array2D<Vector*> mfem::MultigridBase::Z
mutableprotected

Definition at line 44 of file multigrid.hpp.


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