8.1
general documentation
cs_lagr_restart.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_RESTART_H__
2 #define __CS_LAGR_RESTART_H__
3 
4 /*============================================================================
5  * Checkpoint/restart handling for 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 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 #include "cs_field.h"
36 #include "cs_map.h"
37 #include "cs_restart.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
41 BEGIN_C_DECLS
42 
43 /*=============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Type definitions
49  *============================================================================*/
50 
51 /*=============================================================================
52  * Public function prototypes
53  *============================================================================*/
54 
55 /*----------------------------------------------------------------------------
56  * Read particle data from checkpoint.
57  *
58  * parameters:
59  * r <-> associated restart file pointer
60  *
61  * returns:
62  * number of particle arrays read
63  *----------------------------------------------------------------------------*/
64 
65 int
66 cs_lagr_restart_read_particle_data(cs_restart_t *r);
67 
68 /*----------------------------------------------------------------------------
69  * Write particle data to checkpoint.
70  *
71  * parameters:
72  * r <-> associated restart file pointer
73  *
74  * returns:
75  * number of particle arrays written
76  *----------------------------------------------------------------------------*/
77 
78 int
79 cs_lagr_restart_write_particle_data(cs_restart_t *r);
80 
81 /*----------------------------------------------------------------------------*/
82 
83 END_C_DECLS
84 
85 #endif /* __CS_LAGR_RESTART_H__ */
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_field.h
cs_lagr_restart_write_particle_data
int cs_lagr_restart_write_particle_data(cs_restart_t *r)
Write particle data to checkpoint.
Definition: cs_lagr_restart.c:673
cs_lagr_restart_read_particle_data
int cs_lagr_restart_read_particle_data(cs_restart_t *r)
Read particle data from checkpoint.
Definition: cs_lagr_restart.c:386
cs_map.h
cs_restart.h
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:95