8.3
general documentation
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-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 "fvm_io_num.h"
39
40#include "cs_base.h"
41#include "cs_mesh.h"
42
43/*----------------------------------------------------------------------------*/
44
46
47/*============================================================================
48 * Type definitions
49 *============================================================================*/
50
53typedef enum {
54
66
67/*============================================================================
68 * Public function prototypes for Fortran API
69 *============================================================================*/
70
71/*----------------------------------------------------------------------------
72 * Pass information relative to mesh metadata to the Fortran API
73 *
74 * Fortran Interface:
75 *
76 * subroutine ledevi(iperio, iperot)
77 * *****************
78 *
79 * integer iperio : <-- : Periodicity indicator
80 *----------------------------------------------------------------------------*/
81
82void
83CS_PROCF(ledevi, LEDEVI)(int *iperio);
84
85/*============================================================================
86 * Public function prototypes
87 *============================================================================*/
88
89/*----------------------------------------------------------------------------
90 * Define input mesh file to read.
91 *
92 * If this function is never called, the default file is read.
93 * The first time this function is called, this default is overriden by the
94 * defined file, and all subsequent calls define additional meshes to read.
95 *
96 * parameters:
97 * file_name <-- name of file to read
98 * n_group_renames <-- number of groups to rename
99 * group_rename <-- old (group_rename[i*2]) to new (group_rename[i*2 + 1])
100 * group names array (size: n_group_renames*2)
101 * transf_matrix <-- coordinate transformation matrix (or null)
102 *----------------------------------------------------------------------------*/
103
104void
105cs_preprocessor_data_add_file(const char *file_name,
106 size_t n_group_renames,
107 const char **group_rename,
108 const double transf_matrix[3][4]);
109
110/*----------------------------------------------------------------------------
111 * Check for periodicity information in mesh meta-data.
112 *
113 * returns:
114 * 0 if no periodicity is present in mesh input,
115 * 1 for translation periodicity only,
116 * 2 for rotation or mixed periodicity
117 *----------------------------------------------------------------------------*/
118
119int
121
122/*----------------------------------------------------------------------------*/
128/*----------------------------------------------------------------------------*/
129
132
133/*----------------------------------------------------------------------------*/
142/*----------------------------------------------------------------------------*/
143
144void
146
147/*----------------------------------------------------------------------------
148 * Read mesh meta-data.
149 *
150 * parameters:
151 * mesh <-- pointer to mesh structure
152 * mesh_builder <-- pointer to mesh builder structure
153 * ignore_cartesian <-- option to ignore cartesian blocks
154 *----------------------------------------------------------------------------*/
155
156void
158 cs_mesh_builder_t *mesh_builder,
159 bool ignore_cartesian);
160
161/*----------------------------------------------------------------------------
162 * Read pre-processor mesh data and finalize input.
163 *
164 * At this stage, ghost cells are not generated yet, so the interior
165 * face connectivity is not complete near parallel domain or periodic
166 * boundaries. Also, isolated faces, if present, are considered to be
167 * boundary faces, as they may participate in future mesh joining
168 * operations. Their matching cell number will be set to -1.
169 * Remaining isolated faces should be removed before completing
170 * the mesh structure.
171 *
172 * parameters:
173 * mesh <-- pointer to mesh structure
174 * mesh_builder <-- pointer to mesh builder structure
175 * ignore_cartesian <-- option to ignore cartesian blocks
176 *----------------------------------------------------------------------------*/
177
178void
180 cs_mesh_builder_t *mesh_builder,
181 bool ignore_cartesian);
182
183/*----------------------------------------------------------------------------*/
184
186
187#endif /* __CS_PRE_PROCESSOR_DATA_H__ */
188
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
#define CS_PROCF(x, y)
Definition: cs_defs.h:576
#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:2239
void cs_preprocessor_data_read_headers(cs_mesh_t *mesh, cs_mesh_builder_t *mesh_builder, bool ignore_cartesian)
Definition: cs_preprocessor_data.cpp:2390
cs_preprocessor_data_restart_mode_t cs_preprocessor_data_get_restart_mode(void)
Return restart behavior for preprocessing.
Definition: cs_preprocessor_data.cpp:2192
void cs_preprocessor_data_read_mesh(cs_mesh_t *mesh, cs_mesh_builder_t *mesh_builder, bool ignore_cartesian)
Definition: cs_preprocessor_data.cpp:2462
int cs_preprocessor_check_perio(void)
Definition: cs_preprocessor_data.cpp:2349
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:2212
void ledevi(int *iperio)
Definition: cs_preprocessor_data.cpp:2161
integer, save iperio
presence of periodicity.
Definition: period.f90:40
Definition: mesh.f90:26
Definition: cs_mesh_builder.h:57
Definition: cs_mesh.h:85