8.2
general documentation
cs_interpolate.h
Go to the documentation of this file.
1 #ifndef __CS_INTERPOLATE_H__
2 #define __CS_INTERPOLATE_H__
3 
4 /*============================================================================
5  * Interpolation function handling.
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 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 #include "cs_mesh_location.h"
36 
37 /*----------------------------------------------------------------------------*/
38 
39 BEGIN_C_DECLS
40 
41 /*=============================================================================
42  * Macro definitions
43  *============================================================================*/
44 
45 /*============================================================================
46  * Type definitions
47  *============================================================================*/
48 
49 /*----------------------------------------------------------------------------
50  * Field values interpolation type
51  *----------------------------------------------------------------------------*/
52 
53 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 typedef void
71 (cs_interpolate_from_location_t) (void *input,
72  cs_datatype_t datatype,
73  int val_dim,
74  cs_lnum_t n_points,
75  const cs_lnum_t point_location[],
76  const cs_real_3_t point_coords[],
77  const void *location_vals,
78  void *point_vals);
79 
80 /*=============================================================================
81  * Public function prototypes
82  *============================================================================*/
83 
84 /*----------------------------------------------------------------------------*/
102 /*----------------------------------------------------------------------------*/
103 
104 void
105 cs_interpolate_from_location_p0(void *input,
106  cs_datatype_t datatype,
107  int val_dim,
108  cs_lnum_t n_points,
109  const cs_lnum_t point_location[],
110  const cs_real_3_t point_coords[],
111  const void *location_vals,
112  void *point_vals);
113 
114 /*----------------------------------------------------------------------------*/
142 /*----------------------------------------------------------------------------*/
143 
144 void
145 cs_interpolate_from_location_p1(void *input,
146  cs_datatype_t datatype,
147  int val_dim,
148  cs_lnum_t n_points,
149  const cs_lnum_t point_location[],
150  const cs_real_3_t point_coords[],
151  const void *location_vals,
152  void *point_vals);
153 
154 /*----------------------------------------------------------------------------*/
155 
156 END_C_DECLS
157 
158 #endif /* __CS_INTERPOLATE_H__ */
cs_defs.h
cs_datatype_t
cs_datatype_t
Definition: cs_defs.h:284
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:528
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:347
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:529
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_interpolate_from_location_t
void() cs_interpolate_from_location_t(void *input, cs_datatype_t datatype, int val_dim, cs_lnum_t n_points, const cs_lnum_t point_location[], const cs_real_3_t point_coords[], const void *location_vals, void *point_vals)
Function pointer for interpolatation of values defined on a mesh location at a given set of points.
Definition: cs_interpolate.h:71
cs_interpolate_from_location_p1
void cs_interpolate_from_location_p1(void *input, cs_datatype_t datatype, int val_dim, cs_lnum_t n_points, const cs_lnum_t point_location[], const cs_real_3_t point_coords[], const void *location_vals, void *point_vals)
Interpolate values defined on a mesh location at a given set of points using a P1 interpolation.
Definition: cs_interpolate.c:227
cs_interpolate_from_location_p0
void cs_interpolate_from_location_p0(void *input, cs_datatype_t datatype, int val_dim, cs_lnum_t n_points, const cs_lnum_t point_location[], const cs_real_3_t point_coords[], const void *location_vals, void *point_vals)
Interpolate values defined on a mesh location at a given set of points using a P0 interpolation.
Definition: cs_interpolate.c:121
cs_mesh_location.h