CubbyFlow::MGParameters< BlasType > Struct Template Reference

Multi-grid input parameter set. More...

#include <Core/Utils/MG.hpp>

Public Attributes
size_t	maxNumberOfLevels = 1
	Max number of multi-grid levels.
unsigned int	numberOfRestrictionIter = 5
	Number of iteration at restriction step.
unsigned int	numberOfCorrectionIter = 5
	Number of iteration at correction step.
unsigned int	numberOfCoarsestIter = 20
	Number of iteration at coarsest step.
unsigned int	numberOfFinalIter = 20
	Number of iteration at final step.
MGRelaxFunc< BlasType >	relaxFunc
	Relaxation function such as Jacobi or Gauss-Seidel.
MGRestrictFunc< BlasType >	restrictFunc
	Restrict function that maps finer to coarser grid.
MGCorrectFunc< BlasType >	correctFunc
	Correction function that maps coarser to finer grid.
double	maxTolerance = 1e-9
	Max error tolerance.

Detailed Description

template<typename BlasType>
struct CubbyFlow::MGParameters< BlasType >

Multi-grid input parameter set.

Member Data Documentation

correctFunc

template<typename BlasType >

MGCorrectFunc<BlasType> CubbyFlow::MGParameters< BlasType >::correctFunc

Correction function that maps coarser to finer grid.

maxNumberOfLevels

template<typename BlasType >

size_t CubbyFlow::MGParameters< BlasType >::maxNumberOfLevels = 1

Max number of multi-grid levels.

maxTolerance

template<typename BlasType >

double CubbyFlow::MGParameters< BlasType >::maxTolerance = 1e-9

Max error tolerance.

numberOfCoarsestIter

template<typename BlasType >

unsigned int CubbyFlow::MGParameters< BlasType >::numberOfCoarsestIter = 20

Number of iteration at coarsest step.

numberOfCorrectionIter

template<typename BlasType >

unsigned int CubbyFlow::MGParameters< BlasType >::numberOfCorrectionIter = 5

Number of iteration at correction step.

numberOfFinalIter

template<typename BlasType >

unsigned int CubbyFlow::MGParameters< BlasType >::numberOfFinalIter = 20

Number of iteration at final step.

numberOfRestrictionIter

template<typename BlasType >

unsigned int CubbyFlow::MGParameters< BlasType >::numberOfRestrictionIter = 5

Number of iteration at restriction step.

relaxFunc

template<typename BlasType >

MGRelaxFunc<BlasType> CubbyFlow::MGParameters< BlasType >::relaxFunc

Relaxation function such as Jacobi or Gauss-Seidel.

restrictFunc

template<typename BlasType >

MGRestrictFunc<BlasType> CubbyFlow::MGParameters< BlasType >::restrictFunc

Restrict function that maps finer to coarser grid.

---

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

• Core/Utils/MG.hpp