fes_new: Create a handle to a new FES2014 instance

Description Usage Arguments Details Value See Also Examples

View source: R/Rfes2014.R

Description

FES2014 handles are used in fes_calculate and can either be cleaned up manually with fes_delete or are finalized automatically when the R session is destroyed.

Usage

1
fes_new(tide_type, access_mode, ini_file)

Arguments

tide_type

string; one of "ocean", "tide" or "radial"

access_mode

string; one of "io" or "memory"

ini_file

string; path to a fes2014 configuration file

Details

DO NOT SAVE THE HANDLE IN RDATA FILES

Value

<extpointer> A handle to a FES2014 instance

See Also

fes_delete

Examples

1
2
3
4
## Not run: 
hdl <- fes_new("ocean", "memory", "data/fes2014/eastward_velocity.ini")

## End(Not run)

avsdev-cw/Rfes2014 documentation built on Nov. 3, 2019, 2:04 p.m.