cs_vof.h

Go to the documentation of this file.

#ifndef CS_VOF_H
#define CS_VOF_H
 
/*============================================================================
 * Functions associated to VOF model
 *============================================================================*/
 
/*
  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.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Standard C library headers
 *----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_defs.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_quantities.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*=============================================================================
 * Macro definitions
 *============================================================================*/


#define CS_VOF_ENABLED (1 << 0)

#define CS_VOF_FREE_SURFACE (1 << 1)

#define CS_VOF_MERKLE_MASS_TRANSFER (1 << 2)

 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/* VOF model parameters */
/*----------------------*/
 
typedef struct {
 
  unsigned      vof_model;   /* VoF model (sum of masks defining Volume of
                                Fluid model and submodels */
 
  double        rho1;        /* density */
 
  double        rho2;
 
  double        mu1;         /* viscosity */
 
  double        mu2;
 
  double        sigma_s;     /* surface tension */
 
  int           idrift;      /* drift velocity model */
 
  double        cdrift;      /* C_gamma constant (drift flux factor)*/
 
  double        kdrift;
 
} cs_vof_parameters_t;
 
/* Cavitation parameters */
/*-----------------------*/
 
typedef struct {
 
  cs_real_t        presat;  /* reference saturation pressure */
  cs_real_t        uinf;    /* reference velocity */
  cs_real_t        linf;    /* reference length scale */
  cs_real_t        cdest;   /* constant of condensation model (Merkle) */
  cs_real_t        cprod;   /* constant of vaporization model (Merkle) */
  int              icvevm;  /* eddy-viscosity correction indicator */
  cs_real_t        mcav;    /* eddy-viscosity correction cstt (Reboud) */
  int              itscvi;  /* eddy-viscosity correction indicator */
 
} cs_cavitation_parameters_t;

 
typedef enum {
  CS_VOF_CONTACT_ANGLE_OFF,    
  CS_VOF_CONTACT_ANGLE_STATIC, 
  CS_VOF_CONTACT_ANGLE_DYN,    
  CS_VOF_N_CONTACT_ANGLE_TYPES 
} cs_vof_contact_angle_t;
 
/*=============================================================================
 * Global variables
 *============================================================================*/
 
/* pointer to VOF model parameters structure */
 
extern const cs_vof_parameters_t *cs_glob_vof_parameters;
 
/* pointer to cavitation model parameters structure */
 
extern const cs_cavitation_parameters_t *cs_glob_cavitation_parameters;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 *!
 * \brief Provide write access to VOF structure.
 */
/*----------------------------------------------------------------------------*/
 
cs_vof_parameters_t *
cs_get_glob_vof_parameters(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Create VoF fields
 */
/*----------------------------------------------------------------------------*/
 
void
cs_vof_field_create(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_vof_log_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_vof_compute_linear_rho_mu(const cs_mesh_t  *m);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_vof_update_phys_prop(const cs_mesh_t  *m);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_vof_surface_tension(const cs_mesh_t             *m,
                       const cs_mesh_quantities_t  *mq,
                       cs_real_3_t                  stf[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_vof_log_mass_budget(const cs_mesh_t             *m,
                       const cs_mesh_quantities_t  *mq);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_vof_deshpande_drift_flux(const cs_mesh_t             *m,
                            const cs_mesh_quantities_t  *mq);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_vof_drift_term(int               imrgra,
                  int               nswrgp,
                  int               imligp,
                  int               iwarnp,
                  cs_real_t         epsrgp,
                  cs_real_t         climgp,
                  cs_real_t        *pvar,
                  const cs_real_t  *pvara,
                  cs_real_t        *rhs);
 
/*----------------------------------------------------------------------------*/
/*
 * \param[in]     iterns        Navier-Stokes iteration number
 */
/*----------------------------------------------------------------------------*/
 
void
cs_vof_solve_void_fraction(int  iterns);
 
/*----------------------------------------------------------------------------
 *!
 * \brief Provide write access to cavitation parameters structure.
 */
/*----------------------------------------------------------------------------*/
 
cs_cavitation_parameters_t *
cs_get_glob_cavitation_parameters(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Compute the vaporization source term
 * \f$ \Gamma_V \left(\alpha, p\right) = m^+ + m^- \f$ using the
 * Merkle model:
 *
 * \f[
 * m^+ = -\dfrac{C_{prod} \rho_l \min \left( p-p_V,0 \right)\alpha(1-\alpha)}
 *              {0.5\rho_lu_\infty^2t_\infty},
 * \f]
 * \f[
 * m^- = -\dfrac{C_{dest} \rho_v \max \left( p-p_V,0 \right)\alpha(1-\alpha)}
 *              {0.5\rho_lu_\infty^2t_\infty},
 * \f]
 * with \f$ C_{prod}, C_{dest} \f$ empirical constants,
 * \f$ t_\infty=l_\infty/u_\infty \f$ a reference time scale and \f$p_V\f$
 * the reference saturation pressure.
 * \f$ l_\infty \f$, \f$ u_\infty \f$ and \f$p_V\f$ may be provided by
 * the user (user function).
 *
 * Note that the r.h.s. of the void fraction transport equation is
 * \f$ \Gamma_V/\rho_v \f$.
 *
 * \param[in]  pressure  Pressure array
 * \param[in]  voidf     Void fraction array
 */
/*----------------------------------------------------------------------------*/
 
void
cs_cavitation_compute_source_term(const cs_real_t  pressure[],
                                  const cs_real_t  voidf[]);
 
/*----------------------------------------------------------------------------*/
/* Set the contact angle mode */
/*----------------------------------------------------------------------------*/
 
void
cs_vof_contact_angle_set
(
  const cs_vof_contact_angle_t choice
);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* CS_VOF_H */