dummy_hydro: Generate dummy hydro data for Atlantis

Description Usage Arguments Details See Also Examples

Description

This function generates dummy flux, salinity, and temperature files for Atlantis.

Usage

1
2
dummy_hydro(b, z, t = 86400, model_name, bgm_file, hydro = TRUE,
  salt = TRUE, temp = TRUE, gen_nc = FALSE, keep_cdf = TRUE)

Arguments

b

Number of boxes

z

Number of vertical boxes (i.e. layers)

t

Time. Defaults to 86400.

model_name

Name of the model.

bgm_file

Name of the bgm file. Include the file extension!

hydro

Generate the flux data. Defaults to TRUE.

salt

Generate the dummy salinity data. Defaults to TRUE.

temp

Generate the dummy temperature data. Defaults to TRUE

gen_nc

Generate the nc binary? Defaults to FALSE and required netcdf-bin to be installed.

keep_cdf

Keep the readable cdf file? Defaults to TRUE.

Details

This function generates dummy hydrography data, namely flux, salinity, and temperature data, in the Atlantis ncdf4 file format. This function can compress the resultant cdf file if gen_nc = TRUE is set and can clean up after itself if keep_cdf = FALSE is set. It can handle any arbitrary number of boxes (set by b) and vertical layers (set by z).

See Also

gen_init,required_init

Examples

1
dummy_hydro(b = 4, z, model_name = "dummy", bgm_file = "dummy.bgm", gen_nc = TRUE, keep_cdf = FALSE)

cddesja/R4Atlantis-legacy documentation built on May 13, 2019, 2:21 p.m.