dataArgs.h

Go to the documentation of this file.

#ifndef DATAARGS_H
#define DATAARGS_H

#include <vector>
#include <string>
#include "platformEnv.h"



class DataArgsBase
{
  public:

    // The following Args are written to a checkpoint restart file and can therefore be initialised from file
    // if one is provided. They can also be manually set by the user. 
    // -------------------------------------------------------------------------
    
    int
    nx, ny, nz;            

    double
    xmin, xmax,
    ymin, ymax,            
    zmin, zmax,
    frameSkip=10,          
    endTime,               
    cfl=0.5;               
    int Ng=4;              
    double
    gamma=5.0/3.0,         
    sigma=1e3;             
    int
    Ncons, Nprims, Naux;   

    double
    cp=0.1;                
    double
    t=0,                   
    dt;                    
    int
    Nx, Ny, Nz;            


    // The following Args are never written to a restart file and therefore must always be manually set by the user
    // in all cases. 
    // -------------------------------------------------------------------------
    double mu1=-1.0e4, mu2=1.0e4;              
    int
    reportItersPeriod=1;     
    bool
    functionalSigma=false;       
    double
    gam=12;                   

    std::vector<double> 
    optionalSimArgs;          
    std::vector<std::string>
    optionalSimArgNames;     
    int
    nOptionalSimArgs=0;      

    DataArgsBase() {
    };

};


class DataArgs : public DataArgsBase
{
  public:


    DataArgs(int nx, int ny, int nz,
         double xmin, double xmax,
         double ymin, double ymax,
         double zmin, double zmax,
         double endTime) {
      this->nx = nx; this->ny = ny; this->nz = nz;
      this->xmin = xmin; this->ymin = ymin; this->zmin = zmin;
      this->xmax = xmax; this->ymax = ymax; this->zmax = zmax;
      this->endTime = endTime;
    };

    DataArgs& sCfl(double cfl) {
      this->cfl = cfl; return *this; 
    }

    DataArgs& sNg(double Ng) {
      this->Ng = Ng; return *this; 
    }

    DataArgs& sGamma(double gamma) {
      this->gamma = gamma; return *this; 
    }

    DataArgs& sSigma(double sigma) {
      this->sigma = sigma; return *this; 
    }

    DataArgs& sCp(double cp) {
      this->cp = cp; return *this; 
    }

    DataArgs& sMu1(double mu1) {
      this->mu1 = mu1; return *this; 
    }

    DataArgs& sMu2(double mu2) {
      this->mu2 = mu2; return *this; 
    }

    DataArgs& sReportItersPeriod(int reportItersPeriod) {
      this->reportItersPeriod = reportItersPeriod; return *this; 
    }

    DataArgs& sfunctionalSigma(bool functionalSigma) {
      this->functionalSigma = functionalSigma; return *this; 
    }

    DataArgs& sGam(double gam) {
      this->gam = gam; return *this; 
    }

    DataArgs& sFrameSkip(double frameSkip) {
      this->frameSkip = frameSkip; return *this; 
    }

    // input arrays are copied to memory on this object. The input arrays are unchanged and their memory remains allocated 
    // if optionalSimArgs and optionalSimArgNames have already been defined on this object, they are overwritten
    DataArgs& sOptionalSimArgs(std::vector<double> optionalSimArgs, std::vector<std::string> optionalSimArgNames, int nOptionalSimArgs) {
      this->nOptionalSimArgs = nOptionalSimArgs;
      this->optionalSimArgs = optionalSimArgs;
      this->optionalSimArgNames = optionalSimArgNames;
      return *this;
    }

};

#endif