cs_param_amg.cpp File Reference

#include "cs_defs.h"
#include <assert.h>
#include <stdio.h>
#include <string.h>
#include <bft_error.h>
#include <bft_mem.h>
#include "cs_base.h"
#include "cs_log.h"
#include "cs_param_amg.h"

Include dependency graph for cs_param_amg.cpp:

Functions
const char *	cs_param_amg_get_type_name (cs_param_amg_type_t type)
	Get the name of the type of algebraic multigrid (AMG) More...
cs_param_solver_class_t	cs_param_amg_get_class (cs_param_amg_type_t amg_type)
	Retrieve the related solver class from the amg type. More...
cs_param_amg_boomer_t *	cs_param_amg_boomer_create (void)
	Create a new structure storing a set of parameters used when calling boomerAMG. Set default values for all parameters. More...
cs_param_amg_boomer_t *	cs_param_amg_boomer_copy (const cs_param_amg_boomer_t *bamgp)
	Copy the given set of parameters used when calling boomerAMG into a new structure. More...
const char *	cs_param_amg_get_boomer_smoother_name (cs_param_amg_boomer_smoother_t smoother)
	Get the name of the smoother used with BoomerAMG (HYPRE library) More...
void	cs_param_amg_boomer_log (const char *name, const cs_param_amg_boomer_t *bamgp)
	Log the set of parameters used for setting BoomerAMG. More...
cs_param_amg_gamg_t *	cs_param_amg_gamg_create (void)
	Create a new structure storing a set of parameters used when calling GAMG. Set default values for all parameters. More...
cs_param_amg_gamg_t *	cs_param_amg_gamg_copy (const cs_param_amg_gamg_t *gamgp)
	Copy the given set of parameters used when calling GAMG into a new structure. More...
const char *	cs_param_amg_get_gamg_smoother_name (cs_param_amg_gamg_smoother_t smoother)
	Get the name of the smoother used with GAMG (PETSc library) More...
const char *	cs_param_amg_get_gamg_coarse_solver_name (cs_param_amg_gamg_coarse_solver_t coarse)
	Get the name of the smoother used with GAMG (PETSc library) More...
void	cs_param_amg_gamg_log (const char *name, const cs_param_amg_gamg_t *gamgp)
	Log the set of parameters used for setting GAMG. More...
cs_param_amg_hmg_t *	cs_param_amg_hmg_create (void)
	Create a new structure storing a set of parameters used when calling HMG. Set all parameters at their default value. More...
cs_param_amg_hmg_t *	cs_param_amg_hmg_copy (const cs_param_amg_hmg_t *hmgp)
	Copy the given set of parameters used when calling HMG into a new structure. More...
void	cs_param_amg_hmg_log (const char *name, const cs_param_amg_hmg_t *hmgp)
	Log the set of parameters used for setting HMG. More...
cs_param_amg_inhouse_t *	cs_param_amg_inhouse_create (bool used_as_solver, bool used_as_k_cycle)
	Create a new structure storing a set of parameters used when calling the in-house AMG algo. Set default values for all parameters. More...
cs_param_amg_inhouse_t *	cs_param_amg_inhouse_copy (const cs_param_amg_inhouse_t *amgp)
	Copy the given set of parameters used when calling in-house AMG algo. into a new structure. More...
const char *	cs_param_amg_get_inhouse_solver_name (cs_param_amg_inhouse_solver_t solver)
	Get the name of the solver used with in-house AMG algo. More...
void	cs_param_amg_inhouse_log (const char *name, const cs_param_amg_inhouse_t *amgp)
	Log the set of parameters used for setting in-house AMG algorithms. More...

Function Documentation

cs_param_amg_boomer_copy()

cs_param_amg_boomer_t * cs_param_amg_boomer_copy

(

const cs_param_amg_boomer_t *

bamgp

)

Copy the given set of parameters used when calling boomerAMG into a new structure.

Parameters

[in]

bamgp

reference set of boomerAMG parameters

Returns

a pointer to a new set of boomerAMG parameters

cs_param_amg_boomer_create()

cs_param_amg_boomer_t * cs_param_amg_boomer_create

(

void

)

Create a new structure storing a set of parameters used when calling boomerAMG. Set default values for all parameters.

Returns

a pointer to a new set of boomerAMG parameters

cs_param_amg_boomer_log()

void cs_param_amg_boomer_log	(	const char *	name,
		const cs_param_amg_boomer_t *	bamgp
	)

Log the set of parameters used for setting BoomerAMG.

Parameters

[in]	name	name related to the current SLES
[in]	bamgp	set of boomerAMG parameters

cs_param_amg_gamg_copy()

cs_param_amg_gamg_t * cs_param_amg_gamg_copy

(

const cs_param_amg_gamg_t *

gamgp

)

Copy the given set of parameters used when calling GAMG into a new structure.

Parameters

[in]

gamgp

reference set of GAMG parameters

Returns

a pointer to a new set of GAMG parameters

cs_param_amg_gamg_create()

cs_param_amg_gamg_t * cs_param_amg_gamg_create

(

void

)

Create a new structure storing a set of parameters used when calling GAMG. Set default values for all parameters.

Returns

a pointer to a new set of GAMG parameters

cs_param_amg_gamg_log()

void cs_param_amg_gamg_log	(	const char *	name,
		const cs_param_amg_gamg_t *	gamgp
	)

Log the set of parameters used for setting GAMG.

Parameters

[in]	name	name related to the current SLES
[in]	gamgp	set of gamgAMG parameters

cs_param_amg_get_boomer_smoother_name()

const char * cs_param_amg_get_boomer_smoother_name

(

cs_param_amg_boomer_smoother_t

smoother

)

Get the name of the smoother used with BoomerAMG (HYPRE library)

Parameters

[in]

smoother

smoother type

Returns

name of the given smoother type

cs_param_amg_get_class()

cs_param_solver_class_t cs_param_amg_get_class

(

cs_param_amg_type_t

amg_type

)

Retrieve the related solver class from the amg type.

Parameters

[in]

amg_type

type of AMG to consider

Returns

the related solver class or CS_PARAM_SOLVER_CLASS_CS

cs_param_amg_get_gamg_coarse_solver_name()

const char * cs_param_amg_get_gamg_coarse_solver_name

(

cs_param_amg_gamg_coarse_solver_t

coarse

)

Get the name of the smoother used with GAMG (PETSc library)

Parameters

[in]

coarse

type of predefined coarse solver

Returns

name of the given type of coarse solver

cs_param_amg_get_gamg_smoother_name()

const char * cs_param_amg_get_gamg_smoother_name

(

cs_param_amg_gamg_smoother_t

smoother

)

Get the name of the smoother used with GAMG (PETSc library)

Parameters

[in]

smoother

smoother type

Returns

name of the given smoother type

cs_param_amg_get_inhouse_solver_name()

const char * cs_param_amg_get_inhouse_solver_name

(

cs_param_amg_inhouse_solver_t

solver

)

Get the name of the solver used with in-house AMG algo.

Parameters

[in]

solver

solver type

Returns

name of the given solver type

cs_param_amg_get_type_name()

const char * cs_param_amg_get_type_name

(

cs_param_amg_type_t

type

)

Get the name of the type of algebraic multigrid (AMG)

Parameters

[in]

type

type of AMG

Returns

the associated type name

cs_param_amg_hmg_copy()

cs_param_amg_hmg_t * cs_param_amg_hmg_copy

(

const cs_param_amg_hmg_t *

hmgp

)

Copy the given set of parameters used when calling HMG into a new structure.

Parameters

[in]

hmgp

reference set of HMG parameters

Returns

a pointer to a new set of HMG parameters

cs_param_amg_hmg_create()

cs_param_amg_hmg_t * cs_param_amg_hmg_create

(

void

)

Create a new structure storing a set of parameters used when calling HMG. Set all parameters at their default value.

Returns

a pointer to a new set of HMG parameters

cs_param_amg_hmg_log()

void cs_param_amg_hmg_log	(	const char *	name,
		const cs_param_amg_hmg_t *	hmgp
	)

Log the set of parameters used for setting HMG.

Parameters

[in]	name	name related to the current SLES
[in]	hmgp	set of hmgAMG parameters

cs_param_amg_inhouse_copy()

cs_param_amg_inhouse_t * cs_param_amg_inhouse_copy

(

const cs_param_amg_inhouse_t *

amgp

)

Copy the given set of parameters used when calling in-house AMG algo. into a new structure.

Parameters

[in]

amgp

reference set of in-house AMG parameters

Returns

a pointer to a new set of in-house AMG parameters

cs_param_amg_inhouse_create()

cs_param_amg_inhouse_t * cs_param_amg_inhouse_create	(	bool	used_as_solver,
		bool	used_as_k_cycle
	)

Create a new structure storing a set of parameters used when calling the in-house AMG algo. Set default values for all parameters.

Parameters

[in]	used_as_solver	true or false
[in]	used_as_k_cycle	true or false

Returns

a pointer to a new set of parameters

cs_param_amg_inhouse_log()

void cs_param_amg_inhouse_log	(	const char *	name,
		const cs_param_amg_inhouse_t *	amgp
	)

Log the set of parameters used for setting in-house AMG algorithms.

Parameters

[in]	name	name related to the current SLES
[in]	amgp	set of in-house AMG parameters