Skip to main content

Pythonic interface to Ansys Fluent

Project description

PyAnsys PyPI GH-CI MIT Black

Overview

The PyFluent project provides Pythonic access to Ansys Fluent. The package provides features to enable seamless use of Fluent within the Python ecosystem as well as broad access to Fluent features including:

  • Ability to launch Fluent using a local Ansys installation

  • Ability to use Fluent TUI commands for both meshing and solver features

  • Ability to use Fluent’s in-built post processing capabilities

Documentation and Issues

Please see the latest release documentation page for more details.

Please feel free to post issues and other questions at PyFluent Issues. This is the best place to post questions and code.

Installation

The ansys-fluent-core package currently supports Python 3.7 through Python 3.10 on Windows and Linux.

If you want to use PyFluent please install the latest from PyFluent GitHub via:

pip install git+https://github.com/pyansys/pyfluent.git

If you plan on doing local “development” of PyFluent with Git, then install with:

git clone https://github.com/pyansys/pyfluent.git
cd pyfluent
pip install pip -U
pip install -e .
python codegen/allapigen.py  # Generates the API files, requires Fluent

Dependencies

You will need a locally installed licensed copy of ANSYS to run Fluent, with the first supported version being Ansys 2022 R2.

Getting Started

Launching Fluent

You can launch Fluent from Python using the launch_fluent function:

import ansys.fluent.core as pyfluent
session = pyfluent.launch_fluent()
session.check_health()

To use a non-default install location set the PYFLUENT_FLUENT_ROOT environment variable to the <version>/fluent directory where <version> is the Ansys release version you would like to use (eg: v222).

Basic Usage

You can run Fluent TUI commands using the session.tui interface:

session.solver.tui.file.read_case(case_file_name='elbow.cas.h5')
session.solver.tui.define.models.unsteady_2nd_order("yes")
session.solver.tui.solve.initialize.initialize_flow()
session.solver.tui.solve.dual_time_iterate(2, 3)

In addition to all TUI commands being available there are the PyFluent Parametric and PyFluent Visualization packages. The PyFluent Parametric package provides access to Fluent’s parametric workflows and the PyFluent Visualization package provides post-processing and visualization capabilities using pyvista and matplotlib.

License and Acknowledgments

PyFluent is licensed under the MIT license.

This module, ansys-fluent makes no commercial claim over Ansys whatsoever. This tool extends the functionality of Fluent by adding a Python interface to the Fluent without changing the core behavior or license of the original software. The use of the interactive Fluent control of PyFluent requires a legally licensed local copy of Ansys.

To get a copy of Ansys, please visit Ansys.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansys-fluent-core-0.10.0.tar.gz (643.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page