Calibration of the parameters of one catchment or a network of sub-catchments

Source: R/Calibration.GRiwrmInputsModel.R, R/Calibration.InputsModel.R, R/Calibration.R

Calibration algorithm that optimizes the error criterion selected as objective function using the provided functions.

# S3 method for class 'GRiwrmInputsModel'
Calibration(
  InputsModel,
  RunOptions,
  InputsCrit,
  CalibOptions,
  useUpstreamQsim = TRUE,
  ...
)

# S3 method for class 'InputsModel'
Calibration(InputsModel, CalibOptions, ...)

Calibration(InputsModel, ...)

# S3 method for class 'Ungauged'
Calibration(InputsModel, ...)

Arguments

InputsModel

[object of class InputsModel or GRiwrmInputsModel] see CreateInputsModel

RunOptions

[object of class RunOptions or GRiwrmRunOptions] see CreateRunOptions

InputsCrit

[object of class InputsCrit or GRiwrmInputsCrit] see CreateInputsCrit

CalibOptions

[object of class CalibOptions or GRiwrmCalibOptions] see CreateCalibOptions for details

useUpstreamQsim

boolean describing if simulated (TRUE) or observed (FALSE) flows are used for calibration. Default is TRUE

...

further arguments passed to airGR::Calibration, see details

Value

Depending on the class of InputsModel argument (respectively InputsModel and GRiwrmInputsModel object), the returned value is respectively:

  • a OutputsCalib object (See airGR::Calibration for more details on this object)

  • a GRiwrmOutputsCalib object which is a list of OutputsCalib objects with one item per modeled sub-catchment

Details

This function can be used either for a catchment (with an InputsModel object), for a network (with a GRiwrmInputsModel object), or for an ungauged node cluster (with a Ungauged object).

Argument classes should be consistent to the usage:

  • a InputsModel argument of class InputsModel must be followed by a RunOptions argument of class RunOptions, a InputsCrit argument of class InputsCrit and a CalibOptions of class CalibOptions

  • a InputsModel argument of class GRiwrmInputsModel must be followed by a RunOptions argument of class GRiwrmRunOptions, a InputsCrit argument of class GRiwrmInputsCrit and a CalibOptions of class GRiwrmCalibOptions

See the vignettes for examples.