#include <dataArgs.h>

Inheritance diagram for DataArgsBase:

Public Member Functions
	DataArgsBase ()

Public Attributes
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, including from a restart file

: Parameters can be read into DataArgs 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.

Note that the defaults here should be the same as the defaults set in the Data constructor in simData.h that does not use named parameters.

Definition at line 20 of file dataArgs.h.

Constructor & Destructor Documentation

◆ DataArgsBase()

DataArgsBase::DataArgsBase ( )

inline

Constructor.

Definition at line 78 of file dataArgs.h.

Member Data Documentation

◆ cfl

double DataArgsBase::cfl =0.5

Courant factor.

Definition at line 40 of file dataArgs.h.

◆ cp

double DataArgsBase::cp =0.1

Constant divergence cleaning term.

Definition at line 50 of file dataArgs.h.

◆ dt

double DataArgsBase::dt

Width of current timestep.

Definition at line 52 of file dataArgs.h.

◆ endTime

double DataArgsBase::endTime

End time of simulation.

Definition at line 38 of file dataArgs.h.

◆ frameSkip

double DataArgsBase::frameSkip =10

Number of timesteps per file output.

Definition at line 38 of file dataArgs.h.

◆ functionalSigma

bool DataArgsBase::functionalSigma =false

Are we using a functional (vs homogeneous) conductivity?

Definition at line 66 of file dataArgs.h.

◆ gam

double DataArgsBase::gam =12

Exponent in the functional conductivity.

Definition at line 68 of file dataArgs.h.

◆ gamma

double DataArgsBase::gamma =5.0/3.0

Adiabatic index.

Definition at line 43 of file dataArgs.h.

◆ mu1

double DataArgsBase::mu1 =-1.0e4

Definition at line 62 of file dataArgs.h.

◆ mu2

double DataArgsBase::mu2 =1.0e4

Charge mass ratio of specified fluid species, q/m (for two fluid model)

Definition at line 62 of file dataArgs.h.

◆ Naux

int DataArgsBase::Naux

Number of specified variables.

Definition at line 47 of file dataArgs.h.

◆ Ncons

int DataArgsBase::Ncons

Number of specified variables.

Definition at line 47 of file dataArgs.h.

◆ Ng

int DataArgsBase::Ng =4

Number of ghost cells.

Definition at line 41 of file dataArgs.h.

◆ nOptionalSimArgs

int DataArgsBase::nOptionalSimArgs =0

Number of elements to include in optionalSimArgs array.

Definition at line 75 of file dataArgs.h.

◆ Nprims

int DataArgsBase::Nprims

Number of specified variables.

Definition at line 47 of file dataArgs.h.

◆ nx

int DataArgsBase::nx

Number of physical cells in specified direction.

Definition at line 30 of file dataArgs.h.

◆ Nx

int DataArgsBase::Nx

Total number of compute cells in domain in the specified direction.

Definition at line 56 of file dataArgs.h.

◆ ny

int DataArgsBase::ny

Number of physical cells in specified direction.

Definition at line 30 of file dataArgs.h.

◆ Ny

int DataArgsBase::Ny

Total number of compute cells in domain in the specified direction.

Definition at line 56 of file dataArgs.h.

◆ nz

int DataArgsBase::nz

Number of physical cells in specified direction.

Definition at line 30 of file dataArgs.h.

◆ Nz

int DataArgsBase::Nz

Total number of compute cells in domain in the specified direction.

Definition at line 56 of file dataArgs.h.

◆ optionalSimArgNames

std::vector<std::string> DataArgsBase::optionalSimArgNames

Names of optionalSimArgs array elements.

Definition at line 73 of file dataArgs.h.

◆ optionalSimArgs

std::vector<double> DataArgsBase::optionalSimArgs

Array of optional arguments that depend on the simulation being run.

Definition at line 71 of file dataArgs.h.

◆ reportItersPeriod

int DataArgsBase::reportItersPeriod =1

Period with which time step data is reported to screen during program execution.

Definition at line 64 of file dataArgs.h.

◆ sigma

double DataArgsBase::sigma =1e3

Resistivity.

Definition at line 44 of file dataArgs.h.

◆ t

double DataArgsBase::t =0

Current time.

Definition at line 52 of file dataArgs.h.