ParallelCheckpointArgs Class Reference

#include <parallelCheckpointArgs.h>

Inheritance diagram for ParallelCheckpointArgs:

Collaboration diagram for ParallelCheckpointArgs:

Public Member Functions
	ParallelCheckpointArgs (const char *name, ParallelEnv *env)
ParallelCheckpointArgs &	sNx (int nx)
ParallelCheckpointArgs &	sNy (int ny)
ParallelCheckpointArgs &	sNz (int nz)
ParallelCheckpointArgs &	sXmin (double xmin)
ParallelCheckpointArgs &	sYmin (double ymin)
ParallelCheckpointArgs &	sZmin (double zmin)
ParallelCheckpointArgs &	sXmax (double xmax)
ParallelCheckpointArgs &	sYmax (double ymax)
ParallelCheckpointArgs &	sZmax (double zmax)
ParallelCheckpointArgs &	sEndTime (double endTime)
ParallelCheckpointArgs &	sCfl (double cfl)
ParallelCheckpointArgs &	sNg (double Ng)
ParallelCheckpointArgs &	sGamma (double gamma)
ParallelCheckpointArgs &	sSigma (double sigma)
ParallelCheckpointArgs &	sCp (double cp)
ParallelCheckpointArgs &	sMu1 (double mu1)
ParallelCheckpointArgs &	sMu2 (double mu2)
ParallelCheckpointArgs &	sReportItersPeriod (int reportItersPeriod)
ParallelCheckpointArgs &	sfunctionalSigma (bool functionalSigma)
ParallelCheckpointArgs &	sGam (double gam)
ParallelCheckpointArgs &	sFrameSkip (double frameSkip)
ParallelCheckpointArgs &	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 from a restart file in parallel

Parameters are read into CheckpointArgs from a checkpoint restart file. These are then used to initialise Data. This is the best way to make sure that simulation parameters are consistent with the restart file being used for initialisation.

Definition at line 17 of file parallelCheckpointArgs.h.

Constructor & Destructor Documentation

ParallelCheckpointArgs()

ParallelCheckpointArgs::ParallelCheckpointArgs	(	const char *	name,
		ParallelEnv *	env
	)

Constructor.

Reads parameters from a checkpoint restart file into this object for use in Data constructor, using parallel HDF5.

Parameters

name	name of checkpoint file to use for restart, including path and extension
env	environment object containing platform details eg MPI ranks

Member Function Documentation

sCfl()

ParallelCheckpointArgs& ParallelCheckpointArgs::sCfl ( double  cfl )

inline

Definition at line 72 of file parallelCheckpointArgs.h.

sCp()

ParallelCheckpointArgs& ParallelCheckpointArgs::sCp ( double  cp )

inline

Definition at line 88 of file parallelCheckpointArgs.h.

sEndTime()

ParallelCheckpointArgs& ParallelCheckpointArgs::sEndTime ( double  endTime )

inline

Definition at line 68 of file parallelCheckpointArgs.h.

sFrameSkip()

ParallelCheckpointArgs& ParallelCheckpointArgs::sFrameSkip ( double  frameSkip )

inline

Definition at line 112 of file parallelCheckpointArgs.h.

sfunctionalSigma()

ParallelCheckpointArgs& ParallelCheckpointArgs::sfunctionalSigma ( bool  functionalSigma )

inline

Definition at line 104 of file parallelCheckpointArgs.h.

sGam()

ParallelCheckpointArgs& ParallelCheckpointArgs::sGam ( double  gam )

inline

Definition at line 108 of file parallelCheckpointArgs.h.

sGamma()

ParallelCheckpointArgs& ParallelCheckpointArgs::sGamma ( double  gamma )

inline

Definition at line 80 of file parallelCheckpointArgs.h.

sMu1()

ParallelCheckpointArgs& ParallelCheckpointArgs::sMu1 ( double  mu1 )

inline

Definition at line 92 of file parallelCheckpointArgs.h.

sMu2()

ParallelCheckpointArgs& ParallelCheckpointArgs::sMu2 ( double  mu2 )

inline

Definition at line 96 of file parallelCheckpointArgs.h.

sNg()

ParallelCheckpointArgs& ParallelCheckpointArgs::sNg ( double  Ng )

inline

Definition at line 76 of file parallelCheckpointArgs.h.

sNx()

ParallelCheckpointArgs& ParallelCheckpointArgs::sNx ( int  nx )

inline

Definition at line 32 of file parallelCheckpointArgs.h.

sNy()

ParallelCheckpointArgs& ParallelCheckpointArgs::sNy ( int  ny )

inline

Definition at line 36 of file parallelCheckpointArgs.h.

sNz()

ParallelCheckpointArgs& ParallelCheckpointArgs::sNz ( int  nz )

inline

Definition at line 40 of file parallelCheckpointArgs.h.

sOptionalSimArgs()

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

inline

Definition at line 118 of file parallelCheckpointArgs.h.

sReportItersPeriod()

ParallelCheckpointArgs& ParallelCheckpointArgs::sReportItersPeriod ( int  reportItersPeriod )

inline

Definition at line 100 of file parallelCheckpointArgs.h.

sSigma()

ParallelCheckpointArgs& ParallelCheckpointArgs::sSigma ( double  sigma )

inline

Definition at line 84 of file parallelCheckpointArgs.h.

sXmax()

ParallelCheckpointArgs& ParallelCheckpointArgs::sXmax ( double  xmax )

inline

Definition at line 56 of file parallelCheckpointArgs.h.

sXmin()

ParallelCheckpointArgs& ParallelCheckpointArgs::sXmin ( double  xmin )

inline

Definition at line 44 of file parallelCheckpointArgs.h.

sYmax()

ParallelCheckpointArgs& ParallelCheckpointArgs::sYmax ( double  ymax )

inline

Definition at line 60 of file parallelCheckpointArgs.h.

sYmin()

ParallelCheckpointArgs& ParallelCheckpointArgs::sYmin ( double  ymin )

inline

Definition at line 48 of file parallelCheckpointArgs.h.

sZmax()

ParallelCheckpointArgs& ParallelCheckpointArgs::sZmax ( double  zmax )

inline

Definition at line 64 of file parallelCheckpointArgs.h.

sZmin()

ParallelCheckpointArgs& ParallelCheckpointArgs::sZmin ( double  zmin )

inline

Definition at line 52 of file parallelCheckpointArgs.h.

---

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

• parallelCheckpointArgs.h