cs_rad_transfer.h

Go to the documentation of this file.

#ifndef __CS_RAD_TRANSFER_H__
#define __CS_RAD_TRANSFER_H__
 
/*============================================================================
 * Radiation solver operations.
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2025 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 "base/cs_defs.h"
 
#include "base/cs_time_control.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*=============================================================================
 * Local Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definition
 *============================================================================*/
 
/* Radiative transfer model type */
 
typedef enum {
 
  CS_RAD_TRANSFER_NONE = 0, /* Set a value to avoid compilation warnings */
  CS_RAD_TRANSFER_DOM  = 1,
  CS_RAD_TRANSFER_P1   = 2
 
} cs_rad_transfer_model_t;
 
/* Quadrature types */
 
typedef enum {
 
  CS_RAD_QUADRATURE_S4 = 1,
  CS_RAD_QUADRATURE_S6,
  CS_RAD_QUADRATURE_S8,
  CS_RAD_QUADRATURE_T2,
  CS_RAD_QUADRATURE_T4,
  CS_RAD_QUADRATURE_TN,
  CS_RAD_QUADRATURE_LC11,
  CS_RAD_QUADRATURE_DCT020_2468
 
} cs_rad_quadrature_type_t;
 
/* Radiative transfer model boundary condition type.
   We use a naming similar to that of cs_boundary.h here, to ease
   later migration. */
 
enum {
 
  CS_BOUNDARY_RAD_WALL_GRAY = 1,
 
  CS_BOUNDARY_RAD_WALL_GRAY_1D_T = 4,
 
  CS_BOUNDARY_RAD_WALL_GRAY_EXTERIOR_T = 21,
 
  CS_BOUNDARY_RAD_WALL_REFL_EXTERIOR_T = 22,
 
  CS_BOUNDARY_RAD_WALL_GRAY_COND_FLUX = 31,
 
  CS_BOUNDARY_RAD_WALL_REFL_COND_FLUX = 32,
 
};
 
/* Radiative transfer model type for atmospheric module */
 
enum {
 
  CS_RAD_ATMO_3D_NONE = 0,
  CS_RAD_ATMO_3D_DIRECT_SOLAR = 1 << 0,/* Solar IR band (SIR) absobed by H2O */
  CS_RAD_ATMO_3D_DIRECT_SOLAR_O3BAND = 1 << 1, /* UV-visible band (SUV)
                                                  absobed by H2O */
  CS_RAD_ATMO_3D_DIFFUSE_SOLAR = 1 << 2,/* Solar IR band (SIR) absobed by H2O */
  CS_RAD_ATMO_3D_DIFFUSE_SOLAR_O3BAND = 1 << 3, /* UV-visible band (SUV)
                                                   absobed by H2O */
  CS_RAD_ATMO_3D_INFRARED = 1 << 4
 
};
 
/*============================================================================
 *  Global variables
 *============================================================================*/
 
extern const char *cs_rad_transfer_model_name[];
 
extern const char *cs_rad_transfer_quadrature_name[];
 
typedef struct {
 
  cs_rad_transfer_model_t   type;  
  int           nrphas;
  int           iimpar;
  int           verbosity; 
  int           imgrey;    
  int           imoadf;    
  int           iwrp1t;
  int           imfsck;    
  int           imrcfsk;   
  double        xnp1mx;
  int           idiver;    
  int           i_quadrature;
  int           ndirec;
  int           ndirs;
  cs_real_3_t  *vect_s;
  cs_real_t    *angsol;
  int           restart;
  int           nwsgg;
  cs_real_t    *wq;
  int           itpimp;
  int           ipgrno;
  int           iprefl;
  int           ifgrno;
  int           ifrefl;
  int           itpt1d;
  int           ifinfe;
 
  int           atmo_model;          
  int           atmo_dr_id;          
  int           atmo_dr_o3_id;       
  int           atmo_df_id;          
  int           atmo_df_o3_id;       
  int           atmo_ir_id;          
  bool          dispersion;          
  cs_real_t     dispersion_coeff;    
  bool          save_radiance_dir;   /* Option to save radiance for all
                                        directions. This increase the storage
                                        but save some times because calculations
                                        are not initialized to 0.
                                        This is mandatory for atmospheric
                                        because diffusion process induce
                                        redistribution from one direction to
                                        another*/
  cs_time_control_t  time_control;   /* Time control for radiation updates */
 
 
} cs_rad_transfer_params_t;
 
extern cs_rad_transfer_params_t *cs_glob_rad_transfer_params;
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_rad_transfer_finalize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
bool
cs_rad_time_is_active(void);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_RAD_TRANSFER_H__ */