9.0
general documentation
cs_medcoupling_intersector.h
Go to the documentation of this file.
1#ifndef __CS_MEDCOUPLING_INTERSECTOR_HXX__
2#define __CS_MEDCOUPLING_INTERSECTOR_HXX__
3
4/*============================================================================
5 * Interpolation using MEDCoupling Intersector.
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 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "base/cs_defs.h"
35#include "fvm/fvm_writer.h"
36
37/*----------------------------------------------------------------------------*/
38
39BEGIN_C_DECLS
40
41/*============================================================================
42 * Type definitions
43 *============================================================================*/
44
45typedef enum {
46
47 CS_MEDCPL_INTERSECT_SURF,
48 CS_MEDCPL_INTERSECT_VOL,
49 CS_MEDCPL_INTERSECT_VOL_SURF,
50 CS_MEDCPL_N_INTERSECT_TYPES,
51 CS_MEDCPL_INTERSECT_UKNOWN
52} cs_medcpl_intersect_type_t;
53
54typedef enum {
55
56 CS_MEDCPL_MESH_FROM_FILE,
57 CS_MEDCPL_MESH_FROM_PRIMITIVE,
58 CS_MEDCPL_N_MESH_TYPES,
59 CS_MEDCPL_MESH_UKNOWN
60
61} cs_medcpl_mesh_type_t;
62
63/*============================================================================
64 * Structure definitions
65 *============================================================================*/
66
67typedef struct _cs_medcoupling_intersector_t cs_medcoupling_intersector_t;
68
69/*============================================================================
70 * Structure definitions
71 *============================================================================*/
72
73/*----------------------------------------------------------------------------*/
83/*----------------------------------------------------------------------------*/
84
85void
86cs_medcoupling_intersector_add_vol(const char *name,
87 const char *medfile_path,
88 const char *interp_method,
89 const char *select_criteria);
90
91/*----------------------------------------------------------------------------*/
101/*----------------------------------------------------------------------------*/
102
103void
104cs_medcoupling_intersector_add_surf(const char *name,
105 const char *medfile_path,
106 const char *interp_method,
107 const char *select_criteria);
108
109/*----------------------------------------------------------------------------*/
119/*----------------------------------------------------------------------------*/
120
121void
122cs_medcoupling_intersector_add_vol_surf(const char *name,
123 const char *medfile_path,
124 const char *interp_method,
125 const char *select_criteria);
126
127/*----------------------------------------------------------------------------*/
133/*----------------------------------------------------------------------------*/
134
135void
136cs_medcoupling_intersector_destroy(cs_medcoupling_intersector_t *mi);
137
138/*----------------------------------------------------------------------------*/
142/*----------------------------------------------------------------------------*/
143
144void
145cs_medcoupling_intersector_destroy_all(void);
146
147/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157cs_medcoupling_intersector_t *
158cs_medcoupling_intersector_by_id(int id);
159
160/*----------------------------------------------------------------------------*/
168/*----------------------------------------------------------------------------*/
169
170cs_medcoupling_intersector_t *
171cs_medcoupling_intersector_by_name(const char *name);
172
173/*----------------------------------------------------------------------------*/
182/*----------------------------------------------------------------------------*/
183
184cs_real_t *
185cs_medcoupling_intersect_volumes(cs_medcoupling_intersector_t *mi);
186
187/*----------------------------------------------------------------------------*/
196/*----------------------------------------------------------------------------*/
197
198cs_real_t *
199cs_medcoupling_intersect_surfaces(cs_medcoupling_intersector_t *mi);
200
201/*----------------------------------------------------------------------------*/
210/*----------------------------------------------------------------------------*/
211
212cs_real_t *
213cs_medcoupling_intersect_volume_and_surfaces(cs_medcoupling_intersector_t *mi);
214
215/*----------------------------------------------------------------------------*/
222/*----------------------------------------------------------------------------*/
223
224void
225cs_medcoupling_intersector_translate(cs_medcoupling_intersector_t *mi,
226 cs_real_t translation[3]);
227
228/*----------------------------------------------------------------------------*/
238/*----------------------------------------------------------------------------*/
239
240void
241cs_medcoupling_intersector_rotate(cs_medcoupling_intersector_t *mi,
242 cs_real_t invariant[3],
243 cs_real_t axis[3],
244 cs_real_t angle);
245
246/*----------------------------------------------------------------------------*/
254/*----------------------------------------------------------------------------*/
255
256void
257cs_medcoupling_intersector_scale_auto(cs_medcoupling_intersector_t *mi,
258 cs_real_t factor);
259
260/*----------------------------------------------------------------------------*/
268/*----------------------------------------------------------------------------*/
269
270void
271cs_medcoupling_intersector_transform_from_init(cs_medcoupling_intersector_t *mi,
272 cs_real_t matrix[3][4]);
273
274/*----------------------------------------------------------------------------*/
281/*----------------------------------------------------------------------------*/
282
283void
284cs_medcoupling_intersector_dump_mesh(cs_medcoupling_intersector_t *mi,
285 const char *prefix);
286
287/*----------------------------------------------------------------------------*/
293/*----------------------------------------------------------------------------*/
294
295void
296cs_medcoupling_intersector_print_mesh_info(cs_medcoupling_intersector_t *mi);
297
298/*----------------------------------------------------------------------------*/
302/*----------------------------------------------------------------------------*/
303
304int
305cs_mi_post_get_writer_id(void);
306
307/*----------------------------------------------------------------------------*/
314/*----------------------------------------------------------------------------*/
315
316void
317cs_mi_post_init_writer(const char *case_name,
318 const char *dir_name,
319 const char *fmt_name,
320 const char *fmt_opts,
321 fvm_writer_time_dep_t time_dep,
322 bool output_at_start,
323 bool output_at_end,
324 int frequency_n,
325 double frequency_t);
326
327/*----------------------------------------------------------------------------*/
333/*----------------------------------------------------------------------------*/
334
335void
336cs_mi_post_add_mesh(cs_medcoupling_intersector_t *mi);
337
338/*----------------------------------------------------------------------------*/
339
340END_C_DECLS
341
342#endif /* __CS_MEDCOUPLING_INTERSECTOR_HXX__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_medcoupling_intersector_rotate
void cs_medcoupling_intersector_rotate(cs_medcoupling_intersector_t *mi, cs_real_t invariant[3], cs_real_t axis[3], cs_real_t angle)
rotate the mesh
Definition: cs_medcoupling_intersector.cxx:1209
cs_medcoupling_intersector_translate
void cs_medcoupling_intersector_translate(cs_medcoupling_intersector_t *mi, cs_real_t translation[3])
translate the mesh using a given vector
Definition: cs_medcoupling_intersector.cxx:1149
cs_medcoupling_intersector_add_vol
void cs_medcoupling_intersector_add_vol(const char *name, const char *medfile_path, const char *interp_method, const char *select_criteria)
Add a volume MEDCoupling intersector.
Definition: cs_medcoupling_intersector.cxx:829
cs_medcoupling_intersector_add_surf
void cs_medcoupling_intersector_add_surf(const char *name, const char *medfile_path, const char *interp_method, const char *select_criteria)
Add a surface MEDCoupling intersector.
Definition: cs_medcoupling_intersector.cxx:865
cs_medcoupling_intersector_by_id
cs_medcoupling_intersector_t * cs_medcoupling_intersector_by_id(int id)
Get a MEDCoupling intersector using its id.
Definition: cs_medcoupling_intersector.cxx:975
cs_medcoupling_intersector_print_mesh_info
void cs_medcoupling_intersector_print_mesh_info(cs_medcoupling_intersector_t *mi)
print mesh information to log file.
Definition: cs_medcoupling_intersector.cxx:1418
cs_medcoupling_intersector_dump_mesh
void cs_medcoupling_intersector_dump_mesh(cs_medcoupling_intersector_t *mi, const char *prefix)
translate the mesh using a given vector
Definition: cs_medcoupling_intersector.cxx:1395
cs_medcoupling_intersector_destroy
void cs_medcoupling_intersector_destroy(cs_medcoupling_intersector_t *mi)
Destroy a given MEDCoupling intersector.
Definition: cs_medcoupling_intersector.cxx:933
cs_mi_post_init_writer
void cs_mi_post_init_writer(const char *case_name, const char *dir_name, const char *fmt_name, const char *fmt_opts, fvm_writer_time_dep_t time_dep, bool output_at_start, bool output_at_end, int frequency_n, double frequency_t)
Create a new writer that will contains the boundary MED mesh added.
Definition: cs_medcoupling_intersector.cxx:1454
cs_medcoupling_intersector_scale_auto
void cs_medcoupling_intersector_scale_auto(cs_medcoupling_intersector_t *mi, cs_real_t factor)
Scale a mesh using a factor based on the current mesh center position.
Definition: cs_medcoupling_intersector.cxx:1258
cs_medcoupling_intersector_destroy_all
void cs_medcoupling_intersector_destroy_all(void)
Free all allocated intersectors.
Definition: cs_medcoupling_intersector.cxx:954
cs_medcoupling_intersector_transform_from_init
void cs_medcoupling_intersector_transform_from_init(cs_medcoupling_intersector_t *mi, cs_real_t matrix[3][4])
Transform a mesh, but takes as input the initial position of the mesh.
Definition: cs_medcoupling_intersector.cxx:1346
cs_medcoupling_intersect_volume_and_surfaces
cs_real_t * cs_medcoupling_intersect_volume_and_surfaces(cs_medcoupling_intersector_t *mi)
Compute the intersection surfaces between the source mesh and code mesh.
Definition: cs_medcoupling_intersector.cxx:1108
cs_mi_post_get_writer_id
int cs_mi_post_get_writer_id(void)
Return writer id used for medcoupling meshes, 0 means unused.
Definition: cs_medcoupling_intersector.cxx:1439
cs_medcoupling_intersector_by_name
cs_medcoupling_intersector_t * cs_medcoupling_intersector_by_name(const char *name)
Get a MEDCoupling intersector by name.
Definition: cs_medcoupling_intersector.cxx:996
cs_medcoupling_intersect_volumes
cs_real_t * cs_medcoupling_intersect_volumes(cs_medcoupling_intersector_t *mi)
Compute the intersection volumes between the source mesh and code mesh.
Definition: cs_medcoupling_intersector.cxx:1024
cs_medcpl_mesh_type_t
cs_medcpl_mesh_type_t
Definition: cs_medcoupling_intersector.h:54
CS_MEDCPL_MESH_FROM_FILE
@ CS_MEDCPL_MESH_FROM_FILE
Definition: cs_medcoupling_intersector.h:56
CS_MEDCPL_MESH_FROM_PRIMITIVE
@ CS_MEDCPL_MESH_FROM_PRIMITIVE
Definition: cs_medcoupling_intersector.h:57
CS_MEDCPL_MESH_UKNOWN
@ CS_MEDCPL_MESH_UKNOWN
Definition: cs_medcoupling_intersector.h:59
CS_MEDCPL_N_MESH_TYPES
@ CS_MEDCPL_N_MESH_TYPES
Definition: cs_medcoupling_intersector.h:58
cs_medcoupling_intersector_add_vol_surf
void cs_medcoupling_intersector_add_vol_surf(const char *name, const char *medfile_path, const char *interp_method, const char *select_criteria)
Add a surface in volume MEDCoupling intersector.
Definition: cs_medcoupling_intersector.cxx:901
cs_medcpl_intersect_type_t
cs_medcpl_intersect_type_t
Definition: cs_medcoupling_intersector.h:45
CS_MEDCPL_INTERSECT_VOL_SURF
@ CS_MEDCPL_INTERSECT_VOL_SURF
Definition: cs_medcoupling_intersector.h:49
CS_MEDCPL_INTERSECT_VOL
@ CS_MEDCPL_INTERSECT_VOL
Definition: cs_medcoupling_intersector.h:48
CS_MEDCPL_INTERSECT_UKNOWN
@ CS_MEDCPL_INTERSECT_UKNOWN
Definition: cs_medcoupling_intersector.h:51
CS_MEDCPL_INTERSECT_SURF
@ CS_MEDCPL_INTERSECT_SURF
Definition: cs_medcoupling_intersector.h:47
CS_MEDCPL_N_INTERSECT_TYPES
@ CS_MEDCPL_N_INTERSECT_TYPES
Definition: cs_medcoupling_intersector.h:50
cs_mi_post_add_mesh
void cs_mi_post_add_mesh(cs_medcoupling_intersector_t *mi)
Associate a Medcoupling mesh to the default writer.
Definition: cs_medcoupling_intersector.cxx:1497
cs_medcoupling_intersect_surfaces
cs_real_t * cs_medcoupling_intersect_surfaces(cs_medcoupling_intersector_t *mi)
Compute the intersection surfaces between the source mesh and code mesh.
Definition: cs_medcoupling_intersector.cxx:1065
fvm_writer.h
fvm_writer_time_dep_t
fvm_writer_time_dep_t
Definition: fvm_writer.h:57