programmer's documentation
Functions/Subroutines
cs_user_source_terms.f90 File Reference

Additional right-hand side source terms. More...

Functions/Subroutines

subroutine ustsnv (nvar, nscal, ncepdp, ncesmp, ivar, icepdc, icetsm, itypsm, dt, ckupdc, smacel, crvexp, crvimp)
 
subroutine ustssc (nvar, nscal, ncepdp, ncesmp, iscal, icepdc, icetsm, itypsm, dt, ckupdc, smacel, crvexp, crvimp)
 
subroutine cs_user_turbulence_source_terms (nvar, nscal, ncepdp, ncesmp, f_id, icepdc, icetsm, itypsm, ckupdc, smacel, crvexp, crvimp)
 Additional right-hand side source terms for turbulence models. More...
 
subroutine cs_user_turbulence_source_terms2 (nvar, nscal, ncepdp, ncesmp, f_id, icepdc, icetsm, itypsm, ckupdc, smacel, crvexp, crvimp)
 Additional right-hand side source terms for turbulence models and irijco =1. More...
 

Detailed Description

Additional right-hand side source terms.

Additional right-hand side source terms for velocity components equation (Navier-Stokes)

Usage

The additional source term is decomposed into an explicit part (crvexp) and an implicit part (crvimp) that must be provided here. The resulting equation solved by the code for a velocity is:

\[ \rho \norm{\vol{\celli}} \DP{\vect{u}} + .... = \tens{crvimp} \cdot \vect{u} + \vect{crvexp} \]

Note that crvexp and crvimp are defined after the Finite Volume integration over the cells, so they include the "volume" term. More precisely:

The crvexp and crvimp arrays are already initialized to 0 before entering the the routine. It is not needed to do it in the routine (waste of CPU time).

Remarks
The additional force on $ x_i $ direction is given by crvexp(i, iel) + vel(j, iel)* crvimp(j, i).

For stability reasons, Code_Saturne will not add -crvimp directly to the diagonal of the matrix, but Max(-crvimp,0). This way, the crvimp term is treated implicitely only if it strengthens the diagonal of the matrix. However, when using the second-order in time scheme, this limitation cannot be done anymore and -crvimp is added directly. The user should therefore test the negativity of crvimp by himself.

When using the second-order in time scheme, one should supply:

The selection of cells where to apply the source terms is based on a getcel command. For more info on the syntax of the getcel command, refer to the user manual or to the comments on the similar command getfbr in the routine cs_user_boundary_conditions.

Function/Subroutine Documentation

subroutine cs_user_turbulence_source_terms ( integer  nvar,
integer  nscal,
integer  ncepdp,
integer  ncesmp,
integer  f_id,
integer, dimension(ncepdp)  icepdc,
integer, dimension(ncesmp)  icetsm,
integer, dimension(ncesmp,nvar)  itypsm,
double precision, dimension(ncepdp,6)  ckupdc,
double precision, dimension(ncesmp,nvar)  smacel,
double precision, dimension(ncelet)  crvexp,
double precision, dimension(ncelet)  crvimp 
)

Additional right-hand side source terms for turbulence models.

Usage

The additional source term is decomposed into an explicit part (crvexp) and an implicit part (crvimp) that must be provided here. The resulting equations solved by the code are:

\[ \rho \norm{\vol{\celli}} \DP{\varia} + .... = \tens{crvimp} \varia + \vect{crvexp} \]

where $ \varia $ is the turbulence field of index f_id

Note that crvexp, crvimp are defined after the Finite Volume integration over the cells, so they include the "volume" term. More precisely:

  • crvexp is expressed in kg.m2/s2
  • crvimp is expressed in kg/s

The crvexp, crvimp arrays are already initialized to 0 before entering the routine. It is not needed to do it in the routine (waste of CPU time).

For stability reasons, Code_Saturne will not add -crvimp directly to the diagonal of the matrix, but Max(-crvimp,0). This way, the crvimp term is treated implicitely only if it strengthens the diagonal of the matrix. However, when using the second-order in time scheme, this limitation cannot be done anymore and -crvimp is added directly. The user should therefore test the negativity of crvimp by himself.

When using the second-order in time scheme, one should supply:

  • crvexp at time n
  • crvimp at time n+1/2

The selection of cells where to apply the source terms is based on a getcel command. For more info on the syntax of the getcel command, refer to the user manual or to the comments on the similar command getfbr in the routine cs_user_boundary_conditions.

Parameters
[in]nvartotal number of variables
[in]nscaltotal number of scalars
[in]ncepdpnumber of cells with head loss terms
[in]ncesmpnumber of cells with mass source terms
[in]f_idfield index of the current turbulent variable
[in]icepdcindex number of cells with head loss terms
[in]icetsmindex number of cells with mass source terms
[in]itypsmtype of mass source term for each variable (see Examples of data settings for mass source terms (cs_user_mass_source_terms.f90))
[in]ckupdchead loss coefficient
[in]smacelvalue associated to each variable in the mass source terms or mass rate (see Examples of data settings for mass source terms (cs_user_mass_source_terms.f90))
[out]crvexpexplicit part of the source term
[out]crvimpimplicit part of the source term
subroutine cs_user_turbulence_source_terms2 ( integer  nvar,
integer  nscal,
integer  ncepdp,
integer  ncesmp,
integer  f_id,
integer, dimension(ncepdp)  icepdc,
integer, dimension(ncesmp)  icetsm,
integer, dimension(ncesmp,nvar)  itypsm,
double precision, dimension(ncepdp,6)  ckupdc,
double precision, dimension(ncesmp,nvar)  smacel,
double precision, dimension(6,ncelet)  crvexp,
double precision, dimension(6,6,ncelet)  crvimp 
)

Additional right-hand side source terms for turbulence models and irijco =1.

Usage

The additional source term is decomposed into an explicit part (crvexp) and an implicit part (crvimp) that must be provided here. The resulting equations solved by the code are:

\[ \rho \norm{\vol{\celli}} \DP{\varia} + .... = \tens{crvimp} \varia + \vect{crvexp} \]

where $ \varia $ is the turbulence field of index f_id

Note that crvexp, crvimp are defined after the Finite Volume integration over the cells, so they include the "volume" term. More precisely:

  • crvexp is expressed in kg.m2/s2
  • crvimp is expressed in kg/s

The crvexp, crvimp arrays are already initialized to 0 before entering the routine. It is not needed to do it in the routine (waste of CPU time).

For stability reasons, Code_Saturne will not add -crvimp directly to the diagonal of the matrix, but Max(-crvimp,0). This way, the crvimp term is treated implicitely only if it strengthens the diagonal of the matrix. However, when using the second-order in time scheme, this limitation cannot be done anymore and -crvimp is added directly. The user should therefore test the negativity of crvimp by himself.

When using the second-order in time scheme, one should supply:

  • crvexp at time n
  • crvimp at time n+1/2

The selection of cells where to apply the source terms is based on a getcel command. For more info on the syntax of the getcel command, refer to the user manual or to the comments on the similar command getfbr in the routine cs_user_boundary_conditions.

Parameters
[in]nvartotal number of variables
[in]nscaltotal number of scalars
[in]ncepdpnumber of cells with head loss terms
[in]ncesmpnumber of cells with mass source terms
[in]f_idfield index of the current turbulent variable
[in]icepdcindex number of cells with head loss terms
[in]icetsmindex number of cells with mass source terms
[in]itypsmtype of mass source term for each variable (see Examples of data settings for mass source terms (cs_user_mass_source_terms.f90))
[in]ckupdchead loss coefficient
[in]smacelvalue associated to each variable in the mass source terms or mass rate (see Examples of data settings for mass source terms (cs_user_mass_source_terms.f90))
[out]crvexpexplicit part of the source term
[out]crvimpimplicit part of the source term
subroutine ustsnv ( integer  nvar,
integer  nscal,
integer  ncepdp,
integer  ncesmp,
integer  ivar,
integer, dimension(ncepdp)  icepdc,
integer, dimension(ncesmp)  icetsm,
integer, dimension(ncesmp,nvar)  itypsm,
double precision, dimension(ncelet)  dt,
double precision, dimension(ncepdp,6)  ckupdc,
double precision, dimension(ncesmp,nvar)  smacel,
double precision, dimension(3,ncelet)  crvexp,
double precision, dimension(3,3,ncelet)  crvimp 
)
Parameters
[in]nvartotal number of variables
[in]nscaltotal number of scalars
[in]ncepdpnumber of cells with head loss terms
[in]ncesmpnumber of cells with mass source terms
[in]ivarindex number of the current variable
[in]icepdcindex number of cells with head loss terms
[in]icetsmindex number of cells with mass source terms
[in]itypsmtype of mass source term for each variable (see Examples of data settings for mass source terms (cs_user_mass_source_terms.f90))
[in]dttime step (per cell)
[in]ckupdchead loss coefficient
[in]smacelvalue associated to each variable in the mass source terms or mass rate (see Examples of data settings for mass source terms (cs_user_mass_source_terms.f90))
[out]crvexpexplicit part of the source term
[out]crvimpimplicit part of the source term
subroutine ustssc ( integer  nvar,
integer  nscal,
integer  ncepdp,
integer  ncesmp,
integer  iscal,
integer, dimension(ncepdp)  icepdc,
integer, dimension(ncesmp)  icetsm,
integer, dimension(ncesmp,nvar)  itypsm,
double precision, dimension(ncelet)  dt,
double precision, dimension(ncepdp,6)  ckupdc,
double precision, dimension(ncesmp,nvar)  smacel,
double precision, dimension(ncelet)  crvexp,
double precision, dimension(ncelet)  crvimp 
)
Parameters
[in]nvartotal number of variables
[in]nscaltotal number of scalars
[in]ncepdpnumber of cells with head loss terms
[in]ncesmpnumber of cells with mass source terms
[in]iscalindex number of the current scalar
[in]icepdcindex number of cells with head loss terms
[in]icetsmindex number of cells with mass source terms
[in]itypsmtype of mass source term for each variable (see cs_user_mass_source_terms)
[in]dttime step (per cell)
[in]ckupdchead loss coefficient
[in]smacelvalue associated to each variable in the mass source terms or mass rate (see cs_user_mass_source_terms)
[out]crvexpexplicit part of the source term
[out]crvimpimplicit part of the source term