Class PressureLoadAPI

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

This class implements APIs for BoundaryCondition class.

public static class PressureLoadAPI

Inheritance

object ← PressureLoadAPI

Extension Methods

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

Methods

CreatePressureLoad(SubSystemDocument, Obj, string, Obj?)

Create with functions.

[MatchTypeObj(new object[] { "function", typeof(Function) })]
public static Obj CreatePressureLoad(this SubSystemDocument document, Obj pressureLoadComponent, string pressureLoadName = "", Obj? function = null)

Parameters

document SubSystemDocument

The document to create the pressure load.

pressureLoadComponent Obj

The pressure load component

pressureLoadName string

The name of the pressure load. If empty, default name starts with 'PLoad_' will be generated and used.

function Obj?

The name of the function.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document' or 'pressureLoadComponent' arguments are empty.

ArgumentException

Will be thrown if 'function' argument is not empty and type of 'function' is not .

CreatePressureLoad(SubSystemDocument, Obj, Obj, string)

Create with user-subrooutine.

[NotNullObj(new string[] { "usub" })]
[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreatePressureLoad(this SubSystemDocument document, Obj pressureLoadComponent, Obj usub, string pressureLoadName = "")

Parameters

document SubSystemDocument

The document to create the pressure load.

pressureLoadComponent Obj

The pressure load component

usub Obj

The name of the user-subrooutine.

pressureLoadName string

The name of the pressure load. If empty, default name starts with 'PLoad_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

Will be thrown if 'document' or 'pressureLoadComponent' arguments are empty.

ArgumentException

Will be thrown if 'usub' argument is not empty and type of 'usub' is not .