Class ThermalAPI

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

This class implements APIs for BoundaryCondition class.

public static class ThermalAPI

Inheritance

object ← ThermalAPI

Extension Methods

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

Methods

CreateConvectionWithFunction(SubSystemDocument, Obj, string, Obj?, Obj?, ConvectionCoefficient, Temperature)

Create with functions.

[MatchTypeObj(new object[] { "convectionCoefficientFunction", typeof(Function), "ambientTemperatureFunction", typeof(Function) })]
public static Obj CreateConvectionWithFunction(this SubSystemDocument document, Obj convectionComponent, string convectionName = "", Obj? convectionCoefficientFunction = null, Obj? ambientTemperatureFunction = null, ConvectionCoefficientUnit.ConvectionCoefficient convectionCoefficientUnit = ConvectionCoefficient.WPerm2C, TemperatureUnit.Temperature ambientTemperatureUnit = Temperature.C)

Parameters

document SubSystemDocument

The document to create the convection.

convectionComponent Obj

The convection component

convectionName string

The name of the convection. If empty, default name starts with 'Convection_' will be generated and used.

convectionCoefficientFunction Obj?

The name of the convection coefficient function.

ambientTemperatureFunction Obj?

The name of the ambient temperature function.

convectionCoefficientUnit ConvectionCoefficientUnit.ConvectionCoefficient

The unit of the convection coefficient.

ambientTemperatureUnit TemperatureUnit.Temperature

The unit of the ambient temperature.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

ArgumentException

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

CreateConvectionWithUserSubroutine(SubSystemDocument, Obj, Obj, string)

Create with user-subrooutine.

[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreateConvectionWithUserSubroutine(this SubSystemDocument document, Obj convectionComponent, Obj usub, string convectionName = "")

Parameters

document SubSystemDocument

The document to create the convection.

convectionComponent Obj

The convection component

usub Obj

The name of the user-subrooutine.

convectionName string

The name of the convection. If empty, default name starts with 'Convection_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateHeatFlowWithFunction(SubSystemDocument, Obj, string, Obj?, HeatFlow)

Create with functions.

[MatchTypeObj(new object[] { "heatFlowFunction", typeof(Function) })]
public static Obj CreateHeatFlowWithFunction(this SubSystemDocument document, Obj heatFlowComponent, string heatFlowName = "", Obj? heatFlowFunction = null, HeatFlowUnit.HeatFlow heatFlowUnit = HeatFlow.W)

Parameters

document SubSystemDocument

The document to create the heat flow.

heatFlowComponent Obj

The heat flow component

heatFlowName string

The name of the heat flow. If empty, default name starts with 'HeatFlow_' will be generated and used.

heatFlowFunction Obj?

The name of the heat flow function.

heatFlowUnit HeatFlowUnit.HeatFlow

The unit of the heat flow.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateHeatFlowWithUserSubroutine(SubSystemDocument, Obj, Obj, string)

Create with user-subrooutine.

[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreateHeatFlowWithUserSubroutine(this SubSystemDocument document, Obj heatFlowComponent, Obj usub, string heatFlowName = "")

Parameters

document SubSystemDocument

The document to create the heat flow.

heatFlowComponent Obj

The heat flow component

usub Obj

The name of the user-subrooutine.

heatFlowName string

The name of the heat flow. If empty, default name starts with 'HeatFlow_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateHeatFluxWithFunction(SubSystemDocument, Obj, string, Obj?, HeatFlux)

Create with functions.

[MatchTypeObj(new object[] { "heatFluxFunction", typeof(Function) })]
public static Obj CreateHeatFluxWithFunction(this SubSystemDocument document, Obj heatFluxComponent, string heatFluxName = "", Obj? heatFluxFunction = null, HeatFluxUnit.HeatFlux heatFluxUnit = HeatFlux.WPermm2)

Parameters

document SubSystemDocument

The document to create the heat flux.

heatFluxComponent Obj

The heat flux component

heatFluxName string

The name of the heat flux. If empty, default name starts with 'HeatFlux_' will be generated and used.

heatFluxFunction Obj?

The name of the heat flux function.

heatFluxUnit HeatFluxUnit.HeatFlux

The unit of the heat flux.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateHeatFluxWithUserSubroutine(SubSystemDocument, Obj, Obj, string)

Create with user-subrooutine.

[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreateHeatFluxWithUserSubroutine(this SubSystemDocument document, Obj heatFluxComponent, Obj usub, string heatFluxName = "")

Parameters

document SubSystemDocument

The document to create the heat flux.

heatFluxComponent Obj

The heat flux component

usub Obj

The name of the user-subrooutine.

heatFluxName string

The name of the heat flux. If empty, default name starts with 'HeatFlux_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateHeatGenerationWithFunction(SubSystemDocument, Obj, string, Obj?, HeatGeneration)

Create with functions.

[MatchTypeObj(new object[] { "heatGenerationFunction", typeof(Function) })]
public static Obj CreateHeatGenerationWithFunction(this SubSystemDocument document, Obj heatGenerationComponent, string heatGenerationName = "", Obj? heatGenerationFunction = null, HeatGenerationUnit.HeatGeneration heatGenerationUnit = HeatGeneration.WPermm3)

Parameters

document SubSystemDocument

The document to create the heat generation.

heatGenerationComponent Obj

The heat generation component

heatGenerationName string

The name of the heat generation. If empty, default name starts with 'HeatGeneration_' will be generated and used.

heatGenerationFunction Obj?

The name of the heat generation function.

heatGenerationUnit HeatGenerationUnit.HeatGeneration

The unit of the heat generation.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateHeatGenerationWithUserSubroutine(SubSystemDocument, Obj, Obj, string)

Create with user-subrooutine.

[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreateHeatGenerationWithUserSubroutine(this SubSystemDocument document, Obj heatGenerationComponent, Obj usub, string heatGenerationName = "")

Parameters

document SubSystemDocument

The document to create the heat generation.

heatGenerationComponent Obj

The heat generation component

usub Obj

The name of the user-subrooutine.

heatGenerationName string

The name of the heat generation. If empty, default name starts with 'HeatGeneration_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateTemperatureWithDFTHFile(SubSystemDocument, Obj, string, Temperature, string)

Create with .dfth file.

[ExistFile(new string[] { "dfthFilePath" })]
public static Obj CreateTemperatureWithDFTHFile(this SubSystemDocument document, Obj temperatureComponent, string dfthFilePath, TemperatureUnit.Temperature temperatureUnit = Temperature.C, string temperatureName = "")

Parameters

document SubSystemDocument

The document to create the temperature.

temperatureComponent Obj

The temperature component

dfthFilePath string

The .dfth file path.

temperatureUnit TemperatureUnit.Temperature

The unit of the temperature.

temperatureName string

The name of the temperature. If empty, default name starts with 'Temperature_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

Will be thrown if type of 'temperatureFunction' is not .

FileNotFoundException

Will be thrown if dfthFilePath file is not exist.

CreateTemperatureWithFunction(SubSystemDocument, Obj, string, Obj?, Temperature)

Create with functions.

[MatchTypeObj(new object[] { "temperatureFunction", typeof(Function) })]
public static Obj CreateTemperatureWithFunction(this SubSystemDocument document, Obj temperatureComponent, string temperatureName = "", Obj? temperatureFunction = null, TemperatureUnit.Temperature temperatureUnit = Temperature.C)

Parameters

document SubSystemDocument

The document to create the temperature.

temperatureComponent Obj

The temperature component

temperatureName string

The name of the temperature. If empty, default name starts with 'Temperature_' will be generated and used.

temperatureFunction Obj?

The name of the temperature function.

temperatureUnit TemperatureUnit.Temperature

The unit of the temperature.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

Will be thrown if type of 'temperatureFunction' is not .

ArgumentException

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

CreateTemperatureWithUserSubroutine(SubSystemDocument, Obj, Obj, string)

Create with user-subrooutine.

[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreateTemperatureWithUserSubroutine(this SubSystemDocument document, Obj temperatureComponent, Obj usub, string temperatureName = "")

Parameters

document SubSystemDocument

The document to create the temperature.

temperatureComponent Obj

The temperature component

usub Obj

The name of the user-subrooutine.

temperatureName string

The name of the temperature. If empty, default name starts with 'Temperature_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

Will be thrown if type of 'temperatureFunction' is not .

ArgumentException

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

CreateThermalContactWithFunction(SubSystemDocument, Obj, string, Obj?, ConvectionCoefficient)

Create with functions.

[MatchTypeObj(new object[] { "thermalContactFunction", typeof(Function) })]
public static Obj CreateThermalContactWithFunction(this SubSystemDocument document, Obj thermalContactComponent, string thermalContactName = "", Obj? thermalContactFunction = null, ConvectionCoefficientUnit.ConvectionCoefficient convectionCoefficient = ConvectionCoefficient.WPermm2C)

Parameters

document SubSystemDocument

The document to create the thermal contact.

thermalContactComponent Obj

The thermal contact component

thermalContactName string

The name of the thermal contact. If empty, default name starts with 'ThermalContact_' will be generated and used.

thermalContactFunction Obj?

The name of the thermal contact function.

convectionCoefficient ConvectionCoefficientUnit.ConvectionCoefficient

The unit of the thermal contact conductance coefficient.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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

CreateThermalContactWithUserSubroutine(SubSystemDocument, Obj, Obj, string)

Create with user-subrooutine.

[MatchTypeObj(new object[] { "usub", typeof(UserSubroutine) })]
public static Obj CreateThermalContactWithUserSubroutine(this SubSystemDocument document, Obj thermalContactComponent, Obj usub, string thermalContactName = "")

Parameters

document SubSystemDocument

The document to create the thermal contact.

thermalContactComponent Obj

The thermal contact component

usub Obj

The name of the user-subrooutine.

thermalContactName string

The name of the thermal contact. If empty, default name starts with 'ThermalContact_' will be generated and used.

Returns

Obj

The new object that is created by this API.

Exceptions

ArgumentNullException

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

ArgumentException

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