Skip to content
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

Enhance the exposition of supported solver and related file format in DPF #1059

Merged
merged 13 commits into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from 6 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
3 changes: 2 additions & 1 deletion docs/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Getting started

The Data Processing Framework (DPF) provides numerical simulation users and engineers with a toolbox
for accessing and transforming simulation data. DPF can access data from Ansys solver
result (RST) files as well as from several neutral file formats, including CSV, HDF5, and VTK.
result files as well as from several neutral `file formats <https://dpf.docs.pyansys.com/version/stable/index.html>`_.
MichaelNale marked this conversation as resolved.
Show resolved Hide resolved

This **workflow-based** framework allows you to perform complex preprocessing and
postprocessing operations on large amounts of simulation data.

Expand Down
33 changes: 30 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,36 @@ 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. It can access data from solver result files and other neutral
formats, such as CSV, HDF5, and VTK files.
result plots. The following table shows an exhaustive list of supported
apps by DPF and their related format:

MichaelNale marked this conversation as resolved.
Show resolved Hide resolved
+--------------------+------------------------+----------------------------------+
| **Solver** | **File format** | **DPF examples** |
+====================+========================+==================================+
| || .rst, .mode | :ref:`ref_distributed_msup` |
| MAPDL || .rfrq, .rdsp +----------------------------------+
| | | :ref:`ref_average_across_bodies` |
+--------------------+------------------------+----------------------------------+
| LS DYNA | .d3plot, .binout | :ref:`lsdyna_operators` |
+--------------------+------------------------+----------------------------------+
| || *CFF restart files* | :ref:`ref_fluids_model` |
| || .cas/dat.h5 +----------------------------------+
| | | :ref:`ref_fluids_mesh` |
| Fluent +------------------------+----------------------------------+
| || *Project files* | :ref:`ref_fluids_results` |
| || .flprj | |
+--------------------+------------------------+----------------------------------+
| || *CFF files* | :ref:`ref_fluids_model` |
| || .cas/dat.cff | |
| | +----------------------------------+
| | | :ref:`ref_fluids_mesh` |
| CFX +------------------------+----------------------------------+
| || *Project files* | :ref:`ref_fluids_results` |
| || .flprj | |
+--------------------+------------------------+----------------------------------+

Visualisation is ensured by VTK and leverage of `PyVista tools
<https://docs.pyvista.org>`_.

Using the many DPF operators that are available, you can manipulate and
transform this data. You can also chain operators together to create simple
Expand All @@ -29,7 +57,6 @@ The ``ansys.dpf.core`` package provides a Python interface to DPF, enabling
rapid postprocessing of a variety of Ansys file formats and physics solutions
without ever leaving the Python environment.


Brief demo
~~~~~~~~~~
Here is how you open a result file generated by MAPDL (or another ANSYS solver)
Expand Down
9 changes: 3 additions & 6 deletions docs/source/user_guide/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,12 +307,9 @@ DPF provides three main types of operators:
Operators for importing or reading data
***************************************

These operators provide for reading data from solver files or from standard file types:

- For MAPDL, supported solver file formats include RST, MODE, RFRQ, and RDSP.
- For LS DYNA, D3PLOT files are supported.
- For Fluent and CFX, CAS.H5, DAT.H5, RES, and FLPRJ files are supported.
- For Abaqus, ODB files are supported.
These operators provide for reading data from solver files or from standard file types
such as .RST (MAPDL), .D3Plot (LS DYNA), .CAS.H5/.DAT.H5 (Fluent), .CAS.CFF/.DAT.CFF (CFX)
or .OBD (Abaqus).
MichaelNale marked this conversation as resolved.
Show resolved Hide resolved

To read these files, different readers are implemented as plugins.
Plugins can be loaded on demand in any DPF scripting language with "load library" methods.
Expand Down