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 source term computation
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2015 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 #include "cs_cdo.h"
37 #include "cs_cdo_quantities.h"
38 #include "cs_quadrature.h"
39 #include "cs_param.h"
40 
41 /*----------------------------------------------------------------------------*/
42 
44 
45 /*============================================================================
46  * Macro definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Type definitions
51  *============================================================================*/
52 
53 /*============================================================================
54  * Public function prototypes
55  *============================================================================*/
56 
57 /*----------------------------------------------------------------------------*/
73 /*----------------------------------------------------------------------------*/
74 
75 void
76 cs_evaluate(const cs_mesh_t *m,
77  const cs_cdo_quantities_t *quant,
78  const cs_cdo_connect_t *connect,
79  double tcur,
80  cs_flag_t dof_flag,
81  int loc_id,
82  cs_param_def_type_t def_type,
83  cs_quadra_type_t quad_type,
84  cs_def_t def,
85  double *p_values[]);
86 
87 /*----------------------------------------------------------------------------*/
88 
90 
91 #endif /* __CS_EVALUATE_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:419
Definition: cs_cdo_connect.h:86
Definition: cs_cdo_quantities.h:94
Definition: cs_mesh.h:62
void cs_evaluate(const cs_mesh_t *m, const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, double tcur, cs_flag_t dof_flag, int loc_id, cs_param_def_type_t def_type, cs_quadra_type_t quad_type, cs_def_t def, double *p_values[])
Compute the contribution related to a source term or a boundary condition for instance.
Definition: cs_evaluate.c:587
cs_quadra_type_t
Definition: cs_quadrature.h:40
Definition: cs_param.h:66
#define END_C_DECLS
Definition: cs_defs.h:420
unsigned short int cs_flag_t
Definition: cs_cdo.h:50
cs_param_def_type_t
Definition: cs_param.h:74