BG_Flood  0.8
Documentation (Work-in-progress)
Param Class Reference

#include <Param.h>

Public Attributes

int test = -1
 
double g = 9.81
 
double rho = 1025.0
 
double eps = 0.0001
 
double dt = 0.0
 
double CFL = 0.5
 
double theta = 1.3
 
double VelThreshold = -1.0
 
int frictionmodel = 0
 
double cf = 0.0001
 
double Cd = 0.002
 
bool windforcing = false
 
bool atmpforcing = false
 
bool rainforcing = false
 
bool infiltration = false
 
bool conserveElevation = false
 
bool wetdryfix = true
 
bool leftbnd = false
 
bool rightbnd = false
 
bool topbnd = false
 
bool botbnd = false
 
double Pa2m = 0.00009916
 
double Paref = 101300.0
 
double lat = 0.0
 
int GPUDEVICE = 0
 
int doubleprecision = 0
 
int engine = 1
 
double dx = nan("")
 
double delta
 
int nx = 0
 
int ny = 0
 
int nblk = 0
 
int blkwidth = 16
 
int blkmemwidth = 0
 
int blksize = 0
 
int halowidth = 1
 
double xo = nan("")
 
double yo = nan("")
 
double ymax = nan("")
 
double xmax = nan("")
 
double grdalpha = nan("")
 
int posdown = 0
 
int spherical = 0
 
double Radius = 6371220.
 
double mask = 9999.0
 
int initlevel = 0
 
int maxlevel = 0
 
int minlevel = 0
 
int nblkmem = 0
 
int navailblk = 0
 
double membuffer = 1.05
 
double outputtimestep = 0.0
 
double endtime = 0.0
 
double totaltime = 0.0
 
double dtinit = -1
 
double dtmin = 0.0005
 
double zsinit = nan("")
 
double zsoffset = nan("")
 
std::string hotstartfile
 
int hotstep = 0
 
clock_t startcputime
 
clock_t endcputime
 
clock_t setupcputime
 
size_t GPU_initmem_byte
 
size_t GPU_totalmem_byte
 
std::vector< TSoutnodeTSnodesout
 
std::string outfile = "Output.nc"
 
std::vector< std::string > outvars
 
double wet_threshold = 0.1
 
std::vector< outzonePoutzone
 
int maxTSstorage = 16384
 
bool resetmax = false
 
bool outmax = false
 
bool outmean = false
 
bool outtwet = false
 
int outishift = 0
 
int outjshift = 0
 
int nrivers = 0
 
int nblkriver = 0
 
int nbndblkleft = 0
 
int nbndblkright = 0
 
int nbndblktop = 0
 
int nbndblkbot = 0
 
int nmaskblk = 0
 
int smallnc = 1
 
float scalefactor = 0.01f
 
float addoffset = 0.0f
 
double deformmaxtime = 0.0
 
bool rainbnd = false
 
std::string AdaptCrit
 
int * AdaptCrit_funct_pointer
 
std::string Adapt_arg1
 
std::string Adapt_arg2
 
std::string Adapt_arg3
 
std::string Adapt_arg4
 
std::string Adapt_arg5
 
int adaptmaxiteration = 20
 

Detailed Description

A class. A class for holding model parameters.

Member Data Documentation

◆ Adapt_arg1

std::string Param::Adapt_arg1

◆ Adapt_arg2

std::string Param::Adapt_arg2

◆ Adapt_arg3

std::string Param::Adapt_arg3

◆ Adapt_arg4

std::string Param::Adapt_arg4

◆ Adapt_arg5

std::string Param::Adapt_arg5

◆ AdaptCrit

std::string Param::AdaptCrit

◆ AdaptCrit_funct_pointer

int* Param::AdaptCrit_funct_pointer

◆ adaptmaxiteration

int Param::adaptmaxiteration = 20

◆ addoffset

float Param::addoffset = 0.0f

◆ atmpforcing

bool Param::atmpforcing = false

◆ blkmemwidth

int Param::blkmemwidth = 0

◆ blksize

int Param::blksize = 0

◆ blkwidth

int Param::blkwidth = 16

◆ botbnd

bool Param::botbnd = false

◆ Cd

double Param::Cd = 0.002

◆ cf

double Param::cf = 0.0001

◆ CFL

double Param::CFL = 0.5

◆ conserveElevation

bool Param::conserveElevation = false

◆ deformmaxtime

double Param::deformmaxtime = 0.0

◆ delta

double Param::delta

◆ doubleprecision

int Param::doubleprecision = 0

◆ dt

double Param::dt = 0.0

◆ dtinit

double Param::dtinit = -1

◆ dtmin

double Param::dtmin = 0.0005

◆ dx

double Param::dx = nan("")

◆ endcputime

clock_t Param::endcputime

◆ endtime

double Param::endtime = 0.0

◆ engine

int Param::engine = 1

◆ eps

double Param::eps = 0.0001

◆ frictionmodel

int Param::frictionmodel = 0

◆ g

double Param::g = 9.81

◆ GPU_initmem_byte

size_t Param::GPU_initmem_byte

◆ GPU_totalmem_byte

size_t Param::GPU_totalmem_byte

◆ GPUDEVICE

int Param::GPUDEVICE = 0

◆ grdalpha

double Param::grdalpha = nan("")

◆ halowidth

int Param::halowidth = 1

◆ hotstartfile

std::string Param::hotstartfile

◆ hotstep

int Param::hotstep = 0

◆ infiltration

bool Param::infiltration = false

◆ initlevel

int Param::initlevel = 0

◆ lat

double Param::lat = 0.0

◆ leftbnd

bool Param::leftbnd = false

◆ mask

double Param::mask = 9999.0

◆ maxlevel

int Param::maxlevel = 0

◆ maxTSstorage

int Param::maxTSstorage = 16384

◆ membuffer

double Param::membuffer = 1.05

◆ minlevel

int Param::minlevel = 0

◆ navailblk

int Param::navailblk = 0

◆ nblk

int Param::nblk = 0

◆ nblkmem

int Param::nblkmem = 0

◆ nblkriver

int Param::nblkriver = 0

◆ nbndblkbot

int Param::nbndblkbot = 0

◆ nbndblkleft

int Param::nbndblkleft = 0

◆ nbndblkright

int Param::nbndblkright = 0

◆ nbndblktop

int Param::nbndblktop = 0

◆ nmaskblk

int Param::nmaskblk = 0

◆ nrivers

int Param::nrivers = 0

◆ nx

int Param::nx = 0

◆ ny

int Param::ny = 0

◆ outfile

std::string Param::outfile = "Output.nc"

◆ outishift

int Param::outishift = 0

◆ outjshift

int Param::outjshift = 0

◆ outmax

bool Param::outmax = false

◆ outmean

bool Param::outmean = false

◆ outputtimestep

double Param::outputtimestep = 0.0

◆ outtwet

bool Param::outtwet = false

◆ outvars

std::vector<std::string> Param::outvars

◆ outzone

std::vector<outzoneP> Param::outzone

◆ Pa2m

double Param::Pa2m = 0.00009916

◆ Paref

double Param::Paref = 101300.0

◆ posdown

int Param::posdown = 0

◆ Radius

double Param::Radius = 6371220.

◆ rainbnd

bool Param::rainbnd = false

◆ rainforcing

bool Param::rainforcing = false

◆ resetmax

bool Param::resetmax = false

◆ rho

double Param::rho = 1025.0

◆ rightbnd

bool Param::rightbnd = false

◆ scalefactor

float Param::scalefactor = 0.01f

◆ setupcputime

clock_t Param::setupcputime

◆ smallnc

int Param::smallnc = 1

◆ spherical

int Param::spherical = 0

◆ startcputime

clock_t Param::startcputime

◆ test

int Param::test = -1

◆ theta

double Param::theta = 1.3

◆ topbnd

bool Param::topbnd = false

◆ totaltime

double Param::totaltime = 0.0

◆ TSnodesout

std::vector<TSoutnode> Param::TSnodesout

◆ VelThreshold

double Param::VelThreshold = -1.0

◆ wet_threshold

double Param::wet_threshold = 0.1

◆ wetdryfix

bool Param::wetdryfix = true

◆ windforcing

bool Param::windforcing = false

◆ xmax

double Param::xmax = nan("")

◆ xo

double Param::xo = nan("")

◆ ymax

double Param::ymax = nan("")

◆ yo

double Param::yo = nan("")

◆ zsinit

double Param::zsinit = nan("")

◆ zsoffset

double Param::zsoffset = nan("")

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