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

Documentation - add operators_reference_load_apis.html page for Dev Portal #956

Merged
merged 13 commits into from
Jun 21, 2023
7 changes: 5 additions & 2 deletions docs/source/concepts/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Here are descriptions for key DPF terms:
- **Location:** Type of topology associated with the data container. DPF
uses three different spatial locations for finite element data: ``Nodal``,
``Elemental``, and ``ElementalNodal``.
- **Operators:** Objects that are used to create and transform the data.
- **Operators:** Objects that are used to create, transform, and stream the data.
An operator is composed of a **core** and **pins**. The core handles the
calculation, and the pins provide input data to and output data from
the operator.
Expand All @@ -28,6 +28,9 @@ Here are descriptions for key DPF terms:
the support can be a mesh, geometrical entity, or time or frequency values.
- **Workflow:** Global entity that is used to evaluate the data produced
by chained operators.
- **Meshed region:** Entity describing a mesh. Node and element scopings,
element types, connectivity (list of node indices composing each element) and
node coordinates are the fundamental entities composing the meshed region.

Scoping
-------
Expand Down Expand Up @@ -69,7 +72,7 @@ This image summarizes the preceding concepts:

Operators
---------
You use :ref:`ref_dpf_operators_reference` to create and transform the data. An
You use :ref:`ref_dpf_operators_reference` to create, transform, and stream the data. An
*operator* is composed of a core and input and output pins.

- The core handles the calculation.
Expand Down
26 changes: 26 additions & 0 deletions docs/source/operator_reference_load_apis.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
:orphan:

=========
Operators
=========

Loading operators.

.. raw:: html

<iframe
src="_static/dpf_operators.html"
rafacanton marked this conversation as resolved.
Show resolved Hide resolved
style="
position: fixed;
top: 36px;
bottom: 0px;
right: 0px;
width: 100%;
border: none;
margin: 0;
padding: 0;
overflow: hidden;
z-index: 1000;
height: 100%;
">
</iframe>
2 changes: 1 addition & 1 deletion docs/source/user_guide/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Operators

.. include:: <isonum.txt>

An operator is the only object that is used to create and transform
An operator is the main object that is used to create, transform, and stream
data. In DPF, you use operators to load, operate on, and output data.

Each operator contains ``input`` and ``output`` attributes, which
Expand Down