cs_combustion_gas.h

Go to the documentation of this file.

#ifndef __CS_COMBUSTION_GAS_H__
#define __CS_COMBUSTION_GAS_H__
 
/*============================================================================
 * Gas combustion model.
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2024 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
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Local headers
 *----------------------------------------------------------------------------*/
 
#include "cs_defs.h"
#include "cs_field.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
#define  CS_COMBUSTION_GAS_MAX_GLOBAL_SPECIES  25
 
#define  CS_COMBUSTION_GAS_MAX_ATOMIC_SPECIES  5
 
#define CS_COMBUSTION_GAS_MAX_OXYDANTS 3
 
#define  CS_COMBUSTION_GAS_MAX_ELEMENTARY_COMPONENTS  20
 
#define CS_COMBUSTION_GAS_MAX_GLOBAL_REACTIONS 1
 
#define  CS_COMBUSTION_GAS_MAX_TABULATION_POINTS  50
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*------------------------------*/
 
typedef enum {
 
  CS_COMBUSTION_GAS_NONE = -1,
 
  CS_COMBUSTION_3PT_ADIABATIC = 100,
 
  CS_COMBUSTION_3PT_PERMEATIC = 101,
 
  CS_COMBUSTION_SLFM_STEADY_ADIABATIC = 200,
 
  CS_COMBUSTION_SLFM_STEADY_PERMEATIC = 201,
 
  CS_COMBUSTION_SLFM_PROGRESS_ADIABATIC = 202,
 
  CS_COMBUSTION_SLFM_PROGRESS_PERMEATIC = 203,
 
  CS_COMBUSTION_EBU_CONSTANT_ADIABATIC = 300,
 
  CS_COMBUSTION_EBU_CONSTANT_PERMEATIC = 301,
 
  CS_COMBUSTION_EBU_VARIABLE_ADIABATIC = 302,
 
  CS_COMBUSTION_EBU_VARIABLE_PERMEATIC = 303,
 
  CS_COMBUSTION_LW_2PEAK_ADIABATIC = 400,
 
  CS_COMBUSTION_LW_2PEAK_PERMEATIC = 401,
 
  CS_COMBUSTION_LW_3PEAK_ADIABATIC = 402,
 
  CS_COMBUSTION_LW_3PEAK_PERMEATIC = 403,
 
  CS_COMBUSTION_LW_4PEAK_ADIABATIC = 404,
 
  CS_COMBUSTION_LW_4PEAK_PERMEATIC = 405
 
} cs_combustion_gas_model_type_t;
 
/*--------------------------------------------*/
 
typedef struct {
 
  /* Generic members
     ---------------
     (keep aligned with gas combustion, so that we can
     move to an object inheritance model in the future) */
 
  int     n_gas_el_comp;             
  int     n_gas_species;             
  int     n_atomic_species;          
  int     n_reactions;               
  int     n_tab_points;              
  double  pcigas;                    
  double  xco2;                      
  double  xh2o;                      
  double  wmole[CS_COMBUSTION_GAS_MAX_ELEMENTARY_COMPONENTS];
 
  double  wmolat[CS_COMBUSTION_GAS_MAX_ATOMIC_SPECIES];
 
  double oxyn2[CS_COMBUSTION_GAS_MAX_OXYDANTS];
 
  double oxyh2o[CS_COMBUSTION_GAS_MAX_OXYDANTS];
 
  double oxyco2[CS_COMBUSTION_GAS_MAX_OXYDANTS];
 
  double th[CS_COMBUSTION_GAS_MAX_TABULATION_POINTS];
 
  /* Members specific to the gas combustion model
     -------------------------------------------- */
 
  cs_combustion_gas_model_type_t  type;  
  char   *data_file_name;          /* Name of thermochemistry data file */
 
  bool    use_janaf;               
  int     iic;                     
  int     iico2;                   
  int     iio2;                    
  int     isoot;                   
  double  hinfue;                  
  double  tinfue;                  
  double  tinoxy;                  
  double  hinoxy;                  
  double  xsoot;                   
  double  rosoot;                  
  double  wmolg[CS_COMBUSTION_GAS_MAX_GLOBAL_SPECIES];
 
  double  coefeg[CS_COMBUSTION_GAS_MAX_GLOBAL_SPECIES]
                [CS_COMBUSTION_GAS_MAX_ELEMENTARY_COMPONENTS];
 
  double  compog[CS_COMBUSTION_GAS_MAX_GLOBAL_SPECIES]
                [CS_COMBUSTION_GAS_MAX_ELEMENTARY_COMPONENTS];
 
  double fs[CS_COMBUSTION_GAS_MAX_GLOBAL_REACTIONS];
 
  double cpgazg[CS_COMBUSTION_GAS_MAX_TABULATION_POINTS]
               [CS_COMBUSTION_GAS_MAX_GLOBAL_SPECIES];
 
  /* Numerical parameters
     -------------------- */
 
  double srrom;  
  double fmin_lwc;
  double fmax_lwc;
  double hmin_lwc;
  double hmax_lwc;
 
} cs_combustion_gas_model_t;
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
extern cs_combustion_gas_model_t  *cs_glob_combustion_gas_model;
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Activate gas combustion model.
 *
 * \return  pointer to gas combustion model structure.
 *
 * \param[in]  type  gas combustion model type
 */
/*----------------------------------------------------------------------------*/
 
cs_combustion_gas_model_t  *
cs_combustion_gas_set_model(cs_combustion_gas_model_type_t  type);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Set the thermochemical data file name.
 *
 * \param[in] file_name  name of the file.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_combustion_gas_set_thermochemical_data_file(const char  *file_name);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Compute molar and mass fractions of
 *        elementary species Ye, Xe (fuel, O2, CO2, H2O, N2) from
 *        global species Yg (fuel, oxidant, products).
 *
 * \param[in]     yg            global mass fraction
 * \param[out]    ye            elementary mass fraction
 * \param[out]    xe            elementary molar fraction
 */
/*----------------------------------------------------------------------------*/
 
void
cs_combustion_gas_yg2xye(const cs_real_t  yg[],
                         cs_real_t        ye[],
                         cs_real_t        xe[]);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Print the gas combustion module options to setup.log.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_combustion_gas_log_setup(void);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_COMBUSTION_GAS_H__ */