Click or drag to resize

SimulationParameters Class

Simulation parameters, used by the SimulationLauncher and SimulationWorker
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.SimLauncherSimulationParameters

Namespace:  DHI.Mike1D.SimLauncher
Assembly:  DHI.Mike1D.SimLauncher (in DHI.Mike1D.SimLauncher.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class SimulationParameters

The SimulationParameters type exposes the following members.

Constructors
  NameDescription
Public methodSimulationParameters
Default constructor
Top
Properties
  NameDescription
Public propertyCreateHtmllogs
Create the HTML summary and error log files. Default value: True
Public propertyDisableLogfile
Flag to disable log-file writing. Default value: False
Public propertyFlexibleLoad
If true, then input files will be searched for even if the name is wrong. Presently used in the MU bridge to change the extension of RR input files from .CRF to RR.res1d. Default value: False;
Public propertyIncludeExceptionStackTraceInLog
If true, in case of an unexpected exception the stack trace will be printed to the log file. Default value: False
Public propertyM1DxFileName
If WriteM1Dx is set, this is the name of the .m1dx file to write.

If this is not set, the extension of the input file name is changed to .m1dx.

M1DxFileName is relative to the input file name directory.

Public propertyMaxNumThreads
Maximum number of threads to use. Set to zero for unlimited.

Using more than one thread may give different results, due change in order of calculations and therefor different rounding errors from simulation to simulation when running multiple threads. If exact same results are required for each simulation, set this to 1.

The number of threads actually used are limited by the smallest of this number, the number of logical processing units (number of CPU cores), the license and the OMP_NUM_THREADS environment variable.

Public propertyMzIntegration
Enable use of MIKE Zero APV2 standard for updating progress in MIKE Zero (MIKE Zero integration) Default value: False
Public propertyOptions
General options, added to the IConnection Options
Public propertyTopMost
If true, the simulation launcher GUI will be started with the topmost flag set, showing up on top of all other windows Default value: False
Public propertyUseThreadedDomainDecomposition
Use Threaded Domain Decomposition

If you are using more than one thread this flag may be used to deside if domain decomposition is used. Default this is true.

This value is true by default if running with more than 1 thread. If running with 1 thread this value is false.

Public propertyWriteM1Dx
If true, no simulation is executed, data is loaded and stored in the MIKE 1D .m1dx format
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also