cs_parameters.h

Go to the documentation of this file.

#ifndef CS_PARAMETERS_H
#define CS_PARAMETERS_H
 
/*============================================================================
 * General parameters management.
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2026 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.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/
 
#include <stdarg.h>
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_defs.h"
#include "cdo/cs_equation_param.h"
#include "base/cs_field.h"
#include "base/cs_tree.h"
 
/*=============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Structure of variable calculation options
 * (now an alias of cs_equation_param_t)
 *----------------------------------------------------------------------------*/
 
typedef cs_equation_param_t cs_var_cal_opt_t;
 
/*----------------------------------------------------------------------------
 * Structure of the solving info
 *----------------------------------------------------------------------------*/
 
typedef struct {
 
  int     n_it;
  double  rhs_norm;
  double  res_norm;
  double  derive;
  double  l2residual;
 
} cs_solving_info_t;
 
/*----------------------------------------------------------------------------
 * Boundary condition types
 *----------------------------------------------------------------------------*/
 
#define CS_INDEF CS_UNDEF /* For backward compatibility with 9.0 */
 
enum {
 
  CS_UNDEF = 1,              
  CS_INLET = 2,              
  CS_OUTLET = 3,             
  CS_SYMMETRY = 4,
 
  CS_SMOOTHWALL = 5,         
  CS_ROUGHWALL = 6,          
  CS_ESICF = 7,              
  CS_SSPCF = 8,              
  CS_SOPCF = 9,              
  CS_EPHCF = 10,             
  CS_EQHCF = 11,             
  CS_COUPLED = 12,           
  CS_COUPLED_FD = 13,        
  CS_FREE_INLET = 14,        
  CS_FREE_SURFACE = 64,      
  CS_CONVECTIVE_INLET = 16   
};
 
/*----------------------------------------------------------------------------
 * flag for computing the drift mass flux:
 * (for coal classes for instance, only the first
 *  scalar of a class compute the drift flux of the class
 *  and the other scalars use it without recomputing it)
 *----------------------------------------------------------------------------*/
 
enum {
 
  CS_DRIFT_SCALAR_ON = (1 << 0),
  CS_DRIFT_SCALAR_ADD_DRIFT_FLUX = (1 << 1),
  CS_DRIFT_SCALAR_THERMOPHORESIS = (1 << 2),
  CS_DRIFT_SCALAR_TURBOPHORESIS = (1 << 3),
  CS_DRIFT_SCALAR_ELECTROPHORESIS = (1 << 4),
  CS_DRIFT_SCALAR_CENTRIFUGALFORCE = (1 << 5),
  CS_DRIFT_SCALAR_IMPOSED_MASS_FLUX = (1 << 6),
  CS_DRIFT_SCALAR_ZERO_BNDY_FLUX = (1 << 7),
  CS_DRIFT_SCALAR_ZERO_BNDY_FLUX_AT_WALLS = (1 << 8),
  CS_DRIFT_SCALAR_NO_MASS_AGGREGATION = (1 << 9)
 
};
 
/*----------------------------------------------------------------------------
 * Space discretisation options descriptor
 *----------------------------------------------------------------------------*/
 
typedef struct {
 
  int           imvisf;       /* face viscosity field interpolation
                                 - 1: harmonic
                                 - 0: arithmetic (default) */
 
  int           imrgra;       /* type of gradient reconstruction
                                 - 0: iterative process
                                 - 1: standard least square method
                                 - 2: least square method with extended
                                      neighborhood
                                 - 3: least square method with reduced extended
                                      neighborhood
                                 - 4: Green-Gauss using least squares face
                                      values interpolation */
 
  int           iflxmw;       /* method to compute interior mass flux due to ALE
                                 mesh velocity
                                 - 1: based on cell center mesh velocity
                                 - 0: based on nodes displacement */
 
  int           itbrrb;       /* accurate treatment of the wall temperature
                                 - 1: true
                                 - 0: false (default) */
 
} cs_space_disc_t;
 
/*----------------------------------------------------------------------------
 * Time scheme descriptor
 *----------------------------------------------------------------------------*/
 
typedef struct {
 
  int           time_order;   /* global time order of the time stepping */
 
  int           istmpf;       /* time order of the mass flux scheme */
 
  int           isno2t;       /* time scheme activated for the source
                                 terms of the momentum, apart from
                                 convection and diffusion */
 
  int           isto2t;       /* time scheme activated for the source
                                 terms of turbulent equations */
 
  double        thetsn;       /* value of \f$theta_S\f$ for Navier-Stokes
                                 source terms */
 
  double        thetst;       /* value of \f$theta\f$ for turbulence
                                 explicit source terms */
 
  double        thetvi;       /* value of \f$theta\f$ for total viscosity */
 
  double        thetcp;       /* value of \f$theta\f$ for specific heat */
 
  int           iccvfg;       /* calculation with a fixed velocity field
                                 - 1: true (default)
                                 - 0: false */
} cs_time_scheme_t;
 
/*----------------------------------------------------------------------------
 * Auxiliary checkpoint/restart file parameters
 *----------------------------------------------------------------------------*/
 
typedef struct {
 
  int     read_auxiliary;   /* Activate reading of auxiliary restart file */
  int     write_auxiliary;  /* Activate output of auxiliary restart file */
 
} cs_restart_auxiliary_t;
 
/*============================================================================
 * Static global variables
 *============================================================================*/
 
/* Pointer to space discretisation options structure */
 
extern const cs_space_disc_t  *cs_glob_space_disc;
 
/* Pointer to time scheme  options structure */
 
extern const cs_time_scheme_t  *cs_glob_time_scheme;
 
/* Pointer to auxiliary checkpoint/restart file parameters */
 
extern cs_restart_auxiliary_t  *cs_glob_restart_auxiliary;
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
extern cs_tree_node_t  *cs_glob_tree;
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
inline int
cs_parameters_iscavr(cs_field_t *f)
{
  int iscvr = 0, f_id = 0;
  int kscavr = cs_field_key_id("first_moment_id");
  int keysca = cs_field_key_id("scalar_id");
 
  if (kscavr >= 0) {
    f_id = f->get_key_int(kscavr);
    if (f_id >= 0)
      iscvr = cs_field_by_id(f_id)->get_key_int(keysca);
  }
 
  return iscvr;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_space_disc_t *
cs_get_glob_space_disc(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_time_scheme_t *
cs_get_glob_time_scheme(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_set_init_state_on(int idx);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_define_field_keys(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_read_restart_info(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Define a user variable.
 *
 * Solved variables are always defined on cells.
 *
 * \param[in]  name  name of variable and associated field
 * \param[in]  dim   variable dimension
 */
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_add_variable(const char  *name,
                           int          dim);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_add_variable_variance(const char  *name,
                                    const char  *variable_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_add_property(const char  *name,
                           int          dim,
                           int          location_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_parameters_n_added_variables(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_parameters_n_added_properties(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_create_added_variables(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_define_auxiliary_fields(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_create_added_properties(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Add field indexes associated with a new non-user solved scalar
 *        variable, with default options.
 *
 * \param[in, out]  f  field
 */
/*----------------------------------------------------------------------------*/
 
void
cs_add_model_field_indexes(cs_field_t  *f);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Define a boundary values field for a variable field.
 *
 * \param[in, out]  f  pointer to field structure
 *
 * \return  pointer to boundary values field, or NULL if not applicable
 */
/*----------------------------------------------------------------------------*/
 
cs_field_t *
cs_parameters_add_boundary_values(cs_field_t  *f);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Define a boundary values field for temperature, if applicable.
 *
 * When a volume temperature variable field already exists, this amounts
 * to calling \ref cs_parameters_add_boundary_values for that field.
 * When such a variable does not exist but we have an Enthalpy variables,
 * an associated temperature boundary field is returned.
 *
 * \return  pointer to boundary values field, or NULL if not applicable
 */
/*----------------------------------------------------------------------------*/
 
cs_field_t *
cs_parameters_add_boundary_temperature(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool
cs_parameters_need_extended_neighborhood(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_global_complete(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_eqp_complete(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_parameters_output_complete(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_equation_param_t
cs_parameters_equation_param_default(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_time_scheme_log_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_space_disc_log_setup(void);
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_PARAMETERS_H */