METHOD
serialCheckpointArgs.h
Go to the documentation of this file.
1 #ifndef SERIALCHECKPOINTARGS_H
2 #define SERIALCHECKPOINTARGS_H
3 
4 #include <vector>
5 #include <string>
6 #include "platformEnv.h"
7 #include "dataArgs.h"
8 
10 
18 {
19  public:
20 
22 
29  const char* name,
30  PlatformEnv *env);
31 
33  this->nx = nx; return *this;
34  }
35 
37  this->ny = ny; return *this;
38  }
39 
41  this->nz = nz; return *this;
42  }
43 
45  this->xmin = xmin; return *this;
46  }
47 
49  this->ymin = ymin; return *this;
50  }
51 
53  this->zmin = zmin; return *this;
54  }
55 
57  this->xmax = xmax; return *this;
58  }
59 
61  this->ymax = ymax; return *this;
62  }
63 
65  this->zmax = zmax; return *this;
66  }
67 
69  this->endTime = endTime; return *this;
70  }
71 
73  this->cfl = cfl; return *this;
74  }
75 
77  this->Ng = Ng; return *this;
78  }
79 
81  this->gamma = gamma; return *this;
82  }
83 
85  this->sigma = sigma; return *this;
86  }
87 
89  this->cp = cp; return *this;
90  }
91 
93  this->mu1 = mu1; return *this;
94  }
95 
97  this->mu2 = mu2; return *this;
98  }
99 
101  this->reportItersPeriod = reportItersPeriod; return *this;
102  }
103 
105  this->functionalSigma = functionalSigma; return *this;
106  }
107 
109  this->gam = gam; return *this;
110  }
111 
113  this->frameSkip = frameSkip; return *this;
114  }
115 
116  // input arrays are copied to memory on this object. The input arrays are unchanged and their memory remains allocated
117  // if optionalSimArgs and optionalSimArgNames are already set on this object, they are overwritten
118  SerialCheckpointArgs& sOptionalSimArgs(std::vector<double> optionalSimArgs, std::vector<std::string> optionalSimArgNames, int nOptionalSimArgs) {
119  this->nOptionalSimArgs = nOptionalSimArgs;
120  this->optionalSimArgs = optionalSimArgs;
121  this->optionalSimArgNames = optionalSimArgNames;
122  return *this;
123  }
124 };
125 
126 #endif
127 
128 
SerialCheckpointArgs & sZmin(double zmin)
SerialCheckpointArgs & sMu2(double mu2)
int Ng
Number of ghost cells.
Definition: dataArgs.h:41
SerialCheckpointArgs(const char *name, PlatformEnv *env)
Constructor.
Object containing parameters required to populate Data from a restart file in serial ...
double sigma
Resistivity.
Definition: dataArgs.h:44
SerialCheckpointArgs & sSigma(double sigma)
SerialCheckpointArgs & sGamma(double gamma)
SerialCheckpointArgs & sGam(double gam)
double xmax
Positional limits of domain in specified direction.
Definition: dataArgs.h:34
PlatformEnv
Definition: platformEnv.h:16
int ny
Number of physical cells in specified direction.
Definition: dataArgs.h:30
SerialCheckpointArgs & sXmax(double xmax)
double cfl
Courant factor.
Definition: dataArgs.h:40
SerialCheckpointArgs & sEndTime(double endTime)
SerialCheckpointArgs & sXmin(double xmin)
int nz
Number of physical cells in specified direction.
Definition: dataArgs.h:30
SerialCheckpointArgs & sfunctionalSigma(bool functionalSigma)
SerialCheckpointArgs & sCfl(double cfl)
int nx
Number of physical cells in specified direction.
Definition: dataArgs.h:30
double zmin
Positional limits of domain in specified direction.
Definition: dataArgs.h:34
SerialCheckpointArgs & sMu1(double mu1)
double endTime
End time of simulation.
Definition: dataArgs.h:38
SerialCheckpointArgs & sNx(int nx)
int reportItersPeriod
Period with which time step data is reported to screen during program execution.
Definition: dataArgs.h:64
SerialCheckpointArgs & sCp(double cp)
SerialCheckpointArgs & sOptionalSimArgs(std::vector< double > optionalSimArgs, std::vector< std::string > optionalSimArgNames, int nOptionalSimArgs)
double ymax
Positional limits of domain in specified direction.
Definition: dataArgs.h:34
SerialCheckpointArgs & sReportItersPeriod(int reportItersPeriod)
SerialCheckpointArgs & sYmax(double ymax)
SerialCheckpointArgs & sYmin(double ymin)
double mu1
Definition: dataArgs.h:62
SerialCheckpointArgs & sNz(int nz)
double frameSkip
Number of timesteps per file output.
Definition: dataArgs.h:38
std::vector< std::string > optionalSimArgNames
Names of optionalSimArgs array elements.
Definition: dataArgs.h:73
SerialCheckpointArgs & sNy(int ny)
SerialCheckpointArgs & sNg(double Ng)
bool functionalSigma
Are we using a functional (vs homogeneous) conductivity?
Definition: dataArgs.h:66
SerialCheckpointArgs & sFrameSkip(double frameSkip)
double xmin
Positional limits of domain in specified direction.
Definition: dataArgs.h:34
std::vector< double > optionalSimArgs
Array of optional arguments that depend on the simulation being run.
Definition: dataArgs.h:71
double cp
Constant divergence cleaning term.
Definition: dataArgs.h:50
double gamma
Adiabatic index.
Definition: dataArgs.h:43
double gam
Exponent in the functional conductivity.
Definition: dataArgs.h:68
int nOptionalSimArgs
Number of elements to include in optionalSimArgs array.
Definition: dataArgs.h:75
double zmax
Positional limits of domain in specified direction.
Definition: dataArgs.h:34
double mu2
Charge mass ratio of specified fluid species, q/m (for two fluid model)
Definition: dataArgs.h:62
double ymin
Positional limits of domain in specified direction.
Definition: dataArgs.h:34
Object containing parameters required to populate Data, including from a restart file ...
Definition: dataArgs.h:20
SerialCheckpointArgs & sZmax(double zmax)