cs_notebook.h File Reference

#include "cs_defs.h"

Include dependency graph for cs_notebook.h:

Go to the source code of this file.

Functions
void	cs_notebook_load_from_file (void)
	Initialize the notebook object (based on cs_tree_node_t). More...
int	cs_notebook_parameter_is_present (const char *name, int *editable)
	Check if a parameter value is present. More...
cs_real_t	cs_notebook_parameter_value_by_name (const char *name)
	Return a parameter value (real). More...
void	cs_notebook_parameter_set_value (const char *name, cs_real_t val)
	Set a parameter value (real) for an editable parameter. More...
int	cs_notebook_parameter_get_openturns_status (char *name)
	Indicate whether the parameter is used for a study with openturns. More...
const char *	cs_notebook_parameter_get_description (char *name)
	Returns the description of the parameter (GUI defined). More...
int	cs_notebook_parameter_get_id (const char *name)
	Get id associated with a notebook parameter. More...
void	cs_notebook_get_values (int n, const int ids[], double values[])
	Get a group of notebook variable values. More...
void	cs_notebook_set_values (int n, const int ids[], const double values[])
	Set a group of notebook variable values. More...
void	cs_notebook_destroy_all (void)
	Destroy the notebook structure. More...
void	cs_notebook_log (void)
	Output the notebook info to the setup log. More...
void	cs_notebook_uncertain_output (void)
	Write uncertain values to output file. More...

Function Documentation

cs_notebook_destroy_all()

void cs_notebook_destroy_all

(

void

)

Destroy the notebook structure.

Destroys the structures related to the notebook.

cs_notebook_get_values()

void cs_notebook_get_values	(	int	n,
		const int	ids[],
		double	values[]
	)

Get a group of notebook variable values.

Parameters

[in]	n	number of notebook variables to query
[in]	ids	ids of notebook variables to query (value set to 0 where id < 0)
[out]	values	values of notebook variables to query

cs_notebook_load_from_file()

void cs_notebook_load_from_file

(

void

)

Initialize the notebook object (based on cs_tree_node_t).

cs_notebook_log()

void cs_notebook_log

(

void

)

Output the notebook info to the setup log.

cs_notebook_parameter_get_description()

const char* cs_notebook_parameter_get_description

(

char *

name

)

Returns the description of the parameter (GUI defined).

Parameters

[in]

name

name of the parameter

Returns

a const char pointer containing the description.

cs_notebook_parameter_get_id()

int cs_notebook_parameter_get_id

(

const char *

name

)

Get id associated with a notebook parameter.

Parameters

[in]

name

name of the parameter

Returns

-1 if not present, id if present

cs_notebook_parameter_get_openturns_status()

int cs_notebook_parameter_get_openturns_status

(

char *

name

)

Indicate whether the parameter is used for a study with openturns.

Returns an int flag to indicate whether this paramter is used for an OpenTurns study. -1 : The parameter is not used with OpenTurns 0 : The parameter is used as an input from OpenTurns 1 : The parameter is used as an output to OpenTurns

Parameters

[in]

name

name of the parameter

Returns

an int flag value

cs_notebook_parameter_is_present()

int cs_notebook_parameter_is_present	(	const char *	name,
		int *	editable
	)

Check if a parameter value is present.

Parameters

[in]	name	name of the parameter
[out]	editable	1 if the value is editable, 0 otherwise (optional)

Returns

0 if not present, 1 if present

cs_notebook_parameter_set_value()

void cs_notebook_parameter_set_value	(	const char *	name,
		cs_real_t	val
	)

Set a parameter value (real) for an editable parameter.

The name used is the same as the one in the GUI.

Parameters

[in]	name	name of the parameter
[in]	val	value of the parameter

cs_notebook_parameter_value_by_name()

cs_real_t cs_notebook_parameter_value_by_name

(

const char *

name

)

Return a parameter value (real).

The name used is the same as the one in the GUI.

Parameters

[in]

name

name of the parameter

Returns

value of the given parameter

cs_notebook_set_values()

void cs_notebook_set_values	(	int	n,
		const int	ids[],
		const double	values[]
	)

Set a group of notebook variable values.

Parameters

[in]	n	number of notebook variables to set
[in]	ids	ids of notebook variables to set (ignored where id < 0)
[in]	values	values of notebook variables to set

cs_notebook_uncertain_output()

void cs_notebook_uncertain_output

(

void

)

Write uncertain values to output file.

If input and output uncertain variables are provided, output values are written to an output file: cs_uncertain_output.dat Results are ordered in the definition order in the notebook.