8.3
general documentation
cs_mesh_save.h
Go to the documentation of this file.
1#ifndef __CS_MESH_SAVE_H__
2#define __CS_MESH_SAVE_H__
3
4/*============================================================================
5 * Save mesh Preprocessor data
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_base.h"
39#include "cs_mesh.h"
40
41/*----------------------------------------------------------------------------*/
42
43BEGIN_C_DECLS
44
45/*============================================================================
46 * Public function prototypes
47 *============================================================================*/
48
49/*----------------------------------------------------------------------------
50 * Save a mesh as preprocessor data.
51 *
52 * parameters:
53 * mesh <-- pointer to mesh structure
54 * mb <-- pointer to optional mesh builder structure, or NULL
55 * path <-- optional directory name for output, or NULL for default
56 * (directory automatically created if necessary)
57 * filename <-- file name
58 *----------------------------------------------------------------------------*/
59
60void
61cs_mesh_save(cs_mesh_t *mesh,
62 cs_mesh_builder_t *mb,
63 const char *path,
64 const char *filename);
65
66/*----------------------------------------------------------------------------*/
67
68END_C_DECLS
69
70#endif /* __CS_MESH_SAVE_H__ */
71
cs_base.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_mesh.h
cs_mesh_save
void cs_mesh_save(cs_mesh_t *mesh, cs_mesh_builder_t *mb, const char *path, const char *filename)
Definition: cs_mesh_save.cpp:116
mesh
Definition: mesh.f90:26
cs_mesh_builder_t
Definition: cs_mesh_builder.h:57
cs_mesh_t
Definition: cs_mesh.h:85