programmer's documentation
cs_turbomachinery.h
Go to the documentation of this file.
1 #ifndef __CS_TURBOMACHINERY_H__
2 #define __CS_TURBOMACHINERY_H__
3 
4 /*============================================================================
5  * Turbomachinery modeling features.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 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 #include "cs_defs.h"
35 
36 /*----------------------------------------------------------------------------
37  * Local headers
38  *----------------------------------------------------------------------------*/
39 
40 #include "cs_restart.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
45 
46 /*=============================================================================
47  * Local Type Definitions
48  *============================================================================*/
49 
50 /*----------------------------------------------------------------------------
51  * Local Structure Definitions
52  *----------------------------------------------------------------------------*/
53 
54 /* Turbomachinery model type */
55 
56 typedef enum {
57 
58  CS_TURBOMACHINERY_NONE, /* No turbomachinery modeling */
59  CS_TURBOMACHINERY_FROZEN, /* Frozen rotor model */
60  CS_TURBOMACHINERY_TRANSIENT /* full transient simulation */
61 
63 
64 /*============================================================================
65  * Static global variables
66  *============================================================================*/
67 
68 /*============================================================================
69  * Public function prototypes
70  *============================================================================*/
71 
72 /*----------------------------------------------------------------------------
73  * Define rotor/stator model.
74  *----------------------------------------------------------------------------*/
75 
76 void
78 
79 /*----------------------------------------------------------------------------
80  * return rotor/stator model.
81  *----------------------------------------------------------------------------*/
82 
85 
86 /*----------------------------------------------------------------------------
87  * Define a rotor by its axis and cell selection criteria.
88  *
89  * parameters:
90  * cell_criteria <-- cell selection criteria string
91  * rotation_velocity <-- rotation velocity, in radians/second
92  * rotation_axis <-- rotation axis vector
93  * rotation_invariant <-- rotation invariant point
94  *----------------------------------------------------------------------------*/
95 
96 void
97 cs_turbomachinery_add_rotor(const char *cell_criteria,
98  double rotation_velocity,
99  const double rotation_axis[3],
100  const double rotation_invariant[3]);
101 
102 /*----------------------------------------------------------------------------
103  * Add a cs_join_t structure to the list of rotor/stator joinings.
104  *
105  * parameters:
106  * sel_criteria <-- boundary face selection criteria
107  * fraction <-- value of the fraction parameter
108  * plane <-- value of the plane parameter
109  * verbosity <-- level of verbosity required
110  * visualization <-- level of visualization required
111  *
112  * returns:
113  * number (1 to n) associated with new joining
114  *----------------------------------------------------------------------------*/
115 
116 int
117 cs_turbomachinery_join_add(const char *sel_criteria,
118  float fraction,
119  float plane,
120  int verbosity,
121  int visualization);
122 
123 /*----------------------------------------------------------------------------
124  * Add a cs_join_t structure to the list of rotor/stator couplings.
125  *
126  * parameters:
127  * sel_criteria <-- boundary face selection criteria
128  * tolerance <-- value of the search tolerance
129  * verbosity <-- level of verbosity required
130  *
131  * returns:
132  * number (1 to n) associated with new coupling
133  *----------------------------------------------------------------------------*/
134 
135 int
136 cs_turbomachinery_coupling_add(const char *sel_criteria,
137  float tolerance,
138  int verbosity);
139 
140 /*----------------------------------------------------------------------------
141  * Definitions for turbomachinery computation.
142  *----------------------------------------------------------------------------*/
143 
144 void
146 
147 /*----------------------------------------------------------------------------
148  * Initializations for turbomachinery computation
149  *
150  * Note: this function should be called after the mesh is built,
151  * but before cs_post_init_meshes() so that postprocessing meshes are
152  * updated correctly in the transient case.
153  *----------------------------------------------------------------------------*/
154 
155 void
157 
158 /*----------------------------------------------------------------------------
159  * Free turbomachinery info
160  *----------------------------------------------------------------------------*/
161 
162 void
164 
165 /*----------------------------------------------------------------------------
166  * Update mesh for unsteady rotor/stator computation
167  *
168  * parameters:
169  * t_cur_mob <-- current rotor time
170  * t_elapsed --> elapsed computation time
171  *----------------------------------------------------------------------------*/
172 
173 void
174 cs_turbomachinery_update_mesh(double t_cur_mob,
175  double *t_elapsed);
176 
177 /*----------------------------------------------------------------------------
178  * Update mesh for unsteady rotor/stator computation in case of restart.
179  *
180  * Reads mesh from checkpoint when available.
181  *----------------------------------------------------------------------------*/
182 
183 void
185 
186 /*----------------------------------------------------------------------------
187  * Reinitialize interior face-based fields.
188  *----------------------------------------------------------------------------*/
189 
190 void
192 
193 /*----------------------------------------------------------------------------
194  * Resize cell-based fields.
195  *
196  * This function only handles fields owning their values.
197  *----------------------------------------------------------------------------*/
198 
199 void
201 
202 /*----------------------------------------------------------------------------
203  * Compute rotation matrix
204  *
205  * parameters:
206  * rotor_num <-- rotor number (1 to n numbering)
207  * theta <-- rotation angle, in radians
208  * matrix --> resulting rotation matrix
209  *----------------------------------------------------------------------------*/
210 
211 void
213  double theta,
214  cs_real_t matrix[3][4]);
215 
216 /*----------------------------------------------------------------------------
217  * Return cell rotor number.
218  *
219  * Each cell may be associated with a given rotor, or rotation, with 0
220  * indicating that that cell does not rotate.
221  *
222  * returns:
223  * array defining rotor number associated with each cell
224  * (0 for none, 1 to n otherwise)
225  *----------------------------------------------------------------------------*/
226 
227 const int *
229 
230 /*----------------------------------------------------------------------------
231  * Return rotation velocity
232  *
233  * parameters:
234  * rotor_num <-- rotor number (1 to n numbering)
235  *----------------------------------------------------------------------------*/
236 
237 double
239 
240 /*----------------------------------------------------------------------------*/
247 /*----------------------------------------------------------------------------*/
248 
249 void
251  double omega);
252 
253 /*----------------------------------------------------------------------------*/
265 /*----------------------------------------------------------------------------*/
266 
267 void
268 cs_turbomachinery_set_rotation_retry(int n_max_join_retries,
269  double dt_retry_multiplier);
270 
271 /*----------------------------------------------------------------------------
272  * Rotation of vector and tensor fields.
273  *
274  * parameters:
275  * dt <-- cell time step values
276  *----------------------------------------------------------------------------*/
277 
278 void
280 
281 /*----------------------------------------------------------------------------
282  * Compute velocity relative to fixed coordinates at a given point
283  *
284  * Deprecated:
285  * Use cs_rotation_velocity for more consistent naming of this reference
286  * frame velocity.
287  *
288  * parameters:
289  * rotor_num <-- associated rotor number (1 to n numbering)
290  * coords <-- point coordinates
291  * velocity --> velocity relative to fixed coordinates
292  *----------------------------------------------------------------------------*/
293 
294 void
296  const cs_real_t coords[3],
297  cs_real_t velocity[3]);
298 
299 /*----------------------------------------------------------------------------*/
307 /*----------------------------------------------------------------------------*/
308 
309 void
311 
312 /*----------------------------------------------------------------------------*/
320 /*----------------------------------------------------------------------------*/
321 
322 void
324 
325 /*----------------------------------------------------------------------------*/
326 
328 
329 #endif /* __CS_TURBOMACHINERY_H__ */
330 
cs_turbomachinery_model_t
Definition: cs_turbomachinery.h:56
Definition: cs_turbomachinery.h:60
void cs_turbomachinery_rotation_matrix(int rotor_num, double theta, cs_real_t matrix[3][4])
Compute rotation matrix.
Definition: cs_turbomachinery.c:1580
void cs_turbomachinery_set_model(cs_turbomachinery_model_t model)
Define rotor/stator model.
Definition: cs_turbomachinery.c:1187
void cs_turbomachinery_relative_velocity(int rotor_num, const cs_real_t coords[3], cs_real_t velocity[3])
Compute velocity relative to fixed coordinates at a given point.
Definition: cs_turbomachinery.c:1768
void cs_turbomachinery_rotate_fields(const cs_real_t dt[])
Rotation of vector and tensor fields.
Definition: cs_turbomachinery.c:1673
Definition: cs_turbomachinery.h:59
double precision, dimension(ncharm), save omega
Definition: cpincl.f90:99
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
void cs_turbomachinery_initialize(void)
Initializations for turbomachinery computation.
Definition: cs_turbomachinery.c:1408
int cs_turbomachinery_join_add(const char *sel_criteria, float fraction, float plane, int verbosity, int visualization)
Add a cs_join_t structure to the list of rotor/stator joinings.
Definition: cs_turbomachinery.c:1272
Definition: cs_turbomachinery.h:58
const int * cs_turbomachinery_get_cell_rotor_num(void)
Return cell rotor number.
Definition: cs_turbomachinery.c:1603
void cs_turbomachinery_restart_read(cs_restart_t *r)
Read turbomachinery metadata from restart file.
Definition: cs_turbomachinery.c:1793
double cs_turbomachinery_get_rotation_velocity(int rotor_num)
Return rotation velocity.
Definition: cs_turbomachinery.c:1617
void cs_turbomachinery_update_mesh(double t_cur_mob, double *t_elapsed)
Update mesh for unsteady rotor/stator computation.
Definition: cs_turbomachinery.c:1340
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void matrix(const int *iconvp, const int *idiffp, const int *ndircp, const int *isym, const cs_real_t *thetap, const int *imucpp, const cs_real_t coefbp[], const cs_real_t cofbfp[], const cs_real_t rovsdt[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_visc[], const cs_real_t b_visc[], const cs_real_t xcpp[], cs_real_t da[], cs_real_t xa[])
Definition: cs_matrix_building.c:111
cs_turbomachinery_model_t cs_turbomachinery_get_model(void)
Return rotor/stator model.
Definition: cs_turbomachinery.c:1208
void cs_turbomachinery_resize_cell_fields(void)
Resize cell-based fields.
Definition: cs_turbomachinery.c:1524
void cs_turbomachinery_set_rotation_velocity(int rotor_num, double omega)
Set rotation velocity.
Definition: cs_turbomachinery.c:1634
void cs_turbomachinery_add_rotor(const char *cell_criteria, double rotation_velocity, const double rotation_axis[3], const double rotation_invariant[3])
Define a rotor by its axis and cell selection criteria.
Definition: cs_turbomachinery.c:1228
Definition: cs_field_pointer.h:65
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:86
void cs_turbomachinery_restart_mesh(void)
Update mesh for unsteady rotor/stator computation in case of restart.
Definition: cs_turbomachinery.c:1355
double precision, dimension(:,:,:), allocatable theta
Definition: atimbr.f90:123
void cs_turbomachinery_finalize(void)
Free turbomachinery structure.
Definition: cs_turbomachinery.c:1470
int cs_turbomachinery_coupling_add(const char *sel_criteria, float tolerance, int verbosity)
Add a cs_join_t structure to the list of rotor/stator couplings.
Definition: cs_turbomachinery.c:1312
void cs_turbomachinery_reinit_i_face_fields(void)
Reinitialize interior face-based fields.
Definition: cs_turbomachinery.c:1501
void cs_turbomachinery_set_rotation_retry(int n_max_join_retries, double dt_retry_multiplier)
Set turbomachinery joining retry parameters.
Definition: cs_turbomachinery.c:1657
#define END_C_DECLS
Definition: cs_defs.h:462
void cs_turbomachinery_restart_write(cs_restart_t *r)
Write turbomachinery metadata to checkpoint file.
Definition: cs_turbomachinery.c:1838
void cs_turbomachinery_define(void)
Definitions for turbomachinery computation.
Definition: cs_turbomachinery.c:1376