Référence de la structure Arcane::Alina::AMG< Backend, Coarsening, Relax >::params

Parameters of the method. Plus de détails...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/alina/arccore/alina/AMG.h>

Graphe de collaboration de Arcane::Alina::AMG< Backend, Coarsening, Relax >::params:

Types publics
typedef coarsening_type::params	coarsening_params
typedef relax_type::params	relax_params

Fonctions membres publiques
	params (const PropertyTree &p)
void	get (PropertyTree &p, const std::string &path="") const

Attributs publics
coarsening_params	coarsening
	Coarsening parameters.
relax_params	relax
	Relaxation parameters.
Int32	coarse_enough = Backend::direct_solver::coarse_enough()
	Specifies when level is coarse enough to be solved directly.
bool	direct_coarse = true
	Use direct solver at the coarsest level.
Int32	max_levels = std::numeric_limits<Int32>::max()
	Maximum number of levels.
Int32	npre = 1
	Number of pre-relaxations.
Int32	npost = 1
	Number of post-relaxations.
Int32	ncycle = 1
	Number of cycles (1 for V-cycle, 2 for W-cycle, etc.).
Int32	pre_cycles = 1
	Number of cycles to make as part of preconditioning.
bool	allow_rebuild = std::is_same<matrix, build_matrix>::value
	Keep matrices in internal format to allow for quick rebuild of the hierarchy.

Description détaillée

template<class Backend, template< class > class Coarsening, template< class > class Relax>
struct Arcane::Alina::AMG< Backend, Coarsening, Relax >::params

Parameters of the method.

This struct includes parameters for each component of the method as well as some universal parameters.

Définition à la ligne 98 du fichier AMG.h.

Documentation des définitions de type membres

coarsening_params

template<class Backend, template< class > class Coarsening, template< class > class Relax>

typedef coarsening_type::params Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::coarsening_params

Définition à la ligne 100 du fichier AMG.h.

relax_params

template<class Backend, template< class > class Coarsening, template< class > class Relax>

typedef relax_type::params Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::relax_params

Définition à la ligne 101 du fichier AMG.h.

Documentation des constructeurs et destructeur

params()

template<class Backend, template< class > class Coarsening, template< class > class Relax>

Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::params ( const PropertyTree & p )

inline

Définition à la ligne 149 du fichier AMG.h.

Documentation des fonctions membres

get()

template<class Backend, template< class > class Coarsening, template< class > class Relax>

void Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::get ( PropertyTree & p, const std::string & path = "" ) const

inline

Définition à la ligne 166 du fichier AMG.h.

Documentation des données membres

allow_rebuild

template<class Backend, template< class > class Coarsening, template< class > class Relax>

bool Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::allow_rebuild = std::is_same<matrix, build_matrix>::value

Keep matrices in internal format to allow for quick rebuild of the hierarchy.

Définition à la ligne 145 du fichier AMG.h.

coarse_enough

template<class Backend, template< class > class Coarsening, template< class > class Relax>

Int32 Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::coarse_enough = Backend::direct_solver::coarse_enough()

Specifies when level is coarse enough to be solved directly.

If number of variables at a next level in the hierarchy becomes lower than this threshold, then the hierarchy construction is stopped and the linear system is solved directly at this level.

Définition à la ligne 113 du fichier AMG.h.

coarsening

template<class Backend, template< class > class Coarsening, template< class > class Relax>

coarsening_params Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::coarsening

Coarsening parameters.

Définition à la ligne 103 du fichier AMG.h.

direct_coarse

template<class Backend, template< class > class Coarsening, template< class > class Relax>

bool Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::direct_coarse = true

Use direct solver at the coarsest level.

When set, the coarsest level is solved with a direct solver. Otherwise a smoother is used as a solver.

Définition à la ligne 121 du fichier AMG.h.

max_levels

template<class Backend, template< class > class Coarsening, template< class > class Relax>

Int32 Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::max_levels = std::numeric_limits<Int32>::max()

Maximum number of levels.

If this number is reached while the size of the last level is greater that coarse_enough, then the coarsest level will not be solved exactly, but will use a smoother.

Définition à la ligne 130 du fichier AMG.h.

ncycle

template<class Backend, template< class > class Coarsening, template< class > class Relax>

Int32 Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::ncycle = 1

Number of cycles (1 for V-cycle, 2 for W-cycle, etc.).

Définition à la ligne 139 du fichier AMG.h.

npost

template<class Backend, template< class > class Coarsening, template< class > class Relax>

Int32 Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::npost = 1

Number of post-relaxations.

Définition à la ligne 136 du fichier AMG.h.

npre

template<class Backend, template< class > class Coarsening, template< class > class Relax>

Int32 Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::npre = 1

Number of pre-relaxations.

Définition à la ligne 133 du fichier AMG.h.

pre_cycles

template<class Backend, template< class > class Coarsening, template< class > class Relax>

Int32 Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::pre_cycles = 1

Number of cycles to make as part of preconditioning.

Définition à la ligne 142 du fichier AMG.h.

relax

template<class Backend, template< class > class Coarsening, template< class > class Relax>

relax_params Arcane::Alina::AMG< Backend, Coarsening, Relax >::params::relax

Relaxation parameters.

Définition à la ligne 104 du fichier AMG.h.

---

La documentation de cette structure a été générée à partir du fichier suivant :

• AMG.h