8.3
general documentation
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 * Surface roughness
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 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_particle.h"
34
35/*----------------------------------------------------------------------------*/
36
38
39/*============================================================================
40 * Type definitions
41 *============================================================================*/
42
43typedef struct {
44
58
60
62
63/*============================================================================
64 * Public function definitions for Fortran API
65 *============================================================================*/
66
67/*----------------------------------------------------------------------------
68 * Clogging initialization:
69 * - Retrieve various parameters for storing in global structure
70 * - Compute and store the Debye screening length
71 *----------------------------------------------------------------------------*/
72
73void
74roughness_init (const cs_real_t *water_permit,
75 const cs_real_t *ionic_strength,
76 const cs_real_t temperature[],
77 const cs_real_t *valen,
78 const cs_real_t *phi_p,
79 const cs_real_t *phi_s,
80 const cs_real_t *cstham,
81 const cs_real_t *lambda_vdw,
82 const cs_real_t *espasg,
83 const cs_real_t *denasp,
84 const cs_real_t *rayasp,
85 const cs_real_t *rayasg
86 );
87
88/*=============================================================================
89 * Function definitions
90 *============================================================================*/
91
92/*----------------------------------------------------------------------------
93 * Deallocate the arrays storing temperature and Debye length.
94 *----------------------------------------------------------------------------*/
95
96void
98
99/*----------------------------------------------------------------------------
100 * Compute the energy barrier for a rough wall.
101 *
102 * parameters:
103 * particle <-- pointer to particle data
104 * attr_map <-- pointer to attribute map
105 * iel <-- id of cell where the particle is
106 * energy_barrier <-> energy barrier
107 *----------------------------------------------------------------------------*/
108
109void
110cs_lagr_roughness_barrier(const void *particle,
111 const cs_lagr_attribute_map_t *attr_map,
112 cs_lnum_t iel,
113 cs_real_t *energy_barrier);
114
115/*----------------------------------------------------------------------------*/
116
118
119#endif /* __CS_LAGR_ROUGHNESS_H__ */
120
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
#define END_C_DECLS
Definition: cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
void cs_lagr_roughness_finalize(void)
Definition: cs_lagr_roughness.cpp:198
cs_lagr_roughness_param_t * cs_lagr_roughness_param
void cs_lagr_roughness_barrier(const void *particle, const cs_lagr_attribute_map_t *attr_map, cs_lnum_t iel, cs_real_t *energy_barrier)
Definition: cs_lagr_roughness.cpp:215
void roughness_init(const cs_real_t *water_permit, const cs_real_t *ionic_strength, 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 *lambda_vdw, const cs_real_t *espasg, const cs_real_t *denasp, const cs_real_t *rayasp, const cs_real_t *rayasg)
Definition: cs_lagr_roughness.cpp:125
Definition: cs_lagr_particle.h:189
Definition: cs_lagr_roughness.h:43
cs_real_t ionic_strength
Definition: cs_lagr_roughness.h:46
cs_real_t cstham
Definition: cs_lagr_roughness.h:52
cs_real_t * temperature
Definition: cs_lagr_roughness.h:49
cs_real_t denasp
Definition: cs_lagr_roughness.h:55
cs_real_t * debye_length
Definition: cs_lagr_roughness.h:51
cs_real_t phi_s
Definition: cs_lagr_roughness.h:48
cs_real_t lambda_vdw
Definition: cs_lagr_roughness.h:53
cs_real_t water_permit
Definition: cs_lagr_roughness.h:45
cs_real_t phi_p
Definition: cs_lagr_roughness.h:47
cs_real_t rayasp
Definition: cs_lagr_roughness.h:56
cs_real_t valen
Definition: cs_lagr_roughness.h:50
cs_real_t rayasg
Definition: cs_lagr_roughness.h:57
cs_real_t espasg
Definition: cs_lagr_roughness.h:54