6.3
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-2020 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 
31 
32 /*============================================================================
33  * Structure definitions
34  *============================================================================*/
35 
36 typedef struct _cs_medcoupling_intersector_t cs_medcoupling_intersector_t;
37 
38 /*============================================================================
39  * Structure definitions
40  *============================================================================*/
41 
42 /*----------------------------------------------------------------------------*/
52 /*----------------------------------------------------------------------------*/
53 
54 void
55 cs_medcoupling_intersector_add(const char *name,
56  const char *medfile_path,
57  const char *interp_method,
58  const char *select_criteria);
59 
60 /*----------------------------------------------------------------------------*/
66 /*----------------------------------------------------------------------------*/
67 
68 void
69 cs_medcoupling_intersector_destroy(cs_medcoupling_intersector_t *mi);
70 
71 /*----------------------------------------------------------------------------*/
75 /*----------------------------------------------------------------------------*/
76 
77 void
79 
80 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 cs_medcoupling_intersector_t *
92 
93 /*----------------------------------------------------------------------------*/
101 /*----------------------------------------------------------------------------*/
102 
103 cs_medcoupling_intersector_t *
104 cs_medcoupling_intersector_by_name(const char *name);
105 
106 /*----------------------------------------------------------------------------*/
115 /*----------------------------------------------------------------------------*/
116 
117 cs_real_t *
118 cs_medcoupling_intersect_volumes(cs_medcoupling_intersector_t *mi);
119 
120 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
129 void
130 cs_medcoupling_intersector_translate(cs_medcoupling_intersector_t *mi,
131  cs_real_t translation[3]);
132 
133 /*----------------------------------------------------------------------------*/
143 /*----------------------------------------------------------------------------*/
144 
145 void
146 cs_medcoupling_intersector_rotate(cs_medcoupling_intersector_t *mi,
147  cs_real_t invariant[3],
148  cs_real_t axis[3],
149  cs_real_t angle);
150 
151 /*----------------------------------------------------------------------------*/
158 /*----------------------------------------------------------------------------*/
159 
160 void
161 cs_medcoupling_intersector_dump_mesh(cs_medcoupling_intersector_t *mi,
162  const char *prefix);
163 
165 
166 #endif /* __CS_MEDCOUPLING_INTERSECTOR_HXX__ */
cs_medcoupling_intersector_destroy
void cs_medcoupling_intersector_destroy(cs_medcoupling_intersector_t *mi)
Destroy a given MEDCoupling intersector.
Definition: cs_medcoupling_intersector.cxx:416
cs_medcoupling_intersector_add
void cs_medcoupling_intersector_add(const char *name, const char *medfile_path, const char *interp_method, const char *select_criteria)
Add a MEDCoupling intersector.
Definition: cs_medcoupling_intersector.cxx:370
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:468
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:518
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:493
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:551
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:304
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
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:581
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:612
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:490
cs_medcoupling_intersector_destroy_all
void cs_medcoupling_intersector_destroy_all(void)
Free all allocated intersectors.
Definition: cs_medcoupling_intersector.cxx:439