Saras
Finite   Difference   Solver   for   Fluid   Dynamics   Simulations
Public Member Functions | Public Attributes | List of all members
parser Class Reference

Contains all the global variables set by the user through the yaml file. More...

#include "lib/io/parser.h"

Public Member Functions

void writeParams ()
 Function to write all the parameter values to I/O. More...
 

Public Attributes

int ioCnt
 
int rbcType
 
int nThreads
 
int npY
 
int npX
 
int forceType
 
int solnFormat
 
int xInd
 
int yInd
 
int zInd
 
int resType
 
int vcDepth
 
int vcCount
 
int gsSmooth
 
int preSmooth
 
int postSmooth
 
int icType
 
int dScheme
 
int iScheme
 
int probType
 
int xGrid
 
int yGrid
 
int zGrid
 
bool useCFL
 
bool nonHgBC
 
bool readProbes
 
bool restartFlag
 
bool printResidual
 
bool xPer
 
bool yPer
 
bool zPer
 
real Re
 
real Ra
 
real Pr
 
real Ta
 
real Ro
 
real fwInt
 
real rsInt
 
real prInt
 
real Lx
 
real Ly
 
real Lz
 
real tStp
 
real tMax
 
real patchRadius
 
real courantNumber
 
real betaX
 
real betaY
 
real betaZ
 
real cnTolerance
 
real mgTolerance
 
std::vector< blitz::TinyVector< int, 3 > > probesList
 

Detailed Description

Contains all the global variables set by the user through the yaml file.

The class parses the paramters.yaml file and stores all the simulation paramters in publicly accessible constants. The class also has a function to check the consistency of the user set paramters and throw exceptions. The class is best initialized as a constant to prevent inadvertent tampering of the global variables it contains.

Member Function Documentation

◆ writeParams()

void parser::writeParams ( )

Function to write all the parameter values to I/O.

     All the user set parameters have to be written to I/O so that the runlog or any out file
     contains all the relevant information about the case that was run.
     This public function has to be called from the solver by one rank only.

The documentation for this class was generated from the following files: