Turbo Setup

Turbo Setup
This container holds data for an instance of Turbo Setup.

Methods

CreatePerformanceMap

This command class creates a new Turbo Fluid Flow system on the project schematic. Appropriate input and output parameters are exposed from the system.

Return Data reference to the Turbo Fluid Flow system.
Type DataReference

CreateThroughflow

This command class creates a new VistaTF system. The system, comprising Setup, Solution and Results cells, is created on the project schematic and the operating conditions set accordingly.

Return Container representing the VistaTF Setup cell.
Type DataContainerReference

CreateTurboflow

This command class creates a new Turbomachinery Fluid Flow system. The new system appears on the project schematic containing Turbo Mesh, Setup, Solution and Results cells. The Turbo Mesh and Setup cells are initialised leaving the system ready to update.

Return Data reference to the Turbo Fluid Flow system.
Type DataReference

DisplayTurboSetupResults

This command class display the performance map results for the Turbo Setup.

Required Arguments

TFFsystems List of Turbo Fluid Flow Systems
Type List<DataReference>

Edit

This command class launches the Turbo Setup popup GUI.

GetTurboFluidFlowSystems

Returns the Data References to the Turbo Fluid Flow systems used by the Turbo Setup for Performance Maps.

Return Data References to the associated Turbo Fluid Flow systems
Type List<DataReference>

GetTurboSetupProperties

Returns the Data Entity which contains user settings and properties for the Turbo Setup container.

Return Reference to the requested Data Entity
Type DataReference

ReadOperatingPoints

This command class updates the Turbo Setup performance map with changes made to the operating points in the parameter manager.

ReadPerformanceMapResults

This command class reads the results parameters from the Turbo Fluid Flow systems referenced by the Turbo Setup and populates the corresponding Turbo Setup results properties.

Return List of Turbo Fluid Flow Systems
Type List<DataReference>

WriteOperatingPoints

This command class creates/updates the parameter manager with the design points defined by the Turbo Setup performance map.

Data Entities

TurboSetupProperties

This data entity provides access to the properties which define the Turbo Setup component.

Properties

Acentric

This property specifies the acentric factor for the working fluid. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float
Read Only No

Alpha3

This property specifies the flow angle at the inlet to the machine in the absolute reference frame.

Type Quantity
Read Only No

BaseDutyPoint

Reference to the base duty operating point

Type DataReference
Read Only Yes

BaseDutyResults

Dictionary of results for the base duty point. The dictionary Key is the Turbo Fluid Flow system. The dictionary Value is itself a dictionary holding the results parameter references and corresponding Quantities

Type Dictionary<DataReference, Dictionary<DataReference, Quantity>>
Read Only Yes

BaseSpeedParam

Reference to the base duty speed parameter

Type DataReference
Read Only Yes

ComponentConfig

This property specifies the configuration of the components which the machine is comprised of.

Available options:

Impeller and Vaneless Diffuser

Type ComponentConfigType
Read Only No

Cp_A0

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature over two temperature ranges. This property specifies the constant component (coefficient of T^0) of the lower temperature range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type double
Read Only No

Cp_A1

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature over two temperature ranges. This property specifies the coefficient of T^1 of the lower temperature range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type double
Read Only No

Cp_A2

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature over two temperature ranges. This property specifies the coefficient of T^2 of the lower temperature range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type double
Read Only No

Cp_A3

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature over two temperature ranges. This property specifies the coefficient of T^3 of the lower temperature range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type double
Read Only No

Cp_A4

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature over two temperature ranges. This property specifies the coefficient of T^4 of the lower temperature range polynomial. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type double
Read Only No

Cp_Amax

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature over two temperature ranges. This property specifies the maximum temperature limit for which the lower temperature range polynomial is applicable. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float
Read Only No

Cp_Amin

For a user-defined real gas, the specific heat capacity is specified as a polynomial function of temperature over two temperature ranges. This property specifies the minimum temperature limit for which the lower temperature range polynomial is applicable. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type float
Read Only No

CriticalPressure

This property specifies the critical pressure for the working fluid. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity
Read Only No

CriticalTemp

This property specifies the critical temperature for the working fluid. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity
Read Only No

CriticalVol

This property specifies the critical volume for the working fluid. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Real'.

Type Quantity
Read Only No

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type string
Read Only No

GammaUser

This property specifies the ratio of specific heats for the working fluid. Note that this is only available when MaterialPropsOption is set to 'User' and the GasModelOption is set to 'Ideal'.

Type float
Read Only No

GasModel

This property specifies whether to treat the working fluid as an Ideal or a Real gas.

Available options:

Ideal

Real

Type GasModelType
Read Only No

ImperialUnits

Imperial units option

Type bool
Read Only No

IncludeOutOfDate

persistent flag to include out-of-date points on the performance map plot

Type bool
Read Only Yes

MassFlow

This property specifies the design point mass flow rate passing through the machine.

Type Quantity
Read Only No

MassFlowRates

Mass flow rates used to define the performance map

Type List<List<Quantity>>
Read Only Yes

MassParam

Reference to the mass flow rate parameter in the performance map

Type DataReference
Read Only Yes

MaterialNameSelection

This property specifies the name of the working fluid, as selected from the database. Note that this is only available when the MaterialPropsOption is set to 'Database'.

Available options:

air

carbon_dioxide

hydrogen

methane

nitrogen

oxygen

parahydrogen

propylene

R123

R125

R134a

R141b

R142b

R245fa

water

Type MaterialNamesList
Read Only No

MaterialPropsOption

This property specifies whether the working fluid properties are chosen from the materials database or specified directly by the user.

Available options:

Database

User

Type MaterialPropsType
Read Only No

MaxFlow1

Maximum flow rate on speedline 1.

Type Quantity
Read Only No

MaxFlow10

Maximum flow rate on speedline 10.

Type Quantity
Read Only No

MaxFlow11

Maximum flow rate on speedline 11.

Type Quantity
Read Only No

MaxFlow12

Maximum flow rate on speedline 12.

Type Quantity
Read Only No

MaxFlow13

Maximum flow rate on speedline 13.

Type Quantity
Read Only No

MaxFlow14

Maximum flow rate on speedline 14.

Type Quantity
Read Only No

MaxFlow15

Maximum flow rate on speedline 15.

Type Quantity
Read Only No

MaxFlow2

Maximum flow rate on speedline 2.

Type Quantity
Read Only No

MaxFlow3

Maximum flow rate on speedline 3.

Type Quantity
Read Only No

MaxFlow4

Maximum flow rate on speedline 4.

Type Quantity
Read Only No

MaxFlow5

Maximum flow rate on speedline 5.

Type Quantity
Read Only No

MaxFlow6

Maximum flow rate on speedline 6.

Type Quantity
Read Only No

MaxFlow7

Maximum flow rate on speedline 7.

Type Quantity
Read Only No

MaxFlow8

Maximum flow rate on speedline 8.

Type Quantity
Read Only No

MaxFlow9

Maximum flow rate on speedline 9.

Type Quantity
Read Only No

MaxFlowrates

Maximum number of flow rates per speedline permitted

Type int
Read Only Yes

MaxIterParam

Reference to the maximum iteration parameter in the performance map

Type DataReference
Read Only Yes

MaxSpeedlines

Maximum number of speedlines permitted

Type int
Read Only Yes

MeshNodeCount

This property specifies the target passage node count used with the ATM meshing scheme in TurboGrid The minimum value for this property is 50,000 nodes

Type int
Read Only No

MinFlow1

Minimum flow rate on speedline 1.

Type Quantity
Read Only No

MinFlow10

Minimum flow rate on speedline 10.

Type Quantity
Read Only No

MinFlow11

Minimum flow rate on speedline 11.

Type Quantity
Read Only No

MinFlow12

Minimum flow rate on speedline 12.

Type Quantity
Read Only No

MinFlow13

Minimum flow rate on speedline 13.

Type Quantity
Read Only No

MinFlow14

Minimum flow rate on speedline 14.

Type Quantity
Read Only No

MinFlow15

Minimum flow rate on speedline 15.

Type Quantity
Read Only No

MinFlow2

Minimum flow rate on speedline 2.

Type Quantity
Read Only No

MinFlow3

Minimum flow rate on speedline 3.

Type Quantity
Read Only No

MinFlow4

Minimum flow rate on speedline 4.

Type Quantity
Read Only No

MinFlow5

Minimum flow rate on speedline 5.

Type Quantity
Read Only No

MinFlow6

Minimum flow rate on speedline 6.

Type Quantity
Read Only No

MinFlow7

Minimum flow rate on speedline 7.

Type Quantity
Read Only No

MinFlow8

Minimum flow rate on speedline 8.

Type Quantity
Read Only No

MinFlow9

Minimum flow rate on speedline 9.

Type Quantity
Read Only No

MuUser

This property specifies the dynamic viscosity of the working fluid.

Type Quantity
Read Only No

NFlow1

The number of mass flow rates specified on speedline 1.

Type int
Read Only No

NFlow10

The number of mass flow rates specified on speedline 10.

Type int
Read Only No

NFlow11

The number of mass flow rates specified on speedline 11.

Type int
Read Only No

NFlow12

The number of mass flow rates specified on speedline 12.

Type int
Read Only No

NFlow13

The number of mass flow rates specified on speedline 13.

Type int
Read Only No

NFlow14

The number of mass flow rates specified on speedline 14.

Type int
Read Only No

NFlow15

The number of mass flow rates specified on speedline 15.

Type int
Read Only No

NFlow2

The number of mass flow rates specified on speedline 2.

Type int
Read Only No

NFlow3

The number of mass flow rates specified on speedline 3.

Type int
Read Only No

NFlow4

The number of mass flow rates specified on speedline 4.

Type int
Read Only No

NFlow5

The number of mass flow rates specified on speedline 5.

Type int
Read Only No

NFlow6

The number of mass flow rates specified on speedline 6.

Type int
Read Only No

NFlow7

The number of mass flow rates specified on speedline 7.

Type int
Read Only No

NFlow8

The number of mass flow rates specified on speedline 8.

Type int
Read Only No

NFlow9

The number of mass flow rates specified on speedline 9.

Type int
Read Only No

NFlows

Number of flow rates per speedline in the performance map

Type List<int>
Read Only Yes

NSpeeds

The number of speedlines to be calculated by the Turbo Fluid Flow system.

Type int
Read Only No

Omega

This property specifies the design point rotational speed of the impeller.

Type Quantity
Read Only No

Omega1

The percentage rotational speed of the impeller for speedline 1.

Type int
Read Only No

Omega10

The percentage rotational speed of the impeller for speedline 10.

Type int
Read Only No

Omega11

The percentage rotational speed of the impeller for speedline 11.

Type int
Read Only No

Omega12

The percentage rotational speed of the impeller for speedline 12.

Type int
Read Only No

Omega13

The percentage rotational speed of the impeller for speedline 13.

Type int
Read Only No

Omega14

The percentage rotational speed of the impeller for speedline 14.

Type int
Read Only No

Omega15

The percentage rotational speed of the impeller for speedline 15.

Type int
Read Only No

Omega2

The percentage rotational speed of the impeller for speedline 2.

Type int
Read Only No

Omega3

The percentage rotational speed of the impeller for speedline 3.

Type int
Read Only No

Omega4

The percentage rotational speed of the impeller for speedline 4.

Type int
Read Only No

Omega5

The percentage rotational speed of the impeller for speedline 5.

Type int
Read Only No

Omega6

The percentage rotational speed of the impeller for speedline 6.

Type int
Read Only No

Omega7

The percentage rotational speed of the impeller for speedline 7.

Type int
Read Only No

Omega8

The percentage rotational speed of the impeller for speedline 8.

Type int
Read Only No

Omega9

The percentage rotational speed of the impeller for speedline 9.

Type int
Read Only No

OperatingPts

References to the operating points in the performance map

Type List<List<DataReference>>
Read Only Yes

Preswirl

This property specifies how the radial distribution of the preswirl angle is calculated.

Available options:

constant

free

forced

linear

Type PreswirlType
Read Only No