CreateSupervisor: Creation of a Supervisor for handling regulation in a model

View source: R/CreateSupervisor.R

CreateSupervisorR Documentation

Creation of a Supervisor for handling regulation in a model

Description

Creation of a Supervisor for handling regulation in a model

Usage

CreateSupervisor(InputsModel, TimeStep = 1L)

Arguments

InputsModel

[object of type GRiwrmInputsModel] inputs of the model

TimeStep

numeric number of time steps between each supervision

Details

See RunModel.Supervisor and vignettes for examples of use.

Value

A Supervisor object which is an environment containing all the necessary variables to run a supervised simulation, such as:

  • DatesR POSIXct: vector of date from InputsModel

  • InputsModel: a copy of InputsModel provided by CreateInputsModel.GRiwrm

  • griwrm: a copy of griwrm provided by CreateGRiwrm

  • Controllers list: list of the controllers used in the supervised simulation (See CreateController)

  • some internal state variables updated during simulation (ts.index, ts.previous, ts.date, ts.index0, controller.id)

See Also

RunModel.Supervisor(), CreateController()


inrae/airGRiwrm documentation built on Sept. 27, 2024, 6:08 p.m.