8.0
general documentation
cs_medcoupling_mesh.hxx
Go to the documentation of this file.
1 #ifndef __CS_MEDCOUPLING_MESH_HXX__
2 #define __CS_MEDCOUPLING_MESH_HXX__
3 
4 /*============================================================================
5  * Usage of MEDCoupling base components.
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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------
33  * Standard C library headers
34  *----------------------------------------------------------------------------*/
35 
36 #include <stdarg.h>
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <string.h>
40 
41 #include "cs_mesh.h"
42 
43 /*----------------------------------------------------------------------------
44  * MEDCOUPLING library headers
45  *----------------------------------------------------------------------------*/
46 
47 #if defined(HAVE_MEDCOUPLING)
48 
49 #include "MEDCouplingUMesh.hxx"
50 
51 using namespace MEDCoupling;
52 
53 #endif
54 
56 
57 /*----------------------------------------------------------------------------
58  * MEDCoupling mesh structure
59  *----------------------------------------------------------------------------*/
60 
61 typedef struct {
62 
63  char *sel_criteria; /* Element selection criteria
64  (if provided) */
65 
66  int elt_dim; /* Element dimension */
67 
68  cs_lnum_t n_elts; /* Number of coupled elements */
69  cs_lnum_t *elt_list; /* List of associated elements
70  (0 to n-1) */
71 
72  cs_lnum_t n_vtx; /* Number of vertices */
73  cs_lnum_t *vtx_list; /* List of associated vertices
74  (0 to n-1), or NULL */
75 
76  cs_lnum_t *new_to_old; /* Connectivity used if only a section of
77  the mesh is read */
78 
79  cs_real_t *bbox; /* Bounding box to optimize search */
80 
81 #if defined(HAVE_MEDCOUPLING)
82  MEDCouplingUMesh *med_mesh; /* MED mesh structure */
83 #else
84  void *med_mesh;
85 #endif
86 
88 
89 /*=============================================================================
90  * Public functions
91  *============================================================================*/
92 
93 /*----------------------------------------------------------------------------*/
105 /*----------------------------------------------------------------------------*/
106 
109  const char *name,
110  const char *selection_criteria,
111  int elt_dim,
112  int use_bbox);
113 
114 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
131  const char *name,
132  cs_lnum_t n_elts,
133  const cs_lnum_t elt_ids[],
134  int elt_dim,
135  int use_bbox);
136 
137 /*----------------------------------------------------------------------------*/
143 /*----------------------------------------------------------------------------*/
144 
145 void
147 
148 /*----------------------------------------------------------------------------*/
152 /*----------------------------------------------------------------------------*/
153 
154 void
156 
157 /*----------------------------------------------------------------------------*/
165 /*----------------------------------------------------------------------------*/
166 
167 int
169 
170 /*----------------------------------------------------------------------------*/
178 /*----------------------------------------------------------------------------*/
179 
180 cs_lnum_t
182 
183 /*----------------------------------------------------------------------------*/
191 /*----------------------------------------------------------------------------*/
192 
193 const cs_lnum_t *
195 
196 /*----------------------------------------------------------------------------*/
204 /*----------------------------------------------------------------------------*/
205 
206 cs_lnum_t
208 
209 /*----------------------------------------------------------------------------*/
218 /*----------------------------------------------------------------------------*/
219 
220 const cs_lnum_t *
222 
223 /*----------------------------------------------------------------------------*/
231 /*----------------------------------------------------------------------------*/
232 
233 const cs_lnum_t *
235 
236 /*----------------------------------------------------------------------------*/
247 /*----------------------------------------------------------------------------*/
248 
249 #if defined(HAVE_MEDCOUPLING)
250 MEDCouplingUMesh *
251 #else
252 void *
253 #endif
255  const cs_real_t normal[],
256  const cs_real_t length1,
257  const cs_real_t length2);
258 
259 /*----------------------------------------------------------------------------*/
271 /*----------------------------------------------------------------------------*/
272 
273 #if defined(HAVE_MEDCOUPLING)
274 MEDCouplingUMesh *
275 #else
276 void *
277 #endif
279  const cs_real_t normal[],
280  const cs_real_t radius,
281  const int n_sectors);
282 
283 /*----------------------------------------------------------------------------*/
296 /*----------------------------------------------------------------------------*/
297 
298 #if defined(HAVE_MEDCOUPLING)
299 MEDCouplingUMesh *
300 #else
301 void *
302 #endif
304  const cs_real_t normal[],
305  const cs_real_t radius1,
306  const cs_real_t radius2,
307  const int n_sectors);
308 
309 /*----------------------------------------------------------------------------*/
310 
312 
313 #endif /* __CS_MEDCOUPLING_MESH_HXX__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
#define END_C_DECLS
Definition: cs_defs.h:510
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
const cs_lnum_t * cs_medcoupling_mesh_get_vertex_list(cs_medcoupling_mesh_t *m)
Return a cs_medcoupling_mesh_t structure's (parent) vertices list.
Definition: cs_medcoupling_mesh.cxx:1092
const cs_lnum_t * cs_medcoupling_mesh_get_connectivity(cs_medcoupling_mesh_t *m)
Return a cs_medcoupling_mesh_t structure's (parent) elements list.
Definition: cs_medcoupling_mesh.cxx:1113
cs_lnum_t cs_medcoupling_mesh_get_n_elts(cs_medcoupling_mesh_t *m)
Return a cs_medcoupling_mesh_t structure's number of elements.
Definition: cs_medcoupling_mesh.cxx:1030
cs_medcoupling_mesh_t * cs_medcoupling_mesh_from_ids(cs_mesh_t *csmesh, const char *name, cs_lnum_t n_elts, const cs_lnum_t elt_ids[], int elt_dim, int use_bbox)
create a new cs_medcoupling_mesh_t instance based on cs_mesh_t
Definition: cs_medcoupling_mesh.cxx:916
cs_lnum_t cs_medcoupling_mesh_get_n_vertices(cs_medcoupling_mesh_t *m)
Return a cs_medcoupling_mesh_t structure's number of vertices.
Definition: cs_medcoupling_mesh.cxx:1071
void cs_medcoupling_mesh_destroy(cs_medcoupling_mesh_t *mesh)
Destroy a cs_medcoupling_mesh_t.
Definition: cs_medcoupling_mesh.cxx:963
MEDCouplingUMesh * cs_medcoupling_create_disc_mesh(const cs_real_t origin[], const cs_real_t normal[], const cs_real_t radius, const int n_sectors)
Returns a pointer to a MEDCouplingUMesh of a disc.
Definition: cs_medcoupling_mesh.cxx:1214
MEDCouplingUMesh * cs_medcoupling_create_annulus_mesh(const cs_real_t origin[], const cs_real_t normal[], const cs_real_t radius1, const cs_real_t radius2, const int n_sectors)
Returns a pointer to a MEDCouplingUMesh of an annulus.
Definition: cs_medcoupling_mesh.cxx:1311
cs_medcoupling_mesh_t * cs_medcoupling_mesh_from_base(cs_mesh_t *csmesh, const char *name, const char *selection_criteria, int elt_dim, int use_bbox)
create a new cs_medcoupling_mesh_t instance based on cs_mesh_t
Definition: cs_medcoupling_mesh.cxx:857
void cs_medcoupling_mesh_destroy_all(void)
Destroy all cs_medcoupling_mesh_t instances.
Definition: cs_medcoupling_mesh.cxx:985
int cs_medcoupling_mesh_get_dim(cs_medcoupling_mesh_t *m)
Return a cs_medcoupling_mesh_t structure's spatial dimension.
Definition: cs_medcoupling_mesh.cxx:1010
MEDCouplingUMesh * cs_medcoupling_create_plane_mesh(const cs_real_t origin[], const cs_real_t normal[], const cs_real_t length1, const cs_real_t length2)
Returns a pointer to a MEDCouplingUMesh of a plane.
Definition: cs_medcoupling_mesh.cxx:1141
const cs_lnum_t * cs_medcoupling_mesh_get_elt_list(cs_medcoupling_mesh_t *m)
Return a cs_medcoupling_mesh_t structure's (parent) elements list.
Definition: cs_medcoupling_mesh.cxx:1050
Definition: mesh.f90:26
Definition: cs_medcoupling_mesh.hxx:61
char * sel_criteria
Definition: cs_medcoupling_mesh.hxx:63
cs_lnum_t n_vtx
Definition: cs_medcoupling_mesh.hxx:72
cs_lnum_t n_elts
Definition: cs_medcoupling_mesh.hxx:68
cs_lnum_t * vtx_list
Definition: cs_medcoupling_mesh.hxx:73
cs_lnum_t * new_to_old
Definition: cs_medcoupling_mesh.hxx:76
MEDCouplingUMesh * med_mesh
Definition: cs_medcoupling_mesh.hxx:82
int elt_dim
Definition: cs_medcoupling_mesh.hxx:66
cs_lnum_t * elt_list
Definition: cs_medcoupling_mesh.hxx:69
cs_real_t * bbox
Definition: cs_medcoupling_mesh.hxx:79
Definition: cs_mesh.h:85