diff --git a/doc/source/_static/dpf_operators.html b/doc/source/_static/dpf_operators.html index 6da6e20b8c6..e5a1ee6d295 100644 --- a/doc/source/_static/dpf_operators.html +++ b/doc/source/_static/dpf_operators.html @@ -8384,7 +8384,283 @@
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) |
compute the normals at the given nodes or element scoping based on the given mesh (first version, the element normal is only handled on the shell elements)
-Read/compute element nodal component elastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. +
This operator showcases the use of Markdown and LaTeX in operator and pin descriptions:
+This should result in a paragraph +it's that simple.
+italic, bold
+std::string a = 'test';
+
+var a = 'test';
+
+a: str = 'test'
+
+And well inline code should also work.
++A Quote
+With some text blocks inside
++
+- even a list
+- should be
+- possible
+
Links such as link.
+
| Left header | +middle header | +last header | +
|---|---|---|
| cell 1 | +cell 2 | +cell 3 | +
| cell 4 | +cell 5 | +cell 6 | +
An inline equation $x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$ using LaTeX dollar delimiters.
+An inline equation (x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.) using LaTeX parenthesis delimiters.
+An equation on its own using dollar delimiters: +$$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$$
+An equation on its own using square bracket delimiters: +[x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.]
+This pin showcases the use of Markdown and LaTeX in pin descriptions: +Headings+h2+h3+h4+h5+Text+This should result in a paragraph +it's that simple. +italic, bold +Lists+
Code+Code block+
+
+
+Inline code+And well Quotes+++ Links+Links such as link. +Images+
Separations++ Checklists+
Tables+
LaTeX+An inline equation $x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$ using LaTeX dollar delimiters. +An inline equation (x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.) using LaTeX parenthesis delimiters. +An equation on its own using dollar delimiters: +$$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$$ +An equation on its own using square bracket delimiters: +[x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.] + |
This pin showcases the use of Markdown and LaTeX in pin descriptions: +Headings+h2+h3+h4+h5+Text+This should result in a paragraph +it's that simple. +italic, bold +Lists+
Code+Code block+
+
+
+Inline code+And well Quotes+++ Links+Links such as link. +Images+
Separations++ Checklists+
Tables+
LaTeX+An inline equation $x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$ using LaTeX dollar delimiters. +An inline equation (x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.) using LaTeX parenthesis delimiters. +An equation on its own using dollar delimiters: +$$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$$ +An equation on its own using square bracket delimiters: +[x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.] + |
Read/compute element nodal component elastic strains 3rd principal component by calling the readers defined by the datasources and computing its eigen values. This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed. The off-diagonal strains are first converted from Voigt notation to the standard strain values.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -9499,7 +9775,7 @@Configurating operators |
if this pin is set to 0, the classical ERP is computed, 1 the corrected ERP is computed (a mesh of one face has to be given in the pin 1) and 2 the enhanced ERP is computed. Default is 0. |
if this pin is set to true, the ERP level in dB is computed |
erp reference value. Default is 1E-12 - |
Scales all the fields of a fields container to a given precision threshold, then rounds all the values to the unit.
+Scales all the fields of a fields container to a given precision threshold, then rounds all the values to the unit.
Fields container to be quantized. |
Precision threshold desired. Case double : the threshold is applied on all the fields of the input fields container. @@ -14207,7 +14483,16 @@ Configurating operatorsVersion 0.0.0 Inputs
Outputs
ConfigurationsScriptingChangelogfilter: low pass (timescoping)The low pass filter returns all the values below (but not equal to) the threshold value in input. + |
Transforms Elemental Nodal fields into Elemental fields. Each elemental value is the fraction between the elemental difference and the entity average. The result is computed on a given element's scoping.
+The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. + |
Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. + |
If a fields container is set in this pin, it is used as the denominator of the fraction instead of entity_average_fc. + |
If true, the data across different shell layers is averaged as well (default is false). + |
Read the layer orientations.
+Result file container allowed to be kept open to cache data. + |
Result file path container, used if no streams are set. + |
Requested data as FieldsContainer. + |
The low pass filter returns all the values below (but not equal to) the threshold value in input.
a threshold scalar or a field containing one value is expected |
The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. |
Rescopes a field on the given scoping. If an ID does not exist in the original field, the default value (in 2) is used when defined.
@@ -14671,22 +14956,17 @@if this pin is set to true, each field of the input fields container is defined by time freq scoping and not by ids. Default is false |
weighted data in dB units. |
Maps a field defined on solid elements to a field defined on skin elements. Three cases are possible, based on the solid field data location; (i) Elemental: The values associated with the solid elements are copied according to those underlying the skin, (ii) Nodal: The solid field is rescoped with respect to the nodes of the skin mesh, (iii) ElementalNodal: The values are copied from the solid mesh to the skin mesh for each element face and the nodes associated with it.
-field or fields container with only one field is expected +Version 0.2.1 Inputs
OutputsConfigurationsScriptingChangelogmapping: solid to skin fcMaps a fields container defined on solid elements to a fields container defined on skin elements. Three cases are possible, based on the solid field data location; (i) Elemental: The values associated with the solid elements are copied according to those underlying the skin, (ii) Nodal: The solid field is rescoped with respect to the nodes of the skin mesh, (iii) ElementalNodal: The values are copied from the solid mesh to the skin mesh for each element face and the nodes associated with it. -Version 0.2.0 Inputs
OutputsConfigurationsScriptingChangelogmapping: solid to skin fcMaps a fields container defined on solid elements to a fields container defined on skin elements. Three cases are possible, based on the solid field data location; (i) Elemental: The values associated with the solid elements are copied according to those underlying the skin, (ii) Nodal: The solid field is rescoped with respect to the nodes of the skin mesh, (iii) ElementalNodal: The values are copied from the solid mesh to the skin mesh for each element face and the nodes associated with it. +Version 0.2.1 Inputs
OutputsConfigurationsScriptingChangelogaveraging: elemental difference (field)Transforms an Elemental Nodal or Nodal field into an Elemental field. Each elemental value is the maximum difference between the computed result for all nodes in this element. The result is computed on a given element scoping. + |
Transforms an Elemental Nodal or Nodal field into an Elemental field. Each elemental value is the maximum difference between the computed result for all nodes in this element. The result is computed on a given element scoping.
field or fields container with only one field is expected |
average only on these entities |
The maximum elemental difference is taken through the different shell layers if true (default is false). - |
Transforms Elemental Nodal fields into Elemental fields. Each elemental value is the fraction between the elemental difference and the entity average. The result is computed on a given element's scoping.
-The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. - |
Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. - |
If a fields container is set in this pin, it is used as the denominator of the fraction instead of entity_average_fc. - |
If true, the data across different shell layers is averaged as well (default is false). - |
Extends Elemental Nodal or Nodal fields defined on corner nodes to Elemental Nodal fields defined also on the mid nodes.
+Extends Elemental Nodal or Nodal fields defined on corner nodes to Elemental Nodal fields defined also on the mid nodes.
The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. |
Rotates a field to its corresponding values into the specified cylindrical coordinate system (corresponding to the field position). If a coordinate system is not set in the coordinate_system pin, the field is rotated on each node following the local polar coordinate system.
field or fields container with only one field is expected @@ -14794,9 +15074,9 @@Configurating operators |
expanded meshed region. |
Orthonormalized mode shape transformation |
Read the presol generated file from mapdl.
-filepath +Version 0.0.1 Inputs
OutputsConfigurationsScriptingChangelogresult: prns to fieldRead the presol of nodal field generated file from mapdl. + |
Read the presol of nodal field generated file from mapdl.
filepath |
columns_to_read |
Removes rigid body mode from a total displacement field by minimization. Use a reference point in order to subtract its displacement to the result displacement field.
@@ -15368,7 +15648,7 @@average the elemental nodal result to the requested location (default is nodal). |
if true, cyclic expansion is done. If false, it's ignored.. |
for multibody simulations, the stresses are averaged across bodies if true or not if false (default). - |
Scales a field to a given precision threshold, then rounds all the values to the unit.
+Scales a field to a given precision threshold, then rounds all the values to the unit.
Field to quantize. |
Precision threshold desired.
Case double : the threshold is applied on all the input field.
diff --git a/src/ansys/dpf/core/operators/__init__.py b/src/ansys/dpf/core/operators/__init__.py
index 42ff1927792..d6cc6da1f45 100644
--- a/src/ansys/dpf/core/operators/__init__.py
+++ b/src/ansys/dpf/core/operators/__init__.py
@@ -2,6 +2,7 @@
from . import compression
from . import filter
from . import geo
+from . import info
from . import invariant
from . import logic
from . import mapping
diff --git a/src/ansys/dpf/core/operators/info/__init__.py b/src/ansys/dpf/core/operators/info/__init__.py
new file mode 100644
index 00000000000..c48c735b3a9
--- /dev/null
+++ b/src/ansys/dpf/core/operators/info/__init__.py
@@ -0,0 +1 @@
+from .markdown_latex_example import markdown_latex_example
diff --git a/src/ansys/dpf/core/operators/info/markdown_latex_example.py b/src/ansys/dpf/core/operators/info/markdown_latex_example.py
new file mode 100644
index 00000000000..8883471f600
--- /dev/null
+++ b/src/ansys/dpf/core/operators/info/markdown_latex_example.py
@@ -0,0 +1,950 @@
+"""
+markdown_latex_example
+
+Autogenerated DPF operator classes.
+"""
+
+from __future__ import annotations
+
+from warnings import warn
+from ansys.dpf.core.dpf_operator import Operator
+from ansys.dpf.core.inputs import Input, _Inputs
+from ansys.dpf.core.outputs import Output, _Outputs
+from ansys.dpf.core.operators.specification import PinSpecification, Specification
+from ansys.dpf.core.config import Config
+from ansys.dpf.core.server_types import AnyServerType
+
+
+class markdown_latex_example(Operator):
+ r"""This operator showcases the use of Markdown and LaTeX in operator and
+ pin descriptions: # Headings ## h2 ### h3 #### h4 ##### h5
+
+ Text
+ ====
+
+ This should result in a paragraph it’s that simple.
+
+ *italic*, **bold**
+
+ Lists
+ =====
+
+ - an *unordered list*
+
+ - with **some hierarchy**
+
+ 1. and an ordered
+ 2. mixed
+
+ - list
+ - directly
+
+ - inside
+
+ Code
+ ====
+
+ Code block
+ ----------
+
+ .. code:: c
+
+ std::string a = 'test';
+
+ .. code:: js
+
+ var a = 'test';
+
+ .. code:: python
+
+ a: str = 'test'
+
+ Inline code
+ -----------
+
+ And well ``inline code`` should also work.
+
+ Quotes
+ ======
+
+ A Quote
+
+ With *some text* **blocks inside**
+
+ - even a list
+ - should be
+ - possible
+
+ Links
+ -----
+
+ Links such as `link |