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-2016 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_time_step.h"
36 
37 #include "cs_cdo.h"
38 #include "cs_cdo_quantities.h"
39 #include "cs_quadrature.h"
40 #include "cs_param.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 /*----------------------------------------------------------------------------*/
84 /*----------------------------------------------------------------------------*/
85 
86 void
88  int ml_id,
89  cs_analytic_func_t *ana,
90  cs_quadra_type_t quad_type,
91  double retval[]);
92 
93 /*----------------------------------------------------------------------------*/
103 /*----------------------------------------------------------------------------*/
104 
105 void
107  int ml_id,
108  cs_get_t get,
109  double retval[]);
110 
111 /*----------------------------------------------------------------------------*/
121 /*----------------------------------------------------------------------------*/
122 
123 void
125  int ml_id,
126  cs_analytic_func_t *ana,
127  double retval[]);
128 
129 /*----------------------------------------------------------------------------*/
140 /*----------------------------------------------------------------------------*/
141 
142 void
144  int ml_id,
145  cs_get_t get,
146  double retval[]);
147 
148 /*----------------------------------------------------------------------------*/
157 /*----------------------------------------------------------------------------*/
158 
159 void
161  int ml_id,
162  cs_get_t get,
163  double retval[]);
164 
165 /*----------------------------------------------------------------------------*/
166 
168 
169 #endif /* __CS_EVALUATE_H__ */
time step descriptor
Definition: cs_time_step.h:51
void cs_evaluate_density_from_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:770
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:746
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
Definition: cs_cdo_connect.h:67
Definition: cs_cdo.h:129
Definition: cs_cdo_quantities.h:100
void cs_evaluate_potential_from_analytic(cs_flag_t dof_flag, int ml_id, cs_analytic_func_t *ana, double retval[])
Compute the contribution related to a quantity defined by analytic function for all the degrees of fr...
Definition: cs_evaluate.c:871
void cs_evaluate_density_from_value(cs_flag_t dof_flag, int ml_id, cs_get_t get, double retval[])
Compute the value related to each DoF in the case of a density field Accessor to the value is by unit...
Definition: cs_evaluate.c:821
void( cs_analytic_func_t)(cs_real_t time, const cs_real_3_t xyz, cs_get_t *retval)
Generic analytic function.
Definition: cs_cdo.h:154
void cs_evaluate_potential_from_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:968
void cs_evaluate_potential_from_value(cs_flag_t dof_flag, int ml_id, cs_get_t get, double retval[])
Store the value related to each DoF in the case of a potential field.
Definition: cs_evaluate.c:1017
cs_quadra_type_t
Definition: cs_quadrature.h:40
#define END_C_DECLS
Definition: cs_defs.h:449
unsigned short int cs_flag_t
Definition: cs_defs.h:298