rmt_read_ucn: Read an MT3DMS unformatted concentration file

In rogiersbart/RMT3DMS: Pre- and post-processing of MT3DMS & MT3D-USGS files

Description

rmt_read_ucn reads in an MT3DMS unformatted concentration file and returns it as an RMT3DMS ucn object.

Usage

rmt_read_ucn(
  file = {     cat("Please select ucn file ...\n")     file.choose() },
  btn = {     cat("Please select corresponding btn file ...\n")    
    rmt_read_btn(file.choose()) },
  mask = btn$icbund,
  cinact = btn$cinact,
  solute = NULL,
  precision = "single"
)

Arguments

file	filename; typically '*.ucn'
btn	RMT3DMS btn object
mask	3d array which can be coerced to logical indicating active (TRUE) or inactive (FALSE) cells. Concentration of inactive cells is set to NA. Defaults to the icbund array in btn.
cinact	concentration value(s) indicating inactive cells. These cells are set to NA. Defaults to cinact in btn.
solute	optional integer used to set the species index in. By default, the code tries to guess this from the filename (e.g. 'MT3D001.UCN')
precision	either 'single' (default) or 'double'. Specifies the precision of the binary file.

Value

object of class ucn and rmt_4d_array

rogiersbart/RMT3DMS documentation built on Oct. 16, 2021, 9:45 a.m.