8.1
general documentation
cs_gwf.h
Go to the documentation of this file.
1 #ifndef __CS_GWF_H__
2 #define __CS_GWF_H__
3 
4 /*============================================================================
5  * Set of main functions to handle the groundwater flow module with CDO
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_base.h"
35 #include "cs_equation.h"
36 #include "cs_gwf_param.h"
37 #include "cs_gwf_priv.h"
38 #include "cs_gwf_soil.h"
39 #include "cs_gwf_tracer.h"
40 
41 /*----------------------------------------------------------------------------*/
42 
43 BEGIN_C_DECLS
44 
45 /*============================================================================
46  * Macro definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Type definitions
51  *============================================================================*/
52 
53 /*============================================================================
54  * Public function prototypes
55  *============================================================================*/
56 
57 /*----------------------------------------------------------------------------*/
63 /*----------------------------------------------------------------------------*/
64 
65 bool
66 cs_gwf_is_activated(void);
67 
68 /*----------------------------------------------------------------------------*/
78 /*----------------------------------------------------------------------------*/
79 
80 cs_gwf_t *
81 cs_gwf_activate(cs_gwf_model_type_t model,
82  cs_flag_t option_flag,
83  cs_flag_t post_flag);
84 
85 /*----------------------------------------------------------------------------*/
91 /*----------------------------------------------------------------------------*/
92 
93 cs_gwf_t *
94 cs_gwf_destroy_all(void);
95 
96 /*----------------------------------------------------------------------------*/
102 /*----------------------------------------------------------------------------*/
103 
104 cs_gwf_tpf_t *
105 cs_gwf_get_two_phase_model(void);
106 
107 /*----------------------------------------------------------------------------*/
116 /*----------------------------------------------------------------------------*/
117 
118 void
119 cs_gwf_set_two_phase_numerical_options(cs_gwf_tpf_approx_type_t approx,
120  cs_gwf_tpf_solver_type_t solver,
121  bool use_incremental_solver,
122  bool use_diffusion_view_for_darcy);
123 
124 /*----------------------------------------------------------------------------*/
138 /*----------------------------------------------------------------------------*/
139 
140 void
141 cs_gwf_set_miscible_two_phase_model(cs_real_t l_mass_density,
142  cs_real_t l_viscosity,
143  cs_real_t g_viscosity,
144  cs_real_t l_diffusivity_h,
145  cs_real_t h_molar_mass,
146  cs_real_t ref_temperature,
147  cs_real_t henry_constant);
148 
149 /*----------------------------------------------------------------------------*/
160 /*----------------------------------------------------------------------------*/
161 
162 void
163 cs_gwf_set_immiscible_two_phase_model(cs_real_t l_mass_density,
164  cs_real_t l_viscosity,
165  cs_real_t g_viscosity,
166  cs_real_t h_molar_mass,
167  cs_real_t ref_temperature);
168 
169 /*----------------------------------------------------------------------------*/
173 /*----------------------------------------------------------------------------*/
174 
175 void
176 cs_gwf_log_setup(void);
177 
178 /*----------------------------------------------------------------------------*/
185 /*----------------------------------------------------------------------------*/
186 
187 void
188 cs_gwf_set_post_options(cs_flag_t post_flag,
189  bool reset);
190 
191 /*----------------------------------------------------------------------------*/
198 /*----------------------------------------------------------------------------*/
199 
200 cs_adv_field_t *
201 cs_gwf_get_adv_field(void);
202 
203 /*----------------------------------------------------------------------------*/
217 /*----------------------------------------------------------------------------*/
218 
219 cs_gwf_soil_t *
220 cs_gwf_add_iso_soil(const char *z_name,
221  double density,
222  double k_abs,
223  double porosity,
224  cs_gwf_soil_model_t model);
225 
226 /*----------------------------------------------------------------------------*/
239 /*----------------------------------------------------------------------------*/
240 
241 cs_gwf_soil_t *
242 cs_gwf_add_aniso_soil(const char *z_name,
243  double density,
244  double k_abs[3][3],
245  double porosity,
246  cs_gwf_soil_model_t model);
247 
248 /*----------------------------------------------------------------------------*/
265 /*----------------------------------------------------------------------------*/
266 
267 cs_gwf_tracer_t *
268 cs_gwf_add_tracer(cs_gwf_tracer_model_t tr_model,
269  const char *eq_name,
270  const char *var_name);
271 
272 /*----------------------------------------------------------------------------*/
291 /*----------------------------------------------------------------------------*/
292 
293 cs_gwf_tracer_t *
294 cs_gwf_add_radioactive_tracer(cs_gwf_tracer_model_t tr_model,
295  const char *eq_name,
296  const char *var_name,
297  double lambda);
298 
299 /*----------------------------------------------------------------------------*/
316 /*----------------------------------------------------------------------------*/
317 
318 cs_gwf_tracer_t *
319 cs_gwf_add_user_tracer(const char *eq_name,
320  const char *var_name,
321  cs_gwf_tracer_init_setup_t *init_setup,
322  cs_gwf_tracer_finalize_setup_t *finalize_setup);
323 
324 /*----------------------------------------------------------------------------*/
347 /*----------------------------------------------------------------------------*/
348 
349 cs_gwf_tracer_decay_chain_t *
350 cs_gwf_add_decay_chain(int n_tracers,
351  cs_gwf_tracer_unit_t unit,
352  const char *chain_name,
353  const char *var_names[],
354  cs_gwf_tracer_model_t models[],
355  double lambda_vals[]);
356 
357 /*----------------------------------------------------------------------------*/
364 /*----------------------------------------------------------------------------*/
365 
366 void
367 cs_gwf_init_sharing(const cs_cdo_quantities_t *cdoq,
368  const cs_cdo_connect_t *connect);
369 
370 /*----------------------------------------------------------------------------*/
376 /*----------------------------------------------------------------------------*/
377 
378 void
379 cs_gwf_init_model_context(void);
380 
381 /*----------------------------------------------------------------------------*/
392 /*----------------------------------------------------------------------------*/
393 
394 void
395 cs_gwf_init_setup(void);
396 
397 /*----------------------------------------------------------------------------*/
405 /*----------------------------------------------------------------------------*/
406 
407 void
408 cs_gwf_finalize_setup(const cs_cdo_connect_t *connect,
409  const cs_cdo_quantities_t *quant);
410 
411 /*----------------------------------------------------------------------------*/
425 /*----------------------------------------------------------------------------*/
426 
427 void
428 cs_gwf_hydraulic_update(const cs_mesh_t *mesh,
429  const cs_cdo_connect_t *connect,
430  const cs_cdo_quantities_t *quant,
431  const cs_time_step_t *ts,
432  cs_flag_t update_flag);
433 
434 /*----------------------------------------------------------------------------*/
445 /*----------------------------------------------------------------------------*/
446 
447 void
448 cs_gwf_init_values(const cs_mesh_t *mesh,
449  const cs_cdo_connect_t *connect,
450  const cs_cdo_quantities_t *quant,
451  const cs_time_step_t *ts);
452 
453 /*----------------------------------------------------------------------------*/
463 /*----------------------------------------------------------------------------*/
464 
465 void
466 cs_gwf_compute_steady_state(const cs_mesh_t *mesh,
467  const cs_time_step_t *time_step,
468  const cs_cdo_connect_t *connect,
469  const cs_cdo_quantities_t *cdoq);
470 
471 /*----------------------------------------------------------------------------*/
480 /*----------------------------------------------------------------------------*/
481 
482 void
483 cs_gwf_compute(const cs_mesh_t *mesh,
484  const cs_time_step_t *time_step,
485  const cs_cdo_connect_t *connect,
486  const cs_cdo_quantities_t *cdoq);
487 
488 /*----------------------------------------------------------------------------*/
496 /*----------------------------------------------------------------------------*/
497 
498 void
499 cs_gwf_extra_op(const cs_cdo_connect_t *connect,
500  const cs_cdo_quantities_t *cdoq,
501  const cs_time_step_t *ts);
502 
503 /*----------------------------------------------------------------------------*/
526 /*----------------------------------------------------------------------------*/
527 
528 void
529 cs_gwf_extra_post(void *input,
530  int mesh_id,
531  int cat_id,
532  int ent_flag[5],
533  cs_lnum_t n_cells,
534  cs_lnum_t n_i_faces,
535  cs_lnum_t n_b_faces,
536  const cs_lnum_t cell_ids[],
537  const cs_lnum_t i_face_ids[],
538  const cs_lnum_t b_face_ids[],
539  const cs_time_step_t *time_step);
540 
541 /*----------------------------------------------------------------------------*/
542 
543 END_C_DECLS
544 
545 #endif /* __CS_GWF_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
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_equation.h
lambda
@ lambda
Definition: cs_field_pointer.h:106
cs_gwf_compute_steady_state
void cs_gwf_compute_steady_state(const cs_mesh_t *mesh, const cs_time_step_t *time_step, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq)
Compute the steady-state of the groundwater flows module. Nothing is done if all equations are unstea...
Definition: cs_gwf.c:1454
cs_gwf_set_two_phase_numerical_options
void cs_gwf_set_two_phase_numerical_options(cs_gwf_tpf_approx_type_t approx, cs_gwf_tpf_solver_type_t solver, bool use_incremental_solver, bool use_diffusion_view_for_darcy)
Set the numerical options related to the two phase flow models.
Definition: cs_gwf.c:514
cs_gwf_destroy_all
cs_gwf_t * cs_gwf_destroy_all(void)
Free all structures related to groundwater flows.
Definition: cs_gwf.c:310
cs_gwf_add_radioactive_tracer
cs_gwf_tracer_t * cs_gwf_add_radioactive_tracer(cs_gwf_tracer_model_t tr_model, const char *eq_name, const char *var_name, double lambda)
Add a new equation related to the groundwater flow module.
Definition: cs_gwf.c:939
cs_gwf_add_aniso_soil
cs_gwf_soil_t * cs_gwf_add_aniso_soil(const char *z_name, double density, double k_abs[3][3], double porosity, cs_gwf_soil_model_t model)
Create and add a new cs_gwf_soil_t structure. An initialization by default of all members is performe...
Definition: cs_gwf.c:818
cs_gwf_extra_op
void cs_gwf_extra_op(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, const cs_time_step_t *ts)
Predefined extra-operations for the groundwater flow module.
Definition: cs_gwf.c:1591
cs_gwf_compute
void cs_gwf_compute(const cs_mesh_t *mesh, const cs_time_step_t *time_step, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq)
Compute the system related to groundwater flows module.
Definition: cs_gwf.c:1521
cs_gwf_set_post_options
void cs_gwf_set_post_options(cs_flag_t post_flag, bool reset)
Set the flag dedicated to the post-processing of the GWF module.
Definition: cs_gwf.c:695
cs_gwf_add_decay_chain
cs_gwf_tracer_decay_chain_t * cs_gwf_add_decay_chain(int n_tracers, cs_gwf_tracer_unit_t unit, const char *chain_name, const char *var_names[], cs_gwf_tracer_model_t models[], double lambda_vals[])
Add a set of tracer equations corresponding to a radioactive decay chain in the groundwater flow modu...
Definition: cs_gwf.c:1058
cs_gwf_init_sharing
void cs_gwf_init_sharing(const cs_cdo_quantities_t *cdoq, const cs_cdo_connect_t *connect)
Set shared pointers to main domain members.
Definition: cs_gwf.c:1151
cs_gwf_set_miscible_two_phase_model
void cs_gwf_set_miscible_two_phase_model(cs_real_t l_mass_density, cs_real_t l_viscosity, cs_real_t g_viscosity, cs_real_t l_diffusivity_h, cs_real_t h_molar_mass, cs_real_t ref_temperature, cs_real_t henry_constant)
Set the parameters defining the two-phase flow model in the miscible case. Use SI unit if not prescri...
Definition: cs_gwf.c:589
cs_gwf_extra_post
void cs_gwf_extra_post(void *input, int mesh_id, int cat_id, int ent_flag[5], cs_lnum_t n_cells, cs_lnum_t n_i_faces, cs_lnum_t n_b_faces, const cs_lnum_t cell_ids[], const cs_lnum_t i_face_ids[], const cs_lnum_t b_face_ids[], const cs_time_step_t *time_step)
Predefined post-processing output for the groundwater flow module. According to the model,...
Definition: cs_gwf.c:1648
cs_gwf_finalize_setup
void cs_gwf_finalize_setup(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant)
Last initialization step of the groundwater flow module. At this stage, the mesh quantities are defin...
Definition: cs_gwf.c:1289
cs_gwf_hydraulic_update
void cs_gwf_hydraulic_update(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *ts, cs_flag_t update_flag)
Update the groundwater system related to the hydraulic model: pressure head, head in law,...
Definition: cs_gwf.c:1348
cs_gwf_init_values
void cs_gwf_init_values(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_time_step_t *ts)
Initialize the GWF module (done after all the setup phase and after the initialization of all equatio...
Definition: cs_gwf.c:1405
cs_gwf_get_adv_field
cs_adv_field_t * cs_gwf_get_adv_field(void)
Retrieve the advection field related to the Darcy flux in the liquid phase.
Definition: cs_gwf.c:739
cs_gwf_add_tracer
cs_gwf_tracer_t * cs_gwf_add_tracer(cs_gwf_tracer_model_t tr_model, const char *eq_name, const char *var_name)
Add a new equation related to the groundwater flow module.
Definition: cs_gwf.c:873
cs_gwf_activate
cs_gwf_t * cs_gwf_activate(cs_gwf_model_type_t model, cs_flag_t option_flag, cs_flag_t post_flag)
Initialize the module dedicated to groundwater flows.
Definition: cs_gwf.c:246
cs_gwf_log_setup
void cs_gwf_log_setup(void)
Summary of the main cs_gwf_t structure.
Definition: cs_gwf.c:371
cs_gwf_init_model_context
void cs_gwf_init_model_context(void)
Initialize the context of the model after the activation of the module and make first settings of the...
Definition: cs_gwf.c:1169
cs_gwf_is_activated
bool cs_gwf_is_activated(void)
Check if the groundwater flow module has been activated.
Definition: cs_gwf.c:225
cs_gwf_add_iso_soil
cs_gwf_soil_t * cs_gwf_add_iso_soil(const char *z_name, double density, double k_abs, double porosity, cs_gwf_soil_model_t model)
Create and add a new cs_gwf_soil_t structure. An initialization by default of all members is performe...
Definition: cs_gwf.c:766
cs_gwf_add_user_tracer
cs_gwf_tracer_t * cs_gwf_add_user_tracer(const char *eq_name, const char *var_name, cs_gwf_tracer_init_setup_t *init_setup, cs_gwf_tracer_finalize_setup_t *finalize_setup)
Add a new equation related to the groundwater flow module.
Definition: cs_gwf.c:1003
cs_gwf_get_two_phase_model
cs_gwf_tpf_t * cs_gwf_get_two_phase_model(void)
Get the main structure which manages a two-phase flow model.
Definition: cs_gwf.c:484
cs_gwf_init_setup
void cs_gwf_init_setup(void)
Predefined settings for the groundwater flow model and its related equations.
Definition: cs_gwf.c:1234
cs_gwf_set_immiscible_two_phase_model
void cs_gwf_set_immiscible_two_phase_model(cs_real_t l_mass_density, cs_real_t l_viscosity, cs_real_t g_viscosity, cs_real_t h_molar_mass, cs_real_t ref_temperature)
Set the parameters defining the immiscible two-phase flow model. Use SI unit if not prescribed otherw...
Definition: cs_gwf.c:645
cs_gwf_tpf_approx_type_t
cs_gwf_tpf_approx_type_t
Type of approximation used for the computation of unsteady or diffusion properties.
Definition: cs_gwf_hydraulic_model.h:275
cs_gwf_tpf_solver_type_t
cs_gwf_tpf_solver_type_t
Type of solver considered for a two-phase flow model.
Definition: cs_gwf_hydraulic_model.h:258
cs_gwf_param.h
cs_gwf_tracer_model_t
cs_flag_t cs_gwf_tracer_model_t
Definition: cs_gwf_param.h:296
cs_gwf_model_type_t
cs_gwf_model_type_t
Type of system of equation(s) to consider for the physical modelling.
Definition: cs_gwf_param.h:126
cs_gwf_soil_model_t
cs_gwf_soil_model_t
Predefined hydraulic model of soils used in the groundwater flow module.
Definition: cs_gwf_param.h:279
cs_gwf_tracer_unit_t
cs_gwf_tracer_unit_t
Type of unit for the expression of the radioactive inventory.
Definition: cs_gwf_param.h:110
cs_gwf_priv.h
cs_gwf_soil.h
cs_gwf_tracer.h
cs_gwf_tracer_init_setup_t
void() cs_gwf_tracer_init_setup_t(cs_gwf_tracer_t *tracer)
Generic function to update the first setup stage (the one done before building mesh and its related q...
Definition: cs_gwf_tracer.h:77
cs_gwf_tracer_finalize_setup_t
void() cs_gwf_tracer_finalize_setup_t(const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_adv_field_t *adv, cs_gwf_tracer_t *tracer)
Generic function to finalize the setup of parameters related to a tracer equation....
Definition: cs_gwf_tracer.h:93
atimbr::density
double precision, dimension(:,:,:), allocatable density
Definition: atimbr.f90:124
mesh
Definition: mesh.f90:26
cs_adv_field_t
Definition: cs_advection_field.h:150
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:137
cs_gwf_t
Main set of parameters/structures to manage the groundwater flow (GWF) module. This is an explicit de...
Definition: cs_gwf_hydraulic_model.h:666
cs_gwf_tpf_t
Structure to handle the modelling of miscible or immiscible two-phase flows in a porous media.
Definition: cs_gwf_hydraulic_model.h:315
cs_gwf_tracer_decay_chain_t
Definition: cs_gwf_tracer.h:162
cs_gwf_tracer_t
Set of parameters describing a tracer structure.
cs_mesh_t
Definition: cs_mesh.h:85
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64