programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cs_lagr_roughness.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_ROUGHNESS_H__
2 #define __CS_LAGR_ROUGHNESS_H__
3 
4 /*============================================================================
5  * Functions and types for the roughness modeling
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2014 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_lagr_tracking.h"
34 
35 /*----------------------------------------------------------------------------*/
36 
38 
39 /*============================================================================
40  * Type definitions
41  *============================================================================*/
42 
43 typedef struct {
44 
61 
63 
64 /*============================================================================
65  * Public function definitions for Fortran API
66  *============================================================================*/
67 
68 /*----------------------------------------------------------------------------
69  * Clogging initialization:
70  * - Retrieve various parameters for storing in global structure
71  * - Compute and store the Debye screening length
72  *----------------------------------------------------------------------------*/
73 
74 void
75 CS_PROCF (roughness_init, ROUGHNESS_INIT)(const cs_real_t *faraday_cst,
76  const cs_real_t *free_space_permit,
77  const cs_real_t *water_permit,
78  const cs_real_t *ionic_strength,
79  const cs_real_t temperature[],
80  const cs_real_t *phi1,
81  const cs_real_t *phi2,
82  const cs_real_t *cstham,
83  const cs_real_t *dcutof,
84  const cs_real_t *lambwl,
85  const cs_real_t *kboltz,
86  const cs_real_t *espasg,
87  const cs_real_t *denasp,
88  const cs_real_t *rayasp,
89  const cs_real_t *rayasg
90 );
91 
92 /*=============================================================================
93  * Function definitions
94  *============================================================================*/
95 
96 /*----------------------------------------------------------------------------
97  * Deallocate the arrays storing temperature and Debye length.
98  *----------------------------------------------------------------------------*/
99 
100 void
102 
103 /*----------------------------------------------------------------------------
104  * Compute the energy barrier for a rough wall.
105  *
106  * parameters:
107  * particle <-- pointer to particle data
108  * attr_map <-- pointer to attribute map
109  * face_id <-- id of face neighboring particle
110  * energy_barrier <-> energy barrier
111  *----------------------------------------------------------------------------*/
112 
113 void
114 cs_lagr_roughness_barrier(const void *particle,
115  const cs_lagr_attribute_map_t *attr_map,
116  cs_lnum_t face_id,
117  cs_real_t *energy_barrier);
118 
119 /*----------------------------------------------------------------------------*/
120 
122 
123 #endif /* __CS_LAGR_ROUGHNESS_H__ */
124 
cs_real_t * temperature
Definition: cs_lagr_roughness.h:51
void cs_lagr_roughness_finalize(void)
Definition: cs_lagr_roughness.c:183
#define BEGIN_C_DECLS
Definition: cs_defs.h:405
cs_real_t rayasp
Definition: cs_lagr_roughness.h:59
cs_real_t denasp
Definition: cs_lagr_roughness.h:58
cs_real_t espasg
Definition: cs_lagr_roughness.h:57
cs_real_t phi1
Definition: cs_lagr_roughness.h:49
void roughness_init(const cs_real_t *faraday_cst, const cs_real_t *free_space_permit, const cs_real_t *water_permit, const cs_real_t *ionic_strength, const cs_real_t temperature[], const cs_real_t *phi1, const cs_real_t *phi2, const cs_real_t *cstham, const cs_real_t *dcutof, const cs_real_t *lambwl, const cs_real_t *kboltz, const cs_real_t *espasg, const cs_real_t *denasp, const cs_real_t *rayasp, const cs_real_t *rayasg)
Definition: cs_lagr_roughness.c:103
cs_real_t water_permit
Definition: cs_lagr_roughness.h:47
cs_real_t lambwl
Definition: cs_lagr_roughness.h:55
void cs_lagr_roughness_barrier(const void *particle, const cs_lagr_attribute_map_t *attr_map, cs_lnum_t face_id, cs_real_t *energy_barrier)
Definition: cs_lagr_roughness.c:200
cs_real_t rayasg
Definition: cs_lagr_roughness.h:60
Definition: cs_lagr_roughness.h:43
cs_real_t phi2
Definition: cs_lagr_roughness.h:50
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:292
cs_real_t dcutof
Definition: cs_lagr_roughness.h:54
#define END_C_DECLS
Definition: cs_defs.h:406
double cs_real_t
Definition: cs_defs.h:296
cs_real_t * debye_length
Definition: cs_lagr_roughness.h:52
#define CS_PROCF(x, y)
Definition: cs_defs.h:419
cs_real_t ionic_strength
Definition: cs_lagr_roughness.h:48
cs_real_t free_space_permit
Definition: cs_lagr_roughness.h:46
Definition: cs_lagr_tracking.h:117
cs_real_t cstham
Definition: cs_lagr_roughness.h:53
cs_real_t kboltz
Definition: cs_lagr_roughness.h:56
cs_real_t faraday_cst
Definition: cs_lagr_roughness.h:45