My Project
programmer's documentation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cs_gwf_parameters.h
Go to the documentation of this file.
1 #ifndef __CS_GWF_PARAMETERS_H__
2 #define __CS_GWF_PARAMETERS_H__
3 
4 /*============================================================================
5  * General parameters 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-2019 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_field.h"
42 
43 /*----------------------------------------------------------------------------*/
44 
45 BEGIN_C_DECLS
46 
47 /*=============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Type definitions
53  *============================================================================*/
54 
55 /* Parameter check behavior when an error is detected */
56 
57 /*----------------------------------------------------------------------------
58  * Structure defining the sorption model
59  *----------------------------------------------------------------------------*/
60 
61 typedef struct {
62 
63  int kinetic; /* 0 : sorption at equilibirum
64  1 : sorption with kinetic */
65  int ikd; /* id for kd */
66  int idel; /* id for delay */
67  int ikp; /* id for kplus */
68  int ikm; /* id for kminus */
69  int imxsol; /* id for solubility index */
70  int anai; /* 0: solve EK model in an explicit way
71  1: use analytical solution for EK model */
72 
73 } cs_gwf_soilwater_partition_t;
74 
75 /*============================================================================
76  * Static global variables
77  *============================================================================*/
78 
79 /*=============================================================================
80  * Public function prototypes
81  *============================================================================*/
82 
83 /*----------------------------------------------------------------------------*/
87 /*----------------------------------------------------------------------------*/
88 
89 void
90 cs_gwf_parameters_define_field_keys(void);
91 
92 /*----------------------------------------------------------------------------*/
93 
94 END_C_DECLS
95 
96 #endif /* __CS_GWF_PARAMETERS_H__ */
cs_defs.h
cs_gwf_soilwater_partition_t::kinetic
int kinetic
Definition: cs_gwf_parameters.h:63
cs_gwf_soilwater_partition_t::idel
int idel
Definition: cs_gwf_parameters.h:66
cs_gwf_parameters_define_field_keys
void cs_gwf_parameters_define_field_keys(void)
Define field keys for the ground water flow module.
Definition: cs_gwf_parameters.c:156
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_gwf_soilwater_partition_t::imxsol
int imxsol
Definition: cs_gwf_parameters.h:69
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_gwf_soilwater_partition_t
Definition: cs_gwf_parameters.h:61
cs_gwf_soilwater_partition_t::anai
int anai
Definition: cs_gwf_parameters.h:70
cs_field.h
cs_gwf_soilwater_partition_t::ikp
int ikp
Definition: cs_gwf_parameters.h:67
cs_gwf_soilwater_partition_t::ikd
int ikd
Definition: cs_gwf_parameters.h:65
cs_gwf_soilwater_partition_t::ikm
int ikm
Definition: cs_gwf_parameters.h:68
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16