8.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-2023 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 * Public function prototypes for Fortran API
49 *============================================================================*/
50
51/*----------------------------------------------------------------------------
52 * Pass information relative to mesh metadata to the Fortran API
53 *
54 * Fortran Interface:
55 *
56 * subroutine ledevi(iperio, iperot)
57 * *****************
58 *
59 * integer iperio : <-- : Periodicity indicator
60 * integer iperot : <-- : Number of rotation periodicities
61 *----------------------------------------------------------------------------*/
62
63void
64CS_PROCF(ledevi, LEDEVI)(int *iperio,
65 int *iperot);
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/*----------------------------------------------------------------------------*/
111/*----------------------------------------------------------------------------*/
112
113bool
115
116/*----------------------------------------------------------------------------
117 * Read mesh meta-data.
118 *
119 * parameters:
120 * mesh <-- pointer to mesh structure
121 * mesh_builder <-- pointer to mesh builder structure
122 * ignore_cartesian <-- option to ignore cartesian blocks
123 *----------------------------------------------------------------------------*/
124
125void
127 cs_mesh_builder_t *mesh_builder,
128 bool ignore_cartesian);
129
130/*----------------------------------------------------------------------------
131 * Read pre-processor mesh data and finalize input.
132 *
133 * At this stage, ghost cells are not generated yet, so the interior
134 * face connectivity is not complete near parallel domain or periodic
135 * boundaries. Also, isolated faces, if present, are considered to be
136 * boundary faces, as they may participate in future mesh joining
137 * operations. Their matching cell number will be set to -1.
138 * Remaining isolated faces should be removed before completing
139 * the mesh structure.
140 *
141 * parameters:
142 * mesh <-- pointer to mesh structure
143 * mesh_builder <-- pointer to mesh builder structure
144 * ignore_cartesian <-- option to ignore cartesian blocks
145 *----------------------------------------------------------------------------*/
146
147void
149 cs_mesh_builder_t *mesh_builder,
150 bool ignore_cartesian);
151
152/*----------------------------------------------------------------------------*/
153
155
156#endif /* __CS_PRE_PROCESSOR_DATA_H__ */
157
#define BEGIN_C_DECLS
Definition cs_defs.h:509
#define CS_PROCF(x, y)
Definition cs_defs.h:523
#define END_C_DECLS
Definition cs_defs.h:510
void ledevi(int *iperio, int *iperot)
Definition cs_preprocessor_data.c:2101
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.c:2144
void cs_preprocessor_data_read_headers(cs_mesh_t *mesh, cs_mesh_builder_t *mesh_builder, bool ignore_cartesian)
Definition cs_preprocessor_data.c:2313
bool cs_preprocessor_data_is_restart(void)
Check if the last preprocessing data defined or read is restart data.
Definition cs_preprocessor_data.c:2298
void cs_preprocessor_data_read_mesh(cs_mesh_t *mesh, cs_mesh_builder_t *mesh_builder, bool ignore_cartesian)
Definition cs_preprocessor_data.c:2384
int cs_preprocessor_check_perio(void)
Definition cs_preprocessor_data.c:2254
integer, save iperot
number of rotation periodicities. automaticly evaluated. default value is 0
Definition period.f90:44
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