Parameters.cpp File Reference

User parameters. More...

#include "Carmen.h"
#include "carmen.par"

Include dependency graph for Parameters.cpp:

Functions
void	InitParameters ()
	Inits parameters from file carmen.par. If a parameter is not mentioned in this file, the default value is used. More...

Variables
real	CarmenVersion =2.483
int	StepNb =2
int	IterationNb =0
int	IterationNbRef =1000
real	CFL =0.5
real	TimeStep =0.
real	PhysicalTime =0.
int	Refresh =0
int	RefreshNb =200
real	PrintTime1 =0.
real	PrintTime2 =0.
real	PrintTime3 =0.
real	PrintTime4 =0.
real	PrintTime5 =0.
real	PrintTime6 =0.
int	PrintIt1 =0
int	PrintIt2 =0
int	PrintIt3 =0
int	PrintIt4 =0
int	PrintIt5 =0
int	PrintIt6 =0
int	PrintEvery =0
int	ImageNb =0
bool	UseBackup = true
bool	Recovery =false
bool	TimeAveraging =false
real	StartTimeAveraging =0.
bool	ComputeCPUTimeRef =false
int	EquationType =7
int	SchemeNb =1
int	LimiterNo =5
int	ScalarEqNb =0
int	DivClean =2
int	Dimension =1
int	Coordinate =1
real	XMin [4] ={-1.,-1.,-1.,-1.}
real	XMax [4] ={1.,1.,1.,1.}
int	CMin [4] ={3,3,3,3}
int	CMax [4] ={3,3,3,3}
bool	UseBoundaryRegions = false
bool	Multiresolution =true
bool	TimeAdaptivity =false
int	TimeAdaptivityFactor = 1
int	ScaleNb =5
int	ScaleNbRef =2
int	IcNb = 0
int	PrintMoreScales =0
real	Tolerance =0.
real	ToleranceScale =1.
real	PenalizeFactor =1.
bool	ConstantTimeStep =true
real	ElapsedTime =0.
real	ExpectedCompression = 0.
bool	CVS =false
bool	LES =false
real	SmoothCoeff =0.
int	ThresholdNorm =0
real	Celerity = 1.
real	Viscosity = 1.
real	Re =100.
real	Pr =0.71
real	Gamma =1.4
real	Ma =0.3
real	Fr =0.
real	TRef =273.
real	Circulation =10.
real	ForceX =0.
real	ForceY =0.
real	ForceZ =0.
real	ModelConstant =0.1
real	ThermalConduction =0.
real	ConstantForce =true
bool	Resistivity =false
bool	Diffusivity =false
bool	ComputeTemp =false
real	eta =0.
real	chi =0.
real	Alpha =0.64
real	Ze =10.
real	Le =1.
real	Sigma =5.E-02
real	DIVB =0.
real	DIVBMax =0.
real	Bdivergence =0.
real	PsiGrad =0.
real	ch =0.0
real	auxvar =0.
bool	debug =false
bool	FluxCorrection =true
int	PostProcessing =2
bool	DataIsBinary =true
bool	ZipData =true
bool	WriteAsPoints =false
real	SpaceStep =0.
real	Eigenvalue =0.
real	EigenvalueX =0.
real	EigenvalueY =0.
real	EigenvalueZ =0.
real	EigenvalueMax =0.
Vector	QuantityMax
Vector	QuantityAverage
real	pi =acos(-1.)
int	StepNo =1
int	IterationNo =0
Timer	CPUTime
int	Cluster =1
int	QuantityNb =2
double	FVTimeRef =0.
int	CellNb =0
int	LeafNb =0
real	TotalLeafNb =0.
real	TotalCellNb =0.
real	ErrorMax =0.
real	ErrorGlobalMax =0.
real	ErrorMid =0.
real	ErrorGlobalMid =0.
real	ErrorL2 =0.
real	ErrorGlobalL2 =0.
int	ErrorNb =0
int	ErrorGlobalNb =0
real	RKFError =0.
real	RKFAccuracyFactor =1.E-03
real	RKFSafetyFactor =0.01
real	cr =0.
real	Helicity =0.
real	GlobalMomentum =0.
real	GlobalEnergy =0.
real	GlobalEnstrophy =0.
real	ExactMomentum =0.
real	ExactEnergy =0.
real	FlameVelocity =0.
real	GlobalMomentumOld =0.
real	GlobalVolume =0.
real	GlobalReactionRate =0.
real	AverageRadius =0.
real	PreviousAverageRadius =0.
real	PreviousAverageRadius2 =0.
real	XCenter [4] ={0.,0.,0.,0.}
real	ReactionRateMax =0.
FILE *	GlobalFile
int	ChildNb =0
real	IntVorticity =0.
real	IntDensity =0.
Vector	IntMomentum
real	IntEnergy =0.
real	BaroclinicEffect =0.
int	rank
int	size
int	CPUScales
real	AllXMin [4]
real	AllXMax [4]
int	AllTaskScaleNb
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 = 1 << 0
int	SendGrad = 1 << 1
int	SendQ = 1 << 2
int	SendQs = 1 << 3
int	SendX = 1 << 4
int	SenddX = 1 << 5
char	BackupName [255]

Detailed Description

User parameters.

Function Documentation

void InitParameters

(

)

Inits parameters from file carmen.par. If a parameter is not mentioned in this file, the default value is used.

Returns

void

— Compute ch --------------------------------------------------------—

{
    // --- Local variables ---------------------------------------------------------------------

    int   i;        // Counter

    // --- Set global variables from file "carmen.par" -----------------------------------------

    #include "carmen.par"

    // --- Adapt IterationNbRef to the dimension -----------------------------------------------

    IterationNbRef=(int)(exp((4.-Dimension)*log(10.)));

    // --- Compute the number of children of a given parent cell ---

    ChildNb = (1<<Dimension);

#if defined PARMPI

    AllTaskScaleNb=ScaleNb;
    for (i=0;i<4;i++)
    {
        AllXMax[i]=XMax[i];
        AllXMin[i]=XMin[i];
    }

    //some combinations give deadlock...
    MPISendType = 10;   //0 - Ibsend; 10 - Isend; 20 - Issend;
    MPIRecvType = 1;    //0 - Recv;  1 - Irecv;

    CPUScales=0;
    int tmp=size;
    while ((tmp=(tmp>>1))>0) CPUScales++;
    ScaleNb-=CPUScales/Dimension;

    one_D=1; two_D=1;
    if (Dimension >= 2) one_D=1<<ScaleNb;
    if (Dimension == 3) two_D=1<<ScaleNb;

//#if defined PARMPI

    NeighbourNb=2;
    MaxCellElementsNb=6;

    // -- Create memory arrays thats are needs for the MPI Type creation ---
    disp = new MPI_Aint[NeighbourNb*MaxCellElementsNb*one_D*two_D];
    blocklen = new int [NeighbourNb*MaxCellElementsNb*one_D*two_D];

    // --- Allocate additional memory for MPI buffer send---
    Cell tc;
    int CellElNb,bufsize;
    CellElNb=tc.size().dimension()+tc.center().dimension()+tc.average().dimension()+tc.tempAverage().dimension()+tc.divergence().dimension();

    if (EquationType==6)
        CellElNb += tc.gradient().lines()*tc.gradient().columns();

    bufsize=(CellElNb*one_D*two_D*NeighbourNb+MPI_BSEND_OVERHEAD)*2*Dimension+1024;
    MPIbuffer=new real[bufsize];
    MPI_Buffer_attach(MPIbuffer,bufsize*sizeof(real));

#else
    NeighbourNb=0;
#endif

#if defined PARMPI
    CreateMPITopology();

  // --- Compute domain coordinates for the processors ---
    XMin[1] = AllXMin[1] + coords[0]*(AllXMax[1]-AllXMin[1])/CartDims[0];
    XMax[1] = AllXMin[1] + (coords[0]+1)*(AllXMax[1]-AllXMin[1])/CartDims[0];

    if (Dimension >= 2)
    {
        XMin[2] = AllXMin[2] + coords[1]*(AllXMax[2]-AllXMin[2])/CartDims[1];
        XMax[2] = AllXMin[2] + (coords[1]+1)*(AllXMax[2]-AllXMin[2])/CartDims[1];
    }

    if (Dimension == 3)
    {
        XMin[3] = AllXMin[3] + coords[2]*(AllXMax[3]-AllXMin[3])/CartDims[2];
        XMax[3] = AllXMin[3] + (coords[2]+1)*(AllXMax[3]-AllXMin[3])/CartDims[2];
    }

    // --- Set the backup file name for the current processor
    sprintf(BackupName,"%d_%d_%d_%s",coords[0],coords[1],coords[2],"carmen.bak");
#else
    sprintf(BackupName,"%s","carmen.bak");
#endif


    // --- Use CVS only if Dimension > 1 -------------------------------------------------------

    if (Dimension == 1)
        CVS = false;

    // --- TimeAveraging always false if not Navier-Stokes -------------------------------------

    if (EquationType != 6)
        TimeAveraging = false;

    // --- If there is no file "carmen.bak", set Recovery=false --------------------------------

    if (!fopen(BackupName,"r"))
        Recovery = false;

    // --- If PrintMoreScales != 0 or 1 with Multiresolution = false, print error and stop ---

    if (!Multiresolution && (!(PrintMoreScales == 0 || PrintMoreScales == -1)) )
    {
        cout << "Parameters.cpp: In method `void InitParameters()':\n";
        cout << "Parameters.cpp: value of PrintMoreScales incompatible with FV computations\n";
        cout << "Parameters.cpp: must be 0 or -1\n";
        cout << "carmen: *** [Parameters.o] Execution error\n";
        cout << "carmen: abort execution.\n";
        exit(1);
    }

    // --- Compute global volume ---------------------------------------------------------------

    GlobalVolume = fabs(XMax[1]-XMin[1]);

    if (Dimension > 1)
        GlobalVolume *= fabs(XMax[2]-XMin[2]);

    if (Dimension > 2)
        GlobalVolume *= fabs(XMax[3]-XMin[3]);

    // --- Compute PostProcessing and DataIsBinary ---------------------------------------------

    // In 1D, use Gnuplot instead of Data Explorer

    if (Dimension == 1 && PostProcessing == 2)
        PostProcessing = 1;

    // In 2D-3D, use Data Explorer instead of Gnuplot

    if (Dimension != 1 && PostProcessing == 1)
        PostProcessing = 2;

    // --- Compute number of conservative quantities -------------------------------------------

    QuantityNb = 9;

    // --- Set the dimension of QuantityMax to QuantityNb ---------------------------------------

    QuantityMax.setDimension(QuantityNb);

    // --- Set the dimension of QuantityAverage to 4 (pressure, vorticity, entropy, volume)

    QuantityAverage.setDimension(4);

    // --- Set the dimension of IntMomentum to dimension ----------------------------------------

    IntMomentum.setDimension(Dimension);

    // --- Compute minimal space step -----------------------------------------------------------

    SpaceStep = fabs(XMax[1]-XMin[1]);

    for (i = 2; i <= Dimension; i++)
        SpaceStep = Min(SpaceStep, fabs(XMax[i]-XMin[i]));

    SpaceStep /= (1<<ScaleNb);

    // --- Compute time step from CFL if TimeStep = 0 -------------------------------------------

    if (TimeStep == 0.)
    {
        if (fabs(Eigenvalue)>0.0e-20)
            TimeStep = CFL*SpaceStep/Eigenvalue;
        else
            TimeStep = 0.0001;
    }
    else
        ConstantTimeStep = true;

    ch = CFL*SpaceStep/TimeStep;

}

Here is the caller graph for this function:

Variable Documentation

int AllTaskScaleNb

Global Scale number

real AllXMax[4]

real AllXMin[4]

Global domain parameters

real Alpha =0.64

Temperature ratio

real auxvar =0.

Auxiliar variable

real AverageRadius =0.

Average radius of the flame ball

char BackupName[255]

real BaroclinicEffect =0.

Intensity of the baroclinic effects

real Bdivergence =0.

Auxilian divergence variable

real CarmenVersion =2.483

Version release

int CartDims[3]

real Celerity = 1.

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

int CellElementsNb

int CellNb =0

Number of cells

real CFL =0.5

Courant-Friedrich-Levy number

real ch =0.0

Divergence cleaning ch parameter

real chi =0.

Artificial diffusion constant

int ChildNb =0

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

real Circulation =10.

Circulation parameter

int Cluster =1

0 for local execution, 1 for cluster

int CMax[4] ={3,3,3,3}

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

int CMin[4] ={3,3,3,3}

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

Timer CommTimer

Communication timer for perfomance analyse

bool ComputeCPUTimeRef =false

True = the reference CPU time is being computed

bool ComputeTemp =false

real ConstantForce =true

False = adapt force to maintain constant energy

bool ConstantTimeStep =true

true = constant TimeStep

int Coordinate =1

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 =0.

Alpha parameter divergence cleaning

bool CVS =false

True = use Donoho thresholding to perform CVS.

bool DataIsBinary =true

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

bool debug =false

true = check if tree is graded

bool Diffusivity =false

True = artificial diffusion. False = no artificial diffusion

int Dimension =1

Dimension (1,2,3)

real DIVB =0.

Divergence of B

real DIVBMax =0.

Maximum divergence of B

int DivClean =2

Divergence cleaning: 1-EGLM 2-GLM

real Eigenvalue =0.

Maximal eigenvalue

real EigenvalueMax =0.

Maximal eigenvalue

real EigenvalueX =0.

Eigenvalue at x direction

real EigenvalueY =0.

Eigenvalue at y direction

real EigenvalueZ =0.

Eigenvalue at z direction

real ElapsedTime =0.

ElapsedTime

int EquationType =7

Type of equation

real ErrorGlobalL2 =0.

Global L2 error on space and time

real ErrorGlobalMax =0.

Global error max on space and time

real ErrorGlobalMid =0.

Global mean error on space and time

int ErrorGlobalNb =0

Number of points for the computation of the global mean error

real ErrorL2 =0.

L2 error on the grid

real ErrorMax =0.

Error Max on the grid

real ErrorMid =0.

Mean error on the grid

int ErrorNb =0

Number of points for the computation of the mean error

real eta =0.

Resistivity function

real ExactEnergy =0.

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

real ExactMomentum =0.

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

real ExpectedCompression = 0.

Expected memory compression

real FlameVelocity =0.

Flame velocity

bool FluxCorrection =true

true = conservative flux correction

real ForceX =0.

real ForceY =0.

real ForceZ =0.

real Fr =0.

Froude number

double FVTimeRef =0.

FV reference CPU time for 1 iteration

real Gamma =1.4

Adiabatic function

real GlobalEnergy =0.

Global energy (only for EquationType = 1 or 2)

real GlobalEnstrophy =0.

Global enstrophy (only for EquationType = 6)

FILE* GlobalFile

Global file

real GlobalMomentum =0.

Global momentum (only for EquationType = 1 or 2)

real GlobalMomentumOld =0.

Old global momentum (only for EquationType = 6)

real GlobalReactionRate =0.

Global reaction rate

real GlobalVolume =0.

Global volume

real Helicity =0.

Time derivative of helicity (must be zero)

int IcNb = 0

Initial condition suavization

int ImageNb =0

Print ImageNb images

real IntDensity =0.

Integral of the density

real IntEnergy =0.

Integral of the energy

Vector IntMomentum

Integral of the modulus of the momentum

real IntVorticity =0.

Integral of the modulus of the vorticity

int IterationNb =0

Number of iterations

int IterationNbRef =1000

Number of iterations for the FV reference computation

int IterationNo =0

Current iteration number

real Le =1.

Lewis number

int LeafNb =0

Number of leaves

bool LES =false

True = use eddy-viscosity.

int LimiterNo =5

Limiter number

real Ma =0.3

Mach number

int MaxCellElementsNb

real ModelConstant =0.1

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

true = Multiresolution, false = FV on fine mesh

int NeighbourNb

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

int one_D

real PenalizeFactor =1.

Factor of penalization (obsolete)

real PhysicalTime =0.

Physical elapsed time

real pi =acos(-1.)

Pi constant

int PostProcessing =2

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

real Pr =0.71

Prandtl number

real PreviousAverageRadius =0.

Previous average radius

real PreviousAverageRadius2 =0.

Previous average radius

int PrintEvery =0

Print every PrintEvery iteration

int PrintIt1 =0

Iteration for print 1

int PrintIt2 =0

Iteration for print 2

int PrintIt3 =0

Iteration for print 3

int PrintIt4 =0

Iteration for print 4

int PrintIt5 =0

Iteration for print 5

int PrintIt6 =0

Iteration for print 6

int PrintMoreScales =0

More scales to print

real PrintTime1 =0.

Time for print 1

real PrintTime2 =0.

Time for print 2

real PrintTime3 =0.

Time for print 3

real PrintTime4 =0.

Time for print 4

real PrintTime5 =0.

Time for print 5

real PrintTime6 =0.

Time for print 6

real PsiGrad =0.

Psi gradient

Vector QuantityAverage

Vector containing the average quantities

Vector QuantityMax

Vector containing the maximal quantities

int QuantityNb =2

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 =100.

Reynolds number

real ReactionRateMax =0.

Maximum of the reaction rate

bool Recovery =false

true = restore data from previous computation

int Refresh =0

/ Refresh rate

int RefreshNb =200

Number of refreshments

bool Resistivity =false

True = resistive model. False = ideal model

real RKFAccuracyFactor =1.E-03

Desired value of RKFError (only if TimeAdaptivity=true)

real RKFError =0.

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

real RKFSafetyFactor =0.01

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

int ScalarEqNb =0

Number of additional scalar equations

int ScaleNb =5

Maximal number of scales allowed

int ScaleNbRef =2

Number of scales for the FV reference computation

int SchemeNb =1

Scheme number

int SendD = 1 << 0

int SenddX = 1 << 5

int SendGrad = 1 << 1

int SendQ = 1 << 2

int SendQs = 1 << 3

int SendX = 1 << 4

real Sigma =5.E-02

Radiation coefficient

int size

Number of processors

real SmoothCoeff =0.

Smoothing coefficient

real SpaceStep =0.

Space step

real StartTimeAveraging =0.

Time where the time-averaging procedure must start

int StepNb =2

Number of steps for the time integration

int StepNo =1

Current step number for the time integration

real ThermalConduction =0.

Dimensionless thermal conduction

int ThresholdNorm =0

Normalization of the wavelet basis for the threshold

bool TimeAdaptivity =false

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

int TimeAdaptivityFactor = 1

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

bool TimeAveraging =false

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

real TimeStep =0.

Time step

real Tolerance =0.

Prescribed tolerance

real ToleranceScale =1.

Scale factor for tolerance (when Tolerance = 0).

real TotalCellNb =0.

Total number of cells for all iterations

real TotalLeafNb =0.

Total number of leaves for all iterations

real TRef =273.

Reference temperature for Sutherland's law

int two_D

bool UseBackup = true

true = use Backup procedure.

bool UseBoundaryRegions = false

true = use file carmen.bc

real Viscosity = 1.

0 or 1. 0 means no viscosity.

int WhatSend

bool WriteAsPoints =false

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

real XCenter[4] ={0.,0.,0.,0.}

Coordinate of the center of the flame ball

real XMax[4] ={1.,1.,1.,1.}

Maximal values of coordinates;

real XMin[4] ={-1.,-1.,-1.,-1.}

Minimal values of coordinates;

real Ze =10.

Equivalent to Beta

bool ZipData =true

true = zip data files