Class Divide

Namespace

TimeSeriesAnalysis.Dynamic

Assembly

TimeSeriesAnalysis.dll

Simulatable divide block, requires exactly two inputs

public class Divide : ModelBaseClass, ISimulatableModel

Inheritance

object

ModelBaseClass

Divide

Implements

ISimulatableModel

Inherited Members

ModelBaseClass.ID

ModelBaseClass.ModelInputIDs

ModelBaseClass.additiveInputIDs

ModelBaseClass.outputID

ModelBaseClass.outputIdentID

ModelBaseClass.processModelType

ModelBaseClass.comment

ModelBaseClass.x

ModelBaseClass.y

ModelBaseClass.color

ModelBaseClass.GetID()

ModelBaseClass.SetID(string)

ModelBaseClass.SetProcessModelType(ModelType)

ModelBaseClass.GetProcessModelType()

ModelBaseClass.SetInputIDs(string[], int?)

ModelBaseClass.AddSignalToOutput(string)

ModelBaseClass.GetModelInputIDs()

ModelBaseClass.GetAdditiveInputIDs()

ModelBaseClass.GetBothKindsOfInputIDs()

ModelBaseClass.SetOutputID(string)

ModelBaseClass.GetOutputID()

ModelBaseClass.GetOutputIdentID()

ModelBaseClass.GetLengthOfInputVector()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Divide(DivideParameters, string)

Constructor

public Divide(DivideParameters divideParameters, string ID)

Parameters

divideParameters DivideParameters

ID string

Fields

divideParameters

Paramters that define the Divide model

public DivideParameters divideParameters

Field Value

DivideParameters

Methods

Clone(string)

Create deep copy/clone

public ISimulatableModel Clone(string ID = null)

Parameters

ID string

Returns

ISimulatableModel

GetOutputSignalType()

Gives the type of the output signal

public override SignalType GetOutputSignalType()

Returns

SignalType

GetSteadyStateInput(double, int, double[])

Not implemented

public double? GetSteadyStateInput(double y0, int inputIdx = 0, double[] givenInputValues = null)

Parameters

y0 double

inputIdx int

givenInputValues double[]

Returns

double?

GetSteadyStateOutput(double[], double)

Get the steady state value of the model output

public double? GetSteadyStateOutput(double[] u0, double badDataID = -9999)

Parameters

u0 double[]

vector of inputs for which the steady state is to be calculated

badDataID double

optional special value that indicates "Nan"

Returns

double?

the steady-state value, if it is not possible to calculate, a null is returned

IsModelSimulatable(out string)

Required model which answers if model will be able to simulate given current input

public bool IsModelSimulatable(out string explain)

Parameters

explain string

a string explaining reason for a false return, if applicable

Returns

bool

Iterate(double[], double, double)

Iterate simulation

public double[] Iterate(double[] inputsU, double timeBase_s, double badDataID = -9999)

Parameters

inputsU double[]

timeBase_s double

badDataID double

Returns

double[]

WarmStart(double[], double)

Not implemented

public void WarmStart(double[] inputs, double output)

Parameters

inputs double[]

output double