9.2
general documentation
cs_gwf_uspf.h
Go to the documentation of this file.
1#ifndef CS_GWF_USPF_H
2#define CS_GWF_USPF_H
3
4/*============================================================================
5 * Main functions to handle single-phase flows in an unsaturated porous media
6 * (shorter notation: USPF)
7 *============================================================================*/
8
9/*
10 This file is part of code_saturne, a general-purpose CFD tool.
11
12 Copyright (C) 1998-2026 EDF S.A.
13
14 This program is free software; you can redistribute it and/or modify it under
15 the terms of the GNU General Public License as published by the Free Software
16 Foundation; either version 2 of the License, or (at your option) any later
17 version.
18
19 This program is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22 details.
23
24 You should have received a copy of the GNU General Public License along with
25 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
26 Street, Fifth Floor, Boston, MA 02110-1301, USA.
27*/
28
29/*----------------------------------------------------------------------------*/
30
31/*----------------------------------------------------------------------------
32 * Local headers
33 *----------------------------------------------------------------------------*/
34
35#include "gwf/cs_gwf_hydraulic_model.h"
36
37/*============================================================================
38 * Macro definitions
39 *============================================================================*/
40
41/*============================================================================
42 * Type definitions
43 *============================================================================*/
44
45/*============================================================================
46 * Public function prototypes
47 *============================================================================*/
48
49/*----------------------------------------------------------------------------*/
56/*----------------------------------------------------------------------------*/
57
58cs_gwf_uspf_t *
59cs_gwf_uspf_create(void);
60
61/*----------------------------------------------------------------------------*/
68/*----------------------------------------------------------------------------*/
69
70void
71cs_gwf_uspf_free(cs_gwf_uspf_t **p_mc);
72
73/*----------------------------------------------------------------------------*/
80/*----------------------------------------------------------------------------*/
81
82void
83cs_gwf_uspf_log_setup(cs_gwf_uspf_t *mc);
84
85/*----------------------------------------------------------------------------*/
94/*----------------------------------------------------------------------------*/
95
96void
97cs_gwf_uspf_init(cs_gwf_uspf_t *mc,
98 cs_property_type_t perm_type);
99
100/*----------------------------------------------------------------------------*/
111/*----------------------------------------------------------------------------*/
112
113void
114cs_gwf_uspf_init_setup(cs_flag_t flag,
115 cs_flag_t post_flag,
116 int perm_dim,
117 cs_gwf_uspf_t *mc);
118
119/*----------------------------------------------------------------------------*/
129/*----------------------------------------------------------------------------*/
130
131void
132cs_gwf_uspf_finalize_setup(const cs_cdo_connect_t *connect,
133 const cs_cdo_quantities_t *cdoq,
134 cs_flag_t flag,
135 cs_gwf_uspf_t *mc);
136
137/*----------------------------------------------------------------------------*/
150/*----------------------------------------------------------------------------*/
151
152void
153cs_gwf_uspf_update(const cs_mesh_t *mesh,
154 const cs_cdo_connect_t *connect,
155 const cs_cdo_quantities_t *cdoq,
156 const cs_time_step_t *ts,
157 cs_flag_t update_flag,
158 cs_flag_t option_flag,
159 cs_gwf_uspf_t *mc);
160
161/*----------------------------------------------------------------------------*/
173/*----------------------------------------------------------------------------*/
174
175void
176cs_gwf_uspf_compute(const cs_mesh_t *mesh,
177 const cs_cdo_connect_t *connect,
178 const cs_cdo_quantities_t *cdoq,
179 const cs_time_step_t *time_step,
180 cs_flag_t flag,
181 cs_gwf_uspf_t *mc);
182
183/*----------------------------------------------------------------------------*/
193/*----------------------------------------------------------------------------*/
194
195void
196cs_gwf_uspf_extra_op(const cs_cdo_connect_t *connect,
197 const cs_cdo_quantities_t *cdoq,
198 cs_flag_t post_flag,
199 cs_gwf_uspf_t *mc);
200
201/*----------------------------------------------------------------------------*/
213/*----------------------------------------------------------------------------*/
214
215void
216cs_gwf_uspf_extra_post(int mesh_id,
217 cs_lnum_t n_cells,
218 const cs_lnum_t cell_ids[],
219 cs_flag_t post_flag,
220 const cs_gwf_uspf_t *mc,
221 const cs_time_step_t *time_step);
222
223/*----------------------------------------------------------------------------*/
224
225#endif /* CS_GWF_USPF_H */
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:60
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:334
cs_gwf_hydraulic_model.h
cs_gwf_uspf_finalize_setup
void cs_gwf_uspf_finalize_setup(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_flag_t flag, cs_gwf_uspf_t *mc)
Last setup stage in the case of single-phase flows in an unsaturated porous media.
Definition: cs_gwf_uspf.cpp:500
cs_gwf_uspf_extra_post
void cs_gwf_uspf_extra_post(int mesh_id, cs_lnum_t n_cells, const cs_lnum_t cell_ids[], cs_flag_t post_flag, const cs_gwf_uspf_t *mc, const cs_time_step_t *time_step)
Predefined post-processing output for the groundwater flow module in case of single-phase flows in an...
Definition: cs_gwf_uspf.cpp:737
cs_gwf_uspf_extra_op
void cs_gwf_uspf_extra_op(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_flag_t post_flag, cs_gwf_uspf_t *mc)
Predefined extra-operations for the groundwater flow module in case of single phase flows in an unsat...
Definition: cs_gwf_uspf.cpp:705
cs_gwf_uspf_update
void cs_gwf_uspf_update(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *ts, cs_flag_t update_flag, cs_flag_t option_flag, cs_gwf_uspf_t *mc)
Update quantities in the case of single-phase flows in an unsaturated porous media.
Definition: cs_gwf_uspf.cpp:580
cs_gwf_uspf_init
void cs_gwf_uspf_init(cs_gwf_uspf_t *mc, cs_property_type_t perm_type)
Initialize the model context according to the settings done inside the function cs_user_model() Case ...
Definition: cs_gwf_uspf.cpp:311
cs_gwf_uspf_init_setup
void cs_gwf_uspf_init_setup(cs_flag_t flag, cs_flag_t post_flag, int perm_dim, cs_gwf_uspf_t *mc)
Initial setup stage for single-phase flows in an unsaturated porous media. At this stage,...
Definition: cs_gwf_uspf.cpp:386
cs_gwf_uspf_free
void cs_gwf_uspf_free(cs_gwf_uspf_t **p_mc)
Free the model context structure in case of unsaturated single-phase flows.
Definition: cs_gwf_uspf.cpp:259
cs_gwf_uspf_log_setup
void cs_gwf_uspf_log_setup(cs_gwf_uspf_t *mc)
Log the setup related to the model context of unsaturated single-phase flows in porous media.
Definition: cs_gwf_uspf.cpp:291
cs_gwf_uspf_create
cs_gwf_uspf_t * cs_gwf_uspf_create(void)
Allocate and initialize the model context structure in case of single-phase flows in an unsaturated p...
Definition: cs_gwf_uspf.cpp:199
cs_gwf_uspf_compute
void cs_gwf_uspf_compute(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *time_step, cs_flag_t flag, cs_gwf_uspf_t *mc)
Compute the new state for the groundwater flows module. Case of single-phase flows in an unstaturated...
Definition: cs_gwf_uspf.cpp:657
cs_property_type_t
cs_flag_t cs_property_type_t
Definition: cs_property.h:119
mesh
Definition: mesh.f90:26
cs_cdo_connect_t
Definition: cs_cdo_connect.h:57
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:142
cs_gwf_uspf_t
Structure to handle the modelling of a single-phase flows in a porous media considered as saturated o...
Definition: cs_gwf_hydraulic_model.h:155
cs_mesh_t
Definition: cs_mesh.h:85