HGSGetData: Get data values from HGS files

In FluvialLandscapeLab/HGSReader: Reads output from the HydroGeoSphere model into R

Get data values from HGS files

Description

Get and manipulate output values associated with nodes or cells in an HGS model run.

Usage

HGSGetData(
  HGSFile,
  variables,
  blockNumbers = NULL,
  solutionTimes = NULL,
  includeCoords = T,
  asArray = F
)

Arguments

HGSFile	An S3 object of class "HGSFile" created by calling HGSFile.
variables	A character vector containing valid variable names. Valid variable names are stored in the HGSFile object and can be displayed with <HGSFile>$variables, where <HGSFile> is the name of the HGSFile object.
blockNumbers, solutionTimes	Specify one, but only one, of these two variables to choose the time step from which data should be retrieved. Use blockNumber to specify an index of the times steps that were output (e.g., to get data from the first time step that was output, specify '1', for the second '2', etc.). Use solutionTimes to specify the solution time from which to retrieve data. (Note: Available solutionTimess are stored in the HGSFile object and can be accessed using the HGSQueryBlocks function with "solutionTimes" as a descriptor).
includeCoords	Set to TRUE to return X, Y, Z coordinates (in HGS model units) in addition to specified variables.
asArray	When TRUE, returns an "HGSArray" object. When FALSE, returns an "HGS.data.frame" object. See "Value," below.

Value

HGSGetData When asArray is TRUE, returns an "HGSArray" S3 object, which is 5-dimensional array where the first three dimensions are the node indices in the X, Y, and Z dimensions, the 4th dimension is simulation time, and the 5th dimension consists of the requested variables. "NodeID" or "CellID" is a variable name added to the array automatically. As with any array in R, the HGSArray can be sectioned using square brackets "[]".

Note that "drop = F" can be a useful parameter within the square brackets to prevent loss of an array dimension when a single value of one dimension is specified. See the help for square bracket by clicking this link: [

An HGSCube object always includes all 5 dimensions. HGSCube inherits from HGSArray. As soon as an HGSCube is sectioned with square brackets (therefore, potentially losing at least one dimension), it becomes simply an HGSArray object. When sectioning with square brackets results in a 1-D vector, the HGSArray class designation is lost.

When asArray is FALSE, returns an HGS.data.frame object of values associated with nodes (for NODECENTERED variables) or cells (for CELLCENTERED variables). There is one column for solution time, CellID/NodeID, and each variable requested, along with columns for the X, Y, and Z coordinates (in the spatial units determined when setting up the HGS model run) if includeCoords is TRUE.

Use attr(<HGS.data.frame_Object>, "varLoc") to determine if variables in the HGS.data.frame are NODECENTERED and which are CELLCENTERED.

FluvialLandscapeLab/HGSReader documentation built on April 10, 2024, 8:18 a.m.