Jet  v1.3.3
Public Attributes | List of all members
jet::MgParameters< BlasType > Struct Template Reference

Multigrid input parameter set. More...

#include <jet/mg.h>

Public Attributes

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

Detailed Description

template<typename BlasType>
struct jet::MgParameters< BlasType >

Multigrid input parameter set.

Member Data Documentation

◆ correctFunc

template<typename BlasType >
MgCorrectFunc<BlasType> jet::MgParameters< BlasType >::correctFunc

Correction function that maps coarser to finer grid.

◆ maxNumberOfLevels

template<typename BlasType >
size_t jet::MgParameters< BlasType >::maxNumberOfLevels = 1

Max number of multigrid levels.

◆ maxTolerance

template<typename BlasType >
double jet::MgParameters< BlasType >::maxTolerance = 1e-9

Max error tolerance.

◆ numberOfCoarsestIter

template<typename BlasType >
unsigned int jet::MgParameters< BlasType >::numberOfCoarsestIter = 20

Number of iteration at coarsest step.

◆ numberOfCorrectionIter

template<typename BlasType >
unsigned int jet::MgParameters< BlasType >::numberOfCorrectionIter = 5

Number of iteration at correction step.

◆ numberOfFinalIter

template<typename BlasType >
unsigned int jet::MgParameters< BlasType >::numberOfFinalIter = 20

Number of iteration at final step.

◆ numberOfRestrictionIter

template<typename BlasType >
unsigned int jet::MgParameters< BlasType >::numberOfRestrictionIter = 5

Number of iteration at restriction step.

◆ relaxFunc

template<typename BlasType >
MgRelaxFunc<BlasType> jet::MgParameters< BlasType >::relaxFunc

Relaxation function such as Jacobi or Gauss-Seidel.

◆ restrictFunc

template<typename BlasType >
MgRestrictFunc<BlasType> jet::MgParameters< BlasType >::restrictFunc

Restrict function that maps finer to coarser grid.


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