doxygen/html/param_8h_source.html

#pragma once


#include "inputoutput.h"

#include <string>

#include <cstdlib>


class domain;


using namespace std;


class param {


    public:


        domain  *domn;

        inputoutput *io;


        int     seed;

        double  tEnd;

        double  domainLength;

        int     ngrd0;

        double  rho0;

        double  kvisc0;

        double  sdiff0;

        double  dPdx;

        double  pres;

        string  chemMechFile;

        string  probType;


        double  Z_param;

        double  A_param;

        double  C_param;

        string  LES_type;

        double  Z_LES;

        double  diffCFL;

        double  cvode_atol;

        double  cvode_rtol;

        double  x0virtual;


        bool    LdoDL;

        bool    Lrad;

        bool    Lbuoyant;

        bool    LPeEddy;

        bool    LplanarExpCent0;

        double  g;

        string  Lsolver;

        bool    Lperiodic;

        bool    Lspatial;

        bool    LTMA;

        bool    LplanarTau;

        bool    Lignition;


        string  bcType;

        int     cCoord;

        double  xDomainCenter;


        double  gDens;

        double  dxmin;

        double  dxmax;


        double  Pmax;

        double  Pav;

        double  dtfac;

        int     nDtSmeanWait;

        int     eddyMinCells;

        double  DAtimeFac;

        double  tdfac;

        int     sLastDA;

        double  Lp;

        double  Lmax;

        double  Lmin;


        int     modDump;

        int     modDisp;

        bool    Ltecplot;


        bool    LmultiPhase;

        double  eSurfTens;


        double  uBClo;

        double  uBChi;

        double  vBClo;

        double  vBChi;

        double  wBClo;

        double  wBChi;

        double  sBClo;

        double  sBChi;

        string  hWallBCtype;

        double  TBClo;

        double  TBChi;


        bool    Lrestart;

        string  rstType;

        double  trst;


        double  umin_spatial;


        //----------------- Radiation variables


        string                      radSolveType;

        string                      radCoefType;

        int                         npsi;

        int                         ntheta;


    private:


        template <class T>


        T errMsg(const string param) {

            *io->ostrm << endl << "ERROR: missing parameter: " + param << endl;

            exit(0);

            T dummy = static_cast<T> (0);

            return dummy;

        }


    public:


        param(inputoutput *p_io);

        void init(domain *p_domn);

        ~param(){}


};


domain
Definition domain.h:34

inputoutput
Definition inputoutput.h:25

inputoutput::ostrm
ostream * ostrm
Runtime: points to cout or to a file.
Definition inputoutput.h:33

param
Definition param.h:23

param::probType
string probType
problem type: CHANNEL, CHANNEL_SCALAR, JETMIXL_RXN, COUETTE
Definition param.h:42

param::DAtimeFac
double DAtimeFac
time until catch-up adaption is DAtimeFac * dtCUmax
Definition param.h:80

param::seed
int seed
random number generator seed (negative to randomize it)
Definition param.h:32

param::nDtSmeanWait
int nDtSmeanWait
number of eddy samples before increase dtSmean
Definition param.h:78

param::cCoord
int cCoord
1 = planar, 2 = cylindrical, 3 = spherical
Definition param.h:68

param::LPeEddy
bool LPeEddy
flag to turn on potential energy for eddies (vertical domain)
Definition param.h:57

param::ntheta
int ntheta
Definition param.h:117

param::LTMA
bool LTMA
true for the triplet map TMA: 3 = vol segments; false for TMB: 3 equal length segments
Definition param.h:63

param::LmultiPhase
bool LmultiPhase
true if domain has more than one phase (particles don't count)
Definition param.h:91

param::diffCFL
double diffCFL
multiplies min diffusion timestep
Definition param.h:49

param::~param
~param()
Definition param.h:137

param::dxmin
double dxmin
min grid spacing: = dxmin / domain length
Definition param.h:72

param::vBChi
double vBChi
Dirichlet velocity boundary condition.
Definition param.h:97

param::radCoefType
string radCoefType
PLANCKMEAN, WSGG, RCSLW.
Definition param.h:115

param::g
double g
gravity (default -9.81)
Definition param.h:59

param::io
inputoutput * io
pointer to io object (has the input file)
Definition param.h:30

param::LplanarExpCent0
bool LplanarExpCent0
flag: for planar cases (C=1) set the expansion center at 0 for outflow cases (normally expand about t...
Definition param.h:58

param::uBChi
double uBChi
Dirichlet velocity boundary condition.
Definition param.h:95

param::sBChi
double sBChi
Dirichlet scalar boundary condition.
Definition param.h:101

param::cvode_atol
double cvode_atol
absolute tolerace atol for cvode
Definition param.h:50

param::sdiff0
double sdiff0
initial uniform scalar diffusivity (m^2/s)
Definition param.h:38

param::eddyMinCells
int eddyMinCells
eddy must overlap at least this many cells
Definition param.h:79

param::TBChi
double TBChi
Required if hWallBCtype = ISOTHERMAL.
Definition param.h:104

param::domainLength
double domainLength
length of domain (m)
Definition param.h:34

param::Lspatial
bool Lspatial
spatial formulation if true
Definition param.h:62

param::Lperiodic
bool Lperiodic
periodic if true
Definition param.h:61

param::vBClo
double vBClo
Dirichlet velocity boundary condition.
Definition param.h:96

param::trst
double trst
restart time (from restart file), default is 0.0;
Definition param.h:108

param::modDump
int modDump
accepted eddies before output file
Definition param.h:87

param::Ltecplot
bool Ltecplot
set TRUE for tecplot friendly output
Definition param.h:89

param::Lignition
bool Lignition
true if starting with unreacted mixing profile to allow ignition
Definition param.h:65

param::ngrd0
int ngrd0
initial grid points
Definition param.h:35

param::Lp
double Lp
Most probable eddy size frac of domainLength.
Definition param.h:83

param::Z_param
double Z_param
Viscous penalty parameter.
Definition param.h:44

param::dPdx
double dPdx
initial pressure gradient (Pa/m)
Definition param.h:39

param::Pmax
double Pmax
maximum eddy acceptance probability
Definition param.h:75

param::gDens
double gDens
grid density for mesher
Definition param.h:71

param::LES_type
string LES_type
NONE, THIRDS, ELAPSEDTIME, FRACDOMAIN, INTEGRALSCALE.
Definition param.h:47

param::xDomainCenter
double xDomainCenter
position of the center of the domain
Definition param.h:69

param::TBClo
double TBClo
Required if hWallBCtype = ISOTHERMAL.
Definition param.h:103

param::Lmax
double Lmax
Max eddy size frac of domainLength.
Definition param.h:84

param::hWallBCtype
string hWallBCtype
ADIABATIC or ISOTHERMAL.
Definition param.h:102

param::C_param
double C_param
Eddy frequency parameter.
Definition param.h:46

param::sBClo
double sBClo
Dirichlet scalar boundary condition.
Definition param.h:100

param::eSurfTens
double eSurfTens
surface tension, J/m2 for liquid phases
Definition param.h:92

param::modDisp
int modDisp
frequency to display results (# eddies)
Definition param.h:88

param::dtfac
double dtfac
maximum factor to increase dtSmean
Definition param.h:77

param::Lrestart
bool Lrestart
true to restart from file, else false
Definition param.h:106

param::Z_LES
double Z_LES
large eddy suppression (nonpositive prevents les test)
Definition param.h:48

param::rstType
string rstType
"single" or "multiple"
Definition param.h:107

param::radSolveType
string radSolveType
OPTHIN, TWOFLUX, FVDOM.
Definition param.h:114

param::x0virtual
double x0virtual
LES virtual origin.
Definition param.h:52

param::rho0
double rho0
initial uniform density (kg/m^3)
Definition param.h:36

param::uBClo
double uBClo
Dirichlet velocity boundary condition.
Definition param.h:94

param::A_param
double A_param
Energy Distribution parameter alpha.
Definition param.h:45

param::Lsolver
string Lsolver
EXPLICIT, SEMI-IMPLICIT, or STRANG.
Definition param.h:60

param::LdoDL
bool LdoDL
flag to do the DL energy from the DL instability
Definition param.h:54

param::pres
double pres
initial pressure (Pa)
Definition param.h:40

param::dxmax
double dxmax
max grid spacing = dxmax / domain length
Definition param.h:73

param::param
param(inputoutput *p_io)
Definition param.cc:24

param::Pav
double Pav
Average acceptance probability.
Definition param.h:76

param::Lbuoyant
bool Lbuoyant
flag to turn on bouyancy (horizontal domain)
Definition param.h:56

param::LplanarTau
bool LplanarTau
true for computing cylindrical/spherical tau_eddy using a planar formulation. If accepted,...
Definition param.h:64

param::kvisc0
double kvisc0
initial uniform kinematic viscosity (m^2/s)
Definition param.h:37

param::bcType
string bcType
OUTFLOW, PERIODIC, WALL, WALL_OUT.
Definition param.h:67

param::tdfac
double tdfac
factor between dtCUmax and dtCFL for temporal flows; DEFAULT = 1.0
Definition param.h:81

param::sLastDA
int sLastDA
size of the lastDA vector for timing adaptmesh after diff
Definition param.h:82

param::domn
domain * domn
pointer to domain object
Definition param.h:29

param::tEnd
double tEnd
ending time of realization
Definition param.h:33

param::umin_spatial
double umin_spatial
min u for spatial flows; used when kernels pull velocity
Definition param.h:110

param::init
void init(domain *p_domn)
Definition param.cc:14

param::chemMechFile
string chemMechFile
name of chemical mechanism file
Definition param.h:41

param::wBClo
double wBClo
Dirichlet velocity boundary condition.
Definition param.h:98

param::errMsg
T errMsg(const string param)
Definition param.h:124

param::Lrad
bool Lrad
radiation flag
Definition param.h:55

param::Lmin
double Lmin
Min eddy size frac of domainLength.
Definition param.h:85

param::npsi
int npsi
Definition param.h:116

param::cvode_rtol
double cvode_rtol
relative tolerace rtol for cvode
Definition param.h:51

param::wBChi
double wBChi
Dirichlet velocity boundary condition.
Definition param.h:99

inputoutput.h
Header file for class inputoutput.