8.1
general documentation
Modules | Functions/Subroutines | Variables
optcal.f90 File Reference

Module for calculation options. More...

Modules

module  optcal
 

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...
 
double precision function visls0 (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 turb_hybrid_model_init
 Initialize Fortran hybrid turbulence model API. This maps Fortran pointers to global C structure members. More...
 
subroutine velocity_pressure_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 time_scheme_options_init
 Initialize Fortran time scheme options API. This maps Fortran pointers to global C structure members. More...
 
subroutine restart_auxiliary_options_init
 Initialize Fortran auxiliary options API. This maps Fortran pointers to global C structure members. More...
 
subroutine elec_option_init
 Initialize Fortran ELEC options API. This maps Fortran pointers to global C structure members. More...
 

Variables

integer(c_int), pointer, save ischtp
 Time order of time stepping (see cs_time_scheme_t::time_order). More...
 
integer(c_int), pointer, save istmpf
 Time order of the mass flux scheme. (see cs_time_scheme_t::istmpf). More...
 
integer(c_int), pointer, save nterup
 number of iterations on the velocity-pressure coupling on Navier-Stokes (for the U/P inner iterations scheme) More...
 
integer(c_int), pointer, save isno2t
 Time scheme for source terms of momentum equations (see cs_time_scheme_t::isno2t). More...
 
integer(c_int), pointer, save isto2t
 Time scheme for source terms of turbulence equations (see cs_time_scheme_t::isto2t). More...
 
integer, save initvi = 0
 initvi : =1 if total viscosity read from checkpoint file More...
 
integer, save initro = 0
 initro : =1 if density read from checkpoint file More...
 
integer, save initcp = 0
 initcp : =1 if specific heat read from checkpoint file More...
 
real(c_double), pointer, save thetsn
 Value of $theta_S$ (see cs_time_scheme_t::thetsn). More...
 
real(c_double), pointer, save thetst
 Value of $theta$ (see cs_time_scheme_t::thetst). More...
 
real(c_double), pointer, save thetvi
 Value of $theta$ for total viscoity (see cs_time_scheme_t::thetvi). More...
 
real(c_double), pointer, save thetcp
 Value of $theta$ for specific heat (see cs_time_scheme_t::thetcp). More...
 
real(c_double), pointer, save epsup
 relative precision for the convergence test of the iterative process on velocity-pressure coupling (inner iterations) More...
 
real(c_double), pointer, save xnrmu
 norm of the increment $ \vect{u}^{k+1} - \vect{u}^k $ of the iterative process on velocity-pressure coupling (inner iterations) More...
 
real(c_double), pointer, save xnrmu0
 norm of $ \vect{u}^0 $ (used by velocity-pressure inner iterations) 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...
 
integer(c_int), pointer, save imvisf
 face viscosity field interpolation More...
 
integer, save isuite = 0
 Indicator of a calculation restart (=1) or not (=0). This value is set automatically by the code; depending on whether a restart directory is present, and should not be modified by the user (no need for C mapping). More...
 
integer(c_int), pointer, save ileaux
 Indicates the reading (=1) or not (=0) of the auxiliary calculation restart file
Useful only in the case of a calculation restart. More...
 
integer(c_int), pointer, save iecaux
 Indicates the writing (=1) or not (=0) of the auxiliary calculation restart file. More...
 
integer, save isuit1 = -1
  For the 1D wall thermal module, activation (1) or not(0) of the reading of the mesh and of the wall temperature from the restart file Useful if nfpt1d > 0 More...
 
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 (for all steps between 0 and ntinit, pressure is re-set to 0 before prediction correction). More...
 
real(c_double), pointer, save ttpabs
 Absolute time value for previous calculation. More...
 
real(c_double), pointer, save ttcabs
 Current absolute time. More...
 
real(c_double), pointer, save ttmabs
 Maximum absolute time. 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
 maximum allowed relative increase in the calculated time step value between two successive time steps (to ensure stability, any decrease in the time step is immediate and without limit).
Useful when idtvar is different from 0. More...
 
real(c_double), pointer, save dtmin
 lower limit for the calculated time step when idtvar is different from 0.
Take dtmin = min (ld/ud, sqrt(lt/(gdelta rho/rho)), ...) More...
 
real(c_double), pointer, save dtmax
 upper limit for the calculated time step when idtvar is different from 0.
Take dtmax = max (ld/ud, sqrt(lt/(gdelta rho/rho)), ...) More...
 
real(c_double), pointer, save relxst
 relaxation coefficient for the steady algorithm relxst = 1 : no relaxation. More...
 
integer(c_int), pointer, save itherm
 thermal model More...
 
integer(c_int), pointer, save itpscl
 Temperature scale. More...
 
integer, save iscalt = -1
 Index of the thermal scalar (temperature, energy or enthalpy) More...
 
integer(c_int), pointer, save iturb
  turbulence model More...
 
integer(c_int), pointer, save itytur
 Class of turbulence model (integer value iturb/10) More...
 
integer(c_int), pointer, save hybrid_turb
 Activation of Hybrid RANS/LES model (only valid for iturb equal to 60 or 51) 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 Indicates the type of wall function used for the velocity boundary conditions on a frictional wall. More...
 
integer(c_int), pointer, save iwalfs
 Wall functions for scalar. More...
 
integer(c_int), pointer, save iclkep
 Indicates the clipping method used for $k$ and $\varepsilon$, for the $k-\epsilon$ and v2f models. More...
 
integer(c_int), pointer, save igrhok
 Indicates if the term $\frac{2}{3}\grad \rho k$ is taken into account in the velocity equation. More...
 
integer(c_int), pointer, save igrake
 Indicates if the terms related to gravity are taken into account in the equations of $k-\epsilon$. More...
 
integer(c_int), pointer, save igrari
 Indicates if the terms related to gravity are taken into account in the equations of $R_{ij}-\varepsilon$. More...
 
integer(c_int), pointer, save ikecou
 Indicates if the coupling of the source terms of $k$ and $\epsilon$ or $k$ and $\omega$ is taken into account or not. 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 cs_boundary_condition_set_coeffs) More...
 
integer(c_int), pointer, save irijec
 Indicates if the wall echo terms in $R_{ij}-\epsilon$ LRR model are taken into account: More...
 
integer(c_int), pointer, save idifre
 whole treatment of the diagonal part of the diffusion 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
 Activates or the van Driest wall-damping for the Smagorinsky constant (the Smagorinsky constant is multiplied by the damping function $1-e^{-y^+/ cdries}$, where $y^+$ designates the non-dimensional distance to the nearest wall). More...
 
integer(c_int), pointer, save iicc
 Applied or not the Internal Consistency Constraint (ICC) for the HTLES model, in order to recover the correct RANS behavior when the energy ratio is forced to one in the RANS region: More...
 
integer(c_int), pointer, save ishield
 Applied or not the two-fold shielding function ( $f_s(\xi_K,\xi_D)$ of HTLES, to properly control the RANS-to-LES transition in the vicinity of the wall: More...
 
integer, save ikwcln = 1
 Wall boundary condition on omega in k-omega SST 0: Deprecated Neumann boundary condition 1: Dirichlet boundary condition consistent with Menter's original model: w_wall = 60*nu/(beta*d**2) More...
 
integer(c_int), pointer, save i_les_balance
 Activates or not the LES balance module. More...
 
integer, save nvarcl
 number of variable (deprecated, used only for compatibility) More...
 
integer(c_int), pointer, save ivisse
 Indicates whether the source terms in transposed gradient and velocity divergence should be taken into account in the momentum equation. In the compressible module, these terms also account for the volume viscosity (cf. viscv0 and iviscv) $\partial_i \left[(\kappa -2/3\,(\mu+\mu_t))\partial_k U_k \right] + \partial_j \left[ (\mu+\mu_t)\partial_i U_j \right]$: 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...
 
real(c_double), pointer, save arak
 Arakawa multiplicator for the Rhie and Chow filter (1 by default) More...
 
integer(c_int), pointer, save rcfact
 Factor of the Rhie and Chow filter: More...
 
integer(c_int), pointer, save staggered
 1D staggered scheme option: More...
 
integer(c_int), pointer, save itpcol
 Time scheme option: More...
 
integer(c_int), pointer, save ipucou
 indicates the algorithm for velocity-pressure coupling: More...
 
integer(c_int), pointer, save iccvfg
  indicates whether the dynamic field should be frozen or not: More...
 
integer(c_int), pointer, save idilat
 Algorithm to take into account the density variation in time. More...
 
integer(c_int), pointer, save ipredfl
 Option to switch on massflux prediction before momentum solving to be fully conservative in momentum over time for variable density flows. This option is to be removed. More...
 
real(c_double), pointer, save epsdp
 parameter of diagonal pressure strengthening More...
 
integer(c_int), pointer, save itbrrb
 accurate treatment of the wall temperature More...
 
integer(c_int), pointer, save iphydr
 Improved pressure interpolation scheme. See cs_velocity_pressure_param_t::iphydr. More...
 
integer(c_int), pointer, save igprij
 Improved pressure interpolation scheme. See cs_velocity_pressure_param_t::igprij. More...
 
integer(c_int), pointer, save igpust
 Improved pressure interpolation scheme. See cs_velocity_pressure_param_t::igpust. 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...
 
logical(c_bool), pointer, save fluid_solid
 Has a solid zone where dynamics must be killed? More...
 
integer(c_int), pointer, save n_buoyant_scal
 n_buoyant_scal is the number of buoyant scalar It will be zero if there is no buoyant scalar More...
 
integer(c_int), pointer, save iprcdo
 Dicretization method for pressure. More...
 
integer(c_int), pointer, save ivofmt
 VoF model (sum of masks defining VoF model and submodels). See defined masks in Masks used to specify Volume of Fluid models. More...
 
integer(c_int), pointer, save idrift
 
integer vof_enabled
 Volume of Fluid model. More...
 
integer vof_free_surface
 Free surface model. More...
 
integer vof_merkle_mass_transfer
 Mass transfer Merkle model for vaporization / condensation (cavitation) More...
 
integer, save ncpdct = 0
 Global head losses indicator (ie number of head loss zones) More...
 
integer, save nctsmt = 0
 Indicateur termes sources de masse global (ie somme sur les processeurs de ncetsm) More...
 
integer, save nftcdt = 0
 Global indicator of condensation source terms (ie. sum on the processors of nfbpcd) cells associated to the face with condensation phenomenon. More...
 
integer(c_int), pointer, save iporos
  take the porosity fomulation into account More...
 
integer, save ineedy = 0
 
integer, save imajdy = 0
 
integer, save icdpar = -999
 Specifies the method used to calculate the distance to the wall y and the non-dimensional distance $ y+ $ for all the cells of the calculation domain (when necessary): More...
 
integer, dimension(nscamx), save iscasp
 iscasp(ii) : index of the ii^th species (0 if not a species) 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...
 
integer drift_scalar_imposed_mass_flux
 flag for activating imposed mass flux More...
 
integer drift_scalar_zero_bndy_flux
 flag for seting the mass flux to zero at all boundaries More...
 
integer drift_scalar_zero_bndy_flux_at_walls
 flag for seting the mass flux to zero at walls only More...
 
integer isotropic_diffusion
 flag for isotropic diffusion More...
 
integer orthotropic_diffusion
 flag for orthotropic diffusion More...
 
integer anisotropic_left_diffusion
 flag for diffusion by a left-multiplied symmetric 3x3 tensor More...
 
integer anisotropic_right_diffusion
 
integer anisotropic_diffusion
 flag for diffusion by a symmetric 3x3 tensor More...
 
integer(c_int), pointer, save ielcor
 ielcor : 0 : electric arc scaling desactivate 1 : electric arc scaling activate More...
 
real(c_double), pointer, save pot_diff
 pot_diff : potential between electrods More...
 
real(c_double), pointer, save coejou
 coejou : scaling coefficient More...
 
real(c_double), pointer, save elcou
 elcou : current More...
 

Detailed Description

Module for calculation options.