DataArgs Class Reference

#include <dataArgs.h>

Inheritance diagram for DataArgs:

Collaboration diagram for DataArgs:

Public Member Functions
	DataArgs (int nx, int ny, int nz, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax, double endTime)
DataArgs &	sCfl (double cfl)
DataArgs &	sNg (double Ng)
DataArgs &	sGamma (double gamma)
DataArgs &	sSigma (double sigma)
DataArgs &	sCp (double cp)
DataArgs &	sMu1 (double mu1)
DataArgs &	sMu2 (double mu2)
DataArgs &	sReportItersPeriod (int reportItersPeriod)
DataArgs &	sfunctionalSigma (bool functionalSigma)
DataArgs &	sGam (double gam)
DataArgs &	sFrameSkip (double frameSkip)
DataArgs &	sOptionalSimArgs (std::vector< double > optionalSimArgs, std::vector< std::string > optionalSimArgNames, int nOptionalSimArgs)
Public Member Functions inherited from DataArgsBase
	DataArgsBase ()

Additional Inherited Members
Public Attributes inherited from DataArgsBase
double	frameSkip =10
double	endTime
double	cfl =0.5
int	Ng =4
double	gamma =5.0/3.0
double	sigma =1e3
double	cp =0.1
double	t =0
double	dt
double	mu1 =-1.0e4
double	mu2 =1.0e4
int	reportItersPeriod =1
bool	functionalSigma =false
double	gam =12
std::vector< double >	optionalSimArgs
std::vector< std::string >	optionalSimArgNames
int	nOptionalSimArgs =0
int	nx
int	ny
int	nz
double	xmin
double	xmax
double	ymin
double	ymax
double	zmin
double	zmax
int	Ncons
int	Nprims
int	Naux
int	Nx
int	Ny
int	Nz

Detailed Description

Object containing parameters required to populate Data manually (as opposed to from a restart file)

Required parameters must be set in the constructor. Setters are created for each optional parameter to allow creation of the object using chained named parameters, according to the strategy described in (https://isocpp.org/wiki/faq/ctors#named-parameter-idiom).

Definition at line 90 of file dataArgs.h.

Constructor & Destructor Documentation

DataArgs()

DataArgs::DataArgs ( int  nx, int  ny, int  nz, double  xmin, double  xmax, double  ymin, double  ymax, double  zmin, double  zmax, double  endTime  )

inline

Constructor.

Set required parameters to be used by the Data object.

Definition at line 99 of file dataArgs.h.

Member Function Documentation

sCfl()

DataArgs& DataArgs::sCfl ( double  cfl )

inline

Definition at line 110 of file dataArgs.h.

sCp()

DataArgs& DataArgs::sCp ( double  cp )

inline

Definition at line 126 of file dataArgs.h.

sFrameSkip()

DataArgs& DataArgs::sFrameSkip ( double  frameSkip )

inline

Definition at line 150 of file dataArgs.h.

sfunctionalSigma()

DataArgs& DataArgs::sfunctionalSigma ( bool  functionalSigma )

inline

Definition at line 142 of file dataArgs.h.

sGam()

DataArgs& DataArgs::sGam ( double  gam )

inline

Definition at line 146 of file dataArgs.h.

sGamma()

DataArgs& DataArgs::sGamma ( double  gamma )

inline

Definition at line 118 of file dataArgs.h.

sMu1()

DataArgs& DataArgs::sMu1 ( double  mu1 )

inline

Definition at line 130 of file dataArgs.h.

sMu2()

DataArgs& DataArgs::sMu2 ( double  mu2 )

inline

Definition at line 134 of file dataArgs.h.

sNg()

DataArgs& DataArgs::sNg ( double  Ng )

inline

Definition at line 114 of file dataArgs.h.

sOptionalSimArgs()

DataArgs& DataArgs::sOptionalSimArgs ( std::vector< double >  optionalSimArgs, std::vector< std::string >  optionalSimArgNames, int  nOptionalSimArgs  )

inline

Definition at line 156 of file dataArgs.h.

sReportItersPeriod()

DataArgs& DataArgs::sReportItersPeriod ( int  reportItersPeriod )

inline

Definition at line 138 of file dataArgs.h.

sSigma()

DataArgs& DataArgs::sSigma ( double  sigma )

inline

Definition at line 122 of file dataArgs.h.

---

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

• dataArgs.h