8.3
general documentation
cs_porous_model.h
Go to the documentation of this file.
1#ifndef __CS_POROUS_MODEL_H__
2#define __CS_POROUS_MODEL_H__
3
4/*============================================================================
5 * Porous model management
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
30/*----------------------------------------------------------------------------
31 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "cs_base.h"
35#include "cs_mesh.h"
36#include "cs_mesh_quantities.h"
37
38/*----------------------------------------------------------------------------*/
39
40BEGIN_C_DECLS
41
42/*=============================================================================
43 * Macro definitions
44 *============================================================================*/
45
46/*============================================================================
47 * Type definition
48 *============================================================================*/
49
50/*============================================================================
51 * Global variables
52 *============================================================================*/
53
54/* Choice of the porous model */
55extern int cs_glob_porous_model;
56
57/*=============================================================================
58 * Public function prototypes
59 *============================================================================*/
60
61/*----------------------------------------------------------------------------
62 * Compute fluid volumes and fluid surfaces in addition to cell volumes
63 * and surfaces.
64 *
65 * parameters:
66 * porous_model <-- porous model option (> 0 for porosity)
67 *----------------------------------------------------------------------------*/
68
69void
70cs_porous_model_set_model(int porous_model);
71
72/*----------------------------------------------------------------------------*/
76/*----------------------------------------------------------------------------*/
77
78void
79cs_porous_model_init_disable_flag(void);
80
81/*----------------------------------------------------------------------------*/
87/*----------------------------------------------------------------------------*/
88
89void
90cs_porous_model_set_has_disable_flag(int flag);
91
92/*----------------------------------------------------------------------------*/
96/*----------------------------------------------------------------------------*/
97
98void
99cs_porous_model_init_fluid_quantities(void);
100
101/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
107void
108cs_porous_model_mesh_quantities_update(void);
109
110/*----------------------------------------------------------------------------*/
116/*----------------------------------------------------------------------------*/
117
118void
119cs_porous_model_auto_face_porosity(void);
120
121/*----------------------------------------------------------------------------*/
122/*
123 * \brief Preprocess the fluid surfaces.
124 */
125/*----------------------------------------------------------------------------*/
126
127void
128cs_porous_model_fluid_surfaces_preprocessing(void);
129
130/*----------------------------------------------------------------------------*/
131/*
132 * \brief Penalize porosity and fluid surfaces.
133 */
134/*----------------------------------------------------------------------------*/
135
136void
137cs_porous_model_clip(void);
138
139/*----------------------------------------------------------------------------*/
140
141END_C_DECLS
142
143#endif /* __CS_POROUS_MODEL_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_mesh.h
cs_mesh_quantities.h
cs_porous_model_set_model
void cs_porous_model_set_model(int porous_model)
Definition: cs_porous_model.cpp:117
cs_porous_model_mesh_quantities_update
void cs_porous_model_mesh_quantities_update(void)
Compute solid quantities.
Definition: cs_porous_model.cpp:253
cs_porous_model_fluid_surfaces_preprocessing
void cs_porous_model_fluid_surfaces_preprocessing(void)
Preprocess the fluid surfaces.
Definition: cs_porous_model.cpp:447
cs_porous_model_set_has_disable_flag
void cs_porous_model_set_has_disable_flag(int flag)
Set (unset) has_disable_flag.
Definition: cs_porous_model.cpp:176
cs_glob_porous_model
int cs_glob_porous_model
cs_porous_model_clip
void cs_porous_model_clip(void)
Definition: cs_porous_model.cpp:372
cs_porous_model_init_disable_flag
void cs_porous_model_init_disable_flag(void)
Initialize disable_flag.
Definition: cs_porous_model.cpp:129
cs_porous_model_init_fluid_quantities
void cs_porous_model_init_fluid_quantities(void)
Init fluid quantities.
Definition: cs_porous_model.cpp:239
cs_porous_model_auto_face_porosity
void cs_porous_model_auto_face_porosity(void)
Automatic computation of the face porosity and factors.
Definition: cs_porous_model.cpp:278