Class EquationAPI

Namespace: VM.API.Pre
Assembly: VM.API.Pre.dll

public static class EquationAPI

Inheritance

object ← EquationAPI

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Methods

CreateFirstOrderDifferentialEquation(SubSystemDocument, FunctionEquType, Obj, ExpressionValueVariable?, string, SymmetricType)

Create .

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "function" })]
public static Obj CreateFirstOrderDifferentialEquation(this SubSystemDocument document, EquationFunctionDiff.FunctionEquType diffType, Obj function, ExpressionValueVariable? initialDisp = null, string name = "", SymmetricType symmetricType = SymmetricType.None)

Parameters

document SubSystemDocument

The document to create the 1st differential equation.

diffType EquationFunctionDiff.FunctionEquType

The solving method type of the 1st differential equation.

function Obj

The function of the 1st differential equation.

initialDisp ExpressionValueVariable?

The initial displacement of the 1st differential equation.

name string

The name of the 1st differential equation.

symmetricType SymmetricType

The symmetric type of the new

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'function' argument is null.

ArgumentException

Will be thrown if 'function' is not equal to and .

CreateSecondOrderDifferentialEquation(SubSystemDocument, FunctionEquType, Obj, ExpressionValueVariable?, ExpressionValueVariable?, string, SymmetricType)

Create .

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "function" })]
public static Obj CreateSecondOrderDifferentialEquation(this SubSystemDocument document, EquationFunctionDiff.FunctionEquType diffType, Obj function, ExpressionValueVariable? initialDisp = null, ExpressionValueVariable? initialVel = null, string name = "", SymmetricType symmetricType = SymmetricType.None)

Parameters

document SubSystemDocument

The document to create the 2nd differential equation.

diffType EquationFunctionDiff.FunctionEquType

The solving method type of the 2nd differential equation.

function Obj

The function of the 2nd differential equation.

initialDisp ExpressionValueVariable?

The initial displacement of the 2nd differential equation.

initialVel ExpressionValueVariable?

The initial velocity of the 2nd differential equation.

name string

The name of the 2nd differential equation.

symmetricType SymmetricType

The symmetric type of the new

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'function' argument is null.

ArgumentException

Will be thrown if 'function' is not equal to and .

CreateVariableEquation(SubSystemDocument, Obj, ExpressionValueVariable?, string, SymmetricType)

Create .

[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "function" })]
public static Obj CreateVariableEquation(this SubSystemDocument document, Obj function, ExpressionValueVariable? initialDisp = null, string name = "", SymmetricType symmetricType = SymmetricType.None)

Parameters

document SubSystemDocument

The document to create a variable equation.

function Obj

The function of a variable equation.

initialDisp ExpressionValueVariable?

The initial displacement of a variable equation.

name string

The name of a variable equation.

symmetricType SymmetricType

The symmetric type of the new

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document', 'function' argument is null.

ArgumentException

Will be thrown if 'function' is not equal to and .