swOUT-class: Class 'swOUT'

In Burke-Lauenroth-Lab/rSOILWAT2: An Ecohydrological Ecosystem-Scale Water Balance Simulation Model

Class swOUT

Description

The methods listed below work on this class and the proper slot of the class swInputData.

Usage

swOUT(...)

## S4 method for signature 'swOUT'
get_swOUT(object)

## S4 method for signature 'swOUT'
swOUT_TimeStep(object)

## S4 method for signature 'swOUT'
swOUT_OutputSeparator(object)

## S4 replacement method for signature 'swOUT'
set_swOUT(object) <- value

## S4 replacement method for signature 'swOUT'
activate_swOUT_OutKey(object) <- value

## S4 replacement method for signature 'swOUT'
deactivate_swOUT_OutKey(object) <- value

## S4 replacement method for signature 'swOUT'
swOUT_TimeStep(object) <- value

## S4 replacement method for signature 'swOUT'
swOUT_TimeStepsForEveryKey(object) <- value

## S4 replacement method for signature 'swOUT'
swOUT_OutputSeparator(object) <- value

## S4 method for signature 'swOUT,character'
swReadLines(object, file)

Arguments

...	Arguments to the helper constructor function. Dots can either contain objects to copy into slots of that class (must be named identical to the corresponding slot) or be one object of that class (in which case it will be copied and any missing slots will take their default values). If dots are missing, then corresponding values of rSOILWAT2::sw_exampleData (i.e., the SOILWAT2 "testing" defaults) are copied.
object	An object of class swOUT.
value	A value to assign to a specific slot of the object.
file	A character string. The file name from which to read.

Details

Output can be generated for four different time steps: daily (DY), weekly (WK), monthly (MO), and yearly (YR) periods. We have two options to specify time steps:

• The same time step(s) for every output; this option corresponds to specifying a line with TIMESTEP ... in the SOILWAT2 input file outsetup.in. The matrix in slot timeSteps should have SW_OUTNKEYS rows and SW_OUTNPERIODS columns of which use_OUTNPERIODS contain identical values in each used row.

• A different time step for each output; however, only one time step per output variable can be specified. this option corresponds to specifying the time step in the column PERIOD in the SOILWAT2 input file outsetup.in.

Elements that are turned off have the value eSW_NoTime = 999L.

Slots

outputSeparator

A character string. Currently, only "\t" is functional.

timeSteps

An integer matrix with rows for each output key and columns for each possible output time period. See details.

See Also

swInputData

Examples

showClass("swOUT")
x <- new("swOUT")
x <- swOUT()

x <- swOUT()
activate_swOUT_OutKey(x) <- c("VWCMATRIC", "HYDRED")

x <- swOUT()
deactivate_swOUT_OutKey(x) <- c("VWCMATRIC", "HYDRED")

x <- swOUT()
swOUT_TimeStepsForEveryKey(x) <- c(2, 3)
identical(
  unique(sort(as.vector(swOUT_TimeStep(x)))),
  as.integer(c(2, 3, 999)) # 999 represents 'eSW_NoTime'
)

Burke-Lauenroth-Lab/rSOILWAT2 documentation built on Dec. 9, 2023, 1:46 a.m.