cs_wall_condensation.h

Go to the documentation of this file.

#ifndef CS_WALL_CONDENSATION_H
#define CS_WALL_CONDENSATION_H
 
/*============================================================================
 * Base wall condensation model.
 *============================================================================*/
 
/*
  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.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_defs.h"
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef enum {
  CS_WALL_COND_MODEL_COPAIN    = 0,
  CS_WALL_COND_MODEL_COPAIN_BD = 1,
  CS_WALL_COND_MODEL_UCHIDA    = 2,
  CS_WALL_COND_MODEL_DEHBI     = 3,
} cs_wall_cond_natural_conv_model_t;
 
typedef enum {
  CS_WALL_COND_MODEL_WALL_LAW    = 0,
  CS_WALL_COND_MODEL_SCHLICHTING = 1
} cs_wall_cond_forced_conv_model_t;
 
typedef enum {
  CS_WALL_COND_MIXED_MAX       = 0,
  CS_WALL_COND_MIXED_INCROPERA = 1
} cs_wall_cond_mixed_conv_model_t;
 
typedef struct {
 
  int icondb; 
  int icondv; 
  int nztag1d; 
  // Model type
  cs_wall_cond_natural_conv_model_t natural_conv_model;
  cs_wall_cond_forced_conv_model_t  forced_conv_model;
  cs_wall_cond_mixed_conv_model_t   mixed_conv_model;
 
  /* Surface wall condensation */
 
  // Mesh related quantities
  cs_lnum_t  nfbpcd;
  cs_lnum_t *ifbpcd;
  cs_lnum_t *itypcd;
  cs_lnum_t *izzftcd;
  cs_real_t *spcond;
  cs_real_t *hpcond;
  cs_real_t *twall_cond;
  cs_real_t *thermal_condensation_flux;
  cs_real_t *convective_htc;
  cs_real_t *condensation_htc;
  cs_real_t *total_htc;
  cs_real_t *flthr;
  cs_real_t *dflthr;
 
  // Zone related quantities
  cs_lnum_t  nzones;
  cs_lnum_t *izcophc;
  cs_lnum_t *izcophg;
  cs_lnum_t *iztag1d;
  cs_real_t *ztpar;
  cs_real_t *zxrefcond;
  cs_real_t *zprojcond;
 
  /* Volume wall condensation */
 
  cs_lnum_t  ncmast;
  cs_lnum_t  nvolumes;
  cs_lnum_t *ltmast;
  cs_lnum_t *itypst;
  cs_lnum_t *izmast;
  cs_real_t *svcond;
  cs_real_t *flxmst;
  cs_lnum_t *itagms;
 
} cs_wall_condensation_t;
 
/*============================================================================
 * Static global variables
 *============================================================================*/
 
/* Pointer to wall condensation descriptor structure */
extern const cs_wall_condensation_t  *cs_glob_wall_condensation;
 
/*=============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Provide writable access to _wall_cond structure.
 *
 * \return pointer to global wall_cond structure
 */
/*----------------------------------------------------------------------------*/
 
cs_wall_condensation_t *
cs_get_glob_wall_condensation(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Set the wall condensation model
 *
 * \param[in] model    integer corresponding to the desired model
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_set_model(cs_wall_cond_natural_conv_model_t  model);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Set the onoff state of wall condensation modeling
 *
 * \param[in] icondb  integer corresponding to the onoff state (-1: off, 0: on)
 * \param[in] icondv  integer corresponding to the onoff state with
 *                    metal structures (-1: off, 0: on)
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_set_onoff_state(int  icondb,
                                     int  icondv);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Create the context for wall condensation models.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_create(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Free all structures related to wall condensation models
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_free(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Initialize wall condensation models.
 *
 * This includes building the associated meshes.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_initialize(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Reset values
 *
 * \param[in]  wall_cond  wall_condensation strucutre
 * \param[in]  n_var number of variable
 *
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_reset(cs_wall_condensation_t *wall_cond, const int n_var);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return condensing volume structures surface at each cell.
 *
 * \param[out]  surf  array of volume structure surfaces at each cell
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_volume_exchange_surf_at_cells(cs_real_t  *surf);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Compute the wall condensation source terms.
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_compute(cs_real_t  total_htc[]);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Output statistics about wall condensation source terms (for user log)
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_log(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Explicit and implicit sources terms from sources
 *        condensation computation.
 *
 * \param[in]      f         pointer to field structure
 * \param[in]      xcpp      array of specific heat (Cp)
 * \param[in]      pvara     variable value at time step beginning
 * \param[in,out]  st_exp    explicit source term part linear in the variable
 * \param[in,out]  st_imp    associated value with \c tsexp
 *                           to be stored in the matrix
 */
/*----------------------------------------------------------------------------*/
 
void
cs_wall_condensation_source_terms(const cs_field_t  *f,
                                  const cs_real_t    xcpp[],
                                  const cs_real_t    pvara[],
                                  cs_real_t          st_exp[],
                                  cs_real_t          st_imp[]);
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_WALL_CONDENSATION_H */