cs_equation_system_param.cpp File Reference

#include "cs_defs.h"
#include <assert.h>
#include <ctype.h>
#include <stdlib.h>
#include <bft_mem.h>
#include "cs_equation_system_param.h"

Include dependency graph for cs_equation_system_param.cpp:

Macros
#define	CS_EQUATION_SYSTEM_PARAM_DBG   0

Functions
cs_equation_system_param_t *	cs_equation_system_param_create (const char *name, int block_var_dim)
	Create and initialize a new cs_equation_system_param_t structure. More...
cs_equation_system_param_t *	cs_equation_system_param_free (cs_equation_system_param_t *sysp)
	Free a cs_equation_system_param_t structure. More...
void	cs_equation_system_param_log (const cs_equation_system_param_t *sysp)
	Log the setup gathered in the structure cs_equation_system_param_t. More...
void	cs_equation_system_param_set (cs_equation_system_param_t *sysp, cs_equation_system_key_t key, const char *keyval)
	Set a parameter related to a keyname in a cs_equation_system_param_t structure. More...

Macro Definition Documentation

CS_EQUATION_SYSTEM_PARAM_DBG

#define CS_EQUATION_SYSTEM_PARAM_DBG   0

Function Documentation

cs_equation_system_param_create()

cs_equation_system_param_t * cs_equation_system_param_create	(	const char *	name,
		int	block_var_dim
	)

Create and initialize a new cs_equation_system_param_t structure.

Parameters

[in]	name	name of system of equations
[in]	block_var_dim	dimension of the variable in each block

Returns

a pointer to a newly initialized cs_equation_system_param_t

cs_equation_system_param_free()

cs_equation_system_param_t * cs_equation_system_param_free

(

cs_equation_system_param_t *

sysp

)

Free a cs_equation_system_param_t structure.

Parameters

[in,out]

sysp

pointer to the structure to free

Returns

a null pointer

cs_equation_system_param_log()

void cs_equation_system_param_log

(

const cs_equation_system_param_t *

sysp

)

Log the setup gathered in the structure cs_equation_system_param_t.

Parameters

[in]

sysp

pointer to a parameter structure to log

cs_equation_system_param_set()

void cs_equation_system_param_set	(	cs_equation_system_param_t *	sysp,
		cs_equation_system_key_t	key,
		const char *	keyval
	)

Set a parameter related to a keyname in a cs_equation_system_param_t structure.

Parameters

[in,out]	sysp	pointer to a parameter structure to set
[in]	key	key related to the member of eq to set
[in]	keyval	accessor to the value to set