8.1
general documentation
cs_control.h
Go to the documentation of this file.
1 #ifndef __CS_CONTROL_H__
2 #define __CS_CONTROL_H__
3 
4 /*============================================================================
5  * Interactive control management.
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 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 
30 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 #include "cs_time_step.h"
36 
37 /*----------------------------------------------------------------------------*/
38 
39 BEGIN_C_DECLS
40 
41 /*=============================================================================
42  * Macro definitions
43  *============================================================================*/
44 
45 /*============================================================================
46  * Type definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Public function prototypes
51  *============================================================================*/
52 
53 /*----------------------------------------------------------------------------*/
57 /*----------------------------------------------------------------------------*/
58 
59 void
60 cs_control_finalize(void);
61 
62 /*----------------------------------------------------------------------------
63  * Check the presence of a control file and deal with the interactive
64  * control.
65  *----------------------------------------------------------------------------*/
66 
67 void
68 cs_control_check_file(void);
69 
70 /*----------------------------------------------------------------------------*/
71 
72 END_C_DECLS
73 
74 #endif /* __CS_CONTROL_H__ */
cs_control_check_file
void cs_control_check_file(void)
Check the presence of a control file and deal with the interactive control.
Definition: cs_control.c:1909
cs_control_finalize
void cs_control_finalize(void)
Finalize controller structures.
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_time_step.h