Stable preconditioner object seen by outer MFEM solvers. More...

Inheritance diagram for MFEMGeometricMultigridSolver::MGProxy:

Public Member Functions
	MGProxy (MFEMGeometricMultigridSolver &owner)
	Constructs a proxy that delegates multigrid rebuilding to the owning MOOSE solver. More...

void	setMG (mfem::GeometricMultigrid &mg)
	Updates the concrete MFEM multigrid object used by Mult(). More...

void	SetOperator (const mfem::Operator &op) override
	Rebuilds the owner's multigrid hierarchy for the new outer-solver operator. More...

void	Mult (const mfem::Vector &x, mfem::Vector &y) const override
	Applies the current concrete MFEM multigrid preconditioner. More...

Private Attributes
MFEMGeometricMultigridSolver &	_owner
	Solver object that owns the concrete multigrid and level data. More...

mfem::GeometricMultigrid *	_mg = nullptr
	Non-owning pointer to the currently active concrete MFEM multigrid object. More...

Detailed Description

Stable preconditioner object seen by outer MFEM solvers.

MFEM iterative solvers call SetOperator() on their preconditioner, but mfem::GeometricMultigrid::SetOperator() aborts. This proxy keeps a stable solver address for the outer solver and uses SetOperator() as the hook to rebuild the actual multigrid hierarchy.

Definition at line 82 of file MFEMGeometricMultigridSolver.h.

Constructor & Destructor Documentation

◆ MGProxy()

MFEMGeometricMultigridSolver::MGProxy::MGProxy ( MFEMGeometricMultigridSolver & owner )

Constructs a proxy that delegates multigrid rebuilding to the owning MOOSE solver.

Definition at line 18 of file MFEMGeometricMultigridSolver.C.

                                                                                  : _owner(owner)
 {
   // MGProxy is installed as a preconditioner, so Mult() should overwrite its output vector rather
   // than treating it as an initial iterate. This matches MFEM's
   // IterativeSolver::SetPreconditioner() convention, which sets the preconditioner's iterative_mode
   // to false.
   iterative_mode = false;
 }

Member Function Documentation

◆ Mult()

void MFEMGeometricMultigridSolver::MGProxy::Mult	(	const mfem::Vector &	x,
		mfem::Vector &	y
	)		const

override

Applies the current concrete MFEM multigrid preconditioner.

Definition at line 42 of file MFEMGeometricMultigridSolver.C.

 {
   MFEM_VERIFY(_mg, "MGProxy: GeometricMultigrid not yet built");
   _mg->Mult(x, y);
 }

◆ setMG()

void MFEMGeometricMultigridSolver::MGProxy::setMG ( mfem::GeometricMultigrid & mg )

Updates the concrete MFEM multigrid object used by Mult().

Definition at line 28 of file MFEMGeometricMultigridSolver.C.

Referenced by MFEMGeometricMultigridSolver::BuildMultigrid().

 {
   _mg = &mg;
   height = mg.Height();
   width = mg.Width();
 }

◆ SetOperator()

void MFEMGeometricMultigridSolver::MGProxy::SetOperator ( const mfem::Operator & op )

override

Rebuilds the owner's multigrid hierarchy for the new outer-solver operator.

Definition at line 36 of file MFEMGeometricMultigridSolver.C.

 {
   _owner.BuildMultigrid(op);
 }

Member Data Documentation

◆ _mg

mfem::GeometricMultigrid* MFEMGeometricMultigridSolver::MGProxy::_mg = nullptr

private

Non-owning pointer to the currently active concrete MFEM multigrid object.

Definition at line 102 of file MFEMGeometricMultigridSolver.h.

◆ _owner

MFEMGeometricMultigridSolver& MFEMGeometricMultigridSolver::MGProxy::_owner

private

Solver object that owns the concrete multigrid and level data.

Definition at line 99 of file MFEMGeometricMultigridSolver.h.

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

include/mfem/solvers/MFEMGeometricMultigridSolver.h
src/mfem/solvers/MFEMGeometricMultigridSolver.C

Public Member Functions

Private Attributes