9.2
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-2026 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_base.h"
39#include "mesh/cs_mesh.h"
40
41/*============================================================================
42 * Public function prototypes
43 *============================================================================*/
44
45/*----------------------------------------------------------------------------
46 * Save a mesh as preprocessor data.
47 *
48 * parameters:
49 * mesh <-- pointer to mesh structure
50 * mb <-- pointer to optional mesh builder structure, or NULL
51 * path <-- optional directory name for output, or NULL for default
52 * (directory automatically created if necessary)
53 * filename <-- file name
54 *----------------------------------------------------------------------------*/
55
56void
57cs_mesh_save(cs_mesh_t *mesh,
58 cs_mesh_builder_t *mb,
59 const char *path,
60 const char *filename);
61
62/*----------------------------------------------------------------------------*/
63
64#endif /* CS_MESH_SAVE_H */
65
cs_base.h
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:114
mesh
Definition: mesh.f90:26
cs_mesh_builder_t
Definition: cs_mesh_builder.h:57
cs_mesh_t
Definition: cs_mesh.h:85