programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cs_gwf_physical_properties.h
Go to the documentation of this file.
1 #ifndef __CS_GWF_PHYSICAL_PROPERTIES_H__
2 #define __CS_GWF_PHYSICAL_PROPERTIES_H__
3 
4 /*============================================================================
5  * Physical properties management for groundwater flow module.
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  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 #include <stdarg.h>
35 
36 /*----------------------------------------------------------------------------
37  * Local headers
38  *----------------------------------------------------------------------------*/
39 
40 #include "cs_defs.h"
41 #include "cs_gwf_parameters.h"
42 
43 /*----------------------------------------------------------------------------*/
44 
46 
47 /*=============================================================================
48  * Public function prototypes
49  *============================================================================*/
50 
51 /*----------------------------------------------------------------------------
52  * Update physical properties of the Ground Water Flow module.
53  *
54  * Species transport is delayed by retention in solid phase.
55  * This delay is computed as follows:
56  * R = 1 + rho K_d/theta ;
57  * where R is the delay factor, rho the soil density,
58  * K_d the contaminant distribution coefficient and theta
59  * the moisture content (saturation).
60  *
61  *---------------------------------------------------------------------------*/
62 
63 void
65 
66 /*----------------------------------------------------------------------------
67  * Update sorbed concentration for scalars with kinetic sorption.
68  *
69  * It is estimated by the following analytical expression :
70  * S^{n+1} = S^n exp(- k^{-} dt) - C^n * k^{+}/k^{-}
71  * (exp(- k^{-} dt) - 1)
72  *
73  * parameters:
74  * c_scal --> concentration field
75  * kp --> kplus field
76  * km --> kminus field
77  * sorb <-- sorbed concentration field
78  *----------------------------------------------------------------------------*/
79 
80 void
82  cs_real_t *kp,
83  cs_real_t *km,
84  cs_real_t *sorb);
85 
86 /*----------------------------------------------------------------------------*/
87 
89 
90 #endif /* __CS_GWF_PHYSICAL_PROPERTIES_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_gwf_physical_properties(void)
Update physical properties of the Ground Water Flow module.
Definition: cs_gwf_physical_properties.c:92
#define END_C_DECLS
Definition: cs_defs.h:454
void cs_gwf_sorbed_concentration_update(cs_real_t *c_scal, cs_real_t *kp, cs_real_t *km, cs_real_t *sorb)
Update sorbed concentration for scalars with kinetic sorption.
Definition: cs_gwf_physical_properties.c:152