programmer's documentation
cs_evaluate.h
Go to the documentation of this file.
1 #ifndef __CS_EVALUATE_H__
2 #define __CS_EVALUATE_H__
3 
4 /*============================================================================
5  * Functions and structures to deal with evaluation of quantities
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 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 #include "cs_cdo.h"
36 #include "cs_cdo_local.h"
37 #include "cs_cdo_quantities.h"
38 #include "cs_param.h"
39 #include "cs_quadrature.h"
40 #include "cs_time_step.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
45 
46 /*============================================================================
47  * Macro definitions
48  *============================================================================*/
49 
50 /*============================================================================
51  * Type definitions
52  *============================================================================*/
53 
54 /*============================================================================
55  * Public function prototypes
56  *============================================================================*/
57 
58 /*----------------------------------------------------------------------------*/
66 /*----------------------------------------------------------------------------*/
67 
68 void
70  const cs_cdo_connect_t *connect,
71  const cs_time_step_t *time_step);
72 
73 /*----------------------------------------------------------------------------*/
85 /*----------------------------------------------------------------------------*/
86 
87 void
89  cs_analytic_func_t *ana,
90  cs_quadra_type_t quad_type,
91  const cs_cell_mesh_t *cm,
92  double retval[]);
93 
94 /*----------------------------------------------------------------------------*/
105 /*----------------------------------------------------------------------------*/
106 
107 void
109  int ml_id,
110  cs_analytic_func_t *ana,
111  cs_quadra_type_t quad_type,
112  double retval[]);
113 
114 /*----------------------------------------------------------------------------*/
125 /*----------------------------------------------------------------------------*/
126 
127 void
129  cs_get_t get,
130  const cs_cell_mesh_t *cm,
131  double retval[]);
132 
133 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 void
148  int ml_id,
149  cs_get_t get,
150  double retval[]);
151 
152 /*----------------------------------------------------------------------------*/
162 /*----------------------------------------------------------------------------*/
163 
164 void
166  cs_analytic_func_t *ana,
167  const cs_cell_mesh_t *cm,
168  double retval[]);
169 
170 /*----------------------------------------------------------------------------*/
180 /*----------------------------------------------------------------------------*/
181 
182 void
184  int ml_id,
185  cs_analytic_func_t *ana,
186  double retval[]);
187 
188 /*----------------------------------------------------------------------------*/
199 /*----------------------------------------------------------------------------*/
200 
201 void
203  int ml_id,
204  cs_get_t get,
205  double retval[]);
206 
207 /*----------------------------------------------------------------------------*/
217 /*----------------------------------------------------------------------------*/
218 
219 void
221  cs_get_t get,
222  const cs_cell_mesh_t *cm,
223  double retval[]);
224 
225 /*----------------------------------------------------------------------------*/
234 /*----------------------------------------------------------------------------*/
235 
236 void
238  int ml_id,
239  cs_get_t get,
240  double retval[]);
241 
242 /*----------------------------------------------------------------------------*/
243 
245 
246 #endif /* __CS_EVALUATE_H__ */
void cs_evaluate_cellwise_density_by_analytic(cs_flag_t dof_flag, cs_analytic_func_t *ana, cs_quadra_type_t quad_type, const cs_cell_mesh_t *cm, double retval[])
Evaluate the quantity defined by an analytic expression in the case of a density field for all the Do...
void() cs_analytic_func_t(cs_real_t time, cs_lnum_t n_points, const cs_real_t *xyz, cs_real_t *retval)
Generic analytic function.
Definition: cs_cdo.h:159
time step descriptor
Definition: cs_time_step.h:51
void cs_evaluate_set_shared_pointers(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
Set shared pointers to main domain members.
Definition: cs_evaluate.c:1025
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
void cs_evaluate_cellwise_density_by_value(cs_flag_t dof_flag, cs_get_t get, const cs_cell_mesh_t *cm, double retval[])
Evaluate the quantity defined by a value in the case of a density field for all the DoFs of a cell Ac...
Definition: cs_cdo_local.h:132
Definition: cs_cdo_connect.h:56
void cs_evaluate_potential_by_qov(cs_flag_t dof_flag, int ml_id, cs_get_t get, double retval[])
Define a value to each DoF in the case of a potential field in order to put a given quantity inside t...
Definition: cs_evaluate.c:1250
Definition: cs_param.h:51
void cs_evaluate_cellwise_potential_by_value(cs_flag_t dof_flag, cs_get_t get, const cs_cell_mesh_t *cm, double retval[])
Evaluate the quantity attached to a potential field for all the DoFs of a cell.
Definition: cs_cdo_quantities.h:102
void cs_evaluate_density_by_analytic(cs_flag_t dof_flag, int ml_id, cs_analytic_func_t *ana, cs_quadra_type_t quad_type, double retval[])
Compute the value related to each DoF in the case of a density field The value defined by the analyti...
Definition: cs_evaluate.c:1049
cs_quadra_type_t
Definition: cs_quadrature.h:47
void cs_evaluate_potential_by_value(cs_flag_t dof_flag, int ml_id, cs_get_t get, double retval[])
Evaluate the quantity attached to a potential field for all the DoFs.
Definition: cs_evaluate.c:1297
void cs_evaluate_cellwise_potential_by_analytic(cs_flag_t dof_flag, cs_analytic_func_t *ana, const cs_cell_mesh_t *cm, double retval[])
Evaluate the quantity defined by an analytic function for all the degrees of freedom of a cell...
#define END_C_DECLS
Definition: cs_defs.h:452
unsigned short int cs_flag_t
Definition: cs_defs.h:299
void cs_evaluate_density_by_value(cs_flag_t dof_flag, int ml_id, cs_get_t get, double retval[])
Evaluate the quantity defined by a value in the case of a density field for all the degrees of freedo...
Definition: cs_evaluate.c:1100
void cs_evaluate_potential_by_analytic(cs_flag_t dof_flag, int ml_id, cs_analytic_func_t *ana, double retval[])
Evaluate the quantity attached to a potential field for all the DoFs when the definition relies on an...
Definition: cs_evaluate.c:1150