solver.datamodel.solver_workflow#

class ansys.fluent.core.generated.datamodel_252.solver_workflow.Root(service, rules, path)#

Bases: PyMenu

Singleton Root.

Classes:

`CellZone`(service, rules[, path])
`FaceZone`(service, rules[, path])
`GlobalSettings`(service, rules, path)	Singleton GlobalSettings.
`JournalCommand`(service, rules, command[, path])	Command JournalCommand.
`TWF_AssociateMesh`(service, rules, command[, ...])	Use this task to associate each cell zone from the imported mesh file(s) with the corresponding row. Parameters ---------- AMChildName : str AMSelectComponentScope : str UseWireframe : bool Toggle the display of the model in wireframe. RenameCellZones : str Determines how your zones names appear once this task is complete, depending on your preferences. When set to Yes, using row names, this field will change the associated cell (or face) zone name according to the corresponding Name. When set to Yes, using row numbers, this field will change the associated cell (or face) zone name according to the corresponding Row number. You can also choose No to keep the zone names as they are. DefaultAMRowNumList : list[str] DefaultAMCellZonesList : list[str] AMRowNumList : list[str] OldAMCellZonesList : list[str] NewAMCellZonesList : list[str].
`TWF_BasicMachineDescription`(service, rules, ...)	This task gathers physical information about the turbomachine such as the machine type (axial compressor or turbine, radial compressor or turbine), the number of blade rows in the machine, and the number of blades in each row, and whether or not there is a tip gap. You must also specify the rotating and stationary blade rows. More... Parameters ---------- ComponentType : str Specify the type of machine component: either an Axial Turbine, Axial Compressor, a Radial Turbine, or a Radial Compressor. ComponentName : str Specify a name for the component, or use the default value. NumRows : int Specify the number of rows for the component. For each row, use the table to provide a Name, a Type (stationary or rotating), the Number of Blades, and whether or not there is a tip gap present (spacing between the blade and the hub/shroud). RowNumList : list[str] OldRowNameList : list[str] NewRowNameList : list[str] OldRowTypeList : list[str] NewRowTypeList : list[str] OldNumOfBladesList : list[str] NewNumOfBladesList : list[str] OldEnableTipGapList : list[str] NewEnableTipGapList : list[str] CombustorType : str.
`TWF_BladeRowAnalysisScope`(service, rules, ...)	Use this task to specify which rows are included in the CFD analysis.
`TWF_CompleteWorkflowSetup`(service, rules, ...)	Command TWF_CompleteWorkflowSetup.
`TWF_CreateCFDModel`(service, rules, command)	Use this task to formally create the CFD model. For each blade row, specify the number of modeled passages (or sectors) per row. Make sure to first specify the Axis of Rotation. Use the graphics window to visually verify and ensure the CFD model is constructed properly. Parameters ---------- CFDMChildName : str CFDMSelectMeshAssociation : str AxisOfRotation : str Specify the rotational axis for the generated CFD turbomachine geometry. DelayCFDModelCreation : bool RestrictToFactors : bool Choose whether or not to restrict the number of model blade sectors to a factor of the number of blades. EstimateNumBlades : bool CFDMRowNumList : list[str] OldCFDMNumOfBladesList : list[str] NewCFDMNumOfBladesList : list[str] OldCFDMModelBladesList : list[str] NewCFDMModelBladesList : list[str] OldCFDMAngleOffset : list[str] NewCFDMAngleOffset : list[str] OldCFDMBladesPerSectorList : list[str] NewCFDMBladesPerSectorList : list[str].
`TWF_ImportMesh`(service, rules, command[, path])	Use this task to supply the mesh for the row you wish to include in the CFD model. You can import a single mesh file that includes all of the rows/passages/blades, or import multiple mesh files that represent each passage/blade. Parameters ---------- AddChild : str MeshFilePath : str Specify the name and location of a single mesh file that includes all the zones, or import multiple mesh files that represent each zone. Standard Ansys mesh file types are supported, including .msh, .msh.h5, .def, .cgns, and .gtm. MeshFilePath_old : str MeshName : str CellZoneNames : list[str] ListItemLevels : list[str] ListItemTitles : list[str] ListOfCellZones : str CellZones : list[str].
`TWF_MapRegionInfo`(service, rules, command[, ...])	Use this task to ensure that, for each cell zone, the face zones correspond to the correct passage region. Use the table to check the associations, or make changes as needed. Parameters ---------- MRChildName : str MRSelectCellZone : str Select a cell zone for which you wish to review associations. UseWireframe : bool In order to more easily visualize highlighted items, use this option to display the 3D wireframe representation of the CFD model in the graphics window. DefaultMRRegionNameList : list[str] DefaultMRFaceZoneList : list[str] MRRegionNameList : list[str] OldMRFaceZoneList : list[str] NewMRFaceZoneList : list[str].
`TWF_ReportDefMonitors`(service, rules, command)	In this task, determine whether or not you want this task to create contour plots of the iso-surfaces you defined as part of the Define Turbo Surfaces task.
`TWF_TurboPhysics`(service, rules, command[, path])	Use this task to specify the turbo-related physics for the machine, such as the rotational speed, operating pressure, and the working fluid.
`TWF_TurboRegionsZones`(service, rules, command)	Use this task to specify the main path inflow and outflow operating conditions.
`TWF_TurboSurfaces`(service, rules, command[, ...])	Use this task to create turbo surfaces at span-wise locations that will be used in solution post processing. By default, the locations will be at 0.25, 0.5, and 0.75. Parameters ---------- NumIsoSurfaces : int Specify the number of turbo iso-surfaces you want to create, or keep the default value of 3. IsoSurfaceNumList : list[str] OldIsoSurfaceNameList : list[str] NewIsoSurfaceNameList : list[str] OldIsoSurfaceValueList : list[str] NewIsoSurfaceValueList : list[str] SurfacesList : list[str].
`TWF_TurboTopology`(service, rules, command[, ...])	Use this task so that Ansys Fluent can compute the turbo coordinates the machine main path inflow and outflow, the hub and shroud, and the side boundaries should be associated. Parameters ---------- TopologyName : str Provide a name for the turbo topology, or use the default name. AddChild : str UseWireframe : bool In order to more easily visualize highlighted items, use this option to display the 3D wireframe representation of the turbo topology model in the graphics window. SkipTurboTopology : bool Use this task so that Ansys Fluent can compute the turbo coordinates the machine main path inflow and outflow, the hub and shroud, and the side boundaries should be associated. DefaultTopologyNameList : list[str] DefaultTopologyZoneList : list[str] TopologyNameList : list[str] OldTopologyZoneList : list[str] NewTopologyZoneList : list[str].
`Zone`(service, rules[, path])
`ZoneList`(service, rules, path)	Singleton ZoneList.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CellZone(service, rules, path=None)#

Bases: PyNamedObjectContainer

class FaceZone(service, rules, path=None)#

Bases: PyNamedObjectContainer

class GlobalSettings(service, rules, path)#

Bases: PyMenu

Singleton GlobalSettings.

Classes:

EnableTurboMeshing(service, rules[, path])

Parameter EnableTurboMeshing of value type bool.

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class EnableTurboMeshing(service, rules, path=None)#

Bases: PyParameter

Parameter EnableTurboMeshing of value type bool.

__init__(service, rules, path)#: __init__ method of PyMenu class.

class JournalCommand(service, rules, command, path=None)#

Bases: PyCommand

Command JournalCommand.

Parameters:

JournalStringstr
PythonJournalbool

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_AssociateMesh(service, rules, command, path=None)#

Bases: PyCommand

Use this task to associate each cell zone from the imported mesh file(s) with the corresponding row. Parameters ———- AMChildName : str AMSelectComponentScope : str UseWireframe : bool

Toggle the display of the model in wireframe.

RenameCellZonesstr: Determines how your zones names appear once this task is complete, depending on your preferences. When set to Yes, using row names, this field will change the associated cell (or face) zone name according to the corresponding Name. When set to Yes, using row numbers, this field will change the associated cell (or face) zone name according to the corresponding Row number. You can also choose No to keep the zone names as they are.

DefaultAMRowNumList : list[str] DefaultAMCellZonesList : list[str] AMRowNumList : list[str] OldAMCellZonesList : list[str] NewAMCellZonesList : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_BasicMachineDescription(service, rules, command, path=None)#

Bases: PyCommand

This task gathers physical information about the turbomachine such as the machine type (axial compressor or turbine, radial compressor or turbine), the number of blade rows in the machine, and the number of blades in each row, and whether or not there is a tip gap. You must also specify the rotating and stationary blade rows. More… Parameters ———- ComponentType : str

Specify the type of machine component: either an Axial Turbine, Axial Compressor, a Radial Turbine, or a Radial Compressor.

ComponentNamestr: Specify a name for the component, or use the default value.
NumRowsint: Specify the number of rows for the component. For each row, use the table to provide a Name, a Type (stationary or rotating), the Number of Blades, and whether or not there is a tip gap present (spacing between the blade and the hub/shroud).

RowNumList : list[str] OldRowNameList : list[str] NewRowNameList : list[str] OldRowTypeList : list[str] NewRowTypeList : list[str] OldNumOfBladesList : list[str] NewNumOfBladesList : list[str] OldEnableTipGapList : list[str] NewEnableTipGapList : list[str] CombustorType : str

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_BladeRowAnalysisScope(service, rules, command, path=None)#

Bases: PyCommand

Use this task to specify which rows are included in the CFD analysis. You must define a single contiguous set of rows. Indicate whether or not to include or exclude the row. The analysis scope can include all the rows defined in the Component Description task or a portion of it. Review the information in the table, and make any changes as needed. More… Parameters ———- ASChildName : str ASSelectComponent : str ASRowNumList : list[str] OldASIncludeRowList : list[str] NewASIncludeRowList : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_CompleteWorkflowSetup(service, rules, command, path=None)#

Bases: PyCommand

Command TWF_CompleteWorkflowSetup.

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_CreateCFDModel(service, rules, command, path=None)#

Bases: PyCommand

Use this task to formally create the CFD model. For each blade row, specify the number of modeled passages (or sectors) per row. Make sure to first specify the Axis of Rotation. Use the graphics window to visually verify and ensure the CFD model is constructed properly. Parameters ———- CFDMChildName : str CFDMSelectMeshAssociation : str AxisOfRotation : str

Specify the rotational axis for the generated CFD turbomachine geometry.

DelayCFDModelCreation : bool RestrictToFactors : bool

Choose whether or not to restrict the number of model blade sectors to a factor of the number of blades.

EstimateNumBlades : bool CFDMRowNumList : list[str] OldCFDMNumOfBladesList : list[str] NewCFDMNumOfBladesList : list[str] OldCFDMModelBladesList : list[str] NewCFDMModelBladesList : list[str] OldCFDMAngleOffset : list[str] NewCFDMAngleOffset : list[str] OldCFDMBladesPerSectorList : list[str] NewCFDMBladesPerSectorList : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_ImportMesh(service, rules, command, path=None)#

Bases: PyCommand

Use this task to supply the mesh for the row you wish to include in the CFD model. You can import a single mesh file that includes all of the rows/passages/blades, or import multiple mesh files that represent each passage/blade. Parameters ———- AddChild : str MeshFilePath : str

Specify the name and location of a single mesh file that includes all the zones, or import multiple mesh files that represent each zone. Standard Ansys mesh file types are supported, including .msh, .msh.h5, .def, .cgns, and .gtm.

MeshFilePath_old : str MeshName : str CellZoneNames : list[str] ListItemLevels : list[str] ListItemTitles : list[str] ListOfCellZones : str CellZones : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_MapRegionInfo(service, rules, command, path=None)#

Bases: PyCommand

Use this task to ensure that, for each cell zone, the face zones correspond to the correct passage region. Use the table to check the associations, or make changes as needed. Parameters ———- MRChildName : str MRSelectCellZone : str

Select a cell zone for which you wish to review associations.

UseWireframebool: In order to more easily visualize highlighted items, use this option to display the 3D wireframe representation of the CFD model in the graphics window.

DefaultMRRegionNameList : list[str] DefaultMRFaceZoneList : list[str] MRRegionNameList : list[str] OldMRFaceZoneList : list[str] NewMRFaceZoneList : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_ReportDefMonitors(service, rules, command, path=None)#

Bases: PyCommand

In this task, determine whether or not you want this task to create contour plots of the iso-surfaces you defined as part of the Define Turbo Surfaces task. In addition, once complete, the workflow will have Fluent automatically create performance parameters such as flow rate, pressure-ratio, efficiency, and so on. Parameters ———- RDIsoSurfaceNumList : list[str] OldCreateContourList : list[str] NewCreateContourList : list[str] TurboContoursList : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_TurboPhysics(service, rules, command, path=None)#

Bases: PyCommand

Use this task to specify the turbo-related physics for the machine, such as the rotational speed, operating pressure, and the working fluid. Parameters ———- States : dict[str, Any]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_TurboRegionsZones(service, rules, command, path=None)#

Bases: PyCommand

Use this task to specify the main path inflow and outflow operating conditions. By default, zones are merged to simplify boundary condition input and based on the target turbo model requirements. Parameters ———- States : dict[str, Any]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_TurboSurfaces(service, rules, command, path=None)#

Bases: PyCommand

Use this task to create turbo surfaces at span-wise locations that will be used in solution post processing. By default, the locations will be at 0.25, 0.5, and 0.75. Parameters ———- NumIsoSurfaces : int

Specify the number of turbo iso-surfaces you want to create, or keep the default value of 3.

IsoSurfaceNumList : list[str] OldIsoSurfaceNameList : list[str] NewIsoSurfaceNameList : list[str] OldIsoSurfaceValueList : list[str] NewIsoSurfaceValueList : list[str] SurfacesList : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class TWF_TurboTopology(service, rules, command, path=None)#

Bases: PyCommand

Use this task so that Ansys Fluent can compute the turbo coordinates the machine main path inflow and outflow, the hub and shroud, and the side boundaries should be associated. Parameters ———- TopologyName : str

Provide a name for the turbo topology, or use the default name.

AddChild : str UseWireframe : bool

In order to more easily visualize highlighted items, use this option to display the 3D wireframe representation of the turbo topology model in the graphics window.

SkipTurboTopologybool: Use this task so that Ansys Fluent can compute the turbo coordinates the machine main path inflow and outflow, the hub and shroud, and the side boundaries should be associated.

DefaultTopologyNameList : list[str] DefaultTopologyZoneList : list[str] TopologyNameList : list[str] OldTopologyZoneList : list[str] NewTopologyZoneList : list[str]

Returns:

bool

Methods:

create_instance()

Create a command instance.

create_instance()#: Create a command instance.

class Zone(service, rules, path=None)#

Bases: PyNamedObjectContainer

class ZoneList(service, rules, path)#

Bases: PyMenu

Singleton ZoneList.

Classes:

`CellZones`(service, rules[, path])	Parameter CellZones of value type list[str].
`FaceZones`(service, rules[, path])	Parameter FaceZones of value type list[str].

Methods:

__init__(service, rules, path)

__init__ method of PyMenu class.

class CellZones(service, rules, path=None)#

Bases: PyTextual

Parameter CellZones of value type list[str].

class FaceZones(service, rules, path=None)#

Bases: PyTextual

Parameter FaceZones of value type list[str].

__init__(service, rules, path)#: __init__ method of PyMenu class.

__init__(service, rules, path)#: __init__ method of PyMenu class.