8.1
general documentation
cs_lagr_options.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_OPTIONS_H__
2 #define __CS_LAGR_OPTIONS_H__
3 
4 /*============================================================================
5  * Functions and types for the Lagrangian module
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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------*/
33 
34 BEGIN_C_DECLS
35 
36 /*=============================================================================
37  * Macro definitions
38  *============================================================================*/
39 
40 /*============================================================================
41  * Type definitions
42  *============================================================================*/
43 
44 /*=============================================================================
45  * Global variables
46  *============================================================================*/
47 
48 /*=============================================================================
49  * Public function prototypes
50  *============================================================================*/
51 
52 /*----------------------------------------------------------------------------*/
66 /*----------------------------------------------------------------------------*/
67 
68 void
69 cs_lagr_options_definition(int isuite,
70  int have_thermal_model,
71  cs_real_t dtref,
72  int *iccvfg);
73 
74 /*----------------------------------------------------------------------------*/
75 
76 END_C_DECLS
77 
78 #endif /* __CS_LAGR_OPTIONS_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_lagr_options_definition
void cs_lagr_options_definition(int isuite, int have_thermal_model, cs_real_t dtref, int *iccvfg)
Lagrangian module options definition.
Definition: cs_lagr_options.c:218
optcal::isuite
integer, save isuite
Indicator of a calculation restart (=1) or not (=0). This value is set automatically by the code; dep...
Definition: optcal.f90:158
optcal::iccvfg
integer(c_int), pointer, save iccvfg
indicates whether the dynamic field should be frozen or not:
Definition: optcal.f90:687
optcal::dtref
real(c_double), pointer, save dtref
Reference time step.
Definition: optcal.f90:273