9.0
general documentation
Loading...
Searching...
No Matches
cs_preprocessor_data.h
Go to the documentation of this file.
1#ifndef __CS_PRE_PROCESSOR_DATA_H__
2#define __CS_PRE_PROCESSOR_DATA_H__
3
4/*============================================================================
5 * Exchange of data between code_saturne Kernel and Preprocessor
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 "fvm/fvm_io_num.h"
39
40#include "base/cs_base.h"
41#include "mesh/cs_mesh.h"
42
43/*----------------------------------------------------------------------------*/
44
46
47/*============================================================================
48 * Type definitions
49 *============================================================================*/
50
52
66
67/*============================================================================
68 * Public function prototypes
69 *============================================================================*/
70
71/*----------------------------------------------------------------------------
72 * Define input mesh file to read.
73 *
74 * If this function is never called, the default file is read.
75 * The first time this function is called, this default is overriden by the
76 * defined file, and all subsequent calls define additional meshes to read.
77 *
78 * parameters:
79 * file_name <-- name of file to read
80 * n_group_renames <-- number of groups to rename
81 * group_rename <-- old (group_rename[i*2]) to new (group_rename[i*2 + 1])
82 * group names array (size: n_group_renames*2)
83 * transf_matrix <-- coordinate transformation matrix (or null)
84 *----------------------------------------------------------------------------*/
85
86void
87cs_preprocessor_data_add_file(const char *file_name,
88 size_t n_group_renames,
89 const char **group_rename,
90 const double transf_matrix[3][4]);
91
92/*----------------------------------------------------------------------------
93 * Check for periodicity information in mesh meta-data.
94 *
95 * returns:
96 * 0 if no periodicity is present in mesh input,
97 * 1 for translation periodicity only,
98 * 2 for rotation or mixed periodicity
99 *----------------------------------------------------------------------------*/
100
101int
103
104/*----------------------------------------------------------------------------*/
110/*----------------------------------------------------------------------------*/
111
114
115/*----------------------------------------------------------------------------*/
124/*----------------------------------------------------------------------------*/
125
126void
128
129/*----------------------------------------------------------------------------
130 * Read mesh meta-data.
131 *
132 * parameters:
133 * mesh <-- pointer to mesh structure
134 * mesh_builder <-- pointer to mesh builder structure
135 * ignore_cartesian <-- option to ignore cartesian blocks
136 *----------------------------------------------------------------------------*/
137
138void
140 cs_mesh_builder_t *mesh_builder,
141 bool ignore_cartesian);
142
143/*----------------------------------------------------------------------------
144 * Read pre-processor mesh data and finalize input.
145 *
146 * At this stage, ghost cells are not generated yet, so the interior
147 * face connectivity is not complete near parallel domain or periodic
148 * boundaries. Also, isolated faces, if present, are considered to be
149 * boundary faces, as they may participate in future mesh joining
150 * operations. Their matching cell number will be set to -1.
151 * Remaining isolated faces should be removed before completing
152 * the mesh structure.
153 *
154 * parameters:
155 * mesh <-- pointer to mesh structure
156 * mesh_builder <-- pointer to mesh builder structure
157 * ignore_cartesian <-- option to ignore cartesian blocks
158 *----------------------------------------------------------------------------*/
159
160void
162 cs_mesh_builder_t *mesh_builder,
163 bool ignore_cartesian);
164
165/*----------------------------------------------------------------------------*/
166
168
169#endif /* __CS_PRE_PROCESSOR_DATA_H__ */
170
#define BEGIN_C_DECLS
Definition cs_defs.h:542
#define END_C_DECLS
Definition cs_defs.h:543
cs_preprocessor_data_restart_mode_t
Definition cs_preprocessor_data.h:53
@ CS_PREPROCESSOR_DATA_RESTART_NONE
Definition cs_preprocessor_data.h:55
@ CS_PREPROCESSOR_DATA_RESTART_ONLY
Definition cs_preprocessor_data.h:60
@ CS_PREPROCESSOR_DATA_RESTART_AND_MODIFY
Definition cs_preprocessor_data.h:58
void cs_preprocessor_data_add_file(const char *file_name, size_t n_group_renames, const char **group_rename, const double transf_matrix[3][4])
Definition cs_preprocessor_data.cpp:2244
void cs_preprocessor_data_read_headers(cs_mesh_t *mesh, cs_mesh_builder_t *mesh_builder, bool ignore_cartesian)
Definition cs_preprocessor_data.cpp:2395
cs_preprocessor_data_restart_mode_t cs_preprocessor_data_get_restart_mode(void)
Return restart behavior for preprocessing.
Definition cs_preprocessor_data.cpp:2197
void cs_preprocessor_data_read_mesh(cs_mesh_t *mesh, cs_mesh_builder_t *mesh_builder, bool ignore_cartesian)
Definition cs_preprocessor_data.cpp:2467
int cs_preprocessor_check_perio(void)
Definition cs_preprocessor_data.cpp:2354
void cs_preprocessor_data_set_restart_mode(cs_preprocessor_data_restart_mode_t mode)
Define restart behavior in case of restart.
Definition cs_preprocessor_data.cpp:2217
Definition mesh.f90:26
Definition cs_mesh_builder.h:57
Definition cs_mesh.h:85