Class Divide
Simulatable divide block, requires exactly two inputs
Implements
Inherited Members
Namespace: TimeSeriesAnalysis.Dynamic
Assembly: TimeSeriesAnalysis.dll
Syntax
public class Divide : ModelBaseClass, ISimulatableModel
Constructors
| Edit this page View SourceDivide(DivideParameters, string)
Constructor
Declaration
public Divide(DivideParameters divideParameters, string ID)
Parameters
| Type | Name | Description |
|---|---|---|
| DivideParameters | divideParameters | |
| string | ID |
Fields
| Edit this page View SourcedivideParameters
Paramters that define the Divide model
Declaration
public DivideParameters divideParameters
Field Value
| Type | Description |
|---|---|
| DivideParameters |
Methods
| Edit this page View SourceClone(string)
Create deep copy/clone
Declaration
public ISimulatableModel Clone(string ID = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | ID |
Returns
| Type | Description |
|---|---|
| ISimulatableModel |
GetOutputSignalType()
Gives the type of the output signal
Declaration
public override SignalType GetOutputSignalType()
Returns
| Type | Description |
|---|---|
| SignalType |
Overrides
| Edit this page View SourceGetSteadyStateInput(double, int, double[])
Not implemented
Declaration
public double? GetSteadyStateInput(double y0, int inputIdx = 0, double[] givenInputValues = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | y0 | |
| int | inputIdx | |
| double[] | givenInputValues |
Returns
| Type | Description |
|---|---|
| double? |
GetSteadyStateOutput(double[], double)
Get the steady state value of the model output
Declaration
public double? GetSteadyStateOutput(double[] u0, double badDataID = -9999)
Parameters
| Type | Name | Description |
|---|---|---|
| double[] | u0 | vector of inputs for which the steady state is to be calculated |
| double | badDataID | optional special value that indicates "Nan" |
Returns
| Type | Description |
|---|---|
| double? | the steady-state value, if it is not possible to calculate, a |
IsModelSimulatable(out string)
Required model which answers if model will be able to simulate given current input
Declaration
public bool IsModelSimulatable(out string explain)
Parameters
| Type | Name | Description |
|---|---|---|
| string | explain | a string explaining reason for a false return, if applicable |
Returns
| Type | Description |
|---|---|
| bool |
Iterate(double[], double, double)
Iterate simulation
Declaration
public double[] Iterate(double[] inputsU, double timeBase_s, double badDataID = -9999)
Parameters
| Type | Name | Description |
|---|---|---|
| double[] | inputsU | |
| double | timeBase_s | |
| double | badDataID |
Returns
| Type | Description |
|---|---|
| double[] |
WarmStart(double[], double)
Not implemented
Declaration
public void WarmStart(double[] inputs, double output)
Parameters
| Type | Name | Description |
|---|---|---|
| double[] | inputs | |
| double | output |