programmer's documentation
cs_balance_by_zone.h
Go to the documentation of this file.
1 #ifndef __CS_BALANCE_BY_ZONE_H__
2 #define __CS_BALANCE_BY_ZONE_H__
3 
4 /*============================================================================
5  * Scalar balance on zones.
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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------
33  * Local headers
34  *----------------------------------------------------------------------------*/
35 
36 #include "cs_base.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
42 /*=============================================================================
43  * Public function prototypes
44  *============================================================================*/
45 
46 /*----------------------------------------------------------------------------*/
57 /*----------------------------------------------------------------------------*/
58 
59 void
60 cs_balance_by_zone(const int bc_type[],
61  const char *selection_crit,
62  const char *scalar_name);
63 
64 /*----------------------------------------------------------------------------*/
65 
67 
68 #endif /* __CS_BALANCE_BY_ZONE_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:429
void cs_balance_by_zone(const int bc_type[], const char *selection_crit, const char *scalar_name)
Computes the different terms of the balance of a scalar which name is given as argument, on a volumic zone defined by the criterium also given as argument. The different contributions to the balance are printed in the listing.
Definition: cs_balance_by_zone.c:115
#define END_C_DECLS
Definition: cs_defs.h:430