8.1
general documentation
cs_gwf_toolbox.h
Go to the documentation of this file.
1 #ifndef __CS_GWF_TOOLBOX_H__
2 #define __CS_GWF_TOOLBOX_H__
3 
4 /*============================================================================
5  * Set of pratical functions dedicated to the groundwater flow module
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 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  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_defs.h"
33 #include "cs_gwf_tracer.h"
34 
35 /*----------------------------------------------------------------------------*/
36 
37 BEGIN_C_DECLS
38 
39 /*============================================================================
40  * Macro definitions
41  *============================================================================*/
42 
43 /*============================================================================
44  * Type definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Public function prototypes
49  *============================================================================*/
50 
51 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 void
71 cs_gwf_toolbox_bateman(double time_eval,
72  const cs_gwf_tracer_decay_chain_t *tdc,
73  const double init_inv[],
74  double eval_inv[]);
75 
76 /*----------------------------------------------------------------------------*/
77 
78 END_C_DECLS
79 
80 #endif /* __CS_GWF_TOOLBOX_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_gwf_toolbox_bateman
void cs_gwf_toolbox_bateman(double time_eval, const cs_gwf_tracer_decay_chain_t *tdc, const double init_inv[], double eval_inv[])
Define the values of the inventory for each tracer at the time time_eval given as parameter from an i...
Definition: cs_gwf_toolbox.c:84
cs_gwf_tracer.h
cs_gwf_tracer_decay_chain_t
Definition: cs_gwf_tracer.h:162