9.1
general documentation
cs_time_stepping.h
Go to the documentation of this file.
1#ifndef __CS_TIME_STEPPING_H__
2#define __CS_TIME_STEPPING_H__
3
4/*============================================================================
5 * Main time loop.
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2025 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 "base/cs_defs.h"
39
40/*----------------------------------------------------------------------------*/
41
42BEGIN_C_DECLS
43
44/*=============================================================================
45 * Type definitions
46 *============================================================================*/
47
48/*=============================================================================
49 * Static global variables
50 *============================================================================*/
51
52/*=============================================================================
53 * Public function prototypes
54 *============================================================================*/
55
56/*----------------------------------------------------------------------------*/
61/*----------------------------------------------------------------------------*/
62
63/*----------------------------------------------------------------------------*/
64/*
65 * \brief Main time loop.
66 */
67/*----------------------------------------------------------------------------*/
68
69void
70cs_time_stepping(void);
71
72/*----------------------------------------------------------------------------*/
76/*----------------------------------------------------------------------------*/
77
78void
79cs_time_stepping_read_checkpoint(void);
80
81/*----------------------------------------------------------------------------*/
91/*----------------------------------------------------------------------------*/
92
93void
94cs_time_stepping_write_checkpoint(bool checkpoint_mesh);
95
96/*----------------------------------------------------------------------------*/
97
98END_C_DECLS
99
100#endif /* __CS_TIME_STEPPING_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:554
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:555
cs_time_stepping_write_checkpoint
void cs_time_stepping_write_checkpoint(bool checkpoint_mesh)
Output a checkpoint.
Definition: cs_time_stepping.cpp:987
cs_time_stepping_read_checkpoint
void cs_time_stepping_read_checkpoint(void)
Input a checkpoint.
Definition: cs_time_stepping.cpp:936
cs_time_stepping
void cs_time_stepping(void)
Main time loop.
Definition: cs_time_stepping.cpp:169