8.3
general documentation
cs_restart_map.h
Go to the documentation of this file.
1#ifndef __CS_RESTART_MAP_H__
2#define __CS_RESTART_MAP_H__
3
4/*============================================================================
5 * Checkpoint / restart extension to mapped meshes
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#include "cs_restart.h"
40
41/*----------------------------------------------------------------------------*/
42
43BEGIN_C_DECLS
44
45/*============================================================================
46 * Macro definitions
47 *============================================================================*/
48
49
50/*============================================================================
51 * Local type definitions
52 *============================================================================*/
53
54
55/*=============================================================================
56 * Global variables
57 *============================================================================*/
58
59
60/*============================================================================
61 * Public function prototypes
62 *============================================================================*/
63
64/*----------------------------------------------------------------------------*/
70/*----------------------------------------------------------------------------*/
71
72void
73cs_restart_map_set_mesh_input(const char *mesh_path);
74
75/*----------------------------------------------------------------------------*/
88/*----------------------------------------------------------------------------*/
89
90void
91cs_restart_map_set_options(bool apply_mesh_deformation,
92 float tolerance_base,
93 float tolerance_fraction);
94
95/*----------------------------------------------------------------------------*/
117/*----------------------------------------------------------------------------*/
118
119void
120cs_restart_map_set_locations(bool map_cell_centers,
121 bool map_vertices);
122
123/*----------------------------------------------------------------------------*/
127/*----------------------------------------------------------------------------*/
128
129void
130cs_restart_map_build(void);
131
132/*----------------------------------------------------------------------------*/
138/*----------------------------------------------------------------------------*/
139
140void
141cs_restart_map_free(void);
142
143/*----------------------------------------------------------------------------*/
144
145END_C_DECLS
146
147#endif /* __CS_RESTART_MAP_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_restart.h
cs_restart_map_free
void cs_restart_map_free(void)
Free restart file mapping to different mesh.
Definition: cs_restart_map.cpp:652
cs_restart_map_build
void cs_restart_map_build(void)
Build mapping of restart files to different mesh if defined.
Definition: cs_restart_map.cpp:492
cs_restart_map_set_locations
void cs_restart_map_set_locations(bool map_cell_centers, bool map_vertices)
Indicate whether location for restart file mapping is needed at cells or vertices.
Definition: cs_restart_map.cpp:474
cs_restart_map_set_options
void cs_restart_map_set_options(bool apply_mesh_deformation, float tolerance_base, float tolerance_fraction)
Set options relative to restart file mapping to a given mesh input.
Definition: cs_restart_map.cpp:439
cs_restart_map_set_mesh_input
void cs_restart_map_set_mesh_input(const char *mesh_path)
Indicate restart files should be mapped to a given mesh input.
Definition: cs_restart_map.cpp:414