7.0
general documentation
Functions
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...
 
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)
 Writes 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_load_from_file()

void cs_notebook_load_from_file ( void  )

Initialize the notebook object (based on cs_tree_node_t)

The name used to identify the object is "cs_notebook".

◆ 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]namename of the parameter
Returns
a const char pointer containing the description.

◆ 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]namename 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]namename of the parameter
[out]editable1 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]namename of the parameter
[in]valvalue 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]namename of the parameter
Returns
value of the given parameter

◆ cs_notebook_uncertain_output()

void cs_notebook_uncertain_output ( void  )

Writes 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.