set_config: Create a configuration list for a trajectory or dispersion...

Description Usage Arguments

View source: R/set_config.R

Description

Create a configuration list for a trajectory or dispersion model

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
set_config(tratio = 0.75, initd = 0, kpuff = 0, khmax = 9999,
  kmixd = 0, kmix0 = 250, kzmix = 0, kdef = 0, kbls = 1,
  kblt = 2, conage = 48, numpar = 2500, qcycle = 0, efile = NULL,
  tkerd = 0.18, tkern = 0.18, ninit = 1, ndump = 1, ncycl = 1,
  pinpf = "PARINIT", poutf = "PARDUMP", mgmin = 10, kmsl = 0,
  maxpar = 10000, cpack = 1, cmass = 0, dxf = 1, dyf = 1,
  dzf = 0.01, ichem = 0, maxdim = 1, kspl = 1, krnd = 6,
  frhs = 1, frvs = 0.01, frts = 0.1, frhmax = 3, splitf = 1,
  tm_pres = 0, tm_tpot = 0, tm_tamb = 0, tm_rain = 0,
  tm_mixd = 0, tm_relh = 0, tm_sphu = 0, tm_mixr = 0,
  tm_dswf = 0, tm_terr = 0)

Arguments

tratio

The advection stability ratio. By default, this is set to 0.75.

initd

The initial distribution. Set to 0 by default.

kpuff

The horizontal puff dispersion growth. Setting to 0 results in linear growth whereas option 1 uses an empirical growth scheme. By default, this is set to 0 (linear growth).

khmax

The maximum duration (in hours) for a particle or trajectory. This is set to the absolute maximum by default, which is 9999 hours.

kmixd

The methodology for modeling the mixed layer depth. There are three options: 0 for using the input (the default), 1 for using temperature, and 2 for using the TKE.

kmix0

The minimum mixing depth in meters. This is 250 by default.

kzmix

How to perform vertical mixing adjustments. There are three options: 0 for not doing this at all (the default), 1 uses the PBL average, and 3 scales with TVMIX.

kdef

The modeling method for horizontal turbulence. We can use the vertical with option 0 (the default), or, use the deformation method with option 1.

kbls

How to derive the boundary layer stability. Two options are available for this. We can use fluxes (option 1, default) or use wind temperature (option 2).

kblt

The boundary layer turbulence parameterization to use. This can either be Beljaars (option 1), Kanthar (option 2, default), or TKE (option 3).

conage

Particle to- or from-puff conversion at CONAGE. In units of hours, with a default of 48.

numpar

The number of puffs or particles released per cycle. By default this is set to 2500.

qcycle

An optional cycling of emissions, in units of hours.

efile

An absolute path to an optional temporal emissions file.

tkerd

The unstable turbulent kinetic energy ratio. This is set to 0.18.

tkern

The stable turbulent kinetic energy ratio. This is set to 0.18.

ninit

How to do particle initialization; with 0 no particle initialization is done, with 1 this is done once, options 2 and 3 are the add and replace methods.

ndump

Should the particles be dumped to a file and, if so, how often? Using 0 results in no writing particles to file (the default), and any non-zero value performs this writing once per number of hours specified.

ncycl

The PARDUMP output cycle time.

pinpf

The particle input file name (default is "PARINIT"). This is useful for initialization or boundary conditions.

poutf

The particle output file name (default is "PARDUMP").

mgmin

The minimum meteorological subgrid size. The default value is 10.

kmsl

The starting height reference. If it is to signify a distance above ground level (AGL) then use option 0 (the default). If it is instead relative to mean sea level, then option 1 should be used.

maxpar

The maximum number of particles to be carried in simulation. By default this is 10000.

cpack

The binary concentration packing. Here are the options: 0 for none, 1 for nonzero, 2 for points, and 3 for polar. Option 1 is the default option.

cmass

Informs grid computation. The two options are to compute grid concentrations (with 0, the default) or to compute grid mass (option 1).

dxf, dyf

The horizontal x- and y-grid adjustment factors for an ensemble. By default, these are both set to 1.0.

dzf

The vertical factor for an ensemble. This is 0.01 by default.

ichem

The chemistry conversion module to employ. Option 0 does no chemistry (the default). With option 1 we use a matrix method, option 2 does conversion, and option 3 works on dust.

maxdim

The maximum number of pollutants to carry on one particle. By default, this is 1.

kspl

The standard splitting interval in units of hours. By default, this is 1 hour.

krnd

The enhanced merge interval in hours. By default this is 6 hours.

frhs

The standard horizontal puff rounding fraction for the merge process. This is 1.0 by default.

frvs

The vertical puff rounding fraction, which is 0.01 by default.

frts

The temporal puff rounding fraction, which is 0.10 by default.

frhmax

The maximum value for the horizontal rounding parameter. This is 3.0 by default.

splitf

The automatic size adjustment factor for horizontal splitting. By default, the value is 1.0.

tm_pres, tm_tpot, tm_tamb, tm_rain, tm_mixd, tm_relh, tm_sphu, tm_mixr, tm_dswf, tm_terr

Options to include meteorology along trajectory points. These are the pressure variable marker flag (tm_pres), the potential temperature (tm_tpot), the ambient temperature (tm_tamb), the rainfall rate (tm_rain), the mixed layer depth (tm_mixd), the relative humidity (tm_relh), the specific humidity (tm_sphu), the mixing rate (tm_mixr), the downward short-wave flux (tm_dswf), and the terrain height (tm_terr). Setting any of these to 0 disables output, whereas 1 will enable output of these data points. By default, all are set to 0.


rich-iannone/SplitR documentation built on Nov. 2, 2021, 2:32 a.m.