Vista TF Setup
Vista TF Setup
This container holds Setup data for an instance of Vista TF.
Methods
GetSetupEntity
This query is used to retrieve the Vista TF Setup data entity for the specified container.
-
ReturnA reference to the requested data entity. - Type DataReference
ImportAeroTemplate
Imports throughflow aerodynamic data into the Vista TF Setup from an existing throughflow aero template (.aert) file.
Required Arguments
- FilePath Path of the file to be imported.
- Type string
ImportControlTemplate
Imports throughflow control data into the Vista TF Setup from an existing throughflow control template (.cont) file.
Required Arguments
- FilePath Path of the file to be imported.
- Type string
ImportCorrelationsTemplate
Imports throughflow correlations data into the Vista TF Setup from an existing throughflow correlations template (.cort) file.
Required Arguments
- FilePath Path of the file to be imported.
- Type string
ImportCustomRealGas
Imports custom real gas data into the Vista TF Setup from a real gas file (.rgp)
Required Arguments
- FilePath Path of the file to be imported.
- Type string
ImportGeometry
Imports throughflow geometry data into the Vista TF Setup from an existing throughflow geometry (.geo) file.
Required Arguments
- FilePath Path of the file to be imported.
- Type string
Data Entities
VistaTFSetup
This data entity represents a Vista TF project definition on a geometry.
Properties
ConditionsFromUpstream
Flag to choose whether to update operating conditions from upstream cell or not
- Type bool
- Read Only No
CpGas
Specifies the gas specific heat at constant pressure when FluidOption = IdealGas.
- Type Quantity
- Read Only No
CustomRealGasFilename
The filename for the specified custom real gas file. Only used where the custom real gas option is specified.
- Type string
- 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
DynamicViscosity
Specifies the fluid dynamic viscosity or machine Reynolds number.
Available options:
| A value less than 1 [N s m^-2] (or equivalent value in other units) is interpreted as the dynamic viscosity. Note that the value must be greater than 0.0000001 [N s m^-2]. |
| A value of 0 causes Vista TF to calculate the dynamic viscosity from an inbuilt equation for dynamic viscosity based on Sutherland's law and the Inlet Total Temperature. This works only for an ideal gas. |
| A value greater than 1 [N s m^-2] (or equivalent value in other units) is interpreted as the Reynolds number, in which case Vista TF calculates the dynamic viscosity using this Reynolds number, the Reference Diameter, the Machine Rotational Speed, and the fluid density. |
- Type Quantity
- Read Only No
FlowOption
Specifies the types of boundary conditions.
Available options:
| MassFlow | Specify the estimated mass flow rate and the total to static pressure ratio on the mean streamline. |
| Specify the mass flow rate and the inlet total pressure and total temperature conditions. | PressureDifference |
| PressureRatio | Specify the estimated mass flow rate and the total to static pressure difference on the mean streamline. |
- Type FlowType
- Read Only No
FluidOption
Specifies the type of fluid.
Available options:
| IdealGas | For compressible flow with real gas properties |
| For compressible flows with ideal gas properties. | Liquid |
| RealGas | For incompressible flows. |
- Type FluidType
- Read Only No
InitialCmUref
Specifies the initial guess for the meridional velocity divided by a characteristic velocity, where the latter is half the Reference Diameter multiplied by the Machine Rotational Speed. For more information, see the description for cm_start in Specification of the Control Data File (*.con) in the Vista TF Reference Guide.
- Type float
- Read Only No
InletSwirlAngle
Specifies the inlet swirl angle, which is from the axial direction and positive in the direction of rotation.
- Type Quantity
- Read Only No
MachineTypeOption
Specifies the type of machine that will be analyzed. This property specifies which template files are used and which report is used for the results. This property is only available if the geometry data is imported rather than transferred from BladeEditor.
Available options:
| Pump |
| AxialCompressor |
| CentrifugalCompressor |
| Fan |
| AxialTurbine |
| RadialTurbine |
| HydraulicTurbine |
| Unknown |
| Other (Obsolete use Unknown) |
- Type MachineType
- Read Only No
MassFlow
Specifies the mass flow rate when FlowOption = MassFlow or the estimated mass flow rate when FlowOption = PressureRatio or PressureDifference.
- Type Quantity
- Read Only No
MaxIterations
Specifies the number of calculating streamlines used in the solver.
- Type int
- Read Only No
NumBladeRows
Specifies the number of blade rows solved in the analysis. This property is only available if the geometry data is imported rather than transferred from BladeEditor, and it is only used by the report template for the Results.
- Type int
- Read Only No
NumStreamlines
Specifies the number of calculating streamlines used in the solver.
- Type int
- Read Only No
PolytropicEfficiency
Specifies the small scale polytropic efficiency for the machine, and is used to calculate the losses.
- Type float
- Read Only No
PressureDifference
Specifies the total to static pressure difference on the mean streamline when FlowOption = PressureDifference.
- Type Quantity
- Read Only No
PressureRatio
Specifies the total to static pressure ratio on the mean streamline when FlowOption = PressureRatio.
- Type float
- Read Only No
RefDiameter
Specifies the reference diameter for the definition of the flow coefficient.
- Type Quantity
- Read Only No
RefDiameterOption
Specifies whether to have Vista TF calculate the reference diameter automatically or to use a user defined value.
Available options:
| Automatic | User defined |
| Reference diameter is calculated using the first rotating component. | Reference diameter is specified by the user. |
- Type RefDiameterType
- Read Only No
RotationalDirection
Specifies the positive direction of machine rotation about the Z-axis.
Available options:
| RightHanded | LeftHanded |
| Positive rotation is clockwise about the Z-axis. | Positive rotation is counterclockwise about the Z-axis. |
- Type RotationType
- Read Only No