Carmen Code
 All Classes Files Functions Variables Macros Pages
Variables
Parameters.h File Reference

This header contains all parameters as global variables. More...

#include <stdlib.h>
Include dependency graph for Parameters.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Variables

int Cluster
 
int StepNb
 
int StepNo
 
int IterationNb
 
int IterationNbRef
 
int IterationNo
 
real CFL
 
real TimeStep
 
real PhysicalTime
 
Timer CPUTime
 
double FVTimeRef
 
int Refresh
 
int RefreshNb
 
real PrintTime1
 
real PrintTime2
 
real PrintTime3
 
real PrintTime4
 
real PrintTime5
 
real PrintTime6
 
int PrintIt1
 
int PrintIt2
 
int PrintIt3
 
int PrintIt4
 
int PrintIt5
 
int PrintIt6
 
int PrintEvery
 
int ImageNb
 
bool TimeAveraging
 
real StartTimeAveraging
 
bool Recovery
 
bool UseBackup
 
bool ConstantTimeStep
 
real ElapsedTime
 
real SpaceStep
 
bool ComputeCPUTimeRef
 
int SchemeNb
 
int IcNb
 
int LimiterNo
 
int QuantityNb
 
int EquationType
 
int ScalarEqNb
 
int DivClean
 
int Dimension
 
int ChildNb
 
int Coordinate
 
real XMin [4]
 
real XMax [4]
 
int CMin [4]
 
int CMax [4]
 
bool UseBoundaryRegions
 
bool Multiresolution
 
bool TimeAdaptivity
 
int TimeAdaptivityFactor
 
int CellNb
 
int LeafNb
 
real TotalCellNb
 
real TotalLeafNb
 
int ScaleNb
 
int ScaleNbRef
 
int PrintMoreScales
 
real Tolerance
 
real ToleranceScale
 
real ToleranceInit
 
real PenalizeFactor
 
real ExpectedCompression
 
bool CVS
 
bool LES
 
int ThresholdNorm
 
real SmoothCoeff
 
real eta
 
real Gamma
 
bool Resistivity
 
bool Diffusivity
 
real chi
 
real Celerity
 
real Viscosity
 
real Re
 
real Pr
 
real Ma
 
real Fr
 
real TRef
 
real ModelConstant
 
real ThermalConduction
 
real ConstantForce
 
real Circulation
 
bool ComputeTemp
 
real Alpha
 
real Ze
 
real Le
 
real Sigma
 
real ErrorMax
 
real ErrorGlobalMax
 
real ErrorMid
 
real ErrorGlobalMid
 
real ErrorL2
 
real ErrorGlobalL2
 
int ErrorNb
 
int ErrorGlobalNb
 
real cr
 
real Helicity
 
real GlobalMomentum
 
real GlobalEnergy
 
real GlobalEnstrophy
 
real ExactMomentum
 
real ExactEnergy
 
real GlobalMomentumOld
 
real GlobalVolume
 
real EigenvalueZ
 
real EigenvalueY
 
real EigenvalueX
 
real Eigenvalue
 
real EigenvalueMax
 
Vector QuantityMax
 
Vector QuantityAverage
 
real RKFError
 
real RKFAccuracyFactor
 
real RKFSafetyFactor
 
real FlameVelocity
 
real GlobalReactionRate
 
real AverageRadius
 
real PreviousAverageRadius
 
real PreviousAverageRadius2
 
real XCenter [4]
 
real ReactionRateMax
 
real IntVorticity
 
real IntDensity
 
Vector IntMomentum
 
real IntEnergy
 
real BaroclinicEffect
 
real DIVB
 
real DIVBMax
 
real Bdivergence
 
real PsiGrad
 
real ch
 
real auxvar
 
real pi
 
bool debug
 
bool FluxCorrection
 
real CarmenVersion
 
FILE * GlobalFile
 
int PostProcessing
 
bool DataIsBinary
 
bool ZipData
 
bool WriteAsPoints
 
int AllTaskScaleNb
 
int CPUScales
 
int size
 
int rank
 
real AllXMin [4]
 
real AllXMax [4]
 
int NeighbourNb
 
int coords [3]
 
int CartDims [3]
 
int CellElementsNb
 
int MaxCellElementsNb
 
int one_D
 
int two_D
 
int MPISendType
 
int MPIRecvType
 
Timer CommTimer
 
int rank_il
 
int rank_iu
 
int rank_jl
 
int rank_ju
 
int rank_kl
 
int rank_ku
 
int WhatSend
 
int SendD
 
int SendGrad
 
int SendQ
 
int SendQs
 
int SendX
 
int SenddX
 
char BackupName [255]
 

Detailed Description

This header contains all parameters as global variables.

Variable Documentation

int AllTaskScaleNb

Global Scale number

real AllXMax[4]
real AllXMin[4]

Global domain parameters

real Alpha

Temperature ratio

real auxvar

Auxiliar variable

real AverageRadius

Average radius of the flame ball

char BackupName[255]
real BaroclinicEffect

Intensity of the baroclinic effects

real Bdivergence

Auxilian divergence variable

real CarmenVersion

Version release

int CartDims[3]
real Celerity

Advection-diffusion celerity (0, 1, -1)

int CellElementsNb
int CellNb

Number of cells

real CFL

Courant-Friedrich-Levy number

real ch

Divergence cleaning ch parameter

real chi

Artificial diffusion constant

int ChildNb

Number of children for a given parent (equal to 2**Dimension)

real Circulation

Circulation parameter

int Cluster

0 for local execution, 1 for cluster

int CMax[4]

Max. boundary condition (1 = Boundary, 2 = Symetric, 3 = Periodic)

int CMin[4]

Min. boundary condition (1 = Boundary, 2 = Symetric, 3 = Periodic)

Timer CommTimer

Communication timer for perfomance analyse

bool ComputeCPUTimeRef

True = the reference CPU time is being computed

bool ComputeTemp
real ConstantForce

False = adapt force to maintain constant energy

bool ConstantTimeStep

true = constant TimeStep

int Coordinate

1 = Cartesian, 2 = Spherical in x

int coords[3]

Current CPU coodinates in the virtual CPU processors cart

int CPUScales

CPUScales=log2(Number of processors)

Timer CPUTime

Timer for CPU time

real cr

Alpha parameter divergence cleaning

bool CVS

True = use Donoho thresholding to perform CVS.

bool DataIsBinary

true = write data in binary format, false = write data in ASCII format

bool debug

true = check if tree is graded

bool Diffusivity

True = artificial diffusion. False = no artificial diffusion

int Dimension

Dimension (1,2,3)

real DIVB

Divergence of B

real DIVBMax

Maximum divergence of B

int DivClean

Divergence cleaning: 1-EGLM 2-GLM

real Eigenvalue

Maximal eigenvalue

real EigenvalueMax

Maximal eigenvalue

real EigenvalueX

Eigenvalue at x direction

real EigenvalueY

Eigenvalue at y direction

real EigenvalueZ

Eigenvalue at z direction

real ElapsedTime

ElapsedTime

int EquationType

Type of equation

real ErrorGlobalL2

Global L2 error on space and time

real ErrorGlobalMax

Global error max on space and time

real ErrorGlobalMid

Global mean error on space and time

int ErrorGlobalNb

Number of points for the computation of the global mean error

real ErrorL2

L2 error on the grid

real ErrorMax

Error Max on the grid

real ErrorMid

Mean error on the grid

int ErrorNb

Number of points for the computation of the mean error

real eta

Resistivity function

real ExactEnergy

Global energy for the exact solution (only for EquationType = 1 or 2)

real ExactMomentum

Global momentum for the exact solution (only for EquationType = 1 or 2)

real ExpectedCompression

Expected memory compression

real FlameVelocity

Flame velocity

bool FluxCorrection

true = conservative flux correction

real Fr

Froude number

double FVTimeRef

FV reference CPU time for 1 iteration

real Gamma

Adiabatic function

real GlobalEnergy

Global energy (only for EquationType = 1 or 2)

real GlobalEnstrophy

Global enstrophy (only for EquationType = 6)

FILE* GlobalFile

Global file

real GlobalMomentum

Global momentum (only for EquationType = 1 or 2)

real GlobalMomentumOld

Old global momentum (only for EquationType = 6)

real GlobalReactionRate

Global reaction rate

real GlobalVolume

Global volume

real Helicity

Time derivative of helicity (must be zero)

int IcNb

Initial condition suavization

int ImageNb

Print ImageNb images

real IntDensity

Integral of the density

real IntEnergy

Integral of the energy

Vector IntMomentum

Integral of the modulus of the momentum

real IntVorticity

Integral of the modulus of the vorticity

int IterationNb

Number of iterations

int IterationNbRef

Number of iterations for the FV reference computation

int IterationNo

Current iteration number

real Le

Lewis number

int LeafNb

Number of leaves

bool LES

True = use eddy-viscosity.

int LimiterNo

Limiter number

real Ma

Mach number

int MaxCellElementsNb
real ModelConstant

Constant used in the turbulence model

int MPIRecvType
int MPISendType

Type of calling MPI communication functions. See Parameters.cpp for the more information

bool Multiresolution

true = Multiresolution, false = FV on fine mesh

int NeighbourNb

Important parameter: The deep of the inter-CPU domain overlapping

int one_D
real PenalizeFactor

Factor of penalization (obsolete)

real PhysicalTime

Physical elapsed time

real pi

Pi constant

int PostProcessing

1 = Gnuplot, 2 = Data Explorer, 3 = Tecplot

real Pr

Prandtl number

real PreviousAverageRadius

Previous average radius

real PreviousAverageRadius2

Previous average radius

int PrintEvery

Print every PrintEvery iteration

int PrintIt1

Iteration for print 1

int PrintIt2

Iteration for print 2

int PrintIt3

Iteration for print 3

int PrintIt4

Iteration for print 4

int PrintIt5

Iteration for print 5

int PrintIt6

Iteration for print 6

int PrintMoreScales

More scales to print

real PrintTime1

Time for print 1

real PrintTime2

Time for print 2

real PrintTime3

Time for print 3

real PrintTime4

Time for print 4

real PrintTime5

Time for print 5

real PrintTime6

Time for print 6

real PsiGrad

Psi gradient

Vector QuantityAverage

Vector containing the average quantities

Vector QuantityMax

Vector containing the maximal quantities

int QuantityNb

Number of conservative quantites

int rank

Current CPU

int rank_il

axis X, direction - low

int rank_iu

axis X, direction - high

int rank_jl

axis Y, direction - low

int rank_ju
int rank_kl
int rank_ku
real Re

Reynolds number

real ReactionRateMax

Maximum of the reaction rate

bool Recovery

true = restore data from previous computation

int Refresh

/ Refresh rate

int RefreshNb

Number of refreshments

bool Resistivity

True = resistive model. False = ideal model

real RKFAccuracyFactor

Desired value of RKFError (only if TimeAdaptivity=true)

real RKFError

Maximum of the relative errors between RK2 and RK3 (only if TimeAdaptivity=true)

real RKFSafetyFactor

Safety factor for the computation of the time step (only if TimeAdaptivity=true)

int ScalarEqNb

Number of additional scalar equations

int ScaleNb

Maximal number of scales allowed

int ScaleNbRef

Number of scales for the FV reference computation

int SchemeNb

Scheme number

int SendD
int SenddX
int SendGrad
int SendQ
int SendQs
int SendX
real Sigma

Radiation coefficient

int size

Number of processors

real SmoothCoeff

Smoothing coefficient

real SpaceStep

Space step

real StartTimeAveraging

Time where the time-averaging procedure must start

int StepNb

Number of steps for the time integration

int StepNo

Current step number for the time integration

real ThermalConduction

Dimensionless thermal conduction

int ThresholdNorm

Normalization of the wavelet basis for the threshold

bool TimeAdaptivity

true = use time adaptivity (only when Multiresolution = true, dummy else)

int TimeAdaptivityFactor

The factor of time step between two scales is 2^TimeAdaptivityFactor

bool TimeAveraging

true = use a time-averaging grid (only for turbulence)

real TimeStep

Time step

real Tolerance

Prescribed tolerance

real ToleranceInit

Prescribed tolerance for initial condition (obsolete)

real ToleranceScale

Scale factor for tolerance (when Tolerance = 0).

real TotalCellNb

Total number of cells for all iterations

real TotalLeafNb

Total number of leaves for all iterations

real TRef

Reference temperature for Sutherland's law

int two_D
bool UseBackup

true = use Backup procedure.

bool UseBoundaryRegions

true = use file carmen.bc

real Viscosity

0 or 1. 0 means no viscosity.

int WhatSend
bool WriteAsPoints

true = write data as point-values, false = write data as cell-averages

real XCenter[4]

Coordinate of the center of the flame ball

real XMax[4]

Maximal values of coordinates;

real XMin[4]

Minimal values of coordinates;

real Ze

Equivalent to Beta

bool ZipData

true = zip data files