3-D finite difference-type linear system solver using Multigrid. More...

#include <jet/fdm_mg_solver3.h>

Inheritance diagram for jet::FdmMgSolver3:

Public Member Functions
	FdmMgSolver3 ()=default

virtual	~FdmMgSolver3 ()=default

	FdmMgSolver3 (size_t maxNumberOfLevels, unsigned int numberOfRestrictionIter=5, unsigned int numberOfCorrectionIter=5, unsigned int numberOfCoarsestIter=20, unsigned int numberOfFinalIter=20, double maxTolerance=1e-9, double sorFactor=1.5, bool useRedBlackOrdering=false)
	Constructs the solver with given parameters. More...

const MgParameters< FdmBlas3 > &	params () const
	Returns the Multigrid parameters. More...

double	sorFactor () const
	Returns the SOR (Successive Over Relaxation) factor. More...

bool	useRedBlackOrdering () const
	Returns true if red-black ordering is enabled. More...

bool	solve (FdmLinearSystem3 *system) final
	No-op. Multigrid-type solvers do not solve FdmLinearSystem3. More...

virtual bool	solve (FdmMgLinearSystem3 *system)
	Solves Multigrid linear system. More...

Public Member Functions inherited from jet::FdmLinearSystemSolver3
	FdmLinearSystemSolver3 ()=default

virtual	~FdmLinearSystemSolver3 ()=default

virtual bool	solveCompressed (FdmCompressedLinearSystem3 *)
	Solves the given compressed linear system. More...

Detailed Description

3-D finite difference-type linear system solver using Multigrid.

Constructor & Destructor Documentation

◆ FdmMgSolver3() [1/2]

jet::FdmMgSolver3::FdmMgSolver3 ( )

default

◆ ~FdmMgSolver3()

virtual jet::FdmMgSolver3::~FdmMgSolver3 ( )

virtualdefault

◆ FdmMgSolver3() [2/2]

jet::FdmMgSolver3::FdmMgSolver3	(	size_t	maxNumberOfLevels,
		unsigned int	numberOfRestrictionIter = `5`,
		unsigned int	numberOfCorrectionIter = `5`,
		unsigned int	numberOfCoarsestIter = `20`,
		unsigned int	numberOfFinalIter = `20`,
		double	maxTolerance = `1e-9`,
		double	sorFactor = `1.5`,
		bool	useRedBlackOrdering = `false`
	)

Constructs the solver with given parameters.

Member Function Documentation

◆ params()

const MgParameters<FdmBlas3>& jet::FdmMgSolver3::params ( ) const

Returns the Multigrid parameters.

◆ solve() [1/2]

bool jet::FdmMgSolver3::solve ( FdmLinearSystem3 * system )

finalvirtual

No-op. Multigrid-type solvers do not solve FdmLinearSystem3.

Implements jet::FdmLinearSystemSolver3.

◆ solve() [2/2]

virtual bool jet::FdmMgSolver3::solve ( FdmMgLinearSystem3 * system )

virtual

Solves Multigrid linear system.

Reimplemented in jet::FdmMgpcgSolver3.

◆ sorFactor()

double jet::FdmMgSolver3::sorFactor ( ) const

Returns the SOR (Successive Over Relaxation) factor.

◆ useRedBlackOrdering()

bool jet::FdmMgSolver3::useRedBlackOrdering ( ) const

Returns true if red-black ordering is enabled.

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

jet/fdm_mg_solver3.h

Public Member Functions