8.1
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-2023 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_gwf_hydraulic_model.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Public function prototypes
50  *============================================================================*/
51 
52 /*----------------------------------------------------------------------------*/
59 /*----------------------------------------------------------------------------*/
60 
61 cs_gwf_sspf_t *
62 cs_gwf_sspf_create(void);
63 
64 /*----------------------------------------------------------------------------*/
71 /*----------------------------------------------------------------------------*/
72 
73 void
74 cs_gwf_sspf_free(cs_gwf_sspf_t **p_mc);
75 
76 /*----------------------------------------------------------------------------*/
83 /*----------------------------------------------------------------------------*/
84 
85 void
86 cs_gwf_sspf_log_setup(cs_gwf_sspf_t *mc);
87 
88 /*----------------------------------------------------------------------------*/
98 /*----------------------------------------------------------------------------*/
99 
100 void
101 cs_gwf_sspf_init(cs_gwf_sspf_t *mc,
102  cs_property_t *abs_perm,
103  cs_flag_t flag);
104 
105 /*----------------------------------------------------------------------------*/
114 /*----------------------------------------------------------------------------*/
115 
116 void
117 cs_gwf_sspf_init_setup(cs_flag_t flag,
118  cs_gwf_sspf_t *mc);
119 
120 /*----------------------------------------------------------------------------*/
129 /*----------------------------------------------------------------------------*/
130 
131 void
132 cs_gwf_sspf_finalize_setup(const cs_cdo_connect_t *connect,
133  const cs_cdo_quantities_t *cdoq,
134  cs_gwf_sspf_t *mc);
135 
136 /*----------------------------------------------------------------------------*/
149 /*----------------------------------------------------------------------------*/
150 
151 void
152 cs_gwf_sspf_update(const cs_mesh_t *mesh,
153  const cs_cdo_connect_t *connect,
154  const cs_cdo_quantities_t *cdoq,
155  const cs_time_step_t *ts,
156  cs_flag_t update_flag,
157  cs_flag_t option_flag,
158  cs_gwf_sspf_t *mc);
159 
160 /*----------------------------------------------------------------------------*/
172 /*----------------------------------------------------------------------------*/
173 
174 void
175 cs_gwf_sspf_compute_steady_state(const cs_mesh_t *mesh,
176  const cs_cdo_connect_t *connect,
177  const cs_cdo_quantities_t *cdoq,
178  const cs_time_step_t *time_step,
179  cs_flag_t flag,
180  cs_gwf_sspf_t *mc);
181 
182 /*----------------------------------------------------------------------------*/
194 /*----------------------------------------------------------------------------*/
195 
196 void
197 cs_gwf_sspf_compute(const cs_mesh_t *mesh,
198  const cs_cdo_connect_t *connect,
199  const cs_cdo_quantities_t *cdoq,
200  const cs_time_step_t *time_step,
201  cs_flag_t flag,
202  cs_gwf_sspf_t *mc);
203 
204 /*----------------------------------------------------------------------------*/
214 /*----------------------------------------------------------------------------*/
215 
216 void
217 cs_gwf_sspf_extra_op(const cs_cdo_connect_t *connect,
218  const cs_cdo_quantities_t *cdoq,
219  cs_flag_t post_flag,
220  cs_gwf_sspf_t *mc);
221 
222 /*----------------------------------------------------------------------------*/
235 /*----------------------------------------------------------------------------*/
236 
237 void
238 cs_gwf_sspf_extra_post(int mesh_id,
239  cs_lnum_t n_cells,
240  const cs_lnum_t cell_ids[],
241  cs_flag_t post_flag,
242  const cs_property_t *abs_perm,
243  const cs_gwf_sspf_t *mc,
244  const cs_time_step_t *time_step);
245 
246 /*----------------------------------------------------------------------------*/
247 
248 END_C_DECLS
249 
250 #endif /* __CS_GWF_SSPF_H__ */
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:321
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.c:597
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.c:663
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.c: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.c:292
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.c:271
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.c:431
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.c:195
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.c:246
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.c:361
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.c:694
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.c:468
mesh
Definition: mesh.f90:26
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:137
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:63
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.
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64