|
My Project
programmer's documentation
|
Functions/Subroutines | |
| integer function | iscavr (iscal) |
| If scalar iscal represents the mean of the square of a scalar k, return k; otherwise, return 0. | |
| subroutine | time_step_init |
| Initialize Fortran time step API. This maps Fortran pointers to global C structure members. | |
| subroutine | time_step_options_init |
| Initialize Fortran time step options API. This maps Fortran pointers to global C structure members. | |
| subroutine | thermal_model_init |
| Initialize Fortran thermal model API. This maps Fortran pointers to global C structure members. | |
| subroutine | turb_model_init |
| Initialize Fortran turbulence model API. This maps Fortran pointers to global C structure members. | |
| subroutine | wall_functions_init |
| Initialize Fortran wall functions API. This maps Fortran pointers to global C structure members. | |
| subroutine | turb_rans_model_init |
| Initialize Fortran RANS turbulence model API. This maps Fortran pointers to global C structure members. | |
| subroutine | turb_les_model_init |
| Initialize Fortran LES turbulence model API. This maps Fortran pointers to global C structure members. | |
| subroutine | stokes_options_init |
| Initialize Fortran Stokes options API. This maps Fortran pointers to global C structure members. | |
| subroutine | space_disc_options_init |
| Initialize Fortran space discretisation options API. This maps Fortran pointers to global C structure members. | |
| subroutine | piso_options_init |
| Initialize Fortran PISO options API. This maps Fortran pointers to global C structure members. | |
| subroutine | elec_option_init |
| Initialize Fortran ELEC options API. This maps Fortran pointers to global C structure members. | |
Variables | |
| integer, save | ischtp |
| time order of time stepping | |
| integer, save | istmpf |
| time order of the mass flux scheme The chosen value for istmpf will automatically determine the value given to the variable thetfl. | |
| integer(c_int), pointer, save | nterup |
| number of interations on the pressure-velocity coupling on Navier-Stokes (for the PISO algorithm) | |
| integer, save | isno2t |
| isno2t specifies the time scheme activated for the source terms of the momentum equation, apart from convection and diffusion (for instance: head loss, transposed gradient, ...). | |
| integer, save | isto2t |
| isto2t specifies the time scheme activated for the source terms of the turbulence equations i.e. related to | |
| integer, dimension(nscamx), save | isso2t |
| for each scalar, isso2t specifies the time scheme activated for the source terms of the equation for the scalar, apart from convection and diffusion (for instance: variance production, user-specified terms, ...). | |
| integer, save | initvi |
| initvi : =1 if total viscosity read from checkpoint file | |
| integer, save | initro |
| initro : =1 if density read from checkpoint file | |
| integer, save | initcp |
| initcp : =1 if specific heat read from checkpoint file | |
| integer, dimension(nscamx), save | initvs |
| initvs : =1 if scalar diffusivity read from checkpoint file | |
| double precision, save | thetsn |
The value of | |
| double precision, save | thetst |
The value of | |
| double precision, dimension(nscamx), save | thetss |
The value of | |
| double precision, save | thetfl |
| double precision, save | thetvi |
The value of | |
| double precision, save | thetcp |
The value of | |
| double precision, dimension(nscamx), save | thetvs |
The value of | |
| real(c_double), pointer, save | epsup |
| relative precision for the convergence test of the iterative process on pressure-velocity coupling (PISO) | |
| real(c_double), pointer, save | xnrmu |
| norm of the increment | |
| real(c_double), pointer, save | xnrmu0 |
| norm of | |
| integer(c_int), pointer, save | iflxmw |
| method to compute interior mass flux due to ALE mesh velocity | |
| integer(c_int), pointer, save | imrgra |
| type of gradient reconstruction | |
| real(c_double), pointer, save | anomax |
| non orthogonality angle of the faces, in radians. For larger angle values, cells with one node on the wall are kept in the extended support of the neighboring cells. | |
| integer(c_int), pointer, save | imvisf |
| face viscosity field interpolation | |
| integer, save | isuite |
| 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. | |
| integer, save | ileaux |
| Indicates the reading (=1) or not (=0) of the auxiliary calculation restart file Useful only in the case of a calculation restart. | |
| integer, save | iecaux |
| Indicates the writing (=1) or not (=0) of the auxiliary calculation restart file. | |
| integer, save | isuit1 |
| 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 | |
| integer, save | isuivo |
| For the vortex method, indicates whether the synthetic vortices at the inlet should be initialised or read from the restart file. Useful if iturb = 40, 41, 42 and ivrtex = 1. | |
| integer, save | isuisy |
| Reading of the LES inflow module restart file. -0: not activated -1: activated If isuisy = 1, synthetic fluctuations are not re-initialized in case of restart calculation. Useful if iturb = 40, 41 or 42. | |
| integer(c_int), pointer, save | ntpabs |
| Absolute time step number for previous calculation. | |
| integer(c_int), pointer, save | ntcabs |
| Current absolute time step number. In case of restart, this is equal to ntpabs + number of new iterations. | |
| integer(c_int), pointer, save | ntmabs |
| Maximum absolute time step number. | |
| 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). | |
| real(c_double), pointer, save | ttpabs |
| Absolute time value for previous calculation. | |
| real(c_double), pointer, save | ttcabs |
| Current absolute time. | |
| real(c_double), pointer, save | ttmabs |
| Maximum absolute time. | |
| integer(c_int), pointer, save | iptlro |
| Clip the time step with respect to the buoyant effects. | |
| integer(c_int), pointer, save | idtvar |
| option for a variable time step | |
| real(c_double), pointer, save | dtref |
| Reference time step. | |
| real(c_double), pointer, save | coumax |
| maximum Courant number (when idtvar is different from 0) | |
| real(c_double), pointer, save | cflmmx |
| maximum Courant number for the continuity equation in compressible model | |
| real(c_double), pointer, save | foumax |
| maximum Fourier number (when idtvar is different from 0) | |
| 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. | |
| 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)), ...) | |
| 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)), ...) | |
| double precision, dimension(nvarmx), save | cdtvar |
| multiplicator coefficient for the time step of each variable | |
| real(c_double), pointer, save | relxst |
| relaxation coefficient for the steady algorithm relxst = 1 : no relaxation. | |
| integer(c_int), pointer, save | itherm |
| thermal model | |
| integer(c_int), pointer, save | itpscl |
| Temperature scale. | |
| integer(c_int), pointer, save | iscalt |
| Index of the thermal scalar (temperature, energy or enthalpy) | |
| integer(c_int), pointer, save | iturb |
| turbulence model | |
| integer(c_int), pointer, save | itytur |
| Class of turbulence model (integer value iturb/10) | |
| integer(c_int), pointer, save | irccor |
| Activation of rotation/curvature correction for eddy viscosity turbulence models. | |
| integer(c_int), pointer, save | itycor |
| Type of rotation/curvature correction for eddy viscosity turbulence models. | |
| integer(c_int), pointer, save | idirsm |
| Turbulent diffusion model for second moment closure. | |
| integer(c_int), pointer, save | iwallf |
| Wall functions Indicates the type of wall function used for the velocity boundary conditions on a frictional wall. | |
| integer(c_int), pointer, save | iwalfs |
| Wall functions for scalar. | |
| integer(c_int), pointer, save | iwallt |
| exchange coefficient correlation | |
| integer(c_int), pointer, save | iclkep |
| Indicates the clipping method used for | |
| integer(c_int), pointer, save | igrhok |
| Indicates if the term | |
| integer(c_int), pointer, save | igrake |
| Indicates if the terms related to gravity are taken into account in the equations of | |
| integer(c_int), pointer, save | igrari |
| Indicates if the terms related to gravity are taken into account in the equations of | |
| integer(c_int), pointer, save | ikecou |
| Indicates if the coupling of the source terms of | |
| integer(c_int), pointer, save | reinit_turb |
| Advanced re-init for EBRSM and k-omega models. | |
| integer(c_int), pointer, save | irijco |
| Coupled solving of | |
| integer(c_int), pointer, save | iddes |
| Activation of Hybrid DDES model (only valid for iturb equal to 60) | |
| integer(c_int), pointer, save | irijnu |
| pseudo eddy viscosity in the matrix of momentum equation to partially implicit | |
| integer(c_int), pointer, save | irijrb |
| accurate treatment of | |
| integer(c_int), pointer, save | irijec |
| Indicates if the wall echo terms in | |
| integer(c_int), pointer, save | idifre |
| whole treatment of the diagonal part of the dissusion tensor of | |
| integer(c_int), pointer, save | iclsyr |
| partial implicitation of symmetry BCs of | |
| integer(c_int), pointer, save | iclptr |
| partial implicitation of wall BCs of | |
| 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 | |
| integer(c_int), pointer, save | ivrtex |
| Activates or not the generation of synthetic turbulence at the different inlet boundaries with the LES model (generation of unsteady synthetic eddies). . | |
| integer, save | ikwcln |
| 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) | |
| integer, dimension(nscamx), save | iturt |
| turbulent flux model for | |
| integer, dimension(nscamx), save | ityturt |
| class turbulent flux model (=iturt/10) | |
| integer, save | nvarcl |
| number of variable (deprecated, used only for compatibility) | |
| 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) | |
| integer(c_int), pointer, save | irevmc |
| Reconstruction of the velocity field with the updated pressure option. | |
| integer(c_int), pointer, save | iprco |
| Compute the pressure step thanks to the continuity equation. | |
| real(c_double), pointer, save | arak |
| Arakawa multiplicator for the Rhie and Chow filter (1 by default) | |
| integer(c_int), pointer, save | ipucou |
| indicates the algorithm for velocity/pressure coupling: | |
| integer(c_int), pointer, save | iccvfg |
| indicates whether the dynamic field should be frozen or not: | |
| integer(c_int), pointer, save | idilat |
| Algorithm to take into account the density variation in time. | |
| integer, save | ipredfl |
| Option to switch on massflux predcition befor momentum solving to be fully conservative in momentum over time for variable density flows. This option is to be removed. | |
| real(c_double), pointer, save | epsdp |
| parameter of diagonal pressure strengthening | |
| integer, dimension(ntypmx), save | idebty |
| integer, dimension(ntypmx), save | ifinty |
| integer(c_int), pointer, save | itbrrb |
| accurate treatment of the wall temperature | |
| integer(c_int), pointer, save | iphydr |
| improve static pressure algorithm | |
| integer(c_int), pointer, save | igprij |
| improve static pressure algorithm | |
| integer(c_int), pointer, save | igpust |
| improve static pressure algorithm | |
| integer(c_int), pointer, save | iifren |
| indicates the presence of a Bernoulli boundary face (automatically computed) | |
| integer, save | ifrslb |
| number of the closest free standard outlet (or free inlet) face to xyzp0 | |
| integer, save | itbslb |
| max of ifrslb on all ranks, standard outlet face presence indicator | |
| integer(c_int), pointer, save | icalhy |
| compute the hydrostatic pressure in order to compute the Dirichlet conditions on the pressure at outlets | |
| 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 | |
| logical(c_bool), pointer, save | fluid_solid |
| Has a solid zone where dynamics must be killed? | |
| integer, save | icophc |
| choice the way to compute the exchange coefficient of the condensation source term used by the copain model | |
| integer, save | icophg |
| choice the way to compute the thermal exchange coefficient associated to the heat transfer to wall due to the condensation phenomenon | |
| integer, save | itag1d |
| choice the way to compute the wall temperature at the solid/fluid interface coupled with condensation to the wall | |
| 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 | |
| integer, dimension(nestmx), save | iescal |
| iescal indicates the calculation mode for the error estimator iespre, iesder, iescor or iestot for the Navier-Stokes equation: | |
| 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 | |
| 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. | |
| integer | vof_enabled |
| Volume of Fluid model. | |
| integer | vof_free_surface |
| Free surface model. | |
| integer | vof_merkle_mass_transfer |
| Mass transfer Merkle model for vaporization / condensation (cavitation) | |
| integer, save | ncpdct |
| Indicateur pertes de charge global (ie somme sur les processeurs de ncepdc) | |
| integer, save | nctsmt |
| Indicateur termes sources de masse global (ie somme sur les processeurs de ncetsm) | |
| integer, save | nftcdt |
| Global indicator of condensation source terms (ie. sum on the processors of nfbpcd) cells associated to the face with condensation phenomenon. | |
| integer(c_int), pointer, save | iporos |
| take the porosity fomulation into account | |
| integer, save | iusini |
| integer, save | ineedy |
| integer, save | imajdy |
| integer, save | icdpar |
| Specifies the method used to calculate the distance to the wall y and the non-dimensional distance | |
| 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 | |
| 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 for every scalar iscal representing the average of the square of the fluctuations of another scalar ii= iscavr (iscal) (noted $f$), indicator of the clipping method: | |
| integer, dimension(nscamx), save | iscasp |
| iscasp(ii) : index of the ii^th species (0 if not a species) | |
| double precision, dimension(nscamx), save | visls0 |
| reference molecular diffusivity related to the scalar J ( | |
| double precision, dimension(nscamx), save | rvarfl |
| When iscavr(iscal)>0, rvarfl is the coefficient Useful if and only if there is 1 | |
| double precision, dimension(nscamx), save | ctheta |
| ctheta : coefficient des modeles de flux turbulents GGDH et AFM | |
| 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) | |
| integer | drift_scalar_thermophoresis |
| flag for activating thermophoresis for drift scalars | |
| integer | drift_scalar_turbophoresis |
| flag for activating turbophoresis for drift scalars | |
| integer | drift_scalar_electrophoresis |
| integer | drift_scalar_centrifugalforce |
| flag for activating the centrifugal force for drift scalars | |
| integer | drift_scalar_imposed_mass_flux |
| flag for activating imposed mass flux | |
| integer | drift_scalar_zero_bndy_flux |
| flag for activating imposed mass flux | |
| integer | isotropic_diffusion |
| flag for isotropic diffusion | |
| integer | orthotropic_diffusion |
| flag for orthotropic diffusion | |
| integer | anisotropic_left_diffusion |
| flag for diffusion by a left-multiplied symmetric 3x3 tensor | |
| integer | anisotropic_right_diffusion |
| integer | anisotropic_diffusion |
| flag for diffusion by a symmetric 3x3 tensor | |
| integer(c_int), pointer, save | ngazge |
| ngazge : number of species for electric arc | |
| integer(c_int), pointer, save | ielcor |
| ielcor : 0 : electric arc scaling desactivate 1 : electric arc scaling activate | |
| real(c_double), pointer, save | pot_diff |
| pot_diff : potential between electrods | |
| real(c_double), pointer, save | coejou |
| coejou : scaling coefficient | |
| real(c_double), pointer, save | elcou |
| elcou : current | |
| real(c_double), pointer, save | couimp |
| pot_diff : imposed value for current | |
| integer(c_int), pointer, save | irestrike |
| irestrike : 0 : restrike mode off 1 : restrike mode on | |
| real(c_double), pointer, save | restrike_point_x |
| restrike_point : coordinate of restrike point | |
| real(c_double), pointer, save | restrike_point_y |
| real(c_double), pointer, save | restrike_point_z |
| integer(c_int), pointer, save | ntdcla |
| ntdcla : start iteration for restrike | |
| subroutine elec_option_init |
Initialize Fortran ELEC options API. This maps Fortran pointers to global C structure members.
| integer function iscavr | ( | integer, intent(in) | iscal | ) |
If scalar iscal represents the mean of the square of a scalar k, return k; otherwise, return 0.
| subroutine piso_options_init |
Initialize Fortran PISO options API. This maps Fortran pointers to global C structure members.
| subroutine space_disc_options_init |
Initialize Fortran space discretisation options API. This maps Fortran pointers to global C structure members.
| subroutine stokes_options_init |
Initialize Fortran Stokes options API. This maps Fortran pointers to global C structure members.
| subroutine thermal_model_init |
Initialize Fortran thermal model API. This maps Fortran pointers to global C structure members.
| subroutine time_step_init |
Initialize Fortran time step API. This maps Fortran pointers to global C structure members.
| subroutine time_step_options_init |
Initialize Fortran time step options API. This maps Fortran pointers to global C structure members.
| subroutine turb_les_model_init |
Initialize Fortran LES turbulence model API. This maps Fortran pointers to global C structure members.
| subroutine turb_model_init |
Initialize Fortran turbulence model API. This maps Fortran pointers to global C structure members.
| subroutine turb_rans_model_init |
Initialize Fortran RANS turbulence model API. This maps Fortran pointers to global C structure members.
| subroutine wall_functions_init |
Initialize Fortran wall functions API. This maps Fortran pointers to global C structure members.