Skip to content

tutorials: data structures #2311

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 8 commits into
base: doc/new-tutorials-section
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
44 changes: 0 additions & 44 deletions doc/source/concepts/index.rst

This file was deleted.

9 changes: 7 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import pyvista
from ansys.dpf.core import __version__, server, server_factory
from ansys.dpf.core.examples import get_example_required_minimum_dpf_version
from ansys_sphinx_theme import pyansys_logo_black, ansys_favicon, get_version_match
from ansys_sphinx_theme import ansys_favicon, get_version_match, pyansys_logo_light_mode, pyansys_logo_dark_mode

# Manage errors
pyvista.set_error_output_file("errors.txt")
Expand Down Expand Up @@ -76,6 +76,7 @@
extensions = [
"enum_tools.autoenum",
"nbsphinx",
"sphinx.ext.autosummary",
"sphinx.ext.autosectionlabel",
"sphinx.ext.autodoc",
"sphinx.ext.graphviz",
Expand All @@ -87,6 +88,7 @@
"sphinx_design",
"sphinx_gallery.gen_gallery",
'sphinx_reredirects',
"sphinx_exec_code",
]

redirects = {
Expand Down Expand Up @@ -193,7 +195,6 @@ def reset_servers(gallery_conf, fname, when):
# -- Options for HTML output -------------------------------------------------
html_short_title = html_title = "PyDPF-Core"
html_theme = "ansys_sphinx_theme"
html_logo = pyansys_logo_black
html_favicon = ansys_favicon
html_theme_options = {
"github_url": "https://github.com/ansys/pydpf-core",
Expand All @@ -202,6 +203,10 @@ def reset_servers(gallery_conf, fname, when):
"additional_breadcrumbs": [
("PyAnsys", "https://docs.pyansys.com/"),
],
"logo": {
"image_dark": pyansys_logo_dark_mode,
"image_light": pyansys_logo_light_mode,
},
"switcher": {
"json_url": f"https://{cname}/versions.json",
"version_match": get_version_match(__version__),
Expand Down
1 change: 0 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,5 +193,4 @@ To reach the project support team, email `[email protected] <pyansys.core@a
examples/index
api/index
operator_reference
concepts/index
contributing
53 changes: 53 additions & 0 deletions doc/source/substitution_solvers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
.. _ref_substitution_solvers:

.. Information about the interactions between apps and DPF

.. Files formats

.. MAPDL
.. |MAPDL_files| replace:: .rst, .mode, .rfrq, .rdsp

.. LSDYNA
.. |LS-DYNA_files| replace:: .d3plot, .binout

.. Fluent
.. |Fluent_files1| replace:: **CFF restart files** : .cas.h5, dat.h5
.. |Fluent_files2| replace:: **Project files** : .flprj

.. CFX
.. |CFX_files1| replace:: **CFF files** : .cas.cff.res, dat.cff.res
.. |CFX_files2| replace:: **Project files** : .flprj


.. Server version

.. MAPDL
.. |MAPDL_version| replace:: **1.0** and later (*Ansys 2021 R1*)

.. LSDYNA
.. |LS-DYNA_version| replace:: **4.0** and later (*Ansys 2022 R2*)

.. Fluent
.. |Fluent_version| replace:: **7.0** and later (*Ansys 2024 R1 pre0*)

.. CFX
.. |CFX_version| replace:: **7.0** and later (*Ansys 2024 R1 pre0*)

.. DPF examples

.. MAPDL
.. |MAPDL_example| replace:: :ref:`ref_basic_example`

.. LSDYNA
.. |LS-DYNA_example| replace:: :ref:`examples_lsdyna`

.. Fluent
.. |Fluent_example1| replace:: :ref:`ref_fluids_model`
.. |Fluent_example2| replace:: :ref:`ref_fluids_mesh`
.. |Fluent_example3| replace:: :ref:`ref_fluids_results`

.. CFX
.. |CFX_example1| replace:: :ref:`examples_cfx`
.. |CFX_example2| replace:: :ref:`ref_fluids_model`
.. |CFX_example3| replace:: :ref:`ref_fluids_mesh`
.. |CFX_example4| replace:: :ref:`ref_fluids_results`
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Concept summary
---------------
This image summarizes the preceding concepts:

.. image:: ../images/drawings/field-breakdown.png
.. image:: ../../images/drawings/field-breakdown.png


Operators
Expand All @@ -79,7 +79,7 @@ You use :ref:`ref_dpf_operators_reference` to create, transform, and stream the
- The input and output pins, like those in an integrated circuit in electronics,
submit data to the operator and output the computed result from the operator.

.. image:: ../images/drawings/OperatorPins.png
.. image:: ../../images/drawings/OperatorPins.png

Workflows
---------
Expand All @@ -90,10 +90,10 @@ to operators, which computes requested outputs.
Think of a workflow as a black box in which some operators are chained,
computing the information for which the workflow is made:

.. image:: ../images/drawings/Workflow1.png
.. image:: ../../images/drawings/Workflow1.png

The following image shows operators that have been chained together to create a
total deformation workflow. You can use this workflow in any simulation
workflow with any data sources as inputs.

.. image:: ../images/drawings/Workflow2.png
.. image:: ../../images/drawings/Workflow2.png
28 changes: 28 additions & 0 deletions doc/source/user_guide/concepts/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. _ref_concepts_index:

Concepts
--------

.. grid:: 3
:gutter: 2

.. grid-item-card:: Concepts and terminology
:link: user_guide_concepts
:link-type: ref
:text-align: center

.. image:: ../images/drawings/book-logo.png

.. grid-item-card:: Ways of using DPF
:link: user_guide_waysofusing
:link-type: ref
:text-align: center

.. image:: ../images/drawings/using-dpf.png

.. grid-item-card:: Using DPF: Step by step
:link: user_guide_stepbystep
:link-type: ref
:text-align: center

.. image:: ../images/drawings/checklist.png
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ Define fields
A **field** is a container of simulation data. In numerical simulations,
result data is defined by values associated with entities:

.. image:: ../images/drawings/values-entities.png
.. image:: ../../images/drawings/values-entities.png

Therefore, a field of data might look something like this:

.. image:: ../images/drawings/field.png
.. image:: ../../images/drawings/field.png

This code shows how to define a field from scratch:

Expand All @@ -83,7 +83,7 @@ be a set of mesh IDs, geometric entity IDs, time domain, or frequency domain.

You specify the set of entities by defining a range of IDs:

.. image:: ../images/drawings/scoping-eg.png
.. image:: ../../images/drawings/scoping-eg.png

You must define a scoping prior to its use in the transformation data workflow.

Expand All @@ -109,13 +109,13 @@ A **field container** holds a set of fields. It is used mainly for
transient, harmonic, modal, or multi-step analyses. This image
explains its structure:

.. image:: ../images/drawings/field-con-overview.png
.. image:: ../../images/drawings/field-con-overview.png

A field container is a vector of fields. Fields are ordered with labels
and IDs. Most commonly, a field container is scoped on the time label,
and the IDs are the time or frequency sets:

.. image:: ../images/drawings/field-con.png
.. image:: ../../images/drawings/field-con.png

You can define a field container in multiple ways:

Expand Down Expand Up @@ -162,14 +162,14 @@ An operator takes input from a field, field container, or scoping using
an input pin. Based on what it is designed to do, the operator computes
an output that it passes to a field or field container using an output pin.

.. image:: ../images/drawings/circuit.png
.. image:: ../../images/drawings/circuit.png

Comprehensive information on operators is available in :ref:`ref_dpf_operators_reference`.
In the **Available Operators** area for either the **Entry** or **Premium** operators,
you can either type a keyword in the **Search** option
or browse by operator categories:

.. image:: ../images/drawings/help-operators.png
.. image:: ../../images/drawings/help-operators.png

The page for each operator describes how the operator transforms data,
indicates input and output data, and provides usage examples.
Expand All @@ -185,7 +185,7 @@ Defining an operator consists of three steps:
This image shows how the page for an operator provides a usage example for each available
language (IronPython, CPython, and C++).

.. image:: ../images/drawings/operator-def.png
.. image:: ../../images/drawings/operator-def.png

This code shows how to define an operator from a model:

Expand All @@ -210,7 +210,7 @@ the input to another operator.
This image shows how you would get the norm of a resulting vector from the
dot product of two vectors:

.. image:: ../images/drawings/connect-operators.png
.. image:: ../../images/drawings/connect-operators.png

This code shows how to define a generic workflow that computes the minimum
of displacement by chaining the ``U`` and ``min_max_fc`` operators:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ enabled using the DPF Server application.
These capabilities can be accessed through client APIs, as shown here:


.. image:: ../images/drawings/apis_2.png
.. image:: ../../images/drawings/apis_2.png


1. DPF server application can be accessed using Ansys Inc product, or DPF Server package (see :ref:`ref_dpf_server`) available on the Customer portal.
Expand Down Expand Up @@ -71,12 +71,12 @@ files. You can use it to generate TH-plots, screenshots, and animations or
to create custom result plots using the `numpy <https://numpy.org/>`_
and `matplotlib <https://matplotlib.org/>`_ packages.

.. image:: ../images/drawings/dpf-reports.png
.. image:: ../../images/drawings/dpf-reports.png

Mechanical
~~~~~~~~~~
**DPF in Mechanical** uses IronPython and is accessible with the **ACT Console**.
Use it to perform custom postprocessing and visualization of results directly
within the Mechanical application.

.. image:: ../images/drawings/dpf-mech.png
.. image:: ../../images/drawings/dpf-mech.png
Loading