| | | If true, the data across different shell layers is averaged as well (default is false).
diff --git a/doc/source/operators_doc/operator-specifications/operator_doc_template.md b/doc/source/operators_doc/operator-specifications/operator_doc_template.md
new file mode 100644
index 00000000000..21b8822237f
--- /dev/null
+++ b/doc/source/operators_doc/operator-specifications/operator_doc_template.md
@@ -0,0 +1,44 @@
+---
+category: {{ scripting_info.category }}
+plugin: {{ scripting_info.plugin }}
+license: {{ scripting_info.license }}
+---
+
+# {{ operator_name }}
+
+## Description
+
+{{ operator_description }}
+
+## Inputs
+
+
+| Input | Name| Expected type(s) | Required | Description |
+|-------|-----|------|----------|-------------|
+{%- for input in inputs %}
+| **Pin {{ input.pin_number }}** | {{ input.name }} | {% for t in input.types %}`{{ t }}`{% if not loop.last %}, {% endif %}{% endfor %} | {% if input.optional %}No{% else %}Yes{% endif %} | {{ input.document }} |
+{%- endfor %}
+
+## Outputs
+
+| Input | Name| Expected type(s) | Required | Description |
+|-------|-----|------|----------|-------------|
+{%- for output in outputs %}
+| **Pin {{ output.pin_number }}** | {{ output.name }} | {% for t in output.types %}`{{ t }}`{% if not loop.last %}, {% endif %}{% endfor %} | {% if output.optional %}No{% else %}Yes{% endif %} | {{ output.document }} |
+{%- endfor %}
+
+## Configurations
+
+| Name| Expected type(s) | Default value | Description |
+|-----|------|----------|-------------|
+{%- for configuration in configurations %}
+| **{{ configuration.name }}** | {% for t in configuration.types %}`{{ t }}`{% if not loop.last %}, {% endif %}{% endfor %} | {{ configuration.default_value }} | {{ configuration.document }} |
+{%- endfor %}
+
+## Scripting
+
+| Category| Plugin | Scripting name | Full name | Internal name | License |
+|---------|--------|----------------|-----------|---------------|---------|
+{{range .scripting_info -}}
+| **{{ scripting_info.category }}** | {{ scripting_info.plugin }} | {{ scripting_info.scripting_name }} | {{ scripting_info.full_name }} | {{ scripting_info.internal_name }} | {{ scripting_info.license }} |
+{{endfor}}
\ No newline at end of file
diff --git a/doc/source/operators_doc/operator-specifications/toc_template.j2 b/doc/source/operators_doc/operator-specifications/toc_template.j2
new file mode 100644
index 00000000000..910243ab33e
--- /dev/null
+++ b/doc/source/operators_doc/operator-specifications/toc_template.j2
@@ -0,0 +1,24 @@
+- name: Core concepts
+ items:
+ - name: DPF overview
+ href: core-concepts/dpf.md
+ - name: Data containers
+ href: core-concepts/data-containers.md
+ - name: Operator
+ href: core-concepts/operator.md
+- name: Getting started
+ items:
+ - name: Using data containers
+ href: getting-started/using-data-containers.md
+ - name: Using operators
+ href: getting-started/using-operators.md
+ - name: Workflow examples
+ href: getting-started/workflow-examples.md
+- name: Operator specification
+ items:
+ {% for category in data -%}
+ - name: {{ category.category }}
+ items:{% for operator in category.operators %}
+ - name: {{ operator.operator_name }}
+ href: operator-specifications/{{ operator.file_path }}{% endfor %}
+ {% endfor %}
\ No newline at end of file
diff --git a/src/ansys/dpf/core/custom_type_field.py b/src/ansys/dpf/core/custom_type_field.py
index 863711a5415..40f8702fcb5 100644
--- a/src/ansys/dpf/core/custom_type_field.py
+++ b/src/ansys/dpf/core/custom_type_field.py
@@ -64,8 +64,6 @@ class CustomTypeField(_FieldBase):
The ``CustomTypeField`` class gives you the ability to choose the most optimized unitary
data type for a given usage, and hence, allows you to optimize memory usage.
- The unitary data type must have an equivalent ctype (check this with ``np.ctypeslib.as_ctypes_type``).
-
This can be evaluated data from the :class:`Operator ` class
or created directly by an instance of this class.
@@ -77,7 +75,6 @@ class CustomTypeField(_FieldBase):
----------
unitary_type : numpy.dtype
The data vector of the Field will be a vector of this custom unitary type.
- This dtype must have an equivalent ctype (check this with ``np.ctypeslib.as_ctypes_type``).
nentities : int, optional
Number of entities reserved. The default is ``0``.
field : CustomTypeField, ansys.grpc.dpf.field_pb2.Field, ctypes.c_void_p, optional
@@ -121,13 +118,6 @@ def __init__(
raise errors.DpfVersionNotSupported("5.0")
if unitary_type is not None:
self._type = np.dtype(unitary_type)
- try:
- # Check the type can be converted to a ctype
- np.ctypeslib.as_ctypes_type(self._type)
- except NotImplementedError as e:
- raise ValueError(
- f"CustomTypeField: invalid unitary_type {self._type} (numpy: NotImplementedError: {e})."
- )
else:
self._type = unitary_type
super().__init__(nentities=nentities, field=field, server=server)
diff --git a/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py
index 9264055e6c8..1cc9a3d0e33 100644
--- a/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py
+++ b/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py
@@ -41,7 +41,7 @@ class elemental_mean_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). This pin only has an effect when collapse_shell_layers is false and a value for e_shell_layer is provided.
e_shell_layer: int, optional
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false.
Returns
-------
@@ -170,7 +170,7 @@ def _spec() -> Specification:
name="e_shell_layer",
type_names=["int32"],
optional=True,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false.""",
),
},
map_output_pin_spec={
@@ -405,7 +405,7 @@ def merge_solid_shell(self) -> Input:
def e_shell_layer(self) -> Input:
r"""Allows to connect e_shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py
index 88b9ca416c4..babc7e43a4a 100644
--- a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py
+++ b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py
@@ -39,7 +39,7 @@ class elemental_nodal_to_nodal_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified.
shell_layer: int, optional
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
@@ -182,7 +182,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
@@ -458,7 +458,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
diff --git a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py
index 9d858a804f1..bfe5610613f 100644
--- a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py
+++ b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py
@@ -35,7 +35,7 @@ class nodal_to_elemental_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified.
shell_layer: int, optional
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
@@ -148,7 +148,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
@@ -358,7 +358,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
diff --git a/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py
index fa8762a10e5..f8e54f41d67 100644
--- a/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py
+++ b/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py
@@ -32,7 +32,7 @@ class to_elemental_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified.
shell_layer: int, optional
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
@@ -154,7 +154,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
@@ -381,7 +381,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal.py b/src/ansys/dpf/core/operators/averaging/to_nodal.py
index 50eab892e3f..a400db4906a 100644
--- a/src/ansys/dpf/core/operators/averaging/to_nodal.py
+++ b/src/ansys/dpf/core/operators/averaging/to_nodal.py
@@ -28,7 +28,7 @@ class to_nodal(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified.
shell_layer: int, optional
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
@@ -114,7 +114,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
@@ -266,7 +266,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py
index 89adf13d1cf..cc998dd971c 100644
--- a/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py
+++ b/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py
@@ -28,7 +28,7 @@ class to_nodal_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified.
shell_layer: int, optional
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
@@ -126,7 +126,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
@@ -299,7 +299,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/__init__.py b/src/ansys/dpf/core/operators/result/__init__.py
index 0c78f968687..a516a72dddd 100644
--- a/src/ansys/dpf/core/operators/result/__init__.py
+++ b/src/ansys/dpf/core/operators/result/__init__.py
@@ -125,7 +125,6 @@
from .erp_radiation_efficiency import erp_radiation_efficiency
from .euler_load_buckling import euler_load_buckling
from .euler_nodes import euler_nodes
-from .fluid_velocity import fluid_velocity
from .gasket_deformation import gasket_deformation
from .gasket_deformation_X import gasket_deformation_X
from .gasket_deformation_XY import gasket_deformation_XY
diff --git a/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py b/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py
index 5c149930a9a..15d4208ce9c 100644
--- a/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py
+++ b/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py
@@ -17,119 +17,9 @@
class accu_eqv_creep_strain(Operator):
r"""Read/compute element nodal accumulated equivalent creep strain by
- calling the readers defined by the datasources. - The
- ‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
- they need scoping transposition or result averaging. The resulting
- output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
- - Once the need for averaging has been detected, the behavior of the
- combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ calling the readers defined by the datasources. Regarding the requested
+ location and the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class accu_eqv_creep_strain(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal accumulated equivalent creep strain by
-calling the readers defined by the datasources. - The
-‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
-they need scoping transposition or result averaging. The resulting
-output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
-- Once the need for averaging has been detected, the behavior of the
-combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+calling the readers defined by the datasources. Regarding the requested
+location and the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +552,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +573,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py b/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py
index fd47ac6fbb6..7c06010ca8e 100644
--- a/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py
+++ b/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py
@@ -17,119 +17,9 @@
class accu_eqv_plastic_strain(Operator):
r"""Read/compute element nodal accumulated equivalent plastic strain by
- calling the readers defined by the datasources. - The
- ‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
- they need scoping transposition or result averaging. The resulting
- output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
- - Once the need for averaging has been detected, the behavior of the
- combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ calling the readers defined by the datasources. Regarding the requested
+ location and the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class accu_eqv_plastic_strain(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal accumulated equivalent plastic strain by
-calling the readers defined by the datasources. - The
-‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
-they need scoping transposition or result averaging. The resulting
-output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
-- Once the need for averaging has been detected, the behavior of the
-combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+calling the readers defined by the datasources. Regarding the requested
+location and the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +552,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +573,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py b/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py
index 41bdf9854da..4f138e13550 100644
--- a/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py
+++ b/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py
@@ -17,119 +17,9 @@
class contact_fluid_penetration_pressure(Operator):
r"""Read/compute element actual applied fluid penetration pressure by
- calling the readers defined by the datasources. - The
- ‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
- they need scoping transposition or result averaging. The resulting
- output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
- - Once the need for averaging has been detected, the behavior of the
- combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ calling the readers defined by the datasources. Regarding the requested
+ location and the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class contact_fluid_penetration_pressure(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element actual applied fluid penetration pressure by
-calling the readers defined by the datasources. - The
-‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
-they need scoping transposition or result averaging. The resulting
-output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
-- Once the need for averaging has been detected, the behavior of the
-combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+calling the readers defined by the datasources. Regarding the requested
+location and the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -938,7 +718,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -959,7 +739,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_friction_stress.py b/src/ansys/dpf/core/operators/result/contact_friction_stress.py
index 62e5b817223..13ccc97bcfd 100644
--- a/src/ansys/dpf/core/operators/result/contact_friction_stress.py
+++ b/src/ansys/dpf/core/operators/result/contact_friction_stress.py
@@ -17,119 +17,9 @@
class contact_friction_stress(Operator):
r"""Read/compute element contact friction stress by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class contact_friction_stress(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element contact friction stress by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -934,7 +714,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -955,7 +735,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_gap_distance.py b/src/ansys/dpf/core/operators/result/contact_gap_distance.py
index baba8952b9a..4d4c66f3b8d 100644
--- a/src/ansys/dpf/core/operators/result/contact_gap_distance.py
+++ b/src/ansys/dpf/core/operators/result/contact_gap_distance.py
@@ -17,119 +17,8 @@
class contact_gap_distance(Operator):
r"""Read/compute element contact gap distance by calling the readers defined
- by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ by the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +50,9 @@ class contact_gap_distance(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +177,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element contact gap distance by calling the readers defined
-by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+by the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +272,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -926,7 +704,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -947,7 +725,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_penetration.py b/src/ansys/dpf/core/operators/result/contact_penetration.py
index ab4c2cb4d52..6e6321dcf6e 100644
--- a/src/ansys/dpf/core/operators/result/contact_penetration.py
+++ b/src/ansys/dpf/core/operators/result/contact_penetration.py
@@ -17,119 +17,8 @@
class contact_penetration(Operator):
r"""Read/compute element contact penetration by calling the readers defined
- by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ by the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +50,9 @@ class contact_penetration(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +177,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element contact penetration by calling the readers defined
-by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+by the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +272,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -922,7 +700,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -943,7 +721,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_pressure.py b/src/ansys/dpf/core/operators/result/contact_pressure.py
index fd06c47ceaf..44ec2fad460 100644
--- a/src/ansys/dpf/core/operators/result/contact_pressure.py
+++ b/src/ansys/dpf/core/operators/result/contact_pressure.py
@@ -17,119 +17,8 @@
class contact_pressure(Operator):
r"""Read/compute element contact pressure by calling the readers defined by
- the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +50,9 @@ class contact_pressure(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +177,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element contact pressure by calling the readers defined by
-the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +272,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -918,7 +696,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -939,7 +717,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_sliding_distance.py b/src/ansys/dpf/core/operators/result/contact_sliding_distance.py
index cd6049d46e3..86254a79ee9 100644
--- a/src/ansys/dpf/core/operators/result/contact_sliding_distance.py
+++ b/src/ansys/dpf/core/operators/result/contact_sliding_distance.py
@@ -17,119 +17,9 @@
class contact_sliding_distance(Operator):
r"""Read/compute element contact sliding distance by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class contact_sliding_distance(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element contact sliding distance by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -934,7 +714,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -955,7 +735,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_status.py b/src/ansys/dpf/core/operators/result/contact_status.py
index 6f3ac0b807a..3bf3e116ab3 100644
--- a/src/ansys/dpf/core/operators/result/contact_status.py
+++ b/src/ansys/dpf/core/operators/result/contact_status.py
@@ -17,119 +17,8 @@
class contact_status(Operator):
r"""Read/compute element contact status by calling the readers defined by
- the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +50,9 @@ class contact_status(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +177,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element contact status by calling the readers defined by
-the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +272,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -914,7 +692,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -935,7 +713,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py b/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py
index 88e5b0f1b66..fd66d5cd00b 100644
--- a/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py
+++ b/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py
@@ -17,119 +17,9 @@
class contact_surface_heat_flux(Operator):
r"""Read/compute element total heat flux at contact surface by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class contact_surface_heat_flux(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element total heat flux at contact surface by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -934,7 +714,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -955,7 +735,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/contact_total_stress.py b/src/ansys/dpf/core/operators/result/contact_total_stress.py
index fc587ac3607..c9c9c5f8ee4 100644
--- a/src/ansys/dpf/core/operators/result/contact_total_stress.py
+++ b/src/ansys/dpf/core/operators/result/contact_total_stress.py
@@ -17,119 +17,9 @@
class contact_total_stress(Operator):
r"""Read/compute element contact total stress (pressure plus friction) by
- calling the readers defined by the datasources. - The
- ‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
- they need scoping transposition or result averaging. The resulting
- output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
- - Once the need for averaging has been detected, the behavior of the
- combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ calling the readers defined by the datasources. Regarding the requested
+ location and the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class contact_total_stress(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element contact total stress (pressure plus friction) by
-calling the readers defined by the datasources. - The
-‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
-they need scoping transposition or result averaging. The resulting
-output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
-- Once the need for averaging has been detected, the behavior of the
-combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+calling the readers defined by the datasources. Regarding the requested
+location and the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -926,7 +706,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -947,7 +727,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/creep_strain.py b/src/ansys/dpf/core/operators/result/creep_strain.py
index 03eba292c96..cf437119b17 100644
--- a/src/ansys/dpf/core/operators/result/creep_strain.py
+++ b/src/ansys/dpf/core/operators/result/creep_strain.py
@@ -17,119 +17,9 @@
class creep_strain(Operator):
r"""Read/compute element nodal component creep strains by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class creep_strain(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal component creep strains by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -754,7 +534,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -775,7 +555,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py b/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py
index 5b033dff657..4efbb91040b 100644
--- a/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py
+++ b/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py
@@ -17,119 +17,9 @@
class creep_strain_energy_density(Operator):
r"""Read/compute element nodal creep strain energy density by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class creep_strain_energy_density(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal creep strain energy density by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +552,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +573,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/creep_strain_eqv.py b/src/ansys/dpf/core/operators/result/creep_strain_eqv.py
index 1eb4e411c5d..112a514ce87 100644
--- a/src/ansys/dpf/core/operators/result/creep_strain_eqv.py
+++ b/src/ansys/dpf/core/operators/result/creep_strain_eqv.py
@@ -17,119 +17,9 @@
class creep_strain_eqv(Operator):
r"""Read/compute element nodal equivalent component creep strains by calling
- the readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ the readers defined by the datasources. Regarding the requested location
+ and the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class creep_strain_eqv(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal equivalent component creep strains by calling
-the readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+the readers defined by the datasources. Regarding the requested location
+and the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -758,7 +538,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -779,7 +559,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/elastic_strain.py b/src/ansys/dpf/core/operators/result/elastic_strain.py
index 70c728bc119..099d071f053 100644
--- a/src/ansys/dpf/core/operators/result/elastic_strain.py
+++ b/src/ansys/dpf/core/operators/result/elastic_strain.py
@@ -17,119 +17,9 @@
class elastic_strain(Operator):
r"""Read/compute element nodal component elastic strains by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class elastic_strain(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal component elastic strains by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -914,7 +694,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -935,7 +715,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py b/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py
index cb3bad4c22e..957c3fb3951 100644
--- a/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py
+++ b/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py
@@ -17,119 +17,9 @@
class elastic_strain_energy_density(Operator):
r"""Read/compute element nodal elastic strain energy density by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class elastic_strain_energy_density(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal elastic strain energy density by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -774,7 +554,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -795,7 +575,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py b/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py
index 9801ec3a336..78a327768af 100644
--- a/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py
+++ b/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py
@@ -17,119 +17,9 @@
class elastic_strain_eqv(Operator):
r"""Read/compute element nodal equivalent elastic strain by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class elastic_strain_eqv(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal equivalent elastic strain by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -760,7 +540,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -781,7 +561,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/electric_field.py b/src/ansys/dpf/core/operators/result/electric_field.py
index c9be72782b1..996ea2833d5 100644
--- a/src/ansys/dpf/core/operators/result/electric_field.py
+++ b/src/ansys/dpf/core/operators/result/electric_field.py
@@ -17,119 +17,8 @@
class electric_field(Operator):
r"""Read/compute electric field by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class electric_field(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute electric field by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -754,7 +532,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -775,7 +553,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density.py b/src/ansys/dpf/core/operators/result/electric_flux_density.py
index c292fa9e524..1dc4845c6ca 100644
--- a/src/ansys/dpf/core/operators/result/electric_flux_density.py
+++ b/src/ansys/dpf/core/operators/result/electric_flux_density.py
@@ -17,119 +17,8 @@
class electric_flux_density(Operator):
r"""Read/compute Electric flux density by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class electric_flux_density(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute Electric flux density by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +550,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +571,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/element_nodal_forces.py b/src/ansys/dpf/core/operators/result/element_nodal_forces.py
index 0a3bcec2a37..5fbdf680eff 100644
--- a/src/ansys/dpf/core/operators/result/element_nodal_forces.py
+++ b/src/ansys/dpf/core/operators/result/element_nodal_forces.py
@@ -17,119 +17,8 @@
class element_nodal_forces(Operator):
r"""Read/compute element nodal forces by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +50,9 @@ class element_nodal_forces(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
split_force_components: bool, optional
If this pin is set to true, the output fields container splits the ENF by degree of freedom ("dof" label, 0 for translation, 1 for rotation, 2 for temperature) and derivative order ("derivative_order" label, 0 for stiffness terms, 1 for damping terms and 2 for inertial terms). Default is false.
@@ -296,119 +185,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal forces by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -502,13 +280,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
200: PinSpecification(
name="split_force_components",
@@ -946,7 +724,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -967,7 +745,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/element_orientations.py b/src/ansys/dpf/core/operators/result/element_orientations.py
index 772d2d05c77..21fdce94580 100644
--- a/src/ansys/dpf/core/operators/result/element_orientations.py
+++ b/src/ansys/dpf/core/operators/result/element_orientations.py
@@ -17,119 +17,8 @@
class element_orientations(Operator):
r"""Read/compute element euler angles by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class element_orientations(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element euler angles by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -764,7 +542,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -785,7 +563,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py b/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py
index 5d6873fa82b..0096286d4de 100644
--- a/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py
+++ b/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py
@@ -17,119 +17,9 @@
class eqv_stress_parameter(Operator):
r"""Read/compute element nodal equivalent stress parameter by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class eqv_stress_parameter(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal equivalent stress parameter by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -764,7 +544,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -785,7 +565,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/fluid_velocity.py b/src/ansys/dpf/core/operators/result/fluid_velocity.py
deleted file mode 100644
index 006584540cf..00000000000
--- a/src/ansys/dpf/core/operators/result/fluid_velocity.py
+++ /dev/null
@@ -1,447 +0,0 @@
-"""
-fluid_velocity
-
-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 fluid_velocity(Operator):
- r"""Read/compute FV by calling the readers defined by the datasources.
-
-
- Parameters
- ----------
- time_scoping: Scoping or int or float or Field, optional
- 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.
- mesh_scoping: ScopingsContainer or Scoping, optional
- 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
- fields_container: FieldsContainer, optional
- Fields container already allocated modified inplace
- streams_container: StreamsContainer, optional
- result file container allowed to be kept open to cache data
- data_sources: DataSources
- result file path container, used if no streams are set
- bool_rotate_to_global: bool, optional
- if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.
- mesh: MeshedRegion or MeshesContainer, optional
- prevents from reading the mesh in the result files
-
- Returns
- -------
- fields_container: FieldsContainer
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
-
- >>> # Instantiate operator
- >>> op = dpf.operators.result.fluid_velocity()
-
- >>> # Make input connections
- >>> my_time_scoping = dpf.Scoping()
- >>> op.inputs.time_scoping.connect(my_time_scoping)
- >>> my_mesh_scoping = dpf.ScopingsContainer()
- >>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
- >>> my_fields_container = dpf.FieldsContainer()
- >>> op.inputs.fields_container.connect(my_fields_container)
- >>> my_streams_container = dpf.StreamsContainer()
- >>> op.inputs.streams_container.connect(my_streams_container)
- >>> my_data_sources = dpf.DataSources()
- >>> op.inputs.data_sources.connect(my_data_sources)
- >>> my_bool_rotate_to_global = bool()
- >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
- >>> my_mesh = dpf.MeshedRegion()
- >>> op.inputs.mesh.connect(my_mesh)
-
- >>> # Instantiate operator and connect inputs in one line
- >>> op = dpf.operators.result.fluid_velocity(
- ... time_scoping=my_time_scoping,
- ... mesh_scoping=my_mesh_scoping,
- ... fields_container=my_fields_container,
- ... streams_container=my_streams_container,
- ... data_sources=my_data_sources,
- ... bool_rotate_to_global=my_bool_rotate_to_global,
- ... mesh=my_mesh,
- ... )
-
- >>> # Get output data
- >>> result_fields_container = op.outputs.fields_container()
- """
-
- def __init__(
- self,
- time_scoping=None,
- mesh_scoping=None,
- fields_container=None,
- streams_container=None,
- data_sources=None,
- bool_rotate_to_global=None,
- mesh=None,
- config=None,
- server=None,
- ):
- super().__init__(name="FV", config=config, server=server)
- self._inputs = InputsFluidVelocity(self)
- self._outputs = OutputsFluidVelocity(self)
- if time_scoping is not None:
- self.inputs.time_scoping.connect(time_scoping)
- if mesh_scoping is not None:
- self.inputs.mesh_scoping.connect(mesh_scoping)
- if fields_container is not None:
- self.inputs.fields_container.connect(fields_container)
- if streams_container is not None:
- self.inputs.streams_container.connect(streams_container)
- if data_sources is not None:
- self.inputs.data_sources.connect(data_sources)
- if bool_rotate_to_global is not None:
- self.inputs.bool_rotate_to_global.connect(bool_rotate_to_global)
- if mesh is not None:
- self.inputs.mesh.connect(mesh)
-
- @staticmethod
- def _spec() -> Specification:
- description = r"""Read/compute FV by calling the readers defined by the datasources.
-"""
- spec = Specification(
- description=description,
- map_input_pin_spec={
- 0: PinSpecification(
- name="time_scoping",
- type_names=[
- "scoping",
- "int32",
- "vector",
- "double",
- "field",
- "vector",
- ],
- optional=True,
- document=r"""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.""",
- ),
- 1: PinSpecification(
- name="mesh_scoping",
- type_names=["scopings_container", "scoping"],
- optional=True,
- document=r"""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""",
- ),
- 2: PinSpecification(
- name="fields_container",
- type_names=["fields_container"],
- optional=True,
- document=r"""Fields container already allocated modified inplace""",
- ),
- 3: PinSpecification(
- name="streams_container",
- type_names=["streams_container"],
- optional=True,
- document=r"""result file container allowed to be kept open to cache data""",
- ),
- 4: PinSpecification(
- name="data_sources",
- type_names=["data_sources"],
- optional=False,
- document=r"""result file path container, used if no streams are set""",
- ),
- 5: PinSpecification(
- name="bool_rotate_to_global",
- type_names=["bool"],
- optional=True,
- document=r"""if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.""",
- ),
- 7: PinSpecification(
- name="mesh",
- type_names=["abstract_meshed_region", "meshes_container"],
- optional=True,
- document=r"""prevents from reading the mesh in the result files""",
- ),
- },
- map_output_pin_spec={
- 0: PinSpecification(
- name="fields_container",
- type_names=["fields_container"],
- optional=False,
- document=r"""""",
- ),
- },
- )
- return spec
-
- @staticmethod
- def default_config(server: AnyServerType = None) -> Config:
- """Returns the default config of the operator.
-
- This config can then be changed to the user needs and be used to
- instantiate the operator. The Configuration allows to customize
- how the operation will be processed by the operator.
-
- Parameters
- ----------
- server:
- Server with channel connected to the remote or local instance. When
- ``None``, attempts to use the global server.
-
- Returns
- -------
- config:
- A new Config instance equivalent to the default config for this operator.
- """
- return Operator.default_config(name="FV", server=server)
-
- @property
- def inputs(self) -> InputsFluidVelocity:
- """Enables to connect inputs to the operator
-
- Returns
- --------
- inputs:
- An instance of InputsFluidVelocity.
- """
- return super().inputs
-
- @property
- def outputs(self) -> OutputsFluidVelocity:
- """Enables to get outputs of the operator by evaluating it
-
- Returns
- --------
- outputs:
- An instance of OutputsFluidVelocity.
- """
- return super().outputs
-
-
-class InputsFluidVelocity(_Inputs):
- """Intermediate class used to connect user inputs to
- fluid_velocity operator.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> my_time_scoping = dpf.Scoping()
- >>> op.inputs.time_scoping.connect(my_time_scoping)
- >>> my_mesh_scoping = dpf.ScopingsContainer()
- >>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
- >>> my_fields_container = dpf.FieldsContainer()
- >>> op.inputs.fields_container.connect(my_fields_container)
- >>> my_streams_container = dpf.StreamsContainer()
- >>> op.inputs.streams_container.connect(my_streams_container)
- >>> my_data_sources = dpf.DataSources()
- >>> op.inputs.data_sources.connect(my_data_sources)
- >>> my_bool_rotate_to_global = bool()
- >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
- >>> my_mesh = dpf.MeshedRegion()
- >>> op.inputs.mesh.connect(my_mesh)
- """
-
- def __init__(self, op: Operator):
- super().__init__(fluid_velocity._spec().inputs, op)
- self._time_scoping = Input(fluid_velocity._spec().input_pin(0), 0, op, -1)
- self._inputs.append(self._time_scoping)
- self._mesh_scoping = Input(fluid_velocity._spec().input_pin(1), 1, op, -1)
- self._inputs.append(self._mesh_scoping)
- self._fields_container = Input(fluid_velocity._spec().input_pin(2), 2, op, -1)
- self._inputs.append(self._fields_container)
- self._streams_container = Input(fluid_velocity._spec().input_pin(3), 3, op, -1)
- self._inputs.append(self._streams_container)
- self._data_sources = Input(fluid_velocity._spec().input_pin(4), 4, op, -1)
- self._inputs.append(self._data_sources)
- self._bool_rotate_to_global = Input(
- fluid_velocity._spec().input_pin(5), 5, op, -1
- )
- self._inputs.append(self._bool_rotate_to_global)
- self._mesh = Input(fluid_velocity._spec().input_pin(7), 7, op, -1)
- self._inputs.append(self._mesh)
-
- @property
- def time_scoping(self) -> Input:
- r"""Allows to connect time_scoping input to the operator.
-
- 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.
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> op.inputs.time_scoping.connect(my_time_scoping)
- >>> # or
- >>> op.inputs.time_scoping(my_time_scoping)
- """
- return self._time_scoping
-
- @property
- def mesh_scoping(self) -> Input:
- r"""Allows to connect mesh_scoping input to the operator.
-
- 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
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
- >>> # or
- >>> op.inputs.mesh_scoping(my_mesh_scoping)
- """
- return self._mesh_scoping
-
- @property
- def fields_container(self) -> Input:
- r"""Allows to connect fields_container input to the operator.
-
- Fields container already allocated modified inplace
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> op.inputs.fields_container.connect(my_fields_container)
- >>> # or
- >>> op.inputs.fields_container(my_fields_container)
- """
- return self._fields_container
-
- @property
- def streams_container(self) -> Input:
- r"""Allows to connect streams_container input to the operator.
-
- result file container allowed to be kept open to cache data
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> op.inputs.streams_container.connect(my_streams_container)
- >>> # or
- >>> op.inputs.streams_container(my_streams_container)
- """
- return self._streams_container
-
- @property
- def data_sources(self) -> Input:
- r"""Allows to connect data_sources input to the operator.
-
- result file path container, used if no streams are set
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> op.inputs.data_sources.connect(my_data_sources)
- >>> # or
- >>> op.inputs.data_sources(my_data_sources)
- """
- return self._data_sources
-
- @property
- def bool_rotate_to_global(self) -> Input:
- r"""Allows to connect bool_rotate_to_global input to the operator.
-
- if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
- >>> # or
- >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
- """
- return self._bool_rotate_to_global
-
- @property
- def mesh(self) -> Input:
- r"""Allows to connect mesh input to the operator.
-
- prevents from reading the mesh in the result files
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> op.inputs.mesh.connect(my_mesh)
- >>> # or
- >>> op.inputs.mesh(my_mesh)
- """
- return self._mesh
-
-
-class OutputsFluidVelocity(_Outputs):
- """Intermediate class used to get outputs from
- fluid_velocity operator.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> # Connect inputs : op.inputs. ...
- >>> result_fields_container = op.outputs.fields_container()
- """
-
- def __init__(self, op: Operator):
- super().__init__(fluid_velocity._spec().outputs, op)
- self._fields_container = Output(fluid_velocity._spec().output_pin(0), 0, op)
- self._outputs.append(self._fields_container)
-
- @property
- def fields_container(self) -> Output:
- r"""Allows to get fields_container output of the operator
-
- Returns
- -------
- output:
- An Output instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.fluid_velocity()
- >>> # Get the output from op.outputs. ...
- >>> result_fields_container = op.outputs.fields_container()
- """
- return self._fields_container
diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation.py b/src/ansys/dpf/core/operators/result/gasket_deformation.py
index b46246cd53e..40c870186e3 100644
--- a/src/ansys/dpf/core/operators/result/gasket_deformation.py
+++ b/src/ansys/dpf/core/operators/result/gasket_deformation.py
@@ -17,119 +17,8 @@
class gasket_deformation(Operator):
r"""Read/compute elemental gasket deformation by calling the readers defined
- by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ by the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class gasket_deformation(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute elemental gasket deformation by calling the readers defined
-by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+by the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -760,7 +538,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -781,7 +559,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py
index 36c30143d54..077708999dc 100644
--- a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py
+++ b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py
@@ -17,119 +17,9 @@
class gasket_inelastic_closure(Operator):
r"""Read/compute elemental gasket inelastic closure by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class gasket_inelastic_closure(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute elemental gasket inelastic closure by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +552,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +573,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/gasket_stress.py b/src/ansys/dpf/core/operators/result/gasket_stress.py
index 5ac32a4f5d5..386c6ef0bb1 100644
--- a/src/ansys/dpf/core/operators/result/gasket_stress.py
+++ b/src/ansys/dpf/core/operators/result/gasket_stress.py
@@ -17,119 +17,8 @@
class gasket_stress(Operator):
r"""Read/compute elemental gasket stress by calling the readers defined by
- the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class gasket_stress(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute elemental gasket stress by calling the readers defined by
-the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -754,7 +532,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -775,7 +553,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py b/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py
index 1314f931f0f..eca2356ddf3 100644
--- a/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py
+++ b/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py
@@ -17,119 +17,9 @@
class gasket_thermal_closure(Operator):
r"""Read/compute elemental gasket thermal closure by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class gasket_thermal_closure(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute elemental gasket thermal closure by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +552,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +573,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/heat_flux.py b/src/ansys/dpf/core/operators/result/heat_flux.py
index a6f7ae4b1d6..c860851ae3c 100644
--- a/src/ansys/dpf/core/operators/result/heat_flux.py
+++ b/src/ansys/dpf/core/operators/result/heat_flux.py
@@ -17,119 +17,8 @@
class heat_flux(Operator):
r"""Read/compute heat flux by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +50,9 @@ class heat_flux(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +177,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute heat flux by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +272,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -910,7 +688,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -931,7 +709,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py b/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py
index bb4a322ceaa..fa9b7047c5e 100644
--- a/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py
+++ b/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py
@@ -17,119 +17,9 @@
class hydrostatic_pressure(Operator):
r"""Read/compute element nodal hydrostatic pressure by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class hydrostatic_pressure(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal hydrostatic pressure by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -764,7 +544,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -785,7 +565,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/magnetic_field.py b/src/ansys/dpf/core/operators/result/magnetic_field.py
index 71cfddf4ae4..0fd8be0cd72 100644
--- a/src/ansys/dpf/core/operators/result/magnetic_field.py
+++ b/src/ansys/dpf/core/operators/result/magnetic_field.py
@@ -17,119 +17,8 @@
class magnetic_field(Operator):
r"""Read/compute Magnetic Field by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class magnetic_field(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute Magnetic Field by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -754,7 +532,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -775,7 +553,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density.py
index 475c95bffb1..583dc2b1d3a 100644
--- a/src/ansys/dpf/core/operators/result/magnetic_flux_density.py
+++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density.py
@@ -17,119 +17,8 @@
class magnetic_flux_density(Operator):
r"""Read/compute Magnetic Flux Density by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class magnetic_flux_density(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute Magnetic Flux Density by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +550,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +571,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/num_surface_status_changes.py b/src/ansys/dpf/core/operators/result/num_surface_status_changes.py
index 850485de90e..2725a5ec64d 100644
--- a/src/ansys/dpf/core/operators/result/num_surface_status_changes.py
+++ b/src/ansys/dpf/core/operators/result/num_surface_status_changes.py
@@ -17,119 +17,9 @@
class num_surface_status_changes(Operator):
r"""Read/compute element total number of contact status changes during
- substep by calling the readers defined by the datasources. - The
- ‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
- they need scoping transposition or result averaging. The resulting
- output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
- - Once the need for averaging has been detected, the behavior of the
- combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ substep by calling the readers defined by the datasources. Regarding the
+ requested location and the input mesh scoping, the result location can
+ be Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class num_surface_status_changes(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element total number of contact status changes during
-substep by calling the readers defined by the datasources. - The
-‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
-they need scoping transposition or result averaging. The resulting
-output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
-- Once the need for averaging has been detected, the behavior of the
-combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+substep by calling the readers defined by the datasources. Regarding the
+requested location and the input mesh scoping, the result location can
+be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -934,7 +714,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -955,7 +735,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/plastic_state_variable.py b/src/ansys/dpf/core/operators/result/plastic_state_variable.py
index e29332399bb..3ea16ec3def 100644
--- a/src/ansys/dpf/core/operators/result/plastic_state_variable.py
+++ b/src/ansys/dpf/core/operators/result/plastic_state_variable.py
@@ -17,119 +17,9 @@
class plastic_state_variable(Operator):
r"""Read/compute element nodal plastic state variable by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class plastic_state_variable(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal plastic state variable by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +552,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +573,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/plastic_strain.py b/src/ansys/dpf/core/operators/result/plastic_strain.py
index 37d23532360..363c3d6de6d 100644
--- a/src/ansys/dpf/core/operators/result/plastic_strain.py
+++ b/src/ansys/dpf/core/operators/result/plastic_strain.py
@@ -17,119 +17,9 @@
class plastic_strain(Operator):
r"""Read/compute element nodal component plastic strains by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class plastic_strain(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal component plastic strains by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -754,7 +534,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -775,7 +555,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py b/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py
index 0e0b2dbb8b6..d8cfb68d80a 100644
--- a/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py
+++ b/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py
@@ -17,119 +17,9 @@
class plastic_strain_energy_density(Operator):
r"""Read/compute element nodal plastic strain energy density by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class plastic_strain_energy_density(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal plastic strain energy density by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -774,7 +554,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -795,7 +575,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py b/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py
index acb261ed8a8..6440457defb 100644
--- a/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py
+++ b/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py
@@ -17,119 +17,9 @@
class plastic_strain_eqv(Operator):
r"""Read/compute element nodal equivalent plastic strain by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class plastic_strain_eqv(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal equivalent plastic strain by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -760,7 +540,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -781,7 +561,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/state_variable.py b/src/ansys/dpf/core/operators/result/state_variable.py
index c00c4342c5a..9f0b3dc6b0b 100644
--- a/src/ansys/dpf/core/operators/result/state_variable.py
+++ b/src/ansys/dpf/core/operators/result/state_variable.py
@@ -17,119 +17,8 @@
class state_variable(Operator):
r"""Read/compute elemental state variable by calling the readers defined by
- the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -155,9 +44,9 @@ class state_variable(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -264,119 +153,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute elemental state variable by calling the readers defined by
-the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -452,13 +230,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -793,7 +571,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -814,7 +592,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/stress.py b/src/ansys/dpf/core/operators/result/stress.py
index 74b4ccec9b0..1af9a260d36 100644
--- a/src/ansys/dpf/core/operators/result/stress.py
+++ b/src/ansys/dpf/core/operators/result/stress.py
@@ -17,119 +17,9 @@
class stress(Operator):
r"""Read/compute element nodal component stresses by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -161,9 +51,9 @@ class stress(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -288,119 +178,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal component stresses by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -494,13 +274,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -908,7 +688,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -929,7 +709,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/stress_ratio.py b/src/ansys/dpf/core/operators/result/stress_ratio.py
index 4516fb4bf01..1707ced5bff 100644
--- a/src/ansys/dpf/core/operators/result/stress_ratio.py
+++ b/src/ansys/dpf/core/operators/result/stress_ratio.py
@@ -17,119 +17,8 @@
class stress_ratio(Operator):
r"""Read/compute element nodal stress ratio by calling the readers defined
- by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ by the datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class stress_ratio(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal stress ratio by calling the readers defined
-by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+by the datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -754,7 +532,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -775,7 +553,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/structural_temperature.py b/src/ansys/dpf/core/operators/result/structural_temperature.py
index f2dd0f46305..85d4761f9df 100644
--- a/src/ansys/dpf/core/operators/result/structural_temperature.py
+++ b/src/ansys/dpf/core/operators/result/structural_temperature.py
@@ -17,119 +17,9 @@
class structural_temperature(Operator):
r"""Read/compute element structural nodal temperatures by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class structural_temperature(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element structural nodal temperatures by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -772,7 +552,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -793,7 +573,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/swelling_strains.py b/src/ansys/dpf/core/operators/result/swelling_strains.py
index 2d23887eac6..7c32442a82e 100644
--- a/src/ansys/dpf/core/operators/result/swelling_strains.py
+++ b/src/ansys/dpf/core/operators/result/swelling_strains.py
@@ -17,119 +17,9 @@
class swelling_strains(Operator):
r"""Read/compute element nodal swelling strains by calling the readers
- defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ defined by the datasources. Regarding the requested location and the
+ input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class swelling_strains(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal swelling strains by calling the readers
-defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+defined by the datasources. Regarding the requested location and the
+input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -758,7 +538,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -779,7 +559,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/temperature_grad.py b/src/ansys/dpf/core/operators/result/temperature_grad.py
index bc8be7b6d6c..4db6bc50e47 100644
--- a/src/ansys/dpf/core/operators/result/temperature_grad.py
+++ b/src/ansys/dpf/core/operators/result/temperature_grad.py
@@ -17,119 +17,8 @@
class temperature_grad(Operator):
r"""Read/compute Temperature Gradient by calling the readers defined by the
- datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
- processed to see if they need scoping transposition or result averaging.
- The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
- ‘Elemental’ location. - Once the need for averaging has been detected,
- the behavior of the combined connection of the ‘split_shells’ and
- ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ datasources. Regarding the requested location and the input mesh
+ scoping, the result location can be Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +42,9 @@ class temperature_grad(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +145,8 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute Temperature Gradient by calling the readers defined by the
-datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs are
-processed to see if they need scoping transposition or result averaging.
-The resulting output fields have a ‘Nodal’, ‘ElementalNodal’ or
-‘Elemental’ location. - Once the need for averaging has been detected,
-the behavior of the combined connection of the ‘split_shells’ and
-‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+datasources. Regarding the requested location and the input mesh
+scoping, the result location can be Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +216,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -758,7 +536,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -779,7 +557,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/thermal_strain.py b/src/ansys/dpf/core/operators/result/thermal_strain.py
index 29047b08a33..932943c3293 100644
--- a/src/ansys/dpf/core/operators/result/thermal_strain.py
+++ b/src/ansys/dpf/core/operators/result/thermal_strain.py
@@ -17,119 +17,9 @@
class thermal_strain(Operator):
r"""Read/compute element nodal component thermal strains by calling the
- readers defined by the datasources. - The ‘requested_location’ and
- ‘mesh_scoping’ inputs are processed to see if they need scoping
- transposition or result averaging. The resulting output fields have a
- ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
- averaging has been detected, the behavior of the combined connection of
- the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ readers defined by the datasources. Regarding the requested location and
+ the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class thermal_strain(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal component thermal strains by calling the
-readers defined by the datasources. - The ‘requested_location’ and
-‘mesh_scoping’ inputs are processed to see if they need scoping
-transposition or result averaging. The resulting output fields have a
-‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location. - Once the need for
-averaging has been detected, the behavior of the combined connection of
-the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+readers defined by the datasources. Regarding the requested location and
+the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -754,7 +534,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -775,7 +555,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py b/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py
index 907d14f3e6b..0db344cc063 100644
--- a/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py
+++ b/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py
@@ -17,119 +17,9 @@
class thermal_strains_eqv(Operator):
r"""Read/compute element nodal equivalent component thermal strains by
- calling the readers defined by the datasources. - The
- ‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
- they need scoping transposition or result averaging. The resulting
- output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
- - Once the need for averaging has been detected, the behavior of the
- combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
+ calling the readers defined by the datasources. Regarding the requested
+ location and the input mesh scoping, the result location can be
+ Nodal/ElementalNodal/Elemental.
Parameters
@@ -153,9 +43,9 @@ class thermal_strains_eqv(Operator):
read_beams: bool, optional
elemental nodal beam results are read if this pin is set to true (default is false)
split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
@@ -256,119 +146,9 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Read/compute element nodal equivalent component thermal strains by
-calling the readers defined by the datasources. - The
-‘requested_location’ and ‘mesh_scoping’ inputs are processed to see if
-they need scoping transposition or result averaging. The resulting
-output fields have a ‘Nodal’, ‘ElementalNodal’ or ‘Elemental’ location.
-- Once the need for averaging has been detected, the behavior of the
-combined connection of the ‘split_shells’ and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
+calling the readers defined by the datasources. Regarding the requested
+location and the input mesh scoping, the result location can be
+Nodal/ElementalNodal/Elemental.
"""
spec = Specification(
description=description,
@@ -438,13 +218,13 @@ def _spec() -> Specification:
name="split_shells",
type_names=["bool"],
optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
+ document=r"""This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.""",
),
27: PinSpecification(
name="shell_layer",
type_names=["int32"],
optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.""",
),
},
map_output_pin_spec={
@@ -762,7 +542,7 @@ def read_beams(self) -> Input:
def split_shells(self) -> Input:
r"""Allows to connect split_shells input to the operator.
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
+ This pin forces elemental nodal shell and solid results to be split if this pin is set to true. If set to false (default), a specific shell layer is still needed to merge the fields. Merge is possible only if a shell layer is provided.
Returns
-------
@@ -783,7 +563,7 @@ def split_shells(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ If the requested_location pin is not connected, and if split_shells pin is set to true, we choose one of the shell layer for shell element. If split_shells pin is set to false (default value) and a specific shell layer is provided, results will be merged on this specific shell layer.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/utility/change_shell_layers.py b/src/ansys/dpf/core/operators/utility/change_shell_layers.py
index 38fa823e926..6993daef1e8 100644
--- a/src/ansys/dpf/core/operators/utility/change_shell_layers.py
+++ b/src/ansys/dpf/core/operators/utility/change_shell_layers.py
@@ -30,7 +30,7 @@ class change_shell_layers(Operator):
----------
fields_container: FieldsContainer or Field
e_shell_layer: int
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid.
mesh: MeshedRegion or MeshesContainer, optional
Mesh support of the input fields_container, in case it does not have one defined. If the fields_container contains mixed shell/solid results, the mesh is required (either by connecting this pin or in the support).
merge: bool, optional
@@ -113,7 +113,7 @@ def _spec() -> Specification:
name="e_shell_layer",
type_names=["int32", "enum dataProcessing::EShellLayers"],
optional=False,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid.""",
),
2: PinSpecification(
name="mesh",
@@ -237,7 +237,7 @@ def fields_container(self) -> Input:
def e_shell_layer(self) -> Input:
r"""Allows to connect e_shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid.
Returns
-------
diff --git a/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py b/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py
index 615c4d5f459..dde91f5033a 100644
--- a/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py
+++ b/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py
@@ -27,7 +27,7 @@ class field_clone_to_shell_layer(Operator):
----------
field: Field
shell_layer: int
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid.
duplicate_scoping: bool, optional
If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false.
@@ -102,7 +102,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32", "enum dataProcessing::EShellLayers"],
optional=False,
- document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
+ document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid.""",
),
2: PinSpecification(
name="duplicate_scoping",
@@ -220,7 +220,7 @@ def field(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.
- 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+ 0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid.
Returns
-------
diff --git a/src/ansys/dpf/gate/dpf_vector.py b/src/ansys/dpf/gate/dpf_vector.py
index dca2e4cf1b6..bc17f20edc7 100644
--- a/src/ansys/dpf/gate/dpf_vector.py
+++ b/src/ansys/dpf/gate/dpf_vector.py
@@ -164,13 +164,6 @@ def __del__(self):
class DPFVectorCustomType(DPFVectorBase):
def __init__(self, unitary_type, owner=None, api=dpf_vector_capi.DpfVectorCAPI):
self.type = unitary_type
- try:
- # Check the type can be converted to a ctype
- np.ctypeslib.as_ctypes_type(self.type)
- except NotImplementedError as e:
- raise ValueError(
- f"DPFVectorCustomType: invalid unitary_type {self.type} (numpy: NotImplementedError: {e})."
- )
super().__init__(owner, api)
self._array = MutableListChar()
diff --git a/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll b/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll
index c0ce70d6582..ce0e8556dcc 100644
Binary files a/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll and b/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll differ
diff --git a/src/ansys/dpf/gatebin/DPFClientAPI.dll b/src/ansys/dpf/gatebin/DPFClientAPI.dll
index 8501a67387f..8220515f3a6 100644
Binary files a/src/ansys/dpf/gatebin/DPFClientAPI.dll and b/src/ansys/dpf/gatebin/DPFClientAPI.dll differ
diff --git a/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so b/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so
index a3ca1d6ff62..b87288cc896 100644
Binary files a/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so and b/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so differ
diff --git a/src/ansys/dpf/gatebin/libDPFClientAPI.so b/src/ansys/dpf/gatebin/libDPFClientAPI.so
index d95858592b0..2a0d541eaf4 100644
Binary files a/src/ansys/dpf/gatebin/libDPFClientAPI.so and b/src/ansys/dpf/gatebin/libDPFClientAPI.so differ
diff --git a/tests/test_custom_type_field.py b/tests/test_custom_type_field.py
index b28728a6745..c7b3a126a62 100644
--- a/tests/test_custom_type_field.py
+++ b/tests/test_custom_type_field.py
@@ -21,7 +21,6 @@
# SOFTWARE.
import numpy as np
-import pytest
from ansys import dpf
from ansys.dpf import core
@@ -283,9 +282,6 @@ def test_check_types_custom_type_field(server_type):
pfield4 = core.CustomTypeField(np.float64, server=server_type)
pfield5 = core.CustomTypeField(np.int8, server=server_type)
- with pytest.raises(ValueError, match="CustomTypeField: invalid unitary_type"):
- _ = core.CustomTypeField(np.complex128, server=server_type)
-
forward = dpf.core.operators.utility.forward(server=server_type)
forward.connect(0, pfield)
forward.connect(1, pfield2)
diff --git a/tests/test_dpf_vector.py b/tests/test_dpf_vector.py
index 3b5f9ba27ea..7ef3a8df9b4 100644
--- a/tests/test_dpf_vector.py
+++ b/tests/test_dpf_vector.py
@@ -24,7 +24,6 @@
from ansys.dpf import core as dpf
from ansys.dpf.core import fields_factory
-from ansys.dpf.gate.dpf_vector import DPFVectorCustomType
import conftest
@@ -105,8 +104,3 @@ def test_update_empty_dpf_vector_custom_type_field(server_type):
dp = field._data_pointer
dp = None
assert np.allclose(field.get_entity_data(1), [0])
-
-
-def test_invalid_unitary_type_dpf_vector_custom_type(server_type):
- with pytest.raises(ValueError, match="DPFVectorCustomType: invalid unitary_type"):
- DPFVectorCustomType(unitary_type=np.complex128)
|