Click or drag to resize

DHI.Mike1D.Mike1DDataAccess Namespace

Mike1DDataAccess is the overall data access component, containing data for an entire simulation and from all other data access components.
Classes
  ClassDescription
Public classAbstractMike1DController
An abstract base controller class.

It handles everything related to the ControllerEvent an delegates the real work on to the derived classes in the DoXXX methods.

Public classAdditionalParameter
Additional parameter data.
Public classControlDataXmlBridge
Bridge for reading/writing control data to xml.
Public classControllerCreatedEventArgs
Class containing event data for the controller created event.
Public classControllerEventArgs
Class containing event data for the controller event.
Public classControllerExtensions
Extension methods for the Controller
Public classCouplingSummary
Public classHDPipeDesignData
Data class for pipe design data
Public classHDPipeDesignOptimizationItem
Contains item to optimize
Public classHDPipeDesignOptimizationReach
Pipe design reach. The Control() method sets the Manning number of the _first_ XS in the underlying EngineReach. In MU setups, the cross section is shared between all points in the underlying reach, so in MU setups the Manning number of the whole reach will be controlled.
Public classHTMLErrorLog
Write diagnostics items to an HTML file.

This class only utilizes the log-file rolling, and overrides the WriteHTMLContent(TextWriter) method.

Public classHTMLSummary
Write a summary of a simulation to an HTML file.
Public classHTMLTableEngineDataColumnGetterT, TOut
A column that uses a getter to extract a TOut value from the row data object

This column does not support Accumulate.

Public classHTMLTableEngineDataColumnStringGetter
Public classHTMLTableEngineDataColumnValueGetter
An engine data column return a double value using a getter.

This column supports accumulation

Public classHTMLTableEngineDataColumnValueGetterT
An engine data column return a double value using a getter and including its own IEngineDataItemT, which must have the same data and structure as the one in the table.

This column supports accumulation

Public classHTMLTableEngineDataItemT
Public classLongTermStatisticsData
Class containing the data describing the LTS simulation.
Public classLongTermStatisticsDataXmlBridge
Bridge class for reading lont term statistics data to/from xml
Public classLTSDryWeatherFlowSpecification
Class describing dry weather flow in an LTS simulation.
Public classLTSInitialCondition
LTSInitialCondition hold hot start information for the individual jobs in the LTS simulation
Public classLTSJobCondition
Base class for describing LTS job start/stop and runtime stop conditions.
Public classLTSJobList
LTS joblist
Public classLTSJobListCreator
Class for creating an LTS job list.

The algorithm calculates the inflows only when it is raining. This effectively skips potential jobs where there is boundary inflow satisfying job start condition, but there is no active rain.

Public classLTSJobStartCondition
LTS job start condition.
Public classLTSJobStopCondition
LTS job stop condition.
Public classLTSResultSpecification Obsolete.
Result specification of LTS results
Public classLTSResultSpecificationItem Obsolete.
Public classLTSRuntimeStopCondition
LTS runtime stop condition.
Public classLTSRuntimeStopConditionCollection
Holds a list of LTSRuntimeStopCondition's that must all be satisfied for a job to stop (the LTSRuntimeStopConditions in the collection are combined with the logical "and" operator).
Public classMike1DAdditionalBridge
Bridge for reading the .m1da file, Mike 1D Additional setup file.
Public classMike1DBridge
Common class for loading MIKE 1D setup from various known types of storages.

Currently supporting MIKE 11 (sim11), MIKE URBAN databases (mdb/gdb), MIKE HYDRO (mhydro) and MIKE 1D (m1dx).

Public classMike1DBridgeCollection
Collection of MIKE 1D bridges, IMike1DBridge.

Register a new bridge by calling AddBridge(String, String, IMike1DBridgeFactory)

Public classMike1DControlDataFactory
Factory that sets up and connects the control module with the engine net.
Public classMike1DController
The Mike1DController is the entry point for an HD simulation, including any enabled modules (Rainfall runoff, AD, Control etc.)

It links the simulation setup with the actual engine setup. It controls initialization, start, stop and finalization of the engine.

Public classMike1DControllerEM
The Mike1DControllerEM is the entry point for an HD simulation, including any enabled modules (Rainfall runoff, AD, Control etc.) It is primarely used by DA for the Ensemble Members.

It links the simulation setup with the actual engine setup. It controls initialization, start, stop and finalization of the engine.

Public classMike1DControllerFactory
Factory class for creating IMike1DController.

The controller can either be created based on the content of Mike1DData, or from a IConnection, in which case the data will also be loaded.

The factory handles log files. By default a new log is created every time a new controller is created, and the log file is closed when the controller finishes. You can disable log files by setting DisableLogFile and if you want to reuse a log file for several controllers (append to it), set manually your own LogFileWriter.

Public classMike1DControllerLTS
The Mike1DControllerLTS is the entry point for a Long Term Statistics simulation. It controls initialization, start, stop and finalization of the engine.
Public classMike1DControllerRRCalibrate
The Mike1DController is the entry point for automatic RR calibration.

It will loop through all catchments that has auto calibration enabled, and calibrate each of these individually. When the controller is done, it will update the catchment parameters to contain the optimal parameters.

Public classMike1DData
Class that collects all DataAccess components in one place.
Public classMike1DDataExtensions
Extension methods for the MIKE 1D Data object
Public classMike1DDataXmlBridge
Bridge class for saving MIKE 1D data to XML, handling reading/writing the .m1dx file.

For loading a full setup, use the Mike1DBridge.

Public classMike1DLogFileWriter
Log file writer for MIKE 1D engine.

Call Prepare to open the logfile. If prepare is not called, all writing to the logfile is ignored silently.

Public classMike1DResultDataFactory
Factory that sets up an IResultData to retrieve values from an EngineNet
Public classMike1DResultDataFactoryDataItemVectorProxySource
A IDataItem that can update itself based on an IDoubleVectorGetter
Public classMike1DStateReader
Class for reading MIKE 1D state file and apply to model.
Public classMike1DStateWriter
Class for writing current state of a MIKE 1D model to a state file.
Public classModelCouplingSummary
Public classProgressWriter
Write progress to standard out
Public classSpecialEventArgs
Class containing event data for the special controller event.
Public classStateWriteSpecification
Specification for when and how to write state outputs.
Public classSummaryTableColumnNodeNotes
Special column that adds a G or a C flag in case of ground level or critical level has been exceeded.
Public classSummaryTableColumnTotalRunoffGetter
Special column reporting total runoff of catchment.

It needs to be special to handle CatchmentCombined and not count in twice the runoff from each catchment.

Public classSummaryTableDIColumnStringGetterT
An engine data column return a string value using a getter.
Structures
  StructureDescription
Public structureAssemblyVersionInfo
Helper class for assembly version information
Public structureCouplingSummaryInOutFlow
Public structureHTMLSummaryStructureInfo
Structure info for a generic IStructure
Public structureHTMLSummaryStructureInfoT
Structure info for a structure of type {T}
Public structureLTSJob
A SimulationEvent describes one of a series of simulations that are performed during the total runtime of the Long Term Simulation. A SimulationEvent is the same as am LTS "job" in MU terms.
Interfaces
  InterfaceDescription
Public interfaceIHTMLTableEngineDataColumnTOut
Public interfaceIMike1DBridge
Bridge interface, for loading a MIKE 1D setup from storage.
Public interfaceIMike1DBridgeFactory
Factory class for creating IMike1DBridge, used by Mike1DBridge loader: You can register your own bridge using Mike1DBridgeCollection
Public interfaceIMike1DController
The IMike1DController is the starting point for controlling and running a simulation. Depending on the underlying data components, the controller may do different things. Different data controllers may also do different things on the same data components. The following are examples of controllers:
  • HD controller: runs an HD simulation, including add ons (rainfall runoff, AD etc.)
  • RR controller: runs an RR simulation.
  • RR calibration controller: runs an RR calibration.
  • LTS controller: runs a LTS (Long Term Statistics) HD simulation.
Public interfaceIMike1DMUBridge
Special interface for loading MIKE URBAN data into MIKE 1D within the MIKE URBAN GUI.
Enumerations
  EnumerationDescription
Public enumerationControllerState
State of controller
Public enumerationCouplingFlowDirection
Public enumerationCouplingFlowType
Public enumerationCouplingType
Public enumerationHDPipeDesignIOUnits
Units of pipe design in/output
Public enumerationHDPipeDesignOptimizationCriteriaType
Pipe design criteria type
Public enumerationHDPipeDesignOptimizationGroupType
Pipe design reach group type
Public enumerationHDPipeDesignOptimizationType
The type of optmization to perform
Public enumerationLTSConditionTypes
Runtime stop and job start/stop condition types.
Public enumerationLTSJobListCreatorTypes
Enum specifying what kind of algorithm to use when generating a job list.
Public enumerationLTSNetworkLocationTypes
Type of network locations for LTSJobConditions.
Public enumerationLTSReachLocationTypes Obsolete.
Specific reach locations to report LTS results on.
Public enumerationLTSResultType Obsolete.
Type of LTS results
Public enumerationParameterType
Type of parameter, for additional data
Public enumerationResultSpecificationTypes
Type of result to create default result specifications for. Used in GetDefaultResultSpecification(ResultSpecificationTypes)