programmer's documentation
Functions/Subroutines | Variables
optcal Module Reference

Functions/Subroutines

integer function iscavr (iscal)
 If scalar iscal represents the mean of the square of a scalar k, return k; otherwise, return 0. More...
 
subroutine time_step_init
 Initialize Fortran time step API. This maps Fortran pointers to global C structure members. More...
 
subroutine time_step_options_init
 Initialize Fortran time step options API. This maps Fortran pointers to global C structure members. More...
 
subroutine thermal_model_init
 Initialize Fortran thermal model API. This maps Fortran pointers to global C structure members. More...
 
subroutine turb_model_init
 Initialize Fortran turbulence model API. This maps Fortran pointers to global C structure members. More...
 
subroutine wall_functions_init
 Initialize Fortran wall functions API. This maps Fortran pointers to global C structure members. More...
 
subroutine turb_rans_model_init
 Initialize Fortran RANS turbulence model API. This maps Fortran pointers to global C structure members. More...
 
subroutine turb_les_model_init
 Initialize Fortran LES turbulence model API. This maps Fortran pointers to global C structure members. More...
 
subroutine stokes_options_init
 Initialize Fortran Stokes options API. This maps Fortran pointers to global C structure members. More...
 
subroutine space_disc_options_init
 Initialize Fortran space discretisation options API. This maps Fortran pointers to global C structure members. More...
 
subroutine piso_options_init
 Initialize Fortran PISO options API. This maps Fortran pointers to global C structure members. More...
 

Variables

integer, dimension(nvarmx), save istat
 take unsteady term into account: More...
 
integer, dimension(nvarmx), save iconv
 take convection into account: More...
 
integer, dimension(nvarmx), save idiff
 take diffusion into account: More...
 
integer, dimension(nvarmx), save idifft
 take turbulent diffusion into account: More...
 
integer, dimension(nvarmx), save idften
 type of diffusivity: More...
 
integer, save ischtp
 time order of time stepping More...
 
integer, save istmpf
 time order of the mass flux scheme More...
 
integer(c_int), pointer, save nterup
 number of interations on the pressure-velocity coupling on Navier-Stokes (for the PISO algorithm) More...
 
integer, save isno2t
 extrapolation of source terms in the Navier-Stokes equations More...
 
integer, save isto2t
 extrapolation of turbulent quantities More...
 
integer, dimension(nscamx), save isso2t
 extrapolation of source terms in the transport equation of scalars More...
 
integer, save iroext
 extrapolation of the density field More...
 
integer, save iviext
 extrapolation of the total viscosity field More...
 
integer, save icpext
 extrapolation of the specific heat field $ C_p $ More...
 
integer, dimension(nscamx), save ivsext
 extrapolation of the scalar diffusivity More...
 
integer, save initvi
 initvi : =1 if total viscosity read from checkpoint file More...
 
integer, save initro
 initro : =1 if density read from checkpoint file More...
 
integer, save initcp
 initcp : =1 if specific heat read from checkpoint file More...
 
integer, dimension(nvarmx), save ibdtso
 ibdtso : backward differential scheme in time order More...
 
integer, dimension(nscamx), save initvs
 initvs : =1 if scalar diffusivity read from checkpoint file More...
 
double precision, dimension(nvarmx), save thetav
 $ \theta $-scheme for the main variables More...
 
double precision, save thetsn
 $ \theta_S $-scheme for the source terms in the Navier-Stokes equations More...
 
double precision, save thetst
 $ \theta $-scheme for the source terms of turbulent equations More...
 
double precision, dimension(nscamx), save thetss
 $ \theta $-scheme for the source terms of transport equations of scalars More...
 
double precision, save thetfl
 $ \theta $-scheme for the mass flux More...
 
double precision, save thetvi
 $ \theta $-scheme for the total viscosity More...
 
double precision, save thetro
 $ \theta $-scheme for the density field More...
 
double precision, save thetcp
 $ \theta $-scheme for the scpecific heat field More...
 
double precision, dimension(nscamx), save thetvs
 $ \theta $-scheme for the diffusivity More...
 
real(c_double), pointer, save epsup
 relative precision for the convergence test of the iterative process on pressure-velocity coupling (PISO) More...
 
real(c_double), pointer, save xnrmu
 norm of the increment $ \vect{u}^{k+1} - \vect{u}^k $ of the iterative process on pressure-velocity coupling (PISO) More...
 
real(c_double), pointer, save xnrmu0
 norm of $ \vect{u}^0 $ (used by PISO algorithm) More...
 
double precision, dimension(nvarmx), save blencv
 percentage of upwind: More...
 
integer, dimension(nvarmx), save ischcv
 type of convective scheme More...
 
integer, dimension(nvarmx), save isstpc
 switch off the slope test: More...
 
integer(c_int), pointer, save iflxmw
 method to compute interior mass flux due to ALE mesh velocity More...
 
integer(c_int), pointer, save imrgra
 type of gradient reconstruction More...
 
real(c_double), pointer, save anomax
 anomax : angle de non orthogonalite des faces en radian au dela duquel on retient dans le support etendu des cellules voisines de la face les cellules dont un noeud est sur la face More...
 
integer, dimension(nvarmx), save nswrgr
 max number of iterations for the iterative gradient More...
 
double precision, dimension(nvarmx), save epsrgr
 relative precision of the iterative gradient calculation More...
 
integer, dimension(nvarmx), save imligr
 type of gradient clipping More...
 
double precision, dimension(nvarmx), save climgr
 climgr : facteur de limitation (>=1, =1 : forte limitation) More...
 
double precision, dimension(nvarmx), save extrag
 gradient extrapolation at the boundary More...
 
integer, dimension(nvarmx), save iwgrec
 gradient calculation More...
 
integer, dimension(nvarmx), save ircflu
 face flux reconstruction: More...
 
integer(c_int), pointer, save imvisf
 face viscosity field interpolation More...
 
integer, dimension(nvarmx), save nswrsm
 max number of iteration for the iterative process used to solved the convection diffusion equations More...
 
double precision, dimension(nvarmx), save epsrsm
 relative precision of the iterative process used to solved the convection diffusion equations More...
 
integer, dimension(nvarmx), save iswdyn
 dynamic relaxation type: More...
 
double precision, dimension(nvarmx), save epsilo
 relative precision of the linear solver More...
 
integer, dimension(nvarmx), save idircl
 strengthening of the diagonal part of the matrix if no Dirichlet is set More...
 
integer, dimension(nvarmx), save ndircl
 number of Dirichlet BCs More...
 
integer, save isuite
 
integer, save ileaux
 
integer, save iecaux
 
integer, save isuit1
 
integer, save isuict
 
integer, save isuivo
 
integer, save isuisy
 
integer(c_int), pointer, save ntpabs
 Absolute time step number for previous calculation. More...
 
integer(c_int), pointer, save ntcabs
 Current absolute time step number. In case of restart, this is equal to ntpabs + number of new iterations. More...
 
integer(c_int), pointer, save ntmabs
 Maximum absolute time step number. More...
 
integer(c_int), pointer, save ntinit
 Number of time steps for initalization. More...
 
real(c_double), pointer, save ttpabs
 Absolute time value for previous calculation. More...
 
real(c_double), pointer, save ttcabs
 Current absolute time. In case of restart, this is equal to ttpabs + additional computed time. More...
 
real(c_double), pointer, save ttmabs
 Maximum absolute time. More...
 
integer(c_int), pointer, save inpdt0
 indicator "zero time step" More...
 
integer(c_int), pointer, save iptlro
 Clip the time step with respect to the buoyant effects. More...
 
integer(c_int), pointer, save idtvar
 option for a variable time step More...
 
real(c_double), pointer, save dtref
 reference time step More...
 
real(c_double), pointer, save coumax
 maximum Courant number (when idtvar is different from 0) More...
 
real(c_double), pointer, save cflmmx
 maximum Courant number for the continuity equation in compressible model More...
 
real(c_double), pointer, save foumax
 maximum Fourier number (when idtvar is different from 0) More...
 
real(c_double), pointer, save varrdt
 relative allowed variation of dt (when idtvar is different from 0) More...
 
real(c_double), pointer, save dtmin
 minimum value of dt (when idtvar is different from 0). Take dtmin = min (ld/ud, sqrt(lt/(gdelta rho/rho)), ...) More...
 
real(c_double), pointer, save dtmax
 maximum value of dt (when idtvar is different from 0). Take dtmax = max (ld/ud, sqrt(lt/(gdelta rho/rho)), ...) More...
 
double precision, dimension(nvarmx), save cdtvar
 multiplicator coefficient for the time step of each variable More...
 
double precision, dimension(nvarmx), save relaxv
 relaxation of variables (1 stands fo no relaxation) More...
 
real(c_double), pointer, save relxst
 relaxation coefficient for the steady algorithm More...
 
integer(c_int), pointer, save itherm
 thermal model More...
 
integer(c_int), pointer, save itpscl
 temperature scale More...
 
integer(c_int), pointer, save iscalt
 index of the thermal scalar (temperature, energy of enthalpy), the index of the corresponding variable is isca(iscalt) More...
 
integer(c_int), pointer, save iturb
 
integer(c_int), pointer, save itytur
 Class of turbulence model (integer value iturb/10) More...
 
integer(c_int), pointer, save irccor
 Activation of rotation/curvature correction for eddy viscosity turbulence models. More...
 
integer(c_int), pointer, save itycor
 Type of rotation/curvature correction for eddy viscosity turbulence models. More...
 
integer(c_int), pointer, save idirsm
 Turbulent diffusion model for second moment closure. More...
 
integer(c_int), pointer, save iwallf
 Wall functions. More...
 
integer(c_int), pointer, save iwalfs
 Wall functions for scalar. More...
 
integer(c_int), pointer, save iwallt
 exchange coefficient correlation More...
 
integer(c_int), pointer, save iclkep
 clipping of k and epsilon More...
 
integer(c_int), pointer, save igrhok
 take $ 2/3 \rho \grad k $ in the momentum equation More...
 
integer(c_int), pointer, save igrake
 buoyant term in $ k- \varepsilon $ More...
 
integer(c_int), pointer, save igrari
 buoyant term in $ R_{ij}- \varepsilon $ More...
 
integer(c_int), pointer, save ikecou
 partially coupled version of $ k-\varepsilon $ (only for iturb=20) More...
 
integer(c_int), pointer, save reinit_turb
 Advanced re-init for EBRSM and k-omega models. More...
 
integer(c_int), pointer, save irijco
 Coupled solving of $ \tens{R} $. More...
 
integer(c_int), pointer, save irijnu
 pseudo eddy viscosity in the matrix of momentum equation to partially implicit $ \divv \left( \rho \tens{R} \right) $ More...
 
integer(c_int), pointer, save irijrb
 accurate treatment of $ \tens{R} $ at the boundary (see condli) More...
 
integer(c_int), pointer, save irijec
 wall echo term of $ \tens{R} $ More...
 
integer(c_int), pointer, save idifre
 whole treatment of the diagonal part of the dissusion tensor of $ \tens{R} $ and $ \varepsilon $ More...
 
integer(c_int), pointer, save iclsyr
 partial implicitation of symmetry BCs of $ \tens{R} $ More...
 
integer(c_int), pointer, save iclptr
 partial implicitation of wall BCs of $ \tens{R} $ More...
 
integer(c_int), pointer, save idries
 Van Driest smoothing at the wall (only for itytur=4) More...
 
integer(c_int), pointer, save ivrtex
 vortex method (in LES) More...
 
integer, dimension(nscamx), save iturt
 turbulent flux model for $ \overline{\varia^\prime \vect{u}^\prime} $ for any scalar $ \varia $, iturt(isca) More...
 
integer, dimension(nscamx), save ityturt
 class turbulent flux model (=iturt/10) More...
 
integer, dimension(nscamx), save ifltur
 index of the turbulent flux for the scalar iscal More...
 
integer(c_int), pointer, save nvarcl
 number of variable plus number of turbulent fluxes (used by the boundary conditions) More...
 
integer(c_int), pointer, save ivisse
 take $ \divs \left( \mu \transpose{\gradt \, \vect{u}} - 2/3 \mu \trace{\gradt \, \vect{u}} \right) $ into account in the momentum equation More...
 
integer(c_int), pointer, save irevmc
 Reconstruction of the velocity field with the updated pressure option. More...
 
integer(c_int), pointer, save iprco
 Compute the pressure step thanks to the continuity equation. More...
 
integer(c_int), pointer, save irnpnw
 Compute the normed residual for the pressure step in the prediction step. More...
 
real(c_double), pointer, save rnormp
 normed residual for the pressure step More...
 
real(c_double), pointer, save arak
 Arakawa multiplicator for the Rhie and Chow filter (1 by default) More...
 
integer(c_int), pointer, save ipucou
 Pseudo coupled pressure-velocity solver. More...
 
integer(c_int), pointer, save iccvfg
 
integer(c_int), pointer, save idilat
 Algorithm to take into account the density variation in time. More...
 
real(c_double), pointer, save epsdp
 parameter of diagonal pressure strengthening More...
 
integer, dimension(ntypmx), save idebty
 
integer, dimension(ntypmx), save ifinty
 
integer(c_int), pointer, save itbrrb
 accurate treatment of the wall temperature More...
 
integer, dimension(nscamx), save icpsyr
 indicates if the scalar isca is coupled with syrthes More...
 
integer(c_int), pointer, save iphydr
 improve hydrostatic pressure algorithm More...
 
integer(c_int), pointer, save igprij
 improve static pressure algorithm More...
 
integer(c_int), pointer, save igpust
 improve static pressure algorithm More...
 
integer(c_int), pointer, save iifren
 indicates the presence of a Bernoulli boundary face (automatically computed) More...
 
integer(c_int), pointer, save icalhy
 compute the hydrostatic pressure in order to compute the Dirichlet conditions on the pressure at outlets More...
 
integer(c_int), pointer, save irecmf
 use interpolated face diffusion coefficient instead of cell diffusion coefficient for the mass flux reconstruction for the non-orthogonalities More...
 
integer, save icophc
 choice the way to compute the exchange coefficient of the condensation source term used by the copain model More...
 
integer, save icophg
 choice the way to compute the thermal exchange coefficient associated to the heat transfer to wall due to the condensation phenomenon More...
 
integer, save itag1d
 choice the way to compute the wall temperature at the solid/fluid interface coupled with condensation to the wall More...
 
integer, save itagms
 choice the way to compute the wall temperature at the solid/fluid interface coupled with condensation to the metal mass structures wall More...
 
integer, dimension(nestmx), save iescal
 compute error estimators More...
 
integer, save icavit
 cavitation module More...
 
integer, save ncpdct
 Indicateur pertes de charge global (ie somme sur les processeurs de ncepdc) More...
 
integer, save nfpt1t
 Indicateur module thermique 1d global (ie somme sur les processeurs de nfpt1d) More...
 
integer, save nctsmt
 Indicateur termes sources de masse global (ie somme sur les processeurs de ncetsm) More...
 
integer, save nftcdt
 Global indicator of condensation source terms (ie. sum on the processors of nfbpcd) cells associated to the face with condensation phenomenon. More...
 
integer, save iporos
 take the porosity fomulation into account More...
 
integer, save iusini
 
integer, save ineedy
 ineedy : = 1 distance a la paroi est necessaire pour le calcul = 0 distance a la paroi n'est pas necessaire More...
 
integer, save imajdy
 imajdy : = 1 distance a la paroi a ete mise a jour = 0 distance a la paroi n'a pas ete mise a jour More...
 
integer, save icdpar
 icdpar : = 1 calcul standard (et relecture en suite de calcul) = 2 calcul ancien (et relecture en suite de calcul) =-1 forcer le recalcul en suite (par calcul standard) =-2 forcer le recalcul en suite (par calcul ancien) More...
 
integer, save nitmay
 nitmay : nombre max d'iterations pour les resolutions iteratives More...
 
integer, save nswrsy
 nswrsy : nombre de sweep pour reconstruction des s.m. More...
 
integer, save nswrgy
 nswrgy : nombre de sweep pour reconstruction des gradients More...
 
integer, save imligy
 imligy : methode de limitation du gradient More...
 
integer, save ircfly
 ircfly : indicateur pour reconstruction des flux More...
 
integer, save ischcy
 ischcy : indicateur du schema en espace More...
 
integer, save isstpy
 isstpy : indicateur pour test de pente More...
 
integer, save iwarny
 iwarny : niveau d'impression More...
 
integer, save ntcmxy
 ntcmxy : nombre max d'iteration pour la convection de y More...
 
double precision, save blency
 
double precision, save epsily
 
double precision, save epsrsy
 
double precision, save epsrgy
 
double precision, save climgy
 
double precision, save extray
 
double precision, save coumxy
 
double precision, save epscvy
 
double precision, save yplmxy
 
integer, dimension(nscamx), save iscacp
 iscacp : 0 : scalar does not behave like a temperature 1 : scalar behaves like a temperature (use Cp for wall law) > 1 : not yet allowed, could be used for multiple Cp definitions More...
 
integer, dimension(nscamx), save iclvfl
 iclvfl : 0 : clip variances to zero 1 : clip variances to zero and to f(1-f) 2 : clip variances to max(zero,scamin) and scamax More...
 
integer, dimension(nscamx), save iscasp
 iscasp(ii) : index of the ii^th species (0 if not a species) More...
 
double precision, dimension(nscamx), save visls0
 visls0 : viscosity of scalars if constant More...
 
double precision, dimension(nscamx), save sigmas
 sigmas : prandtl of scalars More...
 
double precision, dimension(nscamx), save rvarfl
 rvarfl : coeff de dissipation des variances More...
 
double precision, dimension(nscamx), save ctheta
 ctheta : coefficient des modeles de flux turbulents GGDH et AFM More...
 
integer drift_scalar_add_drift_flux
 flag for computing the drift mass flux: (for coal classes for instance, only the first scalar of a class compute the drift flux of the class and the other scalars use it without recomputing it) More...
 
integer drift_scalar_thermophoresis
 flag for activating thermophoresis for drift scalars More...
 
integer drift_scalar_turbophoresis
 flag for activating turbophoresis for drift scalars More...
 
integer drift_scalar_electrophoresis
 
integer drift_scalar_centrifugalforce
 flag for activating the centrifugal force for drift scalars More...
 

Function/Subroutine Documentation

integer function optcal::iscavr ( integer, intent(in)  iscal)

If scalar iscal represents the mean of the square of a scalar k, return k; otherwise, return 0.

subroutine optcal::piso_options_init ( )

Initialize Fortran PISO options API. This maps Fortran pointers to global C structure members.

subroutine optcal::space_disc_options_init ( )

Initialize Fortran space discretisation options API. This maps Fortran pointers to global C structure members.

subroutine optcal::stokes_options_init ( )

Initialize Fortran Stokes options API. This maps Fortran pointers to global C structure members.

subroutine optcal::thermal_model_init ( )

Initialize Fortran thermal model API. This maps Fortran pointers to global C structure members.

subroutine optcal::time_step_init ( )

Initialize Fortran time step API. This maps Fortran pointers to global C structure members.

subroutine optcal::time_step_options_init ( )

Initialize Fortran time step options API. This maps Fortran pointers to global C structure members.

subroutine optcal::turb_les_model_init ( )

Initialize Fortran LES turbulence model API. This maps Fortran pointers to global C structure members.

subroutine optcal::turb_model_init ( )

Initialize Fortran turbulence model API. This maps Fortran pointers to global C structure members.

subroutine optcal::turb_rans_model_init ( )

Initialize Fortran RANS turbulence model API. This maps Fortran pointers to global C structure members.

subroutine optcal::wall_functions_init ( )

Initialize Fortran wall functions API. This maps Fortran pointers to global C structure members.