Skip to contents

Merge SicInput objects into a list

Usage

# S3 method for SicInput
merge(x, y = NULL, ...)

Arguments

x

a SicInput object to merge

y

a SicInput object to merge

...

other SicInput objects to merge

Value

A SicInputs object which is a list of SicInput

Details

The list of parameter is compliant with the merge S3 method available in R, so this method can either be called by typing merge or merge.SicInput.

Examples

# How to impose 5 m3/s in the upstream offtake of the model?
# Define location of the boundary condition to set
locations <- SicLocation(list(Nd = 1, Pr = 1, car = "Q"))
# Define its value
sicInputUpstream <- SicInput(5, locations = locations)

# Opening a gate at 0.5 m
sicInputGate <- SicInput(
  0.5,
  locations = SicLocations(list(Bf = 3, Sn = 2, Ouv = 1, Car = "Ouverture"))
)

# Merging all inputs
sicInputs <- merge(sicInputUpstream, sicInputGate)