8.3
general documentation
cs_geom.h
Go to the documentation of this file.
1#ifndef __CS_GEOM_H__
2#define __CS_GEOM_H__
3
4/*============================================================================
5 * Geometric utility functions.
6 *===========================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 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 * Local headers
34 *---------------------------------------------------------------------------*/
35
36/*---------------------------------------------------------------------------*/
37
38BEGIN_C_DECLS
39
40/*=============================================================================
41 * Local Macro definitions
42 *===========================================================================*/
43
44/*============================================================================
45 * Type definition
46 *===========================================================================*/
47
48/*=============================================================================
49 * Global variables
50 *===========================================================================*/
51
52/*=============================================================================
53 * Public function prototypes
54 *===========================================================================*/
55
56/*----------------------------------------------------------------------------*/
71/*----------------------------------------------------------------------------*/
72
73void
74cs_geom_closest_point(cs_lnum_t n_points,
75 const cs_real_t point_coords[][3],
76 const cs_real_t query_coords[3],
77 cs_lnum_t *point_id,
78 int *rank_id);
79
80/*----------------------------------------------------------------------------*/
115/*----------------------------------------------------------------------------*/
116
117double
118cs_geom_segment_intersect_face(int orient,
119 cs_lnum_t n_vertices,
120 const cs_lnum_t vertex_ids[],
121 const cs_real_t vtx_coord[][3],
122 const cs_real_t face_cog[3],
123 const cs_real_t sx0[3],
124 const cs_real_t sx1[3],
125 int n_inout[2],
126 cs_real_t *face_norm);
127
128/*---------------------------------------------------------------------------*/
129
130END_C_DECLS
131
132#endif /* __CS_GEOM_H__ */
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_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
cs_geom_segment_intersect_face
double cs_geom_segment_intersect_face(int orient, cs_lnum_t n_vertices, const cs_lnum_t vertex_ids[], const cs_real_t vtx_coord[][3], const cs_real_t face_cog[3], const cs_real_t sx0[3], const cs_real_t sx1[3], int n_inout[2], cs_real_t *face_norm)
Test if a line segment intersects a face.
Definition: cs_geom.cpp:227
cs_geom_closest_point
void cs_geom_closest_point(cs_lnum_t n_points, const cs_real_t point_coords[][3], const cs_real_t query_coords[3], cs_lnum_t *point_id, int *rank_id)
find the closest point of a set to a given point in space.
Definition: cs_geom.cpp:162