8.2
general documentation
cs_time_step_compute.h
Go to the documentation of this file.
1 #ifndef __CS_TIME_STEP_COMPUTE__
2 #define __CS_TIME_STEP_COMPUTE__
3 
4 /*============================================================================
5  * Compute the local time step and the local Courant and Fourier number
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2024 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  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_defs.h"
39 
40 /*----------------------------------------------------------------------------*/
41 
42 BEGIN_C_DECLS
43 
44 /*=============================================================================
45  * Public function prototypes
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------*/
53 /*----------------------------------------------------------------------------*/
54 
55 /*----------------------------------------------------------------------------*/
56 /*
57  * \param[in] itrale ALE iteration number
58  */
59 /*----------------------------------------------------------------------------*/
60 
61 void
62 cs_local_time_step_compute(int itrale);
63 
64 /*----------------------------------------------------------------------------*/
65 
66 void
67 cs_courant_fourier_compute(void);
68 
69 /*----------------------------------------------------------------------------*/
70 
71 END_C_DECLS
72 
73 #endif /* __CS_TIME_STEP_COMPUTE__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:528
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:529
cs_courant_fourier_compute
void cs_courant_fourier_compute(void)
Compute the local Courant and Fourier number to the log.
Definition: cs_time_step_compute.c:857
cs_local_time_step_compute
void cs_local_time_step_compute(int itrale)
Compute the local time step.
Definition: cs_time_step_compute.c:109