ansys-fluent-core 0.29.dev0__py3-none-any.whl → 0.29.dev2__py3-none-any.whl

ansys/fluent/tests/test_cad_to_post_ftm.py

@@ -1,525 +0,0 @@
-"""
-End-to-end Fluent Solver Workflow using Fault Tolerant Meshing
-------------------------------------------------------------------
-
-This test covers the setup and solution of a three-dimensional
-turbulent fluid flow in a manifold exhaust system using fault
-tolerant meshing workflow.
-
-This test queries the following using PyTest:
-
-- Meshing workflow tasks state before and after the task execution
-- Report definitions check after solution
-"""
-
-from functools import partial
-
-import pytest
-from util.meshing_workflow import (  # noqa: F401
-    assign_task_arguments,
-    execute_task_with_pre_and_postcondition_checks,
-)
-from util.solver import check_report_definition_result
-
-from ansys.fluent.core.utils.fluent_version import FluentVersion
-
-
-@pytest.mark.nightly
-@pytest.mark.codegen_required
-def test_exhaust_system(
-    fault_tolerant_workflow_session, exhaust_system_geometry_filename
-):
-    meshing_session = fault_tolerant_workflow_session
-    workflow = meshing_session.workflow
-
-    _ = partial(assign_task_arguments, workflow=workflow, check_state=True)
-
-    execute_task_with_pre_and_postconditions = partial(
-        execute_task_with_pre_and_postcondition_checks, workflow=workflow
-    )
-
-    ###############################################################################
-    # Import the CAD geometry
-    meshing_session.PartManagement.InputFileChanged(
-        FilePath=exhaust_system_geometry_filename,
-        IgnoreSolidNames=False,
-        PartPerBody=False,
-    )
-    meshing_session.PMFileManagement.FileManager.LoadFiles()
-    meshing_session.PartManagement.Node["Meshing Model"].Copy(
-        Paths=[
-            "/dirty_manifold-for-wrapper," + "1/dirty_manifold-for-wrapper,1/main,1",
-            "/dirty_manifold-for-wrapper,"
-            + "1/dirty_manifold-for-wrapper,1/flow-pipe,1",
-            "/dirty_manifold-for-wrapper,"
-            + "1/dirty_manifold-for-wrapper,1/outpipe3,1",
-            "/dirty_manifold-for-wrapper," + "1/dirty_manifold-for-wrapper,1/object2,1",
-            "/dirty_manifold-for-wrapper," + "1/dirty_manifold-for-wrapper,1/object1,1",
-        ]
-    )
-    meshing_session.PartManagement.ObjectSetting[
-        "DefaultObjectSetting"
-    ].OneZonePer.setState("part")
-    workflow.TaskObject["Import CAD and Part Management"].Arguments.setState(
-        {
-            "Context": 0,
-            "CreateObjectPer": "Custom",
-            "FMDFileName": exhaust_system_geometry_filename,
-            "FileLoaded": "yes",
-            "ObjectSetting": "DefaultObjectSetting",
-            "Options": {
-                "Line": False,
-                "Solid": False,
-                "Surface": False,
-            },
-        }
-    )
-    execute_task_with_pre_and_postconditions(task_name="Import CAD and Part Management")
-
-    ###############################################################################
-    # Provide a description for the geometry and the flow characteristics.
-    describe_geo = workflow.TaskObject["Describe Geometry and Flow"]
-    describe_geo.Arguments.setState(
-        {
-            "AddEnclosure": "No",
-            "CloseCaps": "Yes",
-            "FlowType": "Internal flow through the object",
-        }
-    )
-    describe_geo.UpdateChildTasks(SetupTypeChanged=False)
-    describe_geo.Arguments.setState(
-        {
-            "AddEnclosure": "No",
-            "CloseCaps": "Yes",
-            "DescribeGeometryAndFlowOptions": {
-                "AdvancedOptions": True,
-                "ExtractEdgeFeatures": "Yes",
-            },
-            "FlowType": "Internal flow through the object",
-        }
-    )
-    describe_geo.UpdateChildTasks(SetupTypeChanged=False)
-    execute_task_with_pre_and_postconditions(task_name="Describe Geometry and Flow")
-
-    ###############################################################################
-    # Cover any openings in your geometry.
-    capping = workflow.TaskObject["Enclose Fluid Regions (Capping)"]
-    capping.Arguments.setState(
-        {
-            "CreatePatchPreferences": {
-                "ShowCreatePatchPreferences": False,
-            },
-            "PatchName": "inlet-1",
-            "SelectionType": "zone",
-            "ZoneSelectionList": ["inlet.1"],
-        }
-    )
-    capping.Arguments.setState(
-        {
-            "CreatePatchPreferences": {
-                "ShowCreatePatchPreferences": False,
-            },
-            "PatchName": "inlet-1",
-            "SelectionType": "zone",
-            "ZoneLocation": [
-                "1",
-                "351.68205",
-                "-361.34322",
-                "-301.88668",
-                "396.96205",
-                "-332.84759",
-                "-266.69751",
-                "inlet.1",
-            ],
-            "ZoneSelectionList": ["inlet.1"],
-        }
-    )
-    capping.AddChildToTask()
-    capping.InsertCompoundChildTask()
-    capping.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="inlet-1")
-    capping.Arguments.setState(
-        {
-            "PatchName": "inlet-2",
-            "SelectionType": "zone",
-            "ZoneSelectionList": ["inlet.2"],
-        }
-    )
-    capping.Arguments.setState(
-        {
-            "PatchName": "inlet-2",
-            "SelectionType": "zone",
-            "ZoneLocation": [
-                "1",
-                "441.68205",
-                "-361.34322",
-                "-301.88668",
-                "486.96205",
-                "-332.84759",
-                "-266.69751",
-                "inlet.2",
-            ],
-            "ZoneSelectionList": ["inlet.2"],
-        }
-    )
-    capping.AddChildToTask()
-    capping.InsertCompoundChildTask()
-    capping.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="inlet-2")
-    capping.Arguments.setState(
-        {
-            "PatchName": "inlet-3",
-            "SelectionType": "zone",
-            "ZoneSelectionList": ["inlet"],
-        }
-    )
-    capping.Arguments.setState(
-        {
-            "PatchName": "inlet-3",
-            "SelectionType": "zone",
-            "ZoneLocation": [
-                "1",
-                "261.68205",
-                "-361.34322",
-                "-301.88668",
-                "306.96205",
-                "-332.84759",
-                "-266.69751",
-                "inlet",
-            ],
-            "ZoneSelectionList": ["inlet"],
-        }
-    )
-    capping.AddChildToTask()
-    capping.InsertCompoundChildTask()
-    capping.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="inlet-3")
-    capping.Arguments.setState(
-        {
-            "PatchName": "outlet-1",
-            "SelectionType": "zone",
-            "ZoneSelectionList": ["outlet"],
-            "ZoneType": "pressure-outlet",
-        }
-    )
-    capping.Arguments.setState(
-        {
-            "PatchName": "outlet-1",
-            "SelectionType": "zone",
-            "ZoneLocation": [
-                "1",
-                "352.22702",
-                "-197.8957",
-                "84.102381",
-                "394.41707",
-                "-155.70565",
-                "84.102381",
-                "outlet",
-            ],
-            "ZoneSelectionList": ["outlet"],
-            "ZoneType": "pressure-outlet",
-        }
-    )
-    capping.AddChildToTask()
-    capping.InsertCompoundChildTask()
-    capping.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="outlet-1")
-
-    ###############################################################################
-    # Extract edge features.
-    edge_features = workflow.TaskObject["Extract Edge Features"]
-    edge_features.Arguments.setState(
-        {
-            "ExtractMethodType": "Intersection Loops",
-            "ObjectSelectionList": ["flow_pipe", "main"],
-        }
-    )
-    edge_features.AddChildToTask()
-    edge_features.InsertCompoundChildTask()
-    workflow.TaskObject["edge-group-1"].Arguments.setState(
-        {
-            "ExtractEdgesName": "edge-group-1",
-            "ExtractMethodType": "Intersection Loops",
-            "ObjectSelectionList": ["flow_pipe", "main"],
-        }
-    )
-    edge_features.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="edge-group-1")
-
-    ###############################################################################
-    # Identify regions.
-    region_id = workflow.TaskObject["Identify Regions"]
-    region_id.Arguments.setState(
-        {
-            "SelectionType": "zone",
-            "X": 377.322045740589,
-            "Y": -176.800676988458,
-            "Z": -37.0764628583475,
-            "ZoneSelectionList": ["main.1"],
-        }
-    )
-    region_id.Arguments.setState(
-        {
-            "SelectionType": "zone",
-            "X": 377.322045740589,
-            "Y": -176.800676988458,
-            "Z": -37.0764628583475,
-            "ZoneLocation": [
-                "1",
-                "213.32205",
-                "-225.28068",
-                "-158.25531",
-                "541.32205",
-                "-128.32068",
-                "84.102381",
-                "main.1",
-            ],
-            "ZoneSelectionList": ["main.1"],
-        }
-    )
-    region_id.AddChildToTask()
-    region_id.InsertCompoundChildTask()
-    workflow.TaskObject["fluid-region-1"].Arguments.setState(
-        {
-            "MaterialPointsName": "fluid-region-1",
-            "SelectionType": "zone",
-            "X": 377.322045740589,
-            "Y": -176.800676988458,
-            "Z": -37.0764628583475,
-            "ZoneLocation": [
-                "1",
-                "213.32205",
-                "-225.28068",
-                "-158.25531",
-                "541.32205",
-                "-128.32068",
-                "84.102381",
-                "main.1",
-            ],
-            "ZoneSelectionList": ["main.1"],
-        }
-    )
-    region_id.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="fluid-region-1")
-    region_id.Arguments.setState(
-        {
-            "MaterialPointsName": "void-region-1",
-            "NewRegionType": "void",
-            "ObjectSelectionList": ["inlet-1", "inlet-2", "inlet-3", "main"],
-            "X": 374.722045740589,
-            "Y": -278.9775145640143,
-            "Z": -161.1700719416913,
-        }
-    )
-    region_id.AddChildToTask()
-    region_id.InsertCompoundChildTask()
-    region_id.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="void-region-1")
-
-    ###############################################################################
-    # Define thresholds for any potential leakages.
-    leakage_threshold = workflow.TaskObject["Define Leakage Threshold"]
-    leakage_threshold.Arguments.setState(
-        {
-            "AddChild": "yes",
-            "FlipDirection": True,
-            "PlaneDirection": "X",
-            "RegionSelectionSingle": "void-region-1",
-        }
-    )
-    leakage_threshold.AddChildToTask()
-    leakage_threshold.InsertCompoundChildTask()
-    workflow.TaskObject["leakage-1"].Arguments.setState(
-        {
-            "AddChild": "yes",
-            "FlipDirection": True,
-            "LeakageName": "leakage-1",
-            "PlaneDirection": "X",
-            "RegionSelectionSingle": "void-region-1",
-        }
-    )
-    leakage_threshold.Arguments.setState(
-        {
-            "AddChild": "yes",
-        }
-    )
-    execute_task_with_pre_and_postconditions(task_name="leakage-1")
-
-    ###############################################################################
-    # Review your region settings.
-    workflow.TaskObject["Update Region Settings"].Arguments.setState(
-        {
-            "AllRegionFilterCategories": ["2"] * 5 + ["1"] * 2,
-            "AllRegionLeakageSizeList": ["none"] * 6 + ["6.4"],
-            "AllRegionLinkedConstructionSurfaceList": ["n/a"] * 6 + ["no"],
-            "AllRegionMeshMethodList": ["none"] * 6 + ["wrap"],
-            "AllRegionNameList": [
-                "main",
-                "flow_pipe",
-                "outpipe3",
-                "object2",
-                "object1",
-                "void-region-1",
-                "fluid-region-1",
-            ],
-            "AllRegionOversetComponenList": ["no"] * 7,
-            "AllRegionSourceList": ["object"] * 5 + ["mpt"] * 2,
-            "AllRegionTypeList": ["void"] * 6 + ["fluid"],
-            "AllRegionVolumeFillList": ["none"] * 6 + ["tet"],
-            "FilterCategory": "Identified Regions",
-            "OldRegionLeakageSizeList": [""],
-            "OldRegionMeshMethodList": ["wrap"],
-            "OldRegionNameList": ["fluid-region-1"],
-            "OldRegionOversetComponenList": ["no"],
-            "OldRegionTypeList": ["fluid"],
-            "OldRegionVolumeFillList": ["hexcore"],
-            "RegionLeakageSizeList": [""],
-            "RegionMeshMethodList": ["wrap"],
-            "RegionNameList": ["fluid-region-1"],
-            "RegionOversetComponenList": ["no"],
-            "RegionTypeList": ["fluid"],
-            "RegionVolumeFillList": ["tet"],
-        }
-    )
-    execute_task_with_pre_and_postconditions(task_name="Update Region Settings")
-
-    ###############################################################################
-    # Select options for controlling the mesh.
-    execute_task_with_pre_and_postconditions(task_name="Choose Mesh Control Options")
-
-    ###############################################################################
-    # Generate the surface mesh.
-    execute_task_with_pre_and_postconditions(task_name="Generate the Surface Mesh")
-
-    ###############################################################################
-    # Confirm and update the boundaries.
-    execute_task_with_pre_and_postconditions(task_name="Update Boundaries")
-
-    ###############################################################################
-    # Add boundary layers.
-    add_boundary_layer = workflow.TaskObject["Add Boundary Layers"]
-    add_boundary_layer.AddChildToTask()
-    add_boundary_layer.InsertCompoundChildTask()
-    workflow.TaskObject["aspect-ratio_1"].Arguments.setState(
-        {
-            "BLControlName": "aspect-ratio_1",
-        }
-    )
-    add_boundary_layer.Arguments.setState({})
-    execute_task_with_pre_and_postconditions(task_name="aspect-ratio_1")
-
-    ###############################################################################
-    # Generate the volume mesh.
-    workflow.TaskObject["Generate the Volume Mesh"].Arguments.setState(
-        {
-            "AllRegionNameList": [
-                "main",
-                "flow_pipe",
-                "outpipe3",
-                "object2",
-                "object1",
-                "void-region-1",
-                "fluid-region-1",
-            ],
-            "AllRegionSizeList": ["11.33375"] * 7,
-            "AllRegionVolumeFillList": ["none"] * 6 + ["tet"],
-            "EnableParallel": True,
-        }
-    )
-    execute_task_with_pre_and_postconditions(task_name="Generate the Volume Mesh")
-
-    ###############################################################################
-    # Check the mesh in Meshing mode
-    # TODO: Remove the if condition after a stable version of 23.1 is available and update the commands as required.
-    if meshing_session.get_fluent_version() < FluentVersion.v231:
-        meshing_session.tui.mesh.check_mesh()
-
-    ###############################################################################
-    # Switch to Solution mode
-    solver_session = meshing_session.switch_to_solver()
-    tui = solver_session.tui
-    ###############################################################################
-    # Check the mesh in Solver mode
-    tui.mesh.check()
-
-    ###############################################################################
-    # Set the units for length
-    tui.define.units("length", "mm")
-
-    ###############################################################################
-    # Select kw sst turbulence model
-    tui.define.models.viscous.kw_sst("yes")
-
-    ###############################################################################
-    # Set the velocity and turbulence boundary conditions for the first inlet
-    # (inlet-1).
-    # TODO: Remove the if condition after a stable version of 23.1 is available and update the commands as required.
-    if solver_session.get_fluent_version() < FluentVersion.v231:
-        boundary_conditions = tui.define.boundary_conditions
-        boundary_conditions.set.velocity_inlet("inlet-1", [], "vmag", "no", 1, "quit")
-        ###############################################################################
-        # Apply the same conditions for the other velocity inlet boundaries (inlet_2,
-        # and inlet_3).
-        boundary_conditions.copy_bc("inlet-1", "inlet-2", "inlet-3", ())
-
-        ###############################################################################
-        # Set the boundary conditions at the outlet (outlet-1).
-        boundary_conditions.set.pressure_outlet(
-            "outlet-1", [], "turb-intensity", 5, "quit"
-        )
-        tui.solve.monitors.residual.plot("yes")
-
-        ###############################################################################
-        # Initialize the flow field using the Initialization
-        tui.solve.initialize.hyb_initialization()
-
-        ###############################################################################
-        # Start the calculation by requesting 100 iterations
-        tui.solve.set.number_of_iterations(100)
-        tui.solve.iterate()
-
-        ###############################################################################
-        # Assert the returned mass flow rate report definition value
-        flux = solver_session.solution.report_definitions.flux
-        flux["mass_flow_rate"] = {}
-        flux["mass_flow_rate"].zone_names = [
-            "inlet-1",
-            "inlet-2",
-            "inlet-3",
-            "outlet-1",
-        ]
-
-        check_report_definition = partial(
-            check_report_definition_result,
-            report_definitions=solver_session.solution.report_definitions,
-        )
-
-        check_report_definition(
-            report_definition_name="mass_flow_rate",
-            expected_result=pytest.approx(-6.036667e-07, abs=1e-3),
-        )
-
-        ###############################################################################
-        # Assert the returned velocity-magnitude report definition value on the outlet
-        # surface
-        solver_session.solution.report_definitions.surface[
-            "velocity_magnitude_outlet"
-        ] = {}
-        vmag_outlet = solver_session.solution.report_definitions.surface[
-            "velocity_magnitude_outlet"
-        ]
-        vmag_outlet.report_type = "surface-areaavg"
-        vmag_outlet.field = "velocity-magnitude"
-        vmag_outlet.surface_names = ["outlet-1"]
-
-        check_report_definition = partial(
-            check_report_definition_result,
-            report_definitions=solver_session.solution.report_definitions,
-        )
-
-        check_report_definition(
-            report_definition_name="velocity_magnitude_outlet",
-            expected_result=pytest.approx(3.7988207, rel=1e-3),
-        )
-
-        ###############################################################################