#include "base/cs_defs.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_quantities.h"

Include dependency graph for cs_vof.h:

Classes
struct	cs_vof_parameters_t
	VOF model parameters. Void fraction variable tracks fluid 2. More...

struct	cs_cavitation_parameters_t
	Cavitation model parameters. More...

Macros
#define	CS_VOF_ENABLED (1 << 0)

#define	CS_VOF_FREE_SURFACE (1 << 1)

#define	CS_VOF_MERKLE_MASS_TRANSFER (1 << 2)

Enumerations
enum	cs_vof_contact_angle_t { CS_VOF_CONTACT_ANGLE_OFF , CS_VOF_CONTACT_ANGLE_STATIC , CS_VOF_CONTACT_ANGLE_DYN , CS_VOF_N_CONTACT_ANGLE_TYPES }

Functions
cs_vof_parameters_t *	cs_get_glob_vof_parameters (void)

void	cs_vof_field_create (void)
	Create VoF fields. More...

void	cs_vof_log_setup (void)
	Log setup of VoF model. More...

void	cs_vof_compute_linear_rho_mu (const cs_mesh_t *m)
	Compute the mixture density, mixture dynamic viscosity given fluid volume fractions and the reference density and dynamic viscosity $\rho_l, \mu_l$ (liquid), $\rho_v, \mu_v$ (gas). More...

void	cs_vof_update_phys_prop (const cs_mesh_t *m)
	Compute the mixture density, mixture dynamic viscosity and mixture mass flux given the volumetric flux, the volume fraction and the reference density and dynamic viscosity $\rho_l, \mu_l$ (liquid), $\rho_v, \mu_v$ (gas). More...

void	cs_vof_surface_tension (const cs_mesh_t m, const cs_mesh_quantities_t mq, cs_real_3_t stf[])
	Compute the surface tension momentum source term following the CSF model of Brackbill et al. (1992). More...

void	cs_vof_log_mass_budget (const cs_mesh_t m, const cs_mesh_quantities_t mq)
	Write in main log the global mixture mass budget: More...

void	cs_vof_deshpande_drift_flux (const cs_mesh_t m, const cs_mesh_quantities_t mq)
	Compute a relative velocity $\vect u _d$ directly at internal faces (drift flux), following the approach described by Suraj S. Deshpande et al 2012 Comput. Sci. Disc. 5 014016. It is activated with the option idrift = 1. More...

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)

void	cs_vof_solve_void_fraction (int iterns)
	Solve the void fraction $\alpha$ for the Volume of Fluid method (and hence for cavitating flows). More...

void	cs_vof_smoothe (const cs_mesh_t m, const cs_mesh_quantities_t mq, cs_field_bc_coeffs_t bc_coeffs, cs_real_t pvar)

cs_cavitation_parameters_t *	cs_get_glob_cavitation_parameters (void)

void	cs_cavitation_compute_source_term (const cs_real_t pressure[], const cs_real_t voidf[])
	Compute the vaporization source term $\Gamma_V \left(\alpha, p\right) = m^+ + m^-$ using the Merkle model: More...

void	cs_vof_contact_angle_set (const cs_vof_contact_angle_t choice)
	Set the contact angle mode. More...

Variables
const cs_vof_parameters_t *	cs_glob_vof_parameters

const cs_cavitation_parameters_t *	cs_glob_cavitation_parameters

Enumeration Type Documentation

◆ cs_vof_contact_angle_t

enum cs_vof_contact_angle_t

Enum definition of contact angle model.

Enumerator
CS_VOF_CONTACT_ANGLE_OFF	No contact angle model.
CS_VOF_CONTACT_ANGLE_STATIC	Static contact angle model.
CS_VOF_CONTACT_ANGLE_DYN	Dynamic contact angle model.
CS_VOF_N_CONTACT_ANGLE_TYPES	Number of possible values.

Function Documentation

◆ cs_cavitation_compute_source_term()

void cs_cavitation_compute_source_term	(	const cs_real_t	pressure[],
		const cs_real_t	voidf[]
	)

Compute the vaporization source term $\Gamma_V \left(\alpha, p\right) = m^+ + m^-$ using the Merkle model:

$m^+ = -\dfrac{C_{prod} \rho_l \min \left( p-p_V,0 \right)\alpha(1-\alpha)} {0.5\rho_lu_\infty^2t_\infty},$

$m^- = -\dfrac{C_{dest} \rho_v \max \left( p-p_V,0 \right)\alpha(1-\alpha)} {0.5\rho_lu_\infty^2t_\infty},$

with $C_{prod}, C_{dest}$ empirical constants, $t_\infty=l_\infty/u_\infty$ a reference time scale and the reference saturation pressure. $l_\infty$ , $u_\infty$ and may be provided by the user (user function).

Note that the r.h.s. of the void fraction transport equation is $\Gamma_V/\rho_v$ .

Parameters

[in]	pressure	Pressure array
[in]	voidf	Void fraction array

◆ cs_get_glob_cavitation_parameters()

cs_cavitation_parameters_t * cs_get_glob_cavitation_parameters ( void )

◆ cs_get_glob_vof_parameters()

cs_vof_parameters_t * cs_get_glob_vof_parameters ( void )

◆ cs_vof_compute_linear_rho_mu()

void cs_vof_compute_linear_rho_mu ( const cs_mesh_t * m )

Compute the mixture density, mixture dynamic viscosity given fluid volume fractions and the reference density and dynamic viscosity $\rho_l, \mu_l$ (liquid), $\rho_v, \mu_v$ (gas).

Computation is done as follows on cells:

$\rho_\celli = \alpha_\celli \rho_v + (1-\alpha_\celli) \rho_l,$

$\mu_\celli = \alpha_\celli \mu_v + (1-\alpha_\celli) \mu_l,$

A similar linear formula is followed on boundary using fluid volume fraction value on the boundary.

Parameters

[in] m pointer to mesh structure

◆ cs_vof_contact_angle_set()

void cs_vof_contact_angle_set ( const cs_vof_contact_angle_t choice )

Set the contact angle mode.

Parameters

[in] choice Contact angle model to set.

◆ cs_vof_deshpande_drift_flux()

void cs_vof_deshpande_drift_flux	(	const cs_mesh_t *	m,
		const cs_mesh_quantities_t *	mq
	)

Compute a relative velocity $\vect u _d$ directly at internal faces (drift flux), following the approach described by Suraj S. Deshpande et al 2012 Comput. Sci. Disc. 5 014016. It is activated with the option idrift = 1.

Using the notation:

$\begin{cases} \left ( \vect u ^{n+1} . \vect S \right ) _{\face} = \Dot{m}_{\face}\\ \left ( \vect u _d^{n+1} . \vect S \right ) _{\face} = \Dot{m^d}_{\face} \end{cases}$

The drift flux is computed as:

$\Dot{m^d}_{\face} = min \left ( C_{\gamma} \dfrac{\Dot{m}_{\face}} {\vect S_{\face}}, \underset{\face'}{max} \left [ \dfrac{\Dot{m}_{\face'}} {\vect S_{\face'}} \right ] \right ) \left ( \vect n \cdot \vect S \right ) _{\face}$

Where $C_{\gamma}$ is the drift flux factor defined with the variable cdrift, $\vect n _{\face}$ the normal vector to the interface. The gradient is computed using a centered scheme:

$\vect {n} _{\face} = \dfrac{\left ( \grad \alpha \right ) _{\face}} {\norm {\left ( \grad \alpha \right ) _{\face} + \delta}}, \text{ with: } \left ( \grad \alpha \right ) _{\face _{\celli \cellj}} = \dfrac{\left ( \grad \alpha \right ) _\celli + \left ( \grad \alpha \right ) _\cellj}{2}, \text{ and: } \delta = 10^{-8} / \overline{\vol \celli} ^{1/3}$

Parameters

[in]	m	pointer to mesh structure
[in]	mq	pointer to mesh quantities structure

◆ cs_vof_drift_term()

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
	)

◆ cs_vof_field_create()

void cs_vof_field_create ( void )

Create VoF fields.

◆ cs_vof_log_mass_budget()

void cs_vof_log_mass_budget	(	const cs_mesh_t *	m,
		const cs_mesh_quantities_t *	mq
	)

Write in main log the global mixture mass budget:

$\sum_\celli\left( |\Omega_\celli|\dfrac{\rho_\celli^n - \rho_\celli^{n-1}}{\Delta t} + \sum_{\cellj\in\Face{\celli}}\left(\rho\vect{u}\vect{S}\right)_{\ij}^n \right).$

Parameters

[in]	m	pointer to mesh structure
[in]	mq	pointer to mesh quantities structure

◆ cs_vof_log_setup()

void cs_vof_log_setup ( void )

Log setup of VoF model.

◆ cs_vof_smoothe()

void cs_vof_smoothe	(	const cs_mesh_t *	m,
		const cs_mesh_quantities_t *	mq,
		cs_field_bc_coeffs_t *	bc_coeffs,
		cs_real_t *	pvar
	)

◆ cs_vof_solve_void_fraction()

void cs_vof_solve_void_fraction ( int iterns )

Solve the void fraction $\alpha$ for the Volume of Fluid method (and hence for cavitating flows).

This function solves:

$\dfrac{\alpha^n - \alpha^{n-1}}{\Delta t} + \divs \left( \alpha^n \vect{u}^n \right) + \divs \left( \left[ \alpha^n \left( 1 - \alpha^{n} \right) \right] \vect{u^r}^n \right) = \dfrac{\Gamma_V \left( \alpha^{n-1}, p^n \right)}{\rho_v}$

with $\Gamma_V$ the eventual vaporization source term (Merkle model) in case the cavitation model is enabled, $\rho_v$ the reference gas density and $\vect{u^r}$ the drift velocity for the compressed interface.

Parameters

[in] iterns Navier-Stokes iteration number

◆ cs_vof_surface_tension()

void cs_vof_surface_tension	(	const cs_mesh_t *	m,
		const cs_mesh_quantities_t *	mq,
		cs_real_3_t	stf[]
	)

Compute the surface tension momentum source term following the CSF model of Brackbill et al. (1992).

Parameters

[in]	m	pointer to mesh structure
[in]	mq	pointer to mesh quantities structure
[out]	stf	surface tension momentum source term

◆ cs_vof_update_phys_prop()

void cs_vof_update_phys_prop ( const cs_mesh_t * m )

Compute the mixture density, mixture dynamic viscosity and mixture mass flux given the volumetric flux, the volume fraction and the reference density and dynamic viscosity $\rho_l, \mu_l$ (liquid), $\rho_v, \mu_v$ (gas).

For the computation of mixture density, mixture dynamic viscosity, see cs_vof_compute_linear_rho_mu.

Computation of mass flux is as follows:

$\left( \rho\vect{u}\cdot\vect{S} \right)_\ij = \\ \left\lbrace \begin{array}{ll} \rho_\celli (\vect{u}\cdot\vect{S})_\ij &\text{ if } (\vect{u}\cdot\vect{S})_\ij>0, \\ \rho_\cellj (\vect{u}\cdot\vect{S})_\ij &\text{ otherwise }, \end{array} \right.$

$\left( \rho\vect{u}\cdot\vect{S} \right)_\ib = \\ \left\lbrace \begin{array}{ll} \rho_\celli (\vect{u}\cdot\vect{S})_\ib &\text{ if } (\vect{u}\cdot\vect{S})_\ib>0, \\ \rho_b (\vect{u}\cdot\vect{S})_\ib &\text{ otherwise }. \end{array} \right.$

Parameters

[in] m pointer to mesh structure

Variable Documentation

◆ cs_glob_cavitation_parameters

const cs_cavitation_parameters_t* cs_glob_cavitation_parameters

extern

◆ cs_glob_vof_parameters

const cs_vof_parameters_t* cs_glob_vof_parameters

extern

Classes

Macros

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ cs_vof_contact_angle_t

Function Documentation

◆ cs_cavitation_compute_source_term()

◆ cs_get_glob_cavitation_parameters()

◆ cs_get_glob_vof_parameters()

◆ cs_vof_compute_linear_rho_mu()

◆ cs_vof_contact_angle_set()

◆ cs_vof_deshpande_drift_flux()

◆ cs_vof_drift_term()

◆ cs_vof_field_create()

◆ cs_vof_log_mass_budget()

◆ cs_vof_log_setup()

◆ cs_vof_smoothe()

◆ cs_vof_solve_void_fraction()

◆ cs_vof_surface_tension()

◆ cs_vof_update_phys_prop()

Variable Documentation

◆ cs_glob_cavitation_parameters

◆ cs_glob_vof_parameters