programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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 #include "cs_xdef.h"
42 
43 /*----------------------------------------------------------------------------*/
44 
46 
47 /*============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Type definitions
53  *============================================================================*/
54 
55 /*============================================================================
56  * Public function prototypes
57  *============================================================================*/
58 
59 /*----------------------------------------------------------------------------*/
67 /*----------------------------------------------------------------------------*/
68 
69 void
71  const cs_cdo_connect_t *connect,
72  const cs_time_step_t *time_step);
73 
74 /*----------------------------------------------------------------------------*/
83 /*----------------------------------------------------------------------------*/
84 
85 void
87  const cs_xdef_t *def,
88  double retval[]);
89 
90 /*----------------------------------------------------------------------------*/
100 /*----------------------------------------------------------------------------*/
101 
102 void
104  const cs_xdef_t *def,
105  double retval[]);
106 
107 /*----------------------------------------------------------------------------*/
116 /*----------------------------------------------------------------------------*/
117 
118 void
120  const cs_xdef_t *def,
121  double retval[]);
122 
123 /*----------------------------------------------------------------------------*/
133 /*----------------------------------------------------------------------------*/
134 
135 void
137  const cs_xdef_t *def,
138  double retval[]);
139 
140 /*----------------------------------------------------------------------------*/
148 /*----------------------------------------------------------------------------*/
149 
150 void
152  const cs_xdef_t *def,
153  double retval[]);
154 
155 /*----------------------------------------------------------------------------*/
156 
158 
159 #endif /* __CS_EVALUATE_H__ */
time step descriptor
Definition: cs_time_step.h:51
void cs_evaluate_potential_by_value(cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
Evaluate the quantity attached to a potential field for all the DoFs.
Definition: cs_evaluate.c:1323
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:1053
void cs_evaluate_density_by_analytic(cs_flag_t dof_flag, const cs_xdef_t *def, 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:1075
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
Definition: cs_cdo_connect.h:55
Definition: cs_cdo_quantities.h:89
Definition: cs_xdef.h:72
#define END_C_DECLS
Definition: cs_defs.h:454
unsigned short int cs_flag_t
Definition: cs_defs.h:299
void cs_evaluate_potential_by_analytic(cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
Evaluate the quantity attached to a potential field for all the DoFs when the definition relies on an...
Definition: cs_evaluate.c:1167
void cs_evaluate_density_by_value(cs_flag_t dof_flag, const cs_xdef_t *def, 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:1124
void cs_evaluate_potential_by_qov(cs_flag_t dof_flag, const cs_xdef_t *def, 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:1281