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-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

/*============================================================================
 * 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; // Switch used to activate wall condensation (0 : activated)
  int icondv; /* Switch used to activate wall condensation
                 with metal structures(0 : activated) */
  // 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;

  // Mesh-related information
  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;
} cs_wall_cond_t;

/*============================================================================
 * Static global variables
 *============================================================================*/

/* Pointer to wall condensation descriptor structure */
extern const cs_wall_cond_t *cs_glob_wall_cond;

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

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

cs_wall_cond_t *
cs_get_glob_wall_cond(void);

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

void
cs_wall_condensation_set_model(cs_wall_cond_natural_conv_model_t  model);

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

void
cs_wall_condensation_set_onoff_state(int  icondb,
                                     int  icondv);

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

void
cs_wall_condensation_create(cs_lnum_t  nfbpcd,
                            cs_lnum_t  nzones,
                            cs_lnum_t  nvar);

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

void
cs_wall_condensation_free(void);

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

void
cs_wall_condensation_compute(cs_real_t  total_htc[]);

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

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]      ncmast    number of cells with metal mass condensation
 * \param[in]      ltmast    list of cells with condensation source terms
 *                           (1 to n numbering)
 * \param[in]      itypst    type of metal mass condensation source terms
 * \param[in]      spcondp   value of the variable associated
 *                           to surface condensation source term
 * \param[in]      gam_s     surface condensation flow rate value
 * \param[in]      svcondp   value of the variable associated
 *                           to metal mass condensation source term
 * \param[in]      gam_ms    metal mass condensation flow rate value
 * \param[in]      fluxv_ms  metal mass condensation heat transfer flux
 * \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,
                                  cs_lnum_t          ncmast,
                                  const cs_lnum_t    ltmast[],
                                  const cs_lnum_t    itypst[],
                                  const cs_real_t    spcondp[],
                                  const cs_real_t    gam_s[],
                                  const cs_real_t    svcondp[],
                                  const cs_real_t    gam_ms[],
                                  const cs_real_t    fluxv_ms[],
                                  const cs_real_t    pvara[],
                                  cs_real_t          st_exp[],
                                  cs_real_t          st_imp[]);

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

END_C_DECLS

#endif /* __CS_WALL_CONDENSATION_H__ */