cs_param_hpddm.h File Reference

Routines and structure to handle the HPDDM setup. The structure is used as a context structure of a cs_param_sles_t structure. More...

Go to the source code of this file.

Classes
struct	cs_param_hpddm_t
	Set of parameters to specify additional options to HPDDM For more advanced settings, one has to use the cs_user_sles_hpddm_hook function. Please also refer to the HPDDM user guide for more details. More...

Functions
cs_param_hpddm_t *	cs_param_hpddm_create (void)
	Create and initialize with the default settings a new structure storing a set of parameters used when calling HPDDM. More...
cs_param_hpddm_t *	cs_param_hpddm_copy (const cs_param_hpddm_t *hpddmp)
	Copy into a new structure the given set of parameters used when calling HPDDM. More...
void	cs_param_hpddm_log (const char *name, const cs_param_hpddm_t *hpddmp)
	Log the structure storing the set of parameters used with HPDDM. More...

Detailed Description

Routines and structure to handle the HPDDM setup. The structure is used as a context structure of a cs_param_sles_t structure.

Function Documentation

cs_param_hpddm_copy()

cs_param_hpddm_t * cs_param_hpddm_copy

(

const cs_param_hpddm_t *

hpddmp

)

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

Parameters

[in]

hpddmp

set of hpddm parameters

Returns

a pointer to a new allocated structure

cs_param_hpddm_create()

cs_param_hpddm_t * cs_param_hpddm_create

(

void

)

Create and initialize with the default settings a new structure storing a set of parameters used when calling HPDDM.

Returns

a pointer to a new allocated structure

cs_param_hpddm_log()

void cs_param_hpddm_log	(	const char *	name,
		const cs_param_hpddm_t *	hpddmp
	)

Log the structure storing the set of parameters used with HPDDM.

Parameters

[in]	name	name related to the current SLES
[in]	hpddmp	set of hpddm parameters