Abstract base class for Multigrid solvers. More...

#include <multigrid.hpp>

Inheritance diagram for mfem::MultigridBase:

Collaboration diagram for mfem::MultigridBase:

Public Types
enum class	CycleType { VCYCLE , 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.

	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.

virtual	~MultigridBase ()
	Destructor.

void	AddLevel (Operator op, Solver smoother, bool ownOperator, bool ownSmoother)
	Adds a level to the multigrid operator hierarchy.

int	NumLevels () const
	Returns the number of levels.

int	GetFinestLevelIndex () const
	Returns the index of the finest level.

const Operator *	GetOperatorAtLevel (int level) const
	Returns operator at given level.

Operator *	GetOperatorAtLevel (int level)

const Operator *	GetOperatorAtFinestLevel () const
	Returns operator at finest level.

Operator *	GetOperatorAtFinestLevel ()

const Solver *	GetSmootherAtLevel (int level) const
	Returns smoother at given level.

Solver *	GetSmootherAtLevel (int level)

void	SetCycleType (CycleType cycleType_, int preSmoothingSteps_, int postSmoothingSteps_)
	Set cycle type and number of pre- and post-smoothing steps used by Mult.

virtual void	Mult (const Vector &x, Vector &y) const override
	Application of the multigrid as a preconditioner.

virtual void	ArrayMult (const Array< const Vector * > &X_, Array< Vector * > &Y_) const override
	Operator application on a matrix: `Y=A(X)`.

virtual void	SetOperator (const Operator &op) override
	Not supported for multigrid.

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

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 Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity.

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity.

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity.

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.

virtual const Operator *	GetOutputRestriction () 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.

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.

int	width
	Dimension of the input / number of columns in the matrix.

Additional Inherited Members
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::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()

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt".

Detailed Description

Abstract base class for Multigrid solvers.

Definition at line 25 of file multigrid.hpp.

Member Enumeration Documentation

◆ CycleType

enum class mfem::MultigridBase::CycleType

strong

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]

Operator * mfem::MultigridBase::GetOperatorAtFinestLevel ( )

inline

Definition at line 89 of file multigrid.hpp.

◆ GetOperatorAtFinestLevel() [2/2]

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

inline

Returns operator at finest level.

Definition at line 85 of file multigrid.hpp.

◆ GetOperatorAtLevel() [1/2]

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

inline

Definition at line 79 of file multigrid.hpp.

◆ GetOperatorAtLevel() [2/2]

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

inline

Returns operator at given level.

Definition at line 75 of file multigrid.hpp.

◆ GetSmootherAtLevel() [1/2]

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

inline

Definition at line 99 of file multigrid.hpp.

◆ GetSmootherAtLevel() [2/2]

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

inline

Returns smoother at given level.

Definition at line 95 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

protected

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

protected

Definition at line 44 of file multigrid.hpp.

◆ Z

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

protected

Definition at line 44 of file multigrid.hpp.

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

fem/multigrid.hpp
fem/multigrid.cpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CycleType

Constructor & Destructor Documentation

◆ MultigridBase() [1/2]

◆ MultigridBase() [2/2]

◆ ~MultigridBase()

Member Function Documentation

◆ AddLevel()

◆ ArrayMult()

◆ GetFinestLevelIndex()

◆ GetOperatorAtFinestLevel() [1/2]

◆ GetOperatorAtFinestLevel() [2/2]

◆ GetOperatorAtLevel() [1/2]

◆ GetOperatorAtLevel() [2/2]

◆ GetSmootherAtLevel() [1/2]

◆ GetSmootherAtLevel() [2/2]

◆ Mult()

◆ NumLevels()

◆ SetCycleType()

◆ SetOperator()

Member Data Documentation

◆ cycleType

◆ nrhs

◆ operators

◆ ownedOperators

◆ ownedSmoothers

◆ postSmoothingSteps

◆ preSmoothingSteps

◆ R

◆ smoothers

◆ X

◆ Y

◆ Z