8.0
general documentation
fvm_interpolate.h
Go to the documentation of this file.
1 #ifndef __FVM_INTERPOLATE_H__
2 #define __FVM_INTERPOLATE_H__
3 
4 /*============================================================================
5  * Interpolate data defined on a nodal representation associated with a mesh.
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  * Local headers
34  *----------------------------------------------------------------------------*/
35 
36 #include "fvm_defs.h"
37 #include "fvm_nodal.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
41 BEGIN_C_DECLS
42 
43 /*=============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Type definitions
49  *============================================================================*/
50 
51 /*=============================================================================
52  * Static global variables
53  *============================================================================*/
54 
55 /*=============================================================================
56  * Public function prototypes
57  *============================================================================*/
58 
59 /*----------------------------------------------------------------------------
60  * Interpolate vertex-based values to points located relative to a mesh.
61  *
62  * Least-squared based interpolation is used for now.
63  *
64  * parameters:
65  * this_nodal <-- pointer to nodal mesh representation structure
66  * entity_dim <-- 3 for location on cells, 2 for faces, 1 for edges,
67  * and 0 for vertices
68  * data_dim <-- data dimension
69  * n_points <-- number of points to locate
70  * location_id <-- id of element (with concatenated sections)
71  * in which each point is located
72  * point_coords <-- point coordinates
73  * src_data <-- source data (interleaved)
74  * dest_data <-> destination data (interleaved)
75  *----------------------------------------------------------------------------*/
76 
77 void
78 fvm_interpolate_vtx_data(const fvm_nodal_t *this_nodal,
79  int entity_dim,
80  int data_dim,
81  cs_lnum_t n_points,
82  const cs_lnum_t location_id[],
83  const cs_coord_t point_coords[],
84  const cs_real_t src_data[],
85  cs_real_t dest_data[]);
86 
87 /*----------------------------------------------------------------------------*/
88 
89 END_C_DECLS
90 
91 #endif /* __FVM_INTERPOLATE_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
cs_coord_t
double cs_coord_t
Definition: cs_defs.h:317
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:510
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
fvm_defs.h
fvm_interpolate_vtx_data
void fvm_interpolate_vtx_data(const fvm_nodal_t *this_nodal, int entity_dim, int data_dim, cs_lnum_t n_points, const cs_lnum_t location_id[], const cs_coord_t point_coords[], const cs_real_t src_data[], cs_real_t dest_data[])
Definition: fvm_interpolate.c:107
fvm_nodal.h