cs_gwf_param.h

Go to the documentation of this file.

#ifndef __CS_GWF_PARAM_H__
#define __CS_GWF_PARAM_H__

/*============================================================================
 * Types related to the groundwater flow module
 *============================================================================*/

/*
  This file is part of code_saturne, a general-purpose CFD tool.

  Copyright (C) 1998-2022 EDF S.A.

  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.

  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  details.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
  Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/

#include "cs_defs.h"

/*----------------------------------------------------------------------------*/

BEGIN_C_DECLS

/*============================================================================
 * Macro definitions
 *============================================================================*/

#define CS_GWF_POST_SOIL_CAPACITY              (1 << 0)
#define CS_GWF_POST_LIQUID_SATURATION          (1 << 1)
#define CS_GWF_POST_PERMEABILITY               (1 << 2)
#define CS_GWF_POST_DARCY_FLUX_BALANCE         (1 << 3)
#define CS_GWF_POST_DARCY_FLUX_DIVERGENCE      (1 << 4)
#define CS_GWF_POST_DARCY_FLUX_AT_BOUNDARY     (1 << 5)
#define CS_GWF_POST_GAS_MASS_DENSITY           (1 << 6)

/*============================================================================
 * Type definitions
 *============================================================================*/

typedef enum {

  CS_GWF_TRACER_UNIT_BECQUEREL,
  CS_GWF_TRACER_UNIT_MOLE

} cs_gwf_tracer_unit_t;

typedef enum {

  CS_GWF_MODEL_SATURATED_SINGLE_PHASE,

  CS_GWF_MODEL_UNSATURATED_SINGLE_PHASE,

  CS_GWF_MODEL_MISCIBLE_TWO_PHASE,

  CS_GWF_MODEL_IMMISCIBLE_TWO_PHASE,

  CS_GWF_N_MODEL_TYPES     
} cs_gwf_model_type_t;


typedef enum {

  CS_GWF_GRAVITATION                     = 1<< 0,  /* =   1 */

  CS_GWF_FORCE_RICHARDS_ITERATIONS       = 1<< 6,  /* =   64 */

  CS_GWF_RESCALE_HEAD_TO_ZERO_MEAN_VALUE = 1<< 7,  /* =  128 */

  CS_GWF_ENFORCE_DIVERGENCE_FREE         = 1<< 8   /* =  256 */

} cs_gwf_model_bit_t;

typedef enum {

  CS_GWF_SOIL_GENUCHTEN,
  CS_GWF_SOIL_SATURATED,
  CS_GWF_SOIL_USER,

  CS_GWF_SOIL_N_HYDRAULIC_MODELS

} cs_gwf_soil_model_t;

typedef cs_flag_t  cs_gwf_tracer_model_t;

typedef enum {

  CS_GWF_TRACER_USER                        = 1<< 0, /* =     1 */

  /* Physical phenomena to consider */
  /* ------------------------------ */

  CS_GWF_TRACER_SORPTION_EK_3_PARAMETERS    = 1<< 2, /* =     4 */

  CS_GWF_TRACER_SORPTION_EK_5_PARAMETERS    = 1<< 3, /* =     8 */

  CS_GWF_TRACER_PRECIPITATION               = 1<< 4, /* =    16 */

} cs_gwf_tracer_model_bit_t;

/*============================================================================
 * Public function prototypes
 *============================================================================*/

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_GWF_PARAM_H__ */