8.3
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-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_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
43BEGIN_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
65bool
66cs_gwf_is_activated(void);
67
68/*----------------------------------------------------------------------------*/
78/*----------------------------------------------------------------------------*/
79
80cs_gwf_t *
81cs_gwf_activate(cs_gwf_model_type_t model,
82 cs_flag_t option_flag,
83 cs_flag_t post_flag);
84
85/*----------------------------------------------------------------------------*/
91/*----------------------------------------------------------------------------*/
92
93cs_gwf_t *
94cs_gwf_destroy_all(void);
95
96/*----------------------------------------------------------------------------*/
102/*----------------------------------------------------------------------------*/
103
104cs_gwf_tpf_t *
105cs_gwf_get_two_phase_model(void);
106
107/*----------------------------------------------------------------------------*/
115/*----------------------------------------------------------------------------*/
116
117void
118cs_gwf_set_two_phase_numerical_options(cs_gwf_tpf_approx_type_t approx,
119 cs_gwf_tpf_solver_type_t solver,
120 bool pg_pos);
121
122/*----------------------------------------------------------------------------*/
136/*----------------------------------------------------------------------------*/
137
138void
139cs_gwf_set_miscible_two_phase_model(cs_real_t l_mass_density,
140 cs_real_t l_viscosity,
141 cs_real_t g_viscosity,
142 cs_real_t l_diffusivity_h,
143 cs_real_t h_molar_mass,
144 cs_real_t ref_temperature,
145 cs_real_t henry_constant);
146
147/*----------------------------------------------------------------------------*/
158/*----------------------------------------------------------------------------*/
159
160void
161cs_gwf_set_immiscible_two_phase_model(cs_real_t l_mass_density,
162 cs_real_t l_viscosity,
163 cs_real_t g_viscosity,
164 cs_real_t h_molar_mass,
165 cs_real_t ref_temperature);
166
167/*----------------------------------------------------------------------------*/
171/*----------------------------------------------------------------------------*/
172
173void
174cs_gwf_log_setup(void);
175
176/*----------------------------------------------------------------------------*/
183/*----------------------------------------------------------------------------*/
184
185void
186cs_gwf_set_post_options(cs_flag_t post_flag,
187 bool reset);
188
189/*----------------------------------------------------------------------------*/
196/*----------------------------------------------------------------------------*/
197
198cs_adv_field_t *
199cs_gwf_get_adv_field(void);
200
201/*----------------------------------------------------------------------------*/
215/*----------------------------------------------------------------------------*/
216
217cs_gwf_soil_t *
218cs_gwf_add_iso_soil(const char *z_name,
219 double density,
220 double k_abs,
221 double porosity,
222 cs_gwf_soil_model_t model);
223
224/*----------------------------------------------------------------------------*/
237/*----------------------------------------------------------------------------*/
238
239cs_gwf_soil_t *
240cs_gwf_add_aniso_soil(const char *z_name,
241 double density,
242 double k_abs[3][3],
243 double porosity,
244 cs_gwf_soil_model_t model);
245
246/*----------------------------------------------------------------------------*/
263/*----------------------------------------------------------------------------*/
264
265cs_gwf_tracer_t *
266cs_gwf_add_tracer(cs_gwf_tracer_model_t tr_model,
267 const char *eq_name,
268 const char *var_name);
269
270/*----------------------------------------------------------------------------*/
289/*----------------------------------------------------------------------------*/
290
291cs_gwf_tracer_t *
292cs_gwf_add_radioactive_tracer(cs_gwf_tracer_model_t tr_model,
293 const char *eq_name,
294 const char *var_name,
295 double lambda);
296
297/*----------------------------------------------------------------------------*/
314/*----------------------------------------------------------------------------*/
315
316cs_gwf_tracer_t *
317cs_gwf_add_user_tracer(const char *eq_name,
318 const char *var_name,
319 cs_gwf_tracer_init_setup_t *init_setup,
320 cs_gwf_tracer_finalize_setup_t *finalize_setup);
321
322/*----------------------------------------------------------------------------*/
345/*----------------------------------------------------------------------------*/
346
347cs_gwf_tracer_decay_chain_t *
348cs_gwf_add_decay_chain(int n_tracers,
349 cs_gwf_tracer_unit_t unit,
350 const char *chain_name,
351 const char *var_names[],
352 cs_gwf_tracer_model_t models[],
353 double lambda_vals[]);
354
355/*----------------------------------------------------------------------------*/
362/*----------------------------------------------------------------------------*/
363
364void
365cs_gwf_init_sharing(const cs_cdo_quantities_t *cdoq,
366 const cs_cdo_connect_t *connect);
367
368/*----------------------------------------------------------------------------*/
374/*----------------------------------------------------------------------------*/
375
376void
377cs_gwf_init_model_context(void);
378
379/*----------------------------------------------------------------------------*/
390/*----------------------------------------------------------------------------*/
391
392void
393cs_gwf_init_setup(void);
394
395/*----------------------------------------------------------------------------*/
403/*----------------------------------------------------------------------------*/
404
405void
406cs_gwf_finalize_setup(const cs_cdo_connect_t *connect,
407 const cs_cdo_quantities_t *quant);
408
409/*----------------------------------------------------------------------------*/
423/*----------------------------------------------------------------------------*/
424
425void
426cs_gwf_hydraulic_update(const cs_mesh_t *mesh,
427 const cs_cdo_connect_t *connect,
428 const cs_cdo_quantities_t *quant,
429 const cs_time_step_t *ts,
430 cs_flag_t update_flag);
431
432/*----------------------------------------------------------------------------*/
443/*----------------------------------------------------------------------------*/
444
445void
446cs_gwf_init_values(const cs_mesh_t *mesh,
447 const cs_cdo_connect_t *connect,
448 const cs_cdo_quantities_t *quant,
449 const cs_time_step_t *ts);
450
451/*----------------------------------------------------------------------------*/
461/*----------------------------------------------------------------------------*/
462
463void
464cs_gwf_compute_steady_state(const cs_mesh_t *mesh,
465 const cs_time_step_t *time_step,
466 const cs_cdo_connect_t *connect,
467 const cs_cdo_quantities_t *cdoq);
468
469/*----------------------------------------------------------------------------*/
478/*----------------------------------------------------------------------------*/
479
480void
481cs_gwf_compute(const cs_mesh_t *mesh,
482 const cs_time_step_t *time_step,
483 const cs_cdo_connect_t *connect,
484 const cs_cdo_quantities_t *cdoq);
485
486/*----------------------------------------------------------------------------*/
494/*----------------------------------------------------------------------------*/
495
496void
497cs_gwf_extra_op(const cs_cdo_connect_t *connect,
498 const cs_cdo_quantities_t *cdoq,
499 const cs_time_step_t *ts);
500
501/*----------------------------------------------------------------------------*/
524/*----------------------------------------------------------------------------*/
525
526void
527cs_gwf_extra_post(void *input,
528 int mesh_id,
529 int cat_id,
530 int ent_flag[5],
531 cs_lnum_t n_cells,
532 cs_lnum_t n_i_faces,
533 cs_lnum_t n_b_faces,
534 const cs_lnum_t cell_ids[],
535 const cs_lnum_t i_face_ids[],
536 const cs_lnum_t b_face_ids[],
537 const cs_time_step_t *time_step);
538
539/*----------------------------------------------------------------------------*/
540
541END_C_DECLS
542
543#endif /* __CS_GWF_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:344
cs_equation.h
lambda
@ lambda
Definition: cs_field_pointer.h:108
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.cpp:1424
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.cpp:1018
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.cpp:774
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.cpp:239
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.cpp:1571
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.cpp:1492
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.cpp:650
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.cpp:1113
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.cpp:542
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.cpp:1631
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.cpp:473
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.cpp:721
cs_gwf_destroy_all
cs_gwf_t * cs_gwf_destroy_all(void)
Free all structures related to groundwater flows.
Definition: cs_gwf.cpp:303
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.cpp:1255
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.cpp:1318
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.cpp:962
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.cpp:1374
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.cpp:694
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 pg_pos)
Set the numerical options related to the two phase flow models.
Definition: cs_gwf.cpp:503
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.cpp:830
cs_gwf_log_setup
void cs_gwf_log_setup(void)
Summary of the main cs_gwf_t structure.
Definition: cs_gwf.cpp:358
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.cpp:1131
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.cpp:897
cs_gwf_is_activated
bool cs_gwf_is_activated(void)
Check if the groundwater flow module has been activated.
Definition: cs_gwf.cpp:218
cs_gwf_init_setup
void cs_gwf_init_setup(void)
Predefined settings for the groundwater flow model and its related equations.
Definition: cs_gwf.cpp:1199
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.cpp:599
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:270
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:255
cs_gwf_param.h
cs_gwf_tracer_model_t
cs_flag_t cs_gwf_tracer_model_t
Flags specifying the general behavior of a tracer associated to the groundwater flow module.
Definition: cs_gwf_param.h:297
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:127
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:280
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:111
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:123
mesh
Definition: mesh.f90:26
cs_adv_field_t
Definition: cs_advection_field.h:151
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:139
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:622
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:310
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