9.2
general documentation
cs_gwf_sspf.h
Go to the documentation of this file.
1#ifndef CS_GWF_SSPF_H
2#define CS_GWF_SSPF_H
3
4/*============================================================================
5 * Main functions to handle single-phase flows in a saturated porous media
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2026 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 "gwf/cs_gwf_hydraulic_model.h"
35
36/*============================================================================
37 * Macro definitions
38 *============================================================================*/
39
40/*============================================================================
41 * Type definitions
42 *============================================================================*/
43
44/*============================================================================
45 * Public function prototypes
46 *============================================================================*/
47
48/*----------------------------------------------------------------------------*/
55/*----------------------------------------------------------------------------*/
56
57cs_gwf_sspf_t *
58cs_gwf_sspf_create(void);
59
60/*----------------------------------------------------------------------------*/
67/*----------------------------------------------------------------------------*/
68
69void
70cs_gwf_sspf_free(cs_gwf_sspf_t **p_mc);
71
72/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
82cs_gwf_sspf_log_setup(cs_gwf_sspf_t *mc);
83
84/*----------------------------------------------------------------------------*/
94/*----------------------------------------------------------------------------*/
95
96void
97cs_gwf_sspf_init(cs_gwf_sspf_t *mc,
98 cs_property_t *abs_perm,
99 cs_flag_t flag);
100
101/*----------------------------------------------------------------------------*/
110/*----------------------------------------------------------------------------*/
111
112void
113cs_gwf_sspf_init_setup(cs_flag_t flag,
114 cs_gwf_sspf_t *mc);
115
116/*----------------------------------------------------------------------------*/
125/*----------------------------------------------------------------------------*/
126
127void
128cs_gwf_sspf_finalize_setup(const cs_cdo_connect_t *connect,
129 const cs_cdo_quantities_t *cdoq,
130 cs_gwf_sspf_t *mc);
131
132/*----------------------------------------------------------------------------*/
145/*----------------------------------------------------------------------------*/
146
147void
148cs_gwf_sspf_update(const cs_mesh_t *mesh,
149 const cs_cdo_connect_t *connect,
150 const cs_cdo_quantities_t *cdoq,
151 const cs_time_step_t *ts,
152 cs_flag_t update_flag,
153 cs_flag_t option_flag,
154 cs_gwf_sspf_t *mc);
155
156/*----------------------------------------------------------------------------*/
168/*----------------------------------------------------------------------------*/
169
170void
171cs_gwf_sspf_compute_steady_state(const cs_mesh_t *mesh,
172 const cs_cdo_connect_t *connect,
173 const cs_cdo_quantities_t *cdoq,
174 const cs_time_step_t *time_step,
175 cs_flag_t flag,
176 cs_gwf_sspf_t *mc);
177
178/*----------------------------------------------------------------------------*/
190/*----------------------------------------------------------------------------*/
191
192void
193cs_gwf_sspf_compute(const cs_mesh_t *mesh,
194 const cs_cdo_connect_t *connect,
195 const cs_cdo_quantities_t *cdoq,
196 const cs_time_step_t *time_step,
197 cs_flag_t flag,
198 cs_gwf_sspf_t *mc);
199
200/*----------------------------------------------------------------------------*/
210/*----------------------------------------------------------------------------*/
211
212void
213cs_gwf_sspf_extra_op(const cs_cdo_connect_t *connect,
214 const cs_cdo_quantities_t *cdoq,
215 cs_flag_t post_flag,
216 cs_gwf_sspf_t *mc);
217
218/*----------------------------------------------------------------------------*/
231/*----------------------------------------------------------------------------*/
232
233void
234cs_gwf_sspf_extra_post(int mesh_id,
235 cs_lnum_t n_cells,
236 const cs_lnum_t cell_ids[],
237 cs_flag_t post_flag,
238 const cs_property_t *abs_perm,
239 const cs_gwf_sspf_t *mc,
240 const cs_time_step_t *time_step);
241
242/*----------------------------------------------------------------------------*/
243
244#endif /* CS_GWF_SSPF_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_sspf_compute
void cs_gwf_sspf_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_sspf_t *mc)
Compute the new hydraulic state for the groundwater flows module. Case of single-phase flows in a sat...
Definition: cs_gwf_sspf.cpp:598
cs_gwf_sspf_extra_op
void cs_gwf_sspf_extra_op(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_flag_t post_flag, cs_gwf_sspf_t *mc)
Predefined extra-operations for the groundwater flow module in case of single phase flows in a satura...
Definition: cs_gwf_sspf.cpp:664
cs_gwf_sspf_compute_steady_state
void cs_gwf_sspf_compute_steady_state(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_sspf_t *mc)
Compute the steady-state of the groundwater flows module in case of single-phase flows in a saturated...
Definition: cs_gwf_sspf.cpp:551
cs_gwf_sspf_init
void cs_gwf_sspf_init(cs_gwf_sspf_t *mc, cs_property_t *abs_perm, cs_flag_t flag)
Initialize the model context according to the settings done inside the function cs_user_model() Case ...
Definition: cs_gwf_sspf.cpp:299
cs_gwf_sspf_log_setup
void cs_gwf_sspf_log_setup(cs_gwf_sspf_t *mc)
Log the setup related to the model context of saturated single-phase flows in porous media.
Definition: cs_gwf_sspf.cpp:278
cs_gwf_sspf_finalize_setup
void cs_gwf_sspf_finalize_setup(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_gwf_sspf_t *mc)
Last setup stage in the case of single-phase flows in a saturated porous media.
Definition: cs_gwf_sspf.cpp:440
cs_gwf_sspf_free
void cs_gwf_sspf_free(cs_gwf_sspf_t **p_mc)
Free the model context structure in case of a saturated single-phase flows.
Definition: cs_gwf_sspf.cpp:253
cs_gwf_sspf_create
cs_gwf_sspf_t * cs_gwf_sspf_create(void)
Allocate and initialize the model context structure in case of single-phase flows in a saturated poro...
Definition: cs_gwf_sspf.cpp:203
cs_gwf_sspf_init_setup
void cs_gwf_sspf_init_setup(cs_flag_t flag, cs_gwf_sspf_t *mc)
Initial setup stage for saturated single-phase flows in a porous media. At this stage,...
Definition: cs_gwf_sspf.cpp:368
cs_gwf_sspf_extra_post
void cs_gwf_sspf_extra_post(int mesh_id, cs_lnum_t n_cells, const cs_lnum_t cell_ids[], cs_flag_t post_flag, const cs_property_t *abs_perm, const cs_gwf_sspf_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 a ...
Definition: cs_gwf_sspf.cpp:696
cs_gwf_sspf_update
void cs_gwf_sspf_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_sspf_t *mc)
Perform the update step in the case of single-phase flows in a saturated porous media.
Definition: cs_gwf_sspf.cpp:477
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_sspf_t
Structure to handle the modelling of a single-phase flows in a porous media considered as saturated.
Definition: cs_gwf_hydraulic_model.h:81
cs_mesh_t
Definition: cs_mesh.h:85
cs_property_t
Structure associated to the definition of a property relying on the cs_xdef_t structure.