Click or drag to resize

DHI.Mike1D.Plugins Namespace

Plugin support, interfaces and classes.
Classes
  ClassDescription
Public classAddToOutput
Plugin for adding quantities to output file.

Two arguments are required:

  • ResultId: Id of result output. Values are like: 'DefaultHDResults', 'DefaultRRResults' etc. There can only be one ResultId argument.
  • Quantity: Id of quantity to add to output. Values are names of the PredefinedQuantity, like: 'WaterLevel' etc. There can be more than one Quantity argument
  • UserQuantity: Id of EUM item and ID of quantity to add to output, seperated by '::', example 'eumIInfiltration::WettingLoss [ImperviousSteep]'. There can be more than one UserQuantity argument

Public classCompositeStructureIterations
Print out composite structure iterations to console or file
Public classControlVariableExpression
Plugin class for adding variable expressions to the control module
Public classCulvertIterations
Print out culvert iterations to console or file
Public classDecoupledOutput
Plugin for setting up decoupled output.
Public classEcoLabDebugger
Plugin that enables debug output from ECO Lab.

The following parameters must be set:

  • FilePath: Path to file to write debug info to
  • DebugLevel: ECO Lab debug level
  • StartDateTime: Simulation time of start of debugging, format: yyyy-MM-dd HH:mm:ss
  • EndDateTime: Simulation time of start of debugging, format: yyyy-MM-dd HH:mm:ss

Public classEcoLabNumberChecker
Plugin that checks output from ECO Lab, and will throw an exception on first occurance of a NaN of inf number.
Public classCode exampleGatelevelHotstart
Plugin for using gate level from hotstart file

The plugin takes the following parameters:

Copy
Filepath = ''
Gate = '<<'

Public classCode exampleInitialWaterLevel
Plugin for adding parameter initial water level conditions

The plugin takes the following parameters:

Copy
Node = '<nodeId>;<wl>'
Location = '<reachId>;<chainage>;<wl>'
Span = '<reachId>;<startChainage>;<endChainage>;<wl>'

Public classMike1DPluginInfo
Information on how to load a MIKE 1D plugin.

A Mike 1D plugin is a class implementing the IMike1DPlugin. To utilize such a class, the name of the class and the name of the assembly containing the class must be provided. Also a number of arguments to the assembly can be defined.

Public classPluginWriteSteadyIterationsToFile
Plugin that enables writing of steady iterations to default HD result file.
Public classPostTimestepReport
Abstract class for producing a report at end of time step.
Public classRemoveLID
Plugin for removing some or all LID's from a setup
Public classScriptAttribute
Script attribute, to decorate methods as script methods to run
Public classScriptInfo
Public classScriptLoader
Class for loading, compiling and executing MIKE 1D scripts
Protected classScriptLoaderMethodToInvoke
Methods to invoke, belongs to a ScriptLoaderTypeToInstantiate
Protected classScriptLoaderTypeToInstantiate
Script Types (classes) to instantiate.
Public classUHMRescaleTimestep
Plugin for rescaling the timestep for UHM catchments such that the number of computational cells do not get too big.

One argument can be provided

  • MaxNumberOfCells: Integer number.

Structures
  StructureDescription
Public structureMike1DPluginArgument
Argument for a plugin, in the form of a key and a value
Interfaces
  InterfaceDescription
Public interfaceIMike1DPlugin
Interface for a MIKE 1D Plugin.
Enumerations