Skip to content

DPF 25R2: documentation review #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions 2025R2/dpf-operator-spec-25-r2/core-concepts/dpf-overview.md

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 89 additions & 1 deletion 2025R2/dpf-operator-spec-25-r2/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,91 @@
# Introduction

This documentation provides a comprehensive guide of DPF operator specifications. It is organized into key sections, including core concepts, getting started tutorials, and detailed operator specifications. Whether you are new to DPF or looking for advanced operator details, this guide offers the necessary resources to understand and use DPF effectively in your workflows.
This documentation provides a comprehensive guide of the DPF framework as well as all DPF operators available in ANSYS-made DPF plugins. It is organized into key sections, including core concepts, getting started tutorials, and detailed documentation of available operators. Whether you are new to DPF or looking for information on operators, this guide offers the necessary resources to understand and use DPF effectively in your workflows.

# Overview of DPF

The Ansys Data Processing Framework (DPF) provides numerical simulation users and engineers with a toolbox for accessing and transforming simulation data.
With DPF, you can perform complex preprocessing or postprocessing of large amounts of simulation data within a simulation workflow.

DPF is an independent, physics-agnostic tool that you can plug into many apps for both data input and data output, including visualization and result plots.
The following table shows an exhaustive list of solver apps supported by DPF and their related formats:

| **Solver** | **File format** | **DPF version required** |
|--------------------|---------------------------------|-------------------------------------|
| MAPDL | .rst, .mode, .rth, .rfrq, .rdsp | **1.0** (*2021 R1*) and later |
| MAPDL | .psd, .prs | **10.0** (*2025 R2 pre0*) and later |
| LS DYNA | .d3plot, .binout | **4.0** (*2022 R2*) and later |
| FLUENT | .cas/dat.h5, .flprj | **7.0** (*2024 R1 pre0*) and later |
| CFX | .res, .flprj | **7.0** (*2024 R1 pre0*) and later |

Using the many DPF operators that are available, you can manipulate and transform this data.
You can also chain operators together to create simple or complex data-processing workflows that you can reuse for repeated or future evaluations.

The data in DPF is defined based on physics-agnostic mathematical quantities described in self-sufficient entities called **fields**.
This allows DPF to be a modular and easy-to-use tool with a large range of capabilities.

![dpf-flow](./images/dpf-flow.png)


## Advantages

**Computational efficiency**

DPF is a modern framework based on new hardware architectures.
Thanks to continued development, new capabilities are frequently added.

**Generic interface**

DPF is physics-agnostic, which means that its use is not limited to a particular field, physics solution, or file format.

**Extensibility and customization**

DPF is developed around two core entities:

- Data represented as a **field**
- An **operator** to act upon this data

Each DPF capability is developed through operators that allow for componentization of the framework. Because DPF is plugin-based, new features or formats can be easily added.


# Install DPF

DPF is available with the **Ansys installer** in Ansys 2021 R1 and later, or as a pre-release **DPF Server** standalone package for DPF 2023 R2 and later.

- To install DPF using the Ansys installer, download the standard Ansys installation using your preferred
distribution channel, and install Ansys following the installer instructions. For information
on getting a licensed copy of Ansys, visit the [Ansys website](https://www.ansys.com/).

- The DPF Server package provides pre-releases of DPF and is independent of the Ansys installer.
It is available on the [DPF Pre-Release page](https://download.ansys.com/Others/DPF%20Pre-Release) of the Ansys Customer Portal.


## Operating system compatibility

DPF supports Windows 10 and Rocky Linux 8 and later. To run DPF on CentOS 7, use DPF for 2024 R2 (8.2) or later. For more information, see [Ansys Platform Support](https://www.ansys.com/it-solutions/platform-support).

# Use DPF

You must use one of the DPF client APIs to write scripts and send commands to DPF.

DPF client APIs are currently available in three languages: C++, CPython, and IronPython (for Mechanical scripting).

The following are documentations dedicated to each:

- HGP documentation (C++):

- [DPF C++ Client library](https://developer.ansys.com/docs/dpf-cpp-client-library-2025-r2/index.xhtml) in the Developer Portal documentation for DPF.

- PyDPF documentation (CPython):

- [PyDPF-Core documentation](https://dpf.docs.pyansys.com/version/stable/)

- [PyDPF-Post documentation](https://post.docs.pyansys.com/version/stable/)

- Mechanical scripting (IronPython):

- [Data Processing Framework](https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v252/en/act_script/mech_apis_data_process_frame.html)
in the *Scripting in Mechanical Guide*.

- [Python Result](https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v252/en/wb_sim/ds_python_result_dpf.html)
in the *Mechanical User's Guide*.
6 changes: 2 additions & 4 deletions 2025R2/dpf-operator-spec-25-r2/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
href: index.md
- name: Core concepts
items:
- name: Overview of DPF
href: core-concepts/dpf-overview.md
- name: Understanding data containers
- name: Available types
href: core-concepts/data-containers.md
- name: Operator fundamentals
href: core-concepts/operator.md
Expand Down Expand Up @@ -1478,4 +1476,4 @@
href: operator-specifications/utility/unitary_field.md
- name: weighted merge fields by label
href: operator-specifications/utility/weighted_merge_fields_by_label.md