KASKADE 7 development version: Kaskade::MultigridSolver< Grid, nComponents >::Parameter Struct Reference

KASKADE 7 development version

#include <multiGridSolver.hh>

Detailed Description

template<class Grid, int nComponents = 1>
struct Kaskade::MultigridSolver< Grid, nComponents >::Parameter

Definition at line 469 of file multiGridSolver.hh.

Public Member Functions
	Parameter (size_t maxSteps_, size_t maxSmoothingSteps_, double maxTol_, double relaxation_=0.5, bool verbose_=false)

	Parameter (size_t maxSteps_=100, size_t maxSmoothingSteps_=10, size_t maxCGSteps_=1000, size_t lookahead_=25, double maxTol_=1e-9, double relaxation_=0.5, bool verbose_=false, bool useDirectLevel0Solver_=true)

	Parameter (Parameter const &)=default

Parameter &	operator= (Parameter const &)=default

Public Attributes
size_t	maxSteps

size_t	maxSmoothingSteps

size_t	maxCGSteps = 1000

size_t	lookahead = 25

double	maxTol

double	relaxation

double	cgTol = 1e-9

double	eps = 1e-15

bool	verbose

bool	useDirectLevel0Solver = true

Constructor & Destructor Documentation

◆ Parameter() [1/3]

template<class Grid , int nComponents = 1>

Kaskade::MultigridSolver< Grid, nComponents >::Parameter::Parameter	(	size_t	maxSteps_,
		size_t	maxSmoothingSteps_,
		double	maxTol_,
		double	relaxation_ = `0.5`,
		bool	verbose_ = `false`
	)

inlineexplicit

Definition at line 471 of file multiGridSolver.hh.

◆ Parameter() [2/3]

template<class Grid , int nComponents = 1>

Kaskade::MultigridSolver< Grid, nComponents >::Parameter::Parameter	(	size_t	maxSteps_ = `100`,
		size_t	maxSmoothingSteps_ = `10`,
		size_t	maxCGSteps_ = `1000`,
		size_t	lookahead_ = `25`,
		double	maxTol_ = `1e-9`,
		double	relaxation_ = `0.5`,
		bool	verbose_ = `false`,
		bool	useDirectLevel0Solver_ = `true`
	)

inlineexplicit

Definition at line 475 of file multiGridSolver.hh.

◆ Parameter() [3/3]

template<class Grid , int nComponents = 1>

Kaskade::MultigridSolver< Grid, nComponents >::Parameter::Parameter ( Parameter const & )

default

Member Function Documentation

◆ operator=()

template<class Grid , int nComponents = 1>

Parameter & Kaskade::MultigridSolver< Grid, nComponents >::Parameter::operator= ( Parameter const & )

default

Member Data Documentation

◆ cgTol

template<class Grid , int nComponents = 1>

double Kaskade::MultigridSolver< Grid, nComponents >::Parameter::cgTol = 1e-9

Definition at line 485 of file multiGridSolver.hh.

◆ eps

template<class Grid , int nComponents = 1>

double Kaskade::MultigridSolver< Grid, nComponents >::Parameter::eps = 1e-15

Definition at line 485 of file multiGridSolver.hh.

◆ lookahead

template<class Grid , int nComponents = 1>

size_t Kaskade::MultigridSolver< Grid, nComponents >::Parameter::lookahead = 25

Definition at line 484 of file multiGridSolver.hh.

◆ maxCGSteps

template<class Grid , int nComponents = 1>

size_t Kaskade::MultigridSolver< Grid, nComponents >::Parameter::maxCGSteps = 1000

Definition at line 484 of file multiGridSolver.hh.

◆ maxSmoothingSteps

template<class Grid , int nComponents = 1>

size_t Kaskade::MultigridSolver< Grid, nComponents >::Parameter::maxSmoothingSteps

Definition at line 484 of file multiGridSolver.hh.

◆ maxSteps

template<class Grid , int nComponents = 1>

size_t Kaskade::MultigridSolver< Grid, nComponents >::Parameter::maxSteps

Definition at line 484 of file multiGridSolver.hh.

Referenced by Kaskade::MultigridSolver< Grid, nComponents >::apply().

◆ maxTol

template<class Grid , int nComponents = 1>

double Kaskade::MultigridSolver< Grid, nComponents >::Parameter::maxTol

Definition at line 485 of file multiGridSolver.hh.

Referenced by Kaskade::MultigridSolver< Grid, nComponents >::apply().

◆ relaxation

template<class Grid , int nComponents = 1>

double Kaskade::MultigridSolver< Grid, nComponents >::Parameter::relaxation

Definition at line 485 of file multiGridSolver.hh.

◆ useDirectLevel0Solver

template<class Grid , int nComponents = 1>

bool Kaskade::MultigridSolver< Grid, nComponents >::Parameter::useDirectLevel0Solver = true

Definition at line 486 of file multiGridSolver.hh.

◆ verbose

template<class Grid , int nComponents = 1>

bool Kaskade::MultigridSolver< Grid, nComponents >::Parameter::verbose

Definition at line 486 of file multiGridSolver.hh.

Referenced by Kaskade::MultigridSolver< Grid, nComponents >::apply().

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

multiGridSolver.hh