Icepak templates and arguments#
This section lists all setup templates with their default values and keys available in Icepak.
Note that Icepak parameters contain spaces. To use them as arguments of the "create_setup" method, these
same parameters have to be used without spaces.
You can edit a setup after it is created. Here is an example:
from ansys.aedt.core import Icepak
app = Icepak()
# Any property of this setup can be found on this page.
setup = app.create_setup(MaxIterations=5)
Available turbulent models are: "ZeroEquation", "TwoEquation", "EnhancedTwoEquation", "RNG", "EnhancedRNG", "RealizableTwoEquation", "EnhancedRealizableTwoEquation", "SpalartAllmaras", "kOmegaSST".
{ 'Control Program Name': '',
'Convergence Criteria - Discrete Ordinates': '1e-06',
'Convergence Criteria - Energy': '1e-07',
'Convergence Criteria - Flow': '0.001',
'Convergence Criteria - Specific Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Kinetic Energy': '0.001',
'Copy Fields From Source': False,
'Coupled pressure-velocity formulation': False,
'Discretization Scheme - Discrete Ordinates': 'First',
'Discretization Scheme - Momentum': 'First',
'Discretization Scheme - Pressure': 'Standard',
'Discretization Scheme - Specific Dissipation Rate': 'First',
'Discretization Scheme - Temperature': 'First',
'Discretization Scheme - Turbulent Dissipation Rate': 'First',
'Discretization Scheme - Turbulent Kinetic Energy': 'First',
'Enable Control Program': False,
'Enabled': True,
'Flow Regime': 'Laminar',
'Frozen Flow Simulation': False,
'Import Start Time': False,
'Include Flow': True,
'Include Gravity': False,
'Include Solar': False,
'Include Temperature': False,
'IsEnabled': False,
'Iterations per Time Step': 20,
'Linear Solver Residual Reduction Tolerance - Momentum': '0.1',
'Linear Solver Residual Reduction Tolerance - Pressure': '0.1',
'Linear Solver Residual Reduction Tolerance - Specific Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Temperature': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Kinetic Energy': '0.1',
'Linear Solver Stabilization - Pressure': 'None',
'Linear Solver Stabilization - Temperature': 'None',
'Linear Solver Termination Criterion - Momentum': '0.1',
'Linear Solver Termination Criterion - Pressure': '0.1',
'Linear Solver Termination Criterion - Specific Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Temperature': '0.1',
'Linear Solver Termination Criterion - Turbulent Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Turbulent Kinetic Energy': '0.1',
'Linear Solver Type - Momentum': 'flex',
'Linear Solver Type - Pressure': 'V',
'Linear Solver Type - Specific Dissipation Rate': 'flex',
'Linear Solver Type - Temperature': 'F',
'Linear Solver Type - Turbulent Dissipation Rate': 'flex',
'Linear Solver Type - Turbulent Kinetic Energy': 'flex',
'N Steps': '10',
'Radiation Model': 'Off',
'SaveFieldsType': 'Every N Steps',
'Secondary Gradient': False,
'Solar Radiation - Day': 1,
'Solar Radiation - GMT': '0',
'Solar Radiation - Ground Reflectance': '0',
'Solar Radiation - Hours': 0,
'Solar Radiation - Latitude': '0',
'Solar Radiation - Latitude Direction': 'East',
'Solar Radiation - Longitude': '0',
'Solar Radiation - Longitude Direction': 'North',
'Solar Radiation - Minutes': 0,
'Solar Radiation - Month': 1,
'Solar Radiation - North X': '0',
'Solar Radiation - North Y': '0',
'Solar Radiation - North Z': '1',
'Solar Radiation - Scattering Fraction': '0',
'Solar Radiation - Sunshine Fraction': '0',
'Solar Radiation Model': 'Solar Radiation Calculator',
'Solution Initialization - Specific Dissipation Rate': '1diss_per_s',
'Solution Initialization - Temperature': 'AmbientTemp',
'Solution Initialization - Turbulent Dissipation Rate': '1m2_per_s3',
'Solution Initialization - Turbulent Kinetic Energy': '1m2_per_s2',
'Solution Initialization - Use Model Based Flow Initialization': False,
'Solution Initialization - X Velocity': '0m_per_sec',
'Solution Initialization - Y Velocity': '0m_per_sec',
'Solution Initialization - Z Velocity': '0m_per_sec',
'Start Time': '0s',
'Stop Time': '20s',
'Time Step': '1s',
'Turbulent Model Eqn': 'ZeroEquation',
'Under-relaxation - Momentum': '0.7',
'Under-relaxation - Pressure': '0.3',
'Under-relaxation - Specific Dissipation Rate': '0.8',
'Under-relaxation - Temperature': '1',
'Under-relaxation - Turbulent Dissipation Rate': '0.8',
'Under-relaxation - Turbulent Kinetic Energy': '0.8'}
{ 'Control Program Name': '',
'Convergence Criteria - Discrete Ordinates': '1e-06',
'Convergence Criteria - Energy': '1e-07',
'Convergence Criteria - Flow': '0.001',
'Convergence Criteria - Specific Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Kinetic Energy': '0.001',
'Copy Fields From Source': False,
'Coupled pressure-velocity formulation': False,
'Discretization Scheme - Discrete Ordinates': 'First',
'Discretization Scheme - Momentum': 'First',
'Discretization Scheme - Pressure': 'Standard',
'Discretization Scheme - Specific Dissipation Rate': 'First',
'Discretization Scheme - Temperature': 'First',
'Discretization Scheme - Turbulent Dissipation Rate': 'First',
'Discretization Scheme - Turbulent Kinetic Energy': 'First',
'Enable Control Program': False,
'Enabled': True,
'Flow Regime': 'Laminar',
'Frozen Flow Simulation': False,
'Import Start Time': False,
'Include Flow': False,
'Include Gravity': False,
'Include Solar': False,
'Include Temperature': True,
'IsEnabled': False,
'Iterations per Time Step': 20,
'Linear Solver Residual Reduction Tolerance - Momentum': '0.1',
'Linear Solver Residual Reduction Tolerance - Pressure': '0.1',
'Linear Solver Residual Reduction Tolerance - Specific Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Temperature': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Kinetic Energy': '0.1',
'Linear Solver Stabilization - Pressure': 'None',
'Linear Solver Stabilization - Temperature': 'None',
'Linear Solver Termination Criterion - Momentum': '0.1',
'Linear Solver Termination Criterion - Pressure': '0.1',
'Linear Solver Termination Criterion - Specific Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Temperature': '0.1',
'Linear Solver Termination Criterion - Turbulent Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Turbulent Kinetic Energy': '0.1',
'Linear Solver Type - Momentum': 'flex',
'Linear Solver Type - Pressure': 'V',
'Linear Solver Type - Specific Dissipation Rate': 'flex',
'Linear Solver Type - Temperature': 'F',
'Linear Solver Type - Turbulent Dissipation Rate': 'flex',
'Linear Solver Type - Turbulent Kinetic Energy': 'flex',
'N Steps': '10',
'Radiation Model': 'Off',
'SaveFieldsType': 'Every N Steps',
'Secondary Gradient': False,
'Solar Radiation - Day': 1,
'Solar Radiation - GMT': '0',
'Solar Radiation - Ground Reflectance': '0',
'Solar Radiation - Hours': 0,
'Solar Radiation - Latitude': '0',
'Solar Radiation - Latitude Direction': 'East',
'Solar Radiation - Longitude': '0',
'Solar Radiation - Longitude Direction': 'North',
'Solar Radiation - Minutes': 0,
'Solar Radiation - Month': 1,
'Solar Radiation - North X': '0',
'Solar Radiation - North Y': '0',
'Solar Radiation - North Z': '1',
'Solar Radiation - Scattering Fraction': '0',
'Solar Radiation - Sunshine Fraction': '0',
'Solar Radiation Model': 'Solar Radiation Calculator',
'Solution Initialization - Specific Dissipation Rate': '1diss_per_s',
'Solution Initialization - Temperature': 'AmbientTemp',
'Solution Initialization - Turbulent Dissipation Rate': '1m2_per_s3',
'Solution Initialization - Turbulent Kinetic Energy': '1m2_per_s2',
'Solution Initialization - Use Model Based Flow Initialization': False,
'Solution Initialization - X Velocity': '0m_per_sec',
'Solution Initialization - Y Velocity': '0m_per_sec',
'Solution Initialization - Z Velocity': '0m_per_sec',
'Start Time': '0s',
'Stop Time': '20s',
'Time Step': '1s',
'Turbulent Model Eqn': 'ZeroEquation',
'Under-relaxation - Momentum': '0.7',
'Under-relaxation - Pressure': '0.3',
'Under-relaxation - Specific Dissipation Rate': '0.8',
'Under-relaxation - Temperature': '1',
'Under-relaxation - Turbulent Dissipation Rate': '0.8',
'Under-relaxation - Turbulent Kinetic Energy': '0.8'}
{ 'Control Program Name': '',
'Convergence Criteria - Discrete Ordinates': '1e-06',
'Convergence Criteria - Energy': '1e-07',
'Convergence Criteria - Flow': '0.001',
'Convergence Criteria - Specific Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Kinetic Energy': '0.001',
'Copy Fields From Source': False,
'Coupled pressure-velocity formulation': False,
'Discretization Scheme - Discrete Ordinates': 'First',
'Discretization Scheme - Momentum': 'First',
'Discretization Scheme - Pressure': 'Standard',
'Discretization Scheme - Specific Dissipation Rate': 'First',
'Discretization Scheme - Temperature': 'First',
'Discretization Scheme - Turbulent Dissipation Rate': 'First',
'Discretization Scheme - Turbulent Kinetic Energy': 'First',
'Enable Control Program': False,
'Enabled': True,
'Flow Regime': 'Laminar',
'Frozen Flow Simulation': False,
'Import Start Time': False,
'Include Flow': True,
'Include Gravity': False,
'Include Solar': False,
'Include Temperature': True,
'IsEnabled': False,
'Iterations per Time Step': 20,
'Linear Solver Residual Reduction Tolerance - Momentum': '0.1',
'Linear Solver Residual Reduction Tolerance - Pressure': '0.1',
'Linear Solver Residual Reduction Tolerance - Specific Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Temperature': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Kinetic Energy': '0.1',
'Linear Solver Stabilization - Pressure': 'None',
'Linear Solver Stabilization - Temperature': 'None',
'Linear Solver Termination Criterion - Momentum': '0.1',
'Linear Solver Termination Criterion - Pressure': '0.1',
'Linear Solver Termination Criterion - Specific Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Temperature': '0.1',
'Linear Solver Termination Criterion - Turbulent Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Turbulent Kinetic Energy': '0.1',
'Linear Solver Type - Momentum': 'flex',
'Linear Solver Type - Pressure': 'V',
'Linear Solver Type - Specific Dissipation Rate': 'flex',
'Linear Solver Type - Temperature': 'F',
'Linear Solver Type - Turbulent Dissipation Rate': 'flex',
'Linear Solver Type - Turbulent Kinetic Energy': 'flex',
'N Steps': '10',
'Radiation Model': 'Off',
'SaveFieldsType': 'Every N Steps',
'Secondary Gradient': False,
'Solar Radiation - Day': 1,
'Solar Radiation - GMT': '0',
'Solar Radiation - Ground Reflectance': '0',
'Solar Radiation - Hours': 0,
'Solar Radiation - Latitude': '0',
'Solar Radiation - Latitude Direction': 'East',
'Solar Radiation - Longitude': '0',
'Solar Radiation - Longitude Direction': 'North',
'Solar Radiation - Minutes': 0,
'Solar Radiation - Month': 1,
'Solar Radiation - North X': '0',
'Solar Radiation - North Y': '0',
'Solar Radiation - North Z': '1',
'Solar Radiation - Scattering Fraction': '0',
'Solar Radiation - Sunshine Fraction': '0',
'Solar Radiation Model': 'Solar Radiation Calculator',
'Solution Initialization - Specific Dissipation Rate': '1diss_per_s',
'Solution Initialization - Temperature': 'AmbientTemp',
'Solution Initialization - Turbulent Dissipation Rate': '1m2_per_s3',
'Solution Initialization - Turbulent Kinetic Energy': '1m2_per_s2',
'Solution Initialization - Use Model Based Flow Initialization': False,
'Solution Initialization - X Velocity': '0m_per_sec',
'Solution Initialization - Y Velocity': '0m_per_sec',
'Solution Initialization - Z Velocity': '0m_per_sec',
'Start Time': '0s',
'Stop Time': '20s',
'Time Step': '1s',
'Turbulent Model Eqn': 'ZeroEquation',
'Under-relaxation - Momentum': '0.7',
'Under-relaxation - Pressure': '0.3',
'Under-relaxation - Specific Dissipation Rate': '0.8',
'Under-relaxation - Temperature': '1',
'Under-relaxation - Turbulent Dissipation Rate': '0.8',
'Under-relaxation - Turbulent Kinetic Energy': '0.8'}
{ 'Convergence Criteria - Discrete Ordinates': '1e-06',
'Convergence Criteria - Energy': '1e-07',
'Convergence Criteria - Flow': '0.001',
'Convergence Criteria - Max Iterations': 100,
'Convergence Criteria - Specific Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Kinetic Energy': '0.001',
'Discretization Scheme - Discrete Ordinates': 'First',
'Discretization Scheme - Momentum': 'First',
'Discretization Scheme - Pressure': 'Standard',
'Discretization Scheme - Specific Dissipation Rate': 'First',
'Discretization Scheme - Temperature': 'First',
'Discretization Scheme - Turbulent Dissipation Rate': 'First',
'Discretization Scheme - Turbulent Kinetic Energy': 'First',
'Enabled': True,
'Flow Regime': 'Laminar',
'Frozen Flow Simulation': False,
'Include Flow': True,
'Include Gravity': False,
'IsEnabled': False,
'Linear Solver Residual Reduction Tolerance - Momentum': '0.1',
'Linear Solver Residual Reduction Tolerance - Pressure': '0.1',
'Linear Solver Residual Reduction Tolerance - Specific Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Temperature': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Kinetic Energy': '0.1',
'Linear Solver Stabilization - Pressure': 'None',
'Linear Solver Stabilization - Temperature': 'None',
'Linear Solver Termination Criterion - Momentum': '0.1',
'Linear Solver Termination Criterion - Pressure': '0.1',
'Linear Solver Termination Criterion - Specific Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Temperature': '0.1',
'Linear Solver Termination Criterion - Turbulent Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Turbulent Kinetic Energy': '0.1',
'Linear Solver Type - Momentum': 'flex',
'Linear Solver Type - Pressure': 'V',
'Linear Solver Type - Specific Dissipation Rate': 'flex',
'Linear Solver Type - Temperature': 'F',
'Linear Solver Type - Turbulent Dissipation Rate': 'flex',
'Linear Solver Type - Turbulent Kinetic Energy': 'flex',
'Radiation Model': 'Off',
'Secondary Gradient': False,
'Sequential Solve of Flow and Energy Equations': False,
'Solution Initialization - Specific Dissipation Rate': '1diss_per_s',
'Solution Initialization - Temperature': 'AmbientTemp',
'Solution Initialization - Turbulent Dissipation Rate': '1m2_per_s3',
'Solution Initialization - Turbulent Kinetic Energy': '1m2_per_s2',
'Solution Initialization - X Velocity': '0m_per_sec',
'Solution Initialization - Y Velocity': '0m_per_sec',
'Solution Initialization - Z Velocity': '0m_per_sec',
'Turbulent Model Eqn': 'ZeroEquation',
'Under-relaxation - Momentum': '0.3',
'Under-relaxation - Pressure': '0.7',
'Under-relaxation - Specific Dissipation Rate': '0.8',
'Under-relaxation - Temperature': '1',
'Under-relaxation - Turbulent Dissipation Rate': '0.8',
'Under-relaxation - Turbulent Kinetic Energy': '0.8'}
{ 'Convergence Criteria - Discrete Ordinates': '1e-06',
'Convergence Criteria - Energy': '1e-07',
'Convergence Criteria - Flow': '0.001',
'Convergence Criteria - Max Iterations': 100,
'Convergence Criteria - Specific Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Kinetic Energy': '0.001',
'Discretization Scheme - Discrete Ordinates': 'First',
'Discretization Scheme - Momentum': 'First',
'Discretization Scheme - Pressure': 'Standard',
'Discretization Scheme - Specific Dissipation Rate': 'First',
'Discretization Scheme - Temperature': 'Second',
'Discretization Scheme - Turbulent Dissipation Rate': 'First',
'Discretization Scheme - Turbulent Kinetic Energy': 'First',
'Enabled': True,
'Flow Regime': 'Laminar',
'Include Gravity': False,
'Include Temperature': True,
'IsEnabled': False,
'Linear Solver Residual Reduction Tolerance - Momentum': '0.1',
'Linear Solver Residual Reduction Tolerance - Pressure': '0.1',
'Linear Solver Residual Reduction Tolerance - Specific Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Temperature': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Kinetic Energy': '0.1',
'Linear Solver Stabilization - Pressure': 'None',
'Linear Solver Stabilization - Temperature': 'None',
'Linear Solver Termination Criterion - Momentum': '0.1',
'Linear Solver Termination Criterion - Pressure': '0.1',
'Linear Solver Termination Criterion - Specific Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Temperature': '0.1',
'Linear Solver Termination Criterion - Turbulent Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Turbulent Kinetic Energy': '0.1',
'Linear Solver Type - Momentum': 'flex',
'Linear Solver Type - Pressure': 'V',
'Linear Solver Type - Specific Dissipation Rate': 'flex',
'Linear Solver Type - Temperature': 'F',
'Linear Solver Type - Turbulent Dissipation Rate': 'flex',
'Linear Solver Type - Turbulent Kinetic Energy': 'flex',
'Radiation Model': 'Off',
'Secondary Gradient': False,
'Sequential Solve of Flow and Energy Equations': False,
'Solution Initialization - Specific Dissipation Rate': '1diss_per_s',
'Solution Initialization - Temperature': 'AmbientTemp',
'Solution Initialization - Turbulent Dissipation Rate': '1m2_per_s3',
'Solution Initialization - Turbulent Kinetic Energy': '1m2_per_s2',
'Solution Initialization - X Velocity': '0m_per_sec',
'Solution Initialization - Y Velocity': '0m_per_sec',
'Solution Initialization - Z Velocity': '0m_per_sec',
'Turbulent Model Eqn': 'ZeroEquation',
'Under-relaxation - Momentum': '0.3',
'Under-relaxation - Pressure': '0.7',
'Under-relaxation - Specific Dissipation Rate': '0.8',
'Under-relaxation - Temperature': '1',
'Under-relaxation - Turbulent Dissipation Rate': '0.8',
'Under-relaxation - Turbulent Kinetic Energy': '0.8'}
{ 'Convergence Criteria - Discrete Ordinates': '1e-06',
'Convergence Criteria - Energy': '1e-07',
'Convergence Criteria - Flow': '0.001',
'Convergence Criteria - Max Iterations': 100,
'Convergence Criteria - Specific Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Dissipation Rate': '0.001',
'Convergence Criteria - Turbulent Kinetic Energy': '0.001',
'Discretization Scheme - Discrete Ordinates': 'First',
'Discretization Scheme - Momentum': 'First',
'Discretization Scheme - Pressure': 'Standard',
'Discretization Scheme - Specific Dissipation Rate': 'First',
'Discretization Scheme - Temperature': 'Second',
'Discretization Scheme - Turbulent Dissipation Rate': 'First',
'Discretization Scheme - Turbulent Kinetic Energy': 'First',
'Enabled': True,
'Flow Regime': 'Laminar',
'Frozen Flow Simulation': False,
'Include Flow': True,
'Include Gravity': False,
'Include Temperature': True,
'IsEnabled': False,
'Linear Solver Residual Reduction Tolerance - Momentum': '0.1',
'Linear Solver Residual Reduction Tolerance - Pressure': '0.1',
'Linear Solver Residual Reduction Tolerance - Specific Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Temperature': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Dissipation Rate': '0.1',
'Linear Solver Residual Reduction Tolerance - Turbulent Kinetic Energy': '0.1',
'Linear Solver Stabilization - Pressure': 'None',
'Linear Solver Stabilization - Temperature': 'None',
'Linear Solver Termination Criterion - Momentum': '0.1',
'Linear Solver Termination Criterion - Pressure': '0.1',
'Linear Solver Termination Criterion - Specific Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Temperature': '0.1',
'Linear Solver Termination Criterion - Turbulent Dissipation Rate': '0.1',
'Linear Solver Termination Criterion - Turbulent Kinetic Energy': '0.1',
'Linear Solver Type - Momentum': 'flex',
'Linear Solver Type - Pressure': 'V',
'Linear Solver Type - Specific Dissipation Rate': 'flex',
'Linear Solver Type - Temperature': 'F',
'Linear Solver Type - Turbulent Dissipation Rate': 'flex',
'Linear Solver Type - Turbulent Kinetic Energy': 'flex',
'Radiation Model': 'Off',
'Secondary Gradient': False,
'Sequential Solve of Flow and Energy Equations': False,
'Solution Initialization - Specific Dissipation Rate': '1diss_per_s',
'Solution Initialization - Temperature': 'AmbientTemp',
'Solution Initialization - Turbulent Dissipation Rate': '1m2_per_s3',
'Solution Initialization - Turbulent Kinetic Energy': '1m2_per_s2',
'Solution Initialization - X Velocity': '0m_per_sec',
'Solution Initialization - Y Velocity': '0m_per_sec',
'Solution Initialization - Z Velocity': '0m_per_sec',
'Turbulent Model Eqn': 'ZeroEquation',
'Under-relaxation - Momentum': '0.3',
'Under-relaxation - Pressure': '0.7',
'Under-relaxation - Specific Dissipation Rate': '0.8',
'Under-relaxation - Temperature': '1',
'Under-relaxation - Turbulent Dissipation Rate': '0.8',
'Under-relaxation - Turbulent Kinetic Energy': '0.8'}