programmer's documentation
cs_lagr_clogging.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_CLOGGING_H__
2 #define __CS_LAGR_CLOGGING_H__
3 
4 /*============================================================================
5  * Clogging modeling.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2016 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_defs.h"
35 #include "cs_lagr_particle.h"
36 
37 /*----------------------------------------------------------------------------*/
38 
40 
41 /*============================================================================
42  * Type definitions
43  *============================================================================*/
44 
45 typedef struct {
46 
54 
60 
62 
63 /*============================================================================
64  * Public function definitions
65  *============================================================================*/
66 
67 /*----------------------------------------------------------------------------
68  * Clogging initialization.
69  *
70  * - Retrieve various parameters for storing in global structure.
71  * - Compute and store the Debye screening length
72  *----------------------------------------------------------------------------*/
73 
74 void
75 cloginit(const cs_real_t *water_permit,
76  const cs_real_t *ionic_strength,
77  const cs_real_t *jamming_limit,
78  const cs_real_t *min_porosity,
79  const cs_real_t temperature[],
80  const cs_real_t *valen,
81  const cs_real_t *phi_p,
82  const cs_real_t *phi_s,
83  const cs_real_t *cstham,
84  const cs_real_t *csthpp,
85  const cs_real_t *lambda_vdw
86  );
87 
88 /*----------------------------------------------------------------------------
89  * Clogging finalization.
90  *
91  * Deallocate the arrays storing temperature and Debye length.
92  *----------------------------------------------------------------------------*/
93 
94 void
96 
97 /*----------------------------------------------------------------------------
98  * Clogging:
99  *
100  * - Compute the number of deposited particles in contact with the depositing
101  * particle
102  * - Re-compute the energy barrier if this number is greater than zero
103  *
104  * parameters:
105  * particle <-- pointer to particle data
106  * attr_map <-- pointer to attribute map
107  * iel <-- id of cell where the particle is
108  * face_area <-- area of face
109  * energy_barrier <-> energy barrier
110  * surface_coverage <-> surface coverage
111  * limit <-> jamming limit
112  * mporos <-> minimum porosity
113  *
114  * returns:
115  * number of deposited particles in contact with the depositing particle
116  *----------------------------------------------------------------------------*/
117 
118 int
119 cs_lagr_clogging_barrier(const void *particle,
120  const cs_lagr_attribute_map_t *attr_map,
121  cs_lnum_t iel,
122  cs_real_t *energy_barrier,
123  cs_real_t *surface_coverage,
124  cs_real_t *limit,
125  cs_real_t *mporos);
126 
127 /*----------------------------------------------------------------------------*/
128 
130 
131 #endif /* __CS_LAGR_CLOGGING_H__ */
132 
void cs_lagr_clogging_finalize(void)
Definition: cs_lagr_clogging.c:192
cs_real_t min_porosity
Definition: cs_lagr_clogging.h:50
void cloginit(const cs_real_t *water_permit, const cs_real_t *ionic_strength, const cs_real_t *jamming_limit, const cs_real_t *min_porosity, const cs_real_t temperature[], const cs_real_t *valen, const cs_real_t *phi_p, const cs_real_t *phi_s, const cs_real_t *cstham, const cs_real_t *csthpp, const cs_real_t *lambda_vdw)
Definition: cs_lagr_clogging.c:113
cs_real_t valen
Definition: cs_lagr_clogging.h:51
cs_real_t lambda_vdw
Definition: cs_lagr_clogging.h:59
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
int cs_lagr_clogging_barrier(const void *particle, const cs_lagr_attribute_map_t *attr_map, cs_lnum_t iel, cs_real_t *energy_barrier, cs_real_t *surface_coverage, cs_real_t *limit, cs_real_t *mporos)
Definition: cs_lagr_clogging.c:219
cs_real_t jamming_limit
Definition: cs_lagr_clogging.h:49
double cs_real_t
Floating-point value.
Definition: cs_defs.h:296
cs_real_t ionic_strength
Definition: cs_lagr_clogging.h:48
cs_real_t phi_s
Definition: cs_lagr_clogging.h:53
cs_real_t water_permit
Definition: cs_lagr_clogging.h:47
cs_real_t cstham
Definition: cs_lagr_clogging.h:57
Definition: cs_lagr_clogging.h:45
cs_real_t csthpp
Definition: cs_lagr_clogging.h:58
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:292
#define END_C_DECLS
Definition: cs_defs.h:449
cs_real_t * temperature
Definition: cs_lagr_clogging.h:55
cs_real_t * debye_length
Definition: cs_lagr_clogging.h:56
Definition: cs_lagr_particle.h:138
cs_real_t phi_p
Definition: cs_lagr_clogging.h:52