constants.F90

Go to the documentation of this file.

module constants
 
    ! Define all constants used in the code. This is the *only* module
    ! that is allowed to be imported without an 'only' qualifier.
 
    use precision
#ifndef USE_TAPENADE
#include <petsc/finclude/petsc.h>
    use petsc
#endif
    implicit none
    save
 
    ! Maximum numbers of characters in a string and in a cgns name
 
    integer, parameter :: maxstringlen = 256
    integer, parameter :: maxcgnsnamelen = 32
    integer, parameter :: maxitertypelen = 8
 
    ! Numerical constants
 
    real(kind=realtype), parameter :: pi = 3.1415926535897931_realtype
    real(kind=realtype), parameter :: eps = 1.e-25_realtype
    real(kind=realtype), parameter :: large = 1.e+37_realtype
 
    ! Constants to define the porosity values
 
    integer(kind=porType), parameter :: noflux = -1_portype
    integer(kind=porType), parameter :: boundflux = 0_portype
    integer(kind=porType), parameter :: normalflux = 1_portype
 
    ! Indices in the array of independent variables
 
    integer, parameter :: irho = 1  ! Density
    integer, parameter :: ivx = 2  ! x-Velocity
    integer, parameter :: ivy = 3  ! y-velocity
    integer, parameter :: ivz = 4  ! z-Velocity
    integer, parameter :: irhoe = 5  ! Energy
 
    integer, parameter :: itu1 = 6  ! Turbulent kinetic energy,
    ! SA viscosity
    integer, parameter :: itu2 = 7  ! Dissipation rate, time scale
    integer, parameter :: itu3 = 8  ! Scalar V2
    integer, parameter :: itu4 = 9  ! Scalar F2
    integer, parameter :: itu5 = 10  ! Eddy-viscosity used for
    ! wall functions.
 
    ! Parameters to indicate the position in the work array dw for
    ! turbulence models.
 
    integer, parameter :: idvt = 1  ! Tmp RHS storage; at max a
    ! 2x2 subsystem is solved.
    integer, parameter :: ivort = 3  ! Tmp vort storage
    integer, parameter :: istrain = 3  ! Tmp strain storage
    integer, parameter :: iprod = 3  ! Tmp prod storage
    integer, parameter :: icd = 4  ! Tmp cross term storage
    integer, parameter :: if1sst = 5  ! Tmp F1 (for SST) storage
    integer, parameter :: isct = 4  ! Tmp time scale (for v2f) storage
    integer, parameter :: iscl2 = 5  ! Tmp length scale (for v2f) storage
    integer, parameter :: iqq = 6  ! Central jacobian storage
 
    ! Indices in the array of conservative flow residuals for the
    ! momentum variables.
 
    integer, parameter :: imx = ivx ! x-Momentum
    integer, parameter :: imy = ivy ! y-Momentum
    integer, parameter :: imz = ivz ! z-Momentum
 
    ! Floating point parameters.
 
    real(kind=realtype), parameter :: zero = 0.0_realtype
    real(kind=realtype), parameter :: one = 1.0_realtype
    real(kind=realtype), parameter :: two = 2.0_realtype
    real(kind=realtype), parameter :: three = 3.0_realtype
    real(kind=realtype), parameter :: four = 4.0_realtype
    real(kind=realtype), parameter :: five = 5.0_realtype
    real(kind=realtype), parameter :: six = 6.0_realtype
    real(kind=realtype), parameter :: eight = 8.0_realtype
 
    real(kind=realtype), parameter :: half = 0.5_realtype
    real(kind=realtype), parameter :: third = one / three
    real(kind=realtype), parameter :: fourth = 0.25_realtype
    real(kind=realtype), parameter :: sixth = one / six
    real(kind=realtype), parameter :: eighth = 0.125_realtype
    real(kind=realtype), parameter :: threefourth = 0.75_realtype
    real(kind=realtype), parameter :: sqrtthree = 1.7320508075688772_realtype
 
    ! radian to degree conversion
    real(kind=realtype), parameter :: degtorad = pi / 180.0_realtype
 
    ! String constants
    CHARACTER(*), PARAMETER :: lower_case = 'abcdefghijklmnopqrstuvwxyz'
    CHARACTER(*), PARAMETER :: upper_case = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 
    ! Threshold parameter for real types; the value depends
    ! whether single or double precision is used.
 
#ifdef USE_SINGLE_PRECISION
    real(kind=realtype), parameter :: thresholdreal = 1.e-5_realtype
#else
    real(kind=realtype), parameter :: thresholdreal = 1.e-10_realtype
#endif
 
    ! Definition of the tab and carriage return character.
#ifndef USE_TAPENADE
    character(len=1), parameter :: tabchar = achar(9)
    character(len=1), parameter :: retchar = achar(13)
#endif
 
    integer(kind=intType), parameter :: &
        eulerequations = 1, &
        nsequations = 2, &
        ransequations = 3
 
    integer(kind=intType), parameter :: &
        steady = 1, &
        unsteady = 2, &
        timespectral = 3
 
    integer(kind=intType), parameter :: &
        internalflow = 1, &
        externalflow = 2
 
    integer(kind=intType), parameter :: &
        cpconstant = 1, &
        cptempcurvefits = 2
 
    integer(kind=intType), parameter :: &
        spalartallmaras = 2, &
        spalartallmarasedwards = 3, &
        komegawilcox = 4, &
        komegamodified = 5, &
        ktau = 6, &
        mentersst = 7, &
        v2f = 10
 
    integer(kind=intType), parameter :: &
        strain = 1, &
        vorticity = 2, &
        katolaunder = 3
 
    integer(kind=intType), parameter :: &
        firstorder = 1, &
        secondorder = 2, &
        thirdorder = 3, &
        fourthorder = 4, &
        fifthorder = 5
 
    integer(kind=intType), parameter :: &
        dissscalar = 1, &
        dissmatrix = 2, &
        disscusp = 3, &
        upwind = 9
 
    integer(kind=intType), parameter :: &
        roe = 1, &
        vanleer = 2, &
        ausmdv = 3
 
    integer(kind=intType), parameter :: &
        nolimiter = 2, &
        vanalbeda = 3, &
        minmod = 4
 
    integer(kind=intType), parameter :: &
        noprecond = 1, &
        turkel = 2, &
        choimerkle = 3
 
    integer(kind=intType), parameter :: &
        constantpressure = 1, &
        linextrapolpressure = 2, &
        quadextrapolpressure = 3, &
        normalmomentum = 4
 
    integer(kind=intType), parameter :: &
        constantextrapol = 1, &
        linextrapol = 2
 
    integer(kind=intType), parameter :: &
        nonconservative = 1, &
        conservative = 2
 
    integer(kind=intType), parameter :: &
        precisionsingle = 1, &
        precisiondouble = 2
 
    ! Definition of the parameters for the time integration scheme.
    integer(kind=intType), parameter :: &
        bdf = 1, &
        explicitrk = 2, &
        implicitrk = 3, &
        md = 4
 
    ! Line search parameters
    integer(kind=intType), parameter :: &
        nolinesearch = 0_inttype, &
        cubiclinesearch = 1_inttype, &
        nonmonotonelinesearch = 2_inttype
 
    integer(kind=intType), parameter :: &
        rungekutta = 1, &
        dadi = 2, &
        nllusgs = 3, &
        nllusgsline = 4
 
    integer(kind=intType), parameter :: &
        decoupled = 1, &
        coupled = 2
    integer(kind=intType), parameter :: &
        gmres = 1, &
        adi = 2
 
    integer(kind=intType), parameter :: &
        bcdirichlet0 = 0, &
        bcneumann0 = 1
 
    integer(kind=intType), parameter :: &
        noresaveraging = 0, &
        alwaysresaveraging = 1, &
        alternateresaveraging = 2
 
    integer(kind=intType), parameter :: &
        turbrelaxnotdefined = 0, &
        turbrelaxexplicit = 1, &
        turbrelaximplicit = 2
 
    ! Parameters used for coarsening definition.
    integer(kind=porType), parameter :: &
        leftstarted = -1_portype, &
        regular = 0_portype, &
        rightstarted = 1_portype
 
    ! Parameters used for subsonic inlet bc treatment.
    integer(kind=intType), parameter :: &
        nosubinlet = 0, &
        totalconditions = 1, &
        massflow = 2
    ! Parameters for overset update mdoe
    integer(kind=intType), parameter :: &
        updatefrozen = 0, &
        updatefast = 1, &
        updatefull = 2
 
    integer, parameter :: adtsurfaceadt = 1
    integer, parameter :: adtvolumeadt = 2
    integer(kind=intType), parameter :: ncoormaxlowerlimit = 100000
 
    integer(kind=adtElementType), parameter :: adttriangle = 1
    integer(kind=adtElementType), parameter :: adtquadrilateral = 2
    integer(kind=adtElementType), parameter :: adttetrahedron = 3
    integer(kind=adtElementType), parameter :: adtpyramid = 4
    integer(kind=adtElementType), parameter :: adtprism = 5
    integer(kind=adtElementType), parameter :: adthexahedron = 6
 
    ! BCDefinitions
    integer(kind=intType), parameter :: bcnull = 0
    integer(kind=intType), parameter :: symm = -1
    integer(kind=intType), parameter :: symmpolar = -2
    integer(kind=intType), parameter :: nswalladiabatic = -3
    integer(kind=intType), parameter :: nswallisothermal = -4
    integer(kind=intType), parameter :: eulerwall = -5
    integer(kind=intType), parameter :: farfield = -6
    integer(kind=intType), parameter :: supersonicinflow = -7
    integer(kind=intType), parameter :: subsonicinflow = -8
    integer(kind=intType), parameter :: supersonicoutflow = -9
    integer(kind=intType), parameter :: subsonicoutflow = -10
    integer(kind=intType), parameter :: massbleedinflow = -11
    integer(kind=intType), parameter :: massbleedoutflow = -12
    integer(kind=intType), parameter :: mdot = -13
    integer(kind=intType), parameter :: bcthrust = -14
    integer(kind=intType), parameter :: extrap = -15
    integer(kind=intType), parameter :: b2bmatch = -16
    integer(kind=intType), parameter :: b2bmismatch = -17
    integer(kind=intType), parameter :: slidinginterface = -18
    integer(kind=intType), parameter :: oversetouterbound = -19
    integer(kind=intType), parameter :: domaininterfaceall = -20
    integer(kind=intType), parameter :: domaininterfacerhouvw = -21
    integer(kind=intType), parameter :: domaininterfacep = -22
    integer(kind=intType), parameter :: domaininterfacerho = -23
    integer(kind=intType), parameter :: domaininterfacetotal = -24
    integer(kind=intType), parameter :: bcnotvalid = -25
    !
    !      Number of actual boundary conditions supported by the code
    !      This number refers to bocos, not flow-through BCs
    !      Edit this number when additional boundary conditions are
    !      supported
    !
    integer(kind=intType), parameter :: nbcs = 24
 
    !Block faces on which boundary conditions may be imposed
    integer(kind=intType), parameter :: imin = 1
    integer(kind=intType), parameter :: imax = 2
    integer(kind=intType), parameter :: jmin = 3
    integer(kind=intType), parameter :: jmax = 4
    integer(kind=intType), parameter :: kmin = 5
    integer(kind=intType), parameter :: kmax = 6
 
    integer(kind=intType) :: myintstack(32)
    integer(kind=intType) :: myintptr = 0
 
    ! BC specific input variable counts
    integer(kind=intType), parameter :: nbcvarsubsonicinflow = 17
    integer(kind=intType), parameter :: nbcvarsubsonicoutflow = 1
    integer(kind=intType), parameter :: nbcvarsupersonicinflow = 7
    integer(kind=intType), parameter :: nbcvarisothermalwall = 1
 
    ! Indices of specific familyExcahnge groups based on BC
    integer(kind=intType), parameter :: ibcgroupwalls = 1
    integer(kind=intType), parameter :: ibcgroupinflow = 2
    integer(kind=intType), parameter :: ibcgroupoutflow = 3
    integer(kind=intType), parameter :: ibcgroupsymm = 4
    integer(kind=intType), parameter :: ibcgroupfarfield = 5
    integer(kind=intType), parameter :: ibcgroupoverset = 6
    integer(kind=intType), parameter :: ibcgroupother = 7
 
    integer(kind=intType), parameter :: nfamexchange = 7
 
    ! Constants for tecplot I/O
    real(kind=realtype) :: zonemarker = 299.0
    real(kind=realtype) :: datasectionmarker = 357.0
 
    ! Fringe sort type
    integer(kind=intType), parameter :: sortbydonor = 1
    integer(kind=intType), parameter :: sortbyreceiver = 2
 
    ! Task breakdown for overset connectivity. Note that iComm1
    ! *includes* the surfaceCorrection and donor search times.
    integer(kind=intType), parameter :: iboundingbox = 1
    integer(kind=intType), parameter :: ibuildoverlap = 2
    integer(kind=intType), parameter :: ibuildclusterwalls = 3
    integer(kind=intType), parameter :: icomputecellwallpoint = 4
    integer(kind=intType), parameter :: ibuildadt = 5
    integer(kind=intType), parameter :: ibuildsearchpoints = 6
    integer(kind=intType), parameter :: isurfacecorrection = 7
    integer(kind=intType), parameter :: idonorsearch = 8
    integer(kind=intType), parameter :: ifringeprocessing = 9
    integer(kind=intType), parameter :: icheckdonors = 10
    integer(kind=intType), parameter :: ideterminedonors = 11
    integer(kind=intType), parameter :: iirregularcellcorrection = 12
    integer(kind=intType), parameter :: iflooding = 13
    integer(kind=intType), parameter :: ifinalcommstructures = 14
    integer(kind=intType), parameter :: ifringereduction = 15
    integer(kind=intType), parameter :: itotal = 16
 
    ! Cost functions.
    integer(kind=intType), parameter :: ncostfunction = 104
    integer(kind=intType), parameter :: &
        costfunclift = 1, &
        costfuncdrag = 2, &
        costfuncliftcoef = 3, &
        costfuncdragcoef = 4, &
        costfuncforcex = 5, &
        costfuncforcey = 6, &
        costfuncforcez = 7, &
        costfuncforcexcoef = 8, &
        costfuncforceycoef = 9, &
        costfuncforcezcoef = 10, &
        costfuncmomx = 11, &
        costfuncmomy = 12, &
        costfuncmomz = 13, &
        costfuncmomxcoef = 14, &
        costfuncmomycoef = 15, &
        costfuncmomzcoef = 16, &
        costfunccm0 = 17, &
        costfunccmzalpha = 18, &
        costfunccmzalphadot = 19, &
        costfunccmzq = 20, &
        costfunccmzqdot = 21, &
        costfunccl0 = 22, &
        costfuncclalpha = 23, &
        costfuncclalphadot = 24, &
        costfuncclq = 25, &
        costfuncclqdot = 26, &
        costfunccd0 = 27, &
        costfunccdalpha = 28, &
        costfunccdalphadot = 29, &
        costfunccdq = 30, &
        costfunccdqdot = 31, &
        costfunccfy0 = 32, &
        costfunccfyalpha = 33, &
        costfunccfyalphadot = 34, &
        costfunccfyq = 35, &
        costfunccfyqdot = 36, &
        costfuncbendingcoef = 37, &
        costfuncsepsensor = 38, &
        costfuncsepsensoravgx = 39, &
        costfuncsepsensoravgy = 40, &
        costfuncsepsensoravgz = 41, &
        costfunccavitation = 42, &
        costfuncmdot = 43, &
        costfuncmavgptot = 44, &
        costfuncmavgttot = 45, &
        costfuncmavgrho = 46, &
        costfuncmavgps = 47, &
        costfuncmavgmn = 48, &
        costfuncmavga = 49, &
        costfuncarea = 50, &
        costfuncaxismoment = 51, &
        costfuncflowpower = 52, &
        costfuncforcexpressure = 53, &
        costfuncforceypressure = 54, &
        costfuncforcezpressure = 55, &
        costfuncforcexviscous = 56, &
        costfuncforceyviscous = 57, &
        costfuncforcezviscous = 58, &
        costfuncforcexmomentum = 59, &
        costfuncforceymomentum = 60, &
        costfuncforcezmomentum = 61, &
        costfuncdragpressure = 62, &
        costfuncdragviscous = 63, &
        costfuncdragmomentum = 64, &
        costfuncliftpressure = 65, &
        costfuncliftviscous = 66, &
        costfuncliftmomentum = 67, &
        costfuncforcexcoefpressure = 68, &
        costfuncforcexcoefviscous = 69, &
        costfuncforcexcoefmomentum = 70, &
        costfuncforceycoefpressure = 71, &
        costfuncforceycoefviscous = 72, &
        costfuncforceycoefmomentum = 73, &
        costfuncforcezcoefpressure = 74, &
        costfuncforcezcoefviscous = 75, &
        costfuncforcezcoefmomentum = 76, &
        costfuncliftcoefpressure = 77, &
        costfuncliftcoefviscous = 78, &
        costfuncliftcoefmomentum = 79, &
        costfuncdragcoefpressure = 80, &
        costfuncdragcoefviscous = 81, &
        costfuncdragcoefmomentum = 82, &
        costfuncmavgvx = 83, &
        costfuncmavgvy = 84, &
        costfuncmavgvz = 85, &
        costfunccperror2 = 86, &
        costfuncaavgptot = 87, &
        costfuncaavgps = 88, &
        costfunccpmin = 89, &
        costfunccoforcexx = 90, &
        costfunccoforcexy = 91, &
        costfunccoforcexz = 92, &
        costfunccoforceyx = 93, &
        costfunccoforceyy = 94, &
        costfunccoforceyz = 95, &
        costfunccoforcezx = 96, &
        costfunccoforcezy = 97, &
        costfunccoforcezz = 98, &
        costfunccofliftx = 99, &
        costfunccoflifty = 100, &
        costfunccofliftz = 101, &
        costfuncmavgvi = 102, &
        costfuncsepsensorks = 103, &
        costfuncsepsensorksarea = 104
 
    integer(kind=intType), parameter :: nlocalvalues = 63
    integer(kind=intType), parameter :: &
        ifp = 1, &
        ifv = 4, &
        imp = 7, &
        imv = 10, &
        isepsensor = 13, &
        isepavg = 14, &
        icavitation = 17, &
        iyplus = 18, &
        imassflow = 19, &
        imassptot = 20, &
        imassttot = 21, &
        imassps = 22, &
        iflowmp = 23, &
        iflowfm = 26, &
        iflowmm = 29, &
        imassmn = 32, &
        isigmamn = 33, &
        isigmaptot = 34, &
        ipk = 35, &
        imassa = 36, &
        imassrho = 37, &
        iarea = 38, &
        imassvx = 39, &
        imassvy = 40, &
        imassvz = 41, &
        imassnx = 42, &
        imassny = 43, &
        imassnz = 44, &
        iaxismoment = 45, &
        ipower = 46, &
        icperror2 = 47, &
        iareaptot = 48, &
        iareaps = 49, &
        icpmin = 50, &
        ! the following 3 reserve 3 slots each!
        icoforcex = 51, &
        icoforcey = 54, &
        icoforcez = 57, &
        imassvi = 60, &
        isepsensorks = 61, &
        isepsensorarea = 62, &
        isepsensorksarea = 63
 
    ! Constants for zipper comm
 
    ! Flow-through conditions
    integer(kind=intType), parameter :: nzippflowcomm = 10
 
    integer(kind=intType), parameter :: izippflowp = 5
    integer(kind=intType), parameter :: izippflowgamma = 6
    integer(kind=intType), parameter :: izippflowsface = 7
    integer(kind=intType), parameter :: izippflowx = 8
    integer(kind=intType), parameter :: izippflowy = 9
    integer(kind=intType), parameter :: izippflowz = 10
 
    ! Wall Conditions
    integer(kind=intType), parameter :: nzippwallcomm = 10
 
    integer(kind=intType), parameter :: izippwalltpx = 1
    integer(kind=intType), parameter :: izippwalltpy = 2
    integer(kind=intType), parameter :: izippwalltpz = 3
    integer(kind=intType), parameter :: izippwalltvx = 4
    integer(kind=intType), parameter :: izippwalltvy = 5
    integer(kind=intType), parameter :: izippwalltvz = 6
 
    integer(kind=intType), parameter :: izippwallx = 7
    integer(kind=intType), parameter :: izippwally = 8
    integer(kind=intType), parameter :: izippwallz = 9
 
    ! Metric types
    integer(kind=intType), parameter :: metricvolume = 1
    integer(kind=intType), parameter :: metricskewness = 2
 
end module constants