diff --git a/2025R2/dpf-operator-spec-25-r2/core-concepts/dpf-overview.md b/2025R2/dpf-operator-spec-25-r2/core-concepts/dpf-overview.md deleted file mode 100644 index 579048630..000000000 --- a/2025R2/dpf-operator-spec-25-r2/core-concepts/dpf-overview.md +++ /dev/null @@ -1,17 +0,0 @@ -# Overview of DPF - -The Data Processing Framework (DPF) is designed to provide numerical simulation users/engineers with a toolbox for accessing and transforming simulation data. DPF can access data from solver result files as well as several neutral formats (csv, hdf5, vtk, etc.). Various operators are available allowing the manipulation and the transformation of this data. DPF is a workflow-based framework which allows simple and/or complex evaluations by chaining operators. The data in DPF is defined based on physics agnostic mathematical quantities described in a self-sufficient entity called field. This allows DPF to be a modular and easy to use tool with a large range of capabilities. It's a product designed to handle large amount of data. - -## Advantages - -**Computation efficiency** - -DPF is a modern framework and it has been developed by taking advantages of new hardware architectures. Due to continued development, new capabilities are frequently added. - -**Generecity** - -DPF is physic agnostic. Therefore, its use is not limited to a particular field. - -**Extensibility and Customization** - -DPF is developed around two entities, one for the data (field) and one for the operation (operator). Each DPF capability is developed through operators, allowing componentization of the framework. DPF is also plugin based so adding new features or handling new formats is fast and easy. With componentization, plugins, and DPF scripting, you can add your own capabilities and link your existing work with DPF. diff --git a/2025R2/dpf-operator-spec-25-r2/images/dpf-flow.png b/2025R2/dpf-operator-spec-25-r2/images/dpf-flow.png new file mode 100644 index 000000000..5672e1214 Binary files /dev/null and b/2025R2/dpf-operator-spec-25-r2/images/dpf-flow.png differ diff --git a/2025R2/dpf-operator-spec-25-r2/index.md b/2025R2/dpf-operator-spec-25-r2/index.md index 747105778..e35b112a1 100644 --- a/2025R2/dpf-operator-spec-25-r2/index.md +++ b/2025R2/dpf-operator-spec-25-r2/index.md @@ -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*. diff --git a/2025R2/dpf-operator-spec-25-r2/toc.yml b/2025R2/dpf-operator-spec-25-r2/toc.yml index 6a4d1933d..18ab2e76b 100644 --- a/2025R2/dpf-operator-spec-25-r2/toc.yml +++ b/2025R2/dpf-operator-spec-25-r2/toc.yml @@ -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 @@ -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 - \ No newline at end of file +