My Project
programmer's documentation
Loading...
Searching...
No Matches
cs_notebook.h
Go to the documentation of this file.
1#ifndef __CS_NOTEBOOK_H__
2#define __CS_NOTEBOOK_H__
3
4/*============================================================================
5 * Notebook management.
6 *============================================================================*/
7
8/*
9 This file is part of Code_Saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2019 EDF S.A.
12
13 This program is free software; you can redistribute it and/or modify it under
14 the terms of the GNU General Public License as published by the Free Software
15 Foundation; either version 2 of the License, or (at your option) any later
16 version.
17
18 This program is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 details.
22
23 You should have received a copy of the GNU General Public License along with
24 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25 Street, Fifth Floor, Boston, MA 02110-1301, USA.
26*/
27
28/*----------------------------------------------------------------------------
29 * Local headers
30 *----------------------------------------------------------------------------*/
31
32#include "cs_defs.h"
33
34/*----------------------------------------------------------------------------*/
35
36BEGIN_C_DECLS
37
38/*----------------------------------------------------------------------------*/
44/*----------------------------------------------------------------------------*/
45
46void
47cs_notebook_load_from_file(void);
48
49/*----------------------------------------------------------------------------*/
58/*----------------------------------------------------------------------------*/
59
60int
61cs_notebook_parameter_is_present(const char *name,
62 int *editable);
63
64/*----------------------------------------------------------------------------*/
74/*----------------------------------------------------------------------------*/
75
76cs_real_t
77cs_notebook_parameter_value_by_name(const char *name);
78
79/*----------------------------------------------------------------------------*/
88/*----------------------------------------------------------------------------*/
89
90void
91cs_notebook_parameter_set_value(const char *name,
92 cs_real_t val);
93
94/*----------------------------------------------------------------------------*/
108/*----------------------------------------------------------------------------*/
109
110int
111cs_notebook_parameter_get_openturns_status(char *name);
112
113/*----------------------------------------------------------------------------*/
122/*----------------------------------------------------------------------------*/
123
124const char *
125cs_notebook_parameter_get_description(char *name);
126
127/*----------------------------------------------------------------------------*/
133/*----------------------------------------------------------------------------*/
134
135void
136cs_notebook_destroy_all(void);
137
138/*----------------------------------------------------------------------------*/
142/*----------------------------------------------------------------------------*/
143
144void
145cs_notebook_log(void);
146
147/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void
158cs_notebook_uncertain_output(void);
159
160/*----------------------------------------------------------------------------*/
161
162END_C_DECLS
163
164#endif /* __CS_NOTEBOOK_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition cs_defs.h:467
cs_real_t
double cs_real_t
Floating-point value.
Definition cs_defs.h:302
END_C_DECLS
#define END_C_DECLS
Definition cs_defs.h:468
cs_notebook_parameter_is_present
int cs_notebook_parameter_is_present(const char *name, int *editable)
Check if a parameter value is present.
Definition cs_notebook.c:392
cs_notebook_uncertain_output
void cs_notebook_uncertain_output(void)
Writes uncertain values to output file.
Definition cs_notebook.c:508
cs_notebook_parameter_value_by_name
cs_real_t cs_notebook_parameter_value_by_name(const char *name)
Return a parameter value (real).
Definition cs_notebook.c:424
cs_notebook_parameter_get_description
const char * cs_notebook_parameter_get_description(char *name)
Returns the description of the parameter (GUI defined)
Definition cs_notebook.c:490
cs_notebook_log
void cs_notebook_log(void)
Output the notebook info to the setup log.
Definition cs_notebook.c:293
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.
Definition cs_notebook.c:442
cs_notebook_load_from_file
void cs_notebook_load_from_file(void)
Initialize the notebook object (based on cs_tree_node_t)
Definition cs_notebook.c:331
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.
Definition cs_notebook.c:472
cs_notebook_destroy_all
void cs_notebook_destroy_all(void)
Destroy the notebook structure.
Definition cs_notebook.c:551
Generated on Wed Mar 13 2024 18:14:52 for My Project by doxygen 1.9.8