7.1
general documentation
cs_cell_to_vertex.h
Go to the documentation of this file.
1 #ifndef __CS_CELL_TO_VERTEX_H__
2 #define __CS_CELL_TO_VERTEX_H__
3 
4 /*============================================================================
5  * Cell to vertex interpolation.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2021 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_base.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*=============================================================================
41  * Local Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definition
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------
49  * Cell to vertex computation method
50  *----------------------------------------------------------------------------*/
51 
52 typedef enum {
53 
54  CS_CELL_TO_VERTEX_UNWEIGHTED,
55  CS_CELL_TO_VERTEX_SHEPARD,
57  CS_CELL_TO_VERTEX_LR
60 } cs_cell_to_vertex_type_t;
61 
62 /*============================================================================
63  * Global variables
64  *============================================================================*/
65 
66 /* Short names for cell to vertex methods */
67 
68 extern const char *cs_cell_to_vertex_type_name[];
69 
70 /*=============================================================================
71  * Public function prototypes
72  *============================================================================*/
73 
74 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 void
83 cs_cell_to_vertex_free(void);
84 
85 /*----------------------------------------------------------------------------*/
98 /*----------------------------------------------------------------------------*/
99 
100 void
101 cs_cell_to_vertex(cs_cell_to_vertex_type_t method,
102  int verbosity,
103  cs_lnum_t var_dim,
104  bool ignore_rot_perio,
105  const cs_real_t c_weight[restrict],
106  const cs_real_t c_var[restrict],
107  const cs_real_t b_var[restrict],
108  cs_real_t v_var[restrict]);
109 
110 /*----------------------------------------------------------------------------*/
111 
112 END_C_DECLS
113 
114 #endif /* __CS_CELL_TO_VERTEX__ */
cs_cell_to_vertex
void cs_cell_to_vertex(cs_cell_to_vertex_type_t method, int verbosity, cs_lnum_t var_dim, bool ignore_rot_perio, const cs_real_t c_weight[restrict], const cs_real_t c_var[restrict], const cs_real_t b_var[restrict], cs_real_t v_var[restrict])
Interpolate cell values to vertex values.
Definition: cs_cell_to_vertex.c:1224
restrict
#define restrict
Definition: cs_defs.h:142
cs_base.h
cs_cell_to_vertex_free
void cs_cell_to_vertex_free(void)
Free cell to vertex interpolation weights.
Definition: cs_cell_to_vertex.c:1200
CS_CELL_TO_VERTEX_LR
Definition: cs_cell_to_vertex.h:57
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
CS_CELL_TO_VERTEX_SHEPARD
Definition: cs_cell_to_vertex.h:55
CS_CELL_TO_VERTEX_UNWEIGHTED
Definition: cs_cell_to_vertex.h:54
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_cell_to_vertex_type_t
cs_cell_to_vertex_type_t
Definition: cs_cell_to_vertex.h:52
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:316
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_cell_to_vertex_type_name
const char * cs_cell_to_vertex_type_name[]