field or fields container with only one field is expected |
field or fields container with only one field is expected |
Retrieves the elemental scoping of a given input mesh, which contains the element IDs.
-Computes element-wise field[i]^p.
-Intersect 2 scopings and return the intersection and the difference between the intersection and the first scoping.
-Scales a field by a constant factor. This factor can be a scalar or a vector, where each value of the vector represents a scaler per component. Number of the components are corresponding to the input field dimensionality
+Intersect 2 scopings and return the intersection and the difference between the intersection and the first scoping.
+Computes element-wise field[i]^p.
+Scales a field by a constant factor. This factor can be a scalar or a vector, where each value of the vector represents a scaler per component. Number of the components are corresponding to the input field dimensionality
field or fields container with only one field is expected |
Double/Field/Vector of doubles. When scoped on overall, same value(s) applied on all the data, when scoped elsewhere, corresponding values will be multiplied due to the scoping |
Default is false. If set to true, output of scale is made dimensionless @@ -5544,7 +5544,136 @@Configurating operators |
result file path container, used if no streams are set |
integration point where the result will be read from. Default value: 0 (first integration point). |
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - |
Read/compute element total number of contact status changes during 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.
+Read/compute element total number of contact status changes during substep by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -5558,8 +5687,8 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Computes element-wise ln(field[i]).
field or fields container with only one field is expected |
Export a MeshedRegion in the pyVista format.
@@ -5658,7 +5787,136 @@Field containing weights, one weight per entity |
time_scoping |
Field containing the (weighted) sum for each component in an elementary data - |
Read/compute heat flux 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.
+Read/compute heat flux by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -5672,8 +5930,8 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute co-energy (magnetics) by calling the readers defined by the datasources.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -5727,7 +5985,136 @@Configurating operators |
(for Fluid results only) LabelSpace with combination of zone, phases or species ids |
Compute the absolute value of each data value of the input field, no norm performed.
field or fields container with only one field is expected - |
Read/compute element nodal component thermal strains 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.
+Read/compute element nodal component thermal strains by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -5737,8 +6124,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute incremental energy (magnetics) by calling the readers defined by the datasources.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -5835,7 +6222,136 @@Configurating operators |
Creates a meshes container containing the mesh provided on pin 0.
If a meshes container is set in input, it is passed on as an output with the additional label space (if any). |
Sets a label space. - |
Read/compute element nodal equivalent stress parameter 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.
+Read/compute element nodal equivalent stress parameter by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -5845,8 +6361,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read Beam Torsional Moment (LSDyna) by calling the readers defined by the datasources.
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. |
elements scoping required in output. @@ -5884,7 +6400,136 @@Configurating operators |
Returns the input field or fields container.
field or fields container with only one field is expected |
Returns the input field or fields container.
-Read/compute Electric flux density 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.
+Read/compute Electric flux density by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -5894,8 +6539,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute element nodal component plastic strains 2nd principal component by calling the readers defined by the datasources and computing its eigen values. The off-diagonal strains are first converted from Voigt notation to the standard strain values.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -5933,7 +6578,136 @@Configurating operators |
Average the Elemental Nodal result to the requested location. |
Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. |
The computed result fields container (elemental nodal). - |
Read/compute element nodal equivalent plastic strain 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.
+Read/compute element nodal equivalent plastic strain by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -5943,8 +6717,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute elemental gasket inelastic closure XY shear component (01 component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -5962,7 +6736,136 @@Configurating operators |
any output |
Ties a support to a fields container.
Meshed region or a support of the field. - |
Read/compute element nodal equivalent component creep strains 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.
+Read/compute element nodal equivalent component creep strains by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -5972,8 +6875,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute normal contact moment by calling the readers defined by the datasources.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -6098,7 +7001,136 @@Configurating operators |
prevents from reading the mesh in the result files |
region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). |
(for Fluid results only) LabelSpace with combination of zone, phases or species ids - |
Read/compute element nodal component elastic strains 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.
+Read/compute element nodal component elastic strains by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6112,8 +7144,8 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read Turbulent Viscosity by calling the readers defined by the datasources.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -6132,7 +7164,136 @@Configurating operatorsInputsOutputsConfigurationsScriptinggeo: elements volumeCompute the measure of the Elements (volume for 3D elements, surface for 2D elements or length for 1D elements) using default shape functions, except for polyhedrons. Inputs
OutputsConfigurationsScriptingutility: make overallExtracts a value from a field and makes a new field containing only this value, with the associated scoping's location set as 'overall'. -InputsOutputsConfigurationsScriptingresult: stressRead/compute element nodal component stresses 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. +InputsOutputsConfigurationsScriptingresult: stressRead/compute element nodal component stresses by calling the readers defined by the datasources. +
Supported file typesInputs
OutputsConfigurationsScriptingresult: pressureRead/compute Pressure by calling the readers defined by the datasources. -Supported file typesInputs
OutputsConfigurationsScriptingresult: gasket stressRead/compute elemental gasket stress by calling the readers defined by the datasources. +
Supported file typesInputs
OutputsConfigurationsScriptingresult: contact fluid penetration pressureRead/compute element actual applied fluid penetration pressure 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. + |
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. + |
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. + |
Read/compute element actual applied fluid penetration pressure by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6331,8 +7750,8 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute elemental gasket stress XX normal component (00 component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -6355,7 +7774,136 @@Configurating operators |
requested location, default is Nodal |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) - |
Read/compute elemental gasket deformation 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.
+Read/compute elemental gasket deformation by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6365,8 +7913,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute elemental gasket deformation XX normal component (00 component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -6434,7 +7982,136 @@Configurating operators |
Read/compute elemental gasket inelastic closure 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.
+Read/compute elemental gasket inelastic closure by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6444,8 +8121,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Transforms a Workflow into a symbolic Workflow and writes it to a file (if a path is set in input) or string
0 is ASCII format and 1 is binary, default is 0. |
1 copies connections with its data, 2 forwards named inputs and outputs names, 7 copies connections of named inputs and ouputs with their data. default is 7. @@ -6496,7 +8173,136 @@Configurating operators |
requested location, default is Nodal |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) - |
Read/compute elemental gasket thermal closure 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.
+Read/compute elemental gasket thermal closure by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6506,8 +8312,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute elemental gasket thermal closure XX normal component (00 component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -6654,7 +8460,136 @@Configurating operatorsInputs
Outputs
ConfigurationsScriptingresult: elastic strain eqvRead/compute element nodal equivalent elastic strain 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. + |
Read/compute element nodal equivalent elastic strain by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6664,8 +8599,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute Electric flux density X component of the vector (1st component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -6709,8 +8644,137 @@Configurating operatorsInputs
OutputsConfigurationsScriptingresult: plastic strainRead/compute element nodal component plastic strains 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. + |
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). + |
Read/compute element nodal component plastic strains by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6720,8 +8784,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Transposes the input scoping or scopings container (Elemental/Faces --> Nodal, or Nodal ---> Elemental/Faces), based on the input mesh region.
Scoping or scopings container (the input type is the output type) |
if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included @@ -6816,7 +8880,136 @@Configurating operators |
requested location, default is Nodal |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) - |
Read/compute element nodal hydrostatic pressure 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.
+Read/compute element nodal hydrostatic pressure by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6826,8 +9019,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Computes the stress from an elastic strain field. compute_total_strain limitations are applicable for stress computationGet the Von Mises equivalent stress.
The element scoping on which the result is computed. |
Needed to get mesh and material ids. Optional if a data_sources have been connected. @@ -6914,7 +9107,136 @@Configurating operators |
global mass matrix multiplier |
global stiffness matrix multiplier |
field of modal damping ratio. - |
Read/compute element nodal component creep strains 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.
+Read/compute element nodal component creep strains by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6924,8 +9246,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Export DPF data into vtu format.
directory path |
vtu base file name, (default is file) @@ -6978,7 +9300,136 @@Configurating operators |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) |
read Euler angles on elements from the result file and rotate the fields in the fieldsContainer.
-Read/compute element contact pressure 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.
+Read/compute element contact pressure by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -6992,8 +9443,8 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute element nodal component creep strains YZ shear component (12 component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -7344,7 +9795,136 @@Configurating operators |
requested location, default is Nodal |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) - |
Read/compute electric field 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.
+Read/compute electric field by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7354,8 +9934,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute heat flux Z component of the vector (3rd component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -7375,7 +9955,136 @@Configurating operators |
result file path container, used if no streams are set |
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. |
prevents from reading the mesh in the result files - |
Read/compute element euler angles 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.
+Read/compute element euler angles by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7385,8 +10094,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
This operator is deprecated: use 'hdf5::h5dpf::make_result_file' instead. Serialize the inputs in an hdf5 format.
output file path with .h5 extension |
converts double to float to reduce file size (default is true) @@ -7420,7 +10129,7 @@Configurating operators |
Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields container. |
The mesh region in this pin is used to perform the averaging. It is used if there is no fields support. |
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. - |
0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false. + |
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false. |
Read/compute Magnetic Field Y component of the vector (2nd component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -7445,7 +10154,136 @@Configurating operators |
requested location, default is Nodal |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) - |
Read/compute Temperature Gradient 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.
+Read/compute Temperature Gradient by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7455,8 +10293,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute names result from result streams.
time/freq (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 |
nodes or elements scoping required in output. The scoping's location indicates whether nodes or elements are asked. Using scopings container enables to split the result fields container in domains @@ -7528,7 +10366,136 @@Configurating operators |
mesh expanded, use if cyclic expansion is to be done. |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - |
Read/compute Magnetic Field 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.
+Read/compute Magnetic Field by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7538,8 +10505,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Computes the stress from an elastic strain field. compute_total_strain limitations are applicable for stress computation Get the ZZ normal component (22 component).
The element scoping on which the result is computed. |
Needed to get mesh and material ids. Optional if a data_sources have been connected. @@ -7566,7 +10533,136 @@Configurating operators |
requested location, default is Nodal |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) - |
Read/compute Magnetic Flux Density 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.
+Read/compute Magnetic Flux Density by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7576,8 +10672,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute Magnetic Flux Density X component of the vector (1st component) 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.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -7641,7 +10737,136 @@Configurating operators |
requested location, default is Nodal |
if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) |
elemental nodal beam results are read if this pin is set to true (default is false) - |
Read/compute element nodal forces 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.
+Read/compute element nodal forces by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7655,8 +10880,8 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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 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. |
Computes the strain from a displacement field. Only SOLID185 (B-Bar, Simplified Enhanced Strain, Enhanced Strain formulations), SOLID186 (Full Integration) & SOLID187 elements are supported. @@ -7677,7 +10902,136 @@
Average the Elemental Nodal result to the requested location. |
Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. |
The computed result fields container (elemental nodal). - |
Read/compute element structural nodal temperatures 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.
+Read/compute element structural nodal temperatures by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7687,15 +11041,144 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Reads the result information, such as available results or unit systems from the results files contained in the streams or data sources.
streams (result file container) (optional) |
If the stream is null, retrieves the file path from the data sources. |
The band pass filter returns all the values above (but not equal to) the minimum threshold value and below (but not equal to) the maximum threshold value in input.
A minimum threshold scalar or a field containing one value is expected. |
A maximum threshold scalar or a field containing one value is expected. - |
Read/compute element nodal stress ratio 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.
+Read/compute element nodal stress ratio by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7705,12 +11188,141 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Extracts a skin of the mesh in triangles in a new meshed region.
True: meshing will also take into account shell and skin elements. False: meshing will ignore shell and skin elements. The default is false. |
Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. - |
Read/compute element nodal accumulated equivalent plastic strain 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.
+Read/compute element nodal accumulated equivalent plastic strain by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7720,9 +11332,138 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Read/compute element nodal plastic state variable 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.
+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. + |
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. + |
Read/compute element nodal plastic state variable by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7732,9 +11473,138 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Read/compute element nodal accumulated equivalent creep strain 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.
+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. + |
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. + |
Read/compute element nodal accumulated equivalent creep strain by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7744,9 +11614,138 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Read/compute element nodal plastic strain energy density 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.
+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. + |
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. + |
Read/compute element nodal plastic strain energy density by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7756,11 +11755,140 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Loads the appropriate operator based on the data sources and retrieves material properties.
material properties - |
Read/compute element nodal creep strain energy density 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.
+Read/compute element nodal creep strain energy density by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7770,15 +11898,144 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Compute the radiation efficiency (enhanced erp divided by classical erp)
the input field container expects displacements fields |
the meshes region in this pin has to be boundary or skin mesh |
load step number (if it's specified, the ERP is computed only on the substeps of this step) or time scoping |
mass density (if it's not specified, default value of the air is applied). |
speed of sound (if it's not specified, default value of the speed of sound in the air is applied). - |
Read/compute element nodal elastic strain energy density 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.
+Read/compute element nodal elastic strain energy density by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7788,12 +12045,141 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Exports a field or a fields container into a csv file
field_or_fields_container |
storage type : if matrices (without any particularity) are included in the fields container, the storage format can be chosen. 0 : flat/line format, 1 : ranked format. If 1 is chosen, the csv can not be read by "csv to field" operator anymore. Default : 0. - |
Read/compute element contact status 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.
+Read/compute element contact status by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7807,9 +12193,138 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Read/compute element contact penetration 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.
+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. + |
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. + |
Read/compute element contact penetration by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7823,9 +12338,138 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Read/compute element contact friction stress 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.
+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. + |
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. + |
Read/compute element contact friction stress by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7839,9 +12483,138 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Read/compute element contact total stress (pressure plus friction) 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.
+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. + |
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. + |
Read/compute element contact total stress (pressure plus friction) by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7855,15 +12628,144 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read Global Joint Internal Energy (LSDyna) by calling the readers defined by the datasources.
result file container allowed to be kept open to cache data |
result file path container, used if no streams are set |
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance |
Merges a list of generic data container. For each data entry, the merge operation is forwarded to the correct merge Operator. Primitive types cannot be merged, first instance found will be maintained in the result.
Either a vector of generic data containers (sharing the same data types) or generic data containers from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. - |
Read/compute element contact sliding distance 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.
+Read/compute element contact sliding distance by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7877,12 +12779,141 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Write a field based on a vtk file.
name of the field in the vtk file |
fields_container - |
Read/compute element contact gap distance 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.
+Read/compute element contact gap distance by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7896,9 +12927,138 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Read/compute element total heat flux at contact surface 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.
+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. + |
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. + |
Read/compute element total heat flux at contact surface by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7912,8 +13072,8 @@Configurating operators |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute artificial hourglass energy by calling the readers defined by the datasources.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -7950,7 +13110,136 @@Configurating operators |
prevents from reading the mesh in the result files |
region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). |
(for Fluid results only) LabelSpace with combination of zone, phases or species ids - |
Read/compute element nodal swelling strains 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.
+Read/compute element nodal swelling strains by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -7960,8 +13249,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute total contact force by calling the readers defined by the datasources.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -8077,7 +13366,21 @@Configurating operators |
result file path container, used if no streams are set |
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. |
prevents from reading the mesh in the result files - |
Read/compute joint force reaction by calling the readers defined by the datasources.
+Computes the element-wise Von-Mises criteria on a tensor field.
+field or fields container with only one field is expected + |
Poisson ratio to be used in equivalent strain calculation. + |
Assembles a set of fields into a field matrix.
+Either a fields container, a vector of fields to merge, or fields from pin 0 to ... + |
Read Beam Axial Plastic strain (LSDyna) by calling the readers defined by the datasources.
+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. + |
elements scoping required in output. + |
result file container allowed to be kept open to cache data + |
result file path container, used if no streams are set + |
integration point where the result will be read from. Default value: 0 (first integration point). + |
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance + |
Computes the element-wise Segalman Von-Mises criteria on a tensor field.
+field or fields container with only one field is expected + |
Read/compute joint force reaction by calling the readers defined by the datasources.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -8144,7 +13447,136 @@Configurating operators |
result file path container, used if no streams are set |
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance |
Reads a txt file or string to a DataTree
-Read/compute element nodal equivalent component thermal strains 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.
+Read/compute element nodal equivalent component thermal strains by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace @@ -8154,8 +13586,8 @@Configurating operators |
prevents from reading the mesh in the result files |
requested location Nodal, Elemental or ElementalNodal |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. + |
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. + |
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. |
Read/compute elemental non summable miscellaneous data by calling the readers defined by the datasources. Modal superposition (on demand expansion) and cyclic cxpansion procedures are not supported since results cannot be summed.
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains @@ -8170,8 +13602,137 @@Configurating operators |
mesh expanded, use if cyclic expansion is to be done. |
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label, use if cyclic expansion is to be done. |
angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - |
Read/compute elemental state variable 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.
-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. + |
Read/compute elemental state variable by calling the readers defined by the datasources.
+| Averaging is needed | +'split_shells' | +'shell_layer' | +Expected output | +
|---|---|---|---|
| No | +Not connected/false | +Not connected | +Location as in the result file. Fields with all element shapes combined. All shell layers present. | +
| No | +true | +Not connected | +Location as 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/false | +Connected | +Location as in the result file. Fields with all element shapes combined. Only the requested shell layer present. | +
| Yes | +Not connected/true | +Not connected | +Location as requested. Fields split according to element shapes. All shell layers present. | +
| Yes | +false | +Not connected | +Location as 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/true | +Connected | +Location as requested. Fields split according to element shapes. Only the requested shell layer present. | +
| 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 | +
time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains |
Fields container already allocated modified inplace |
result file container allowed to be kept open to cache data @@ -8181,9 +13742,17 @@Configurating operators |
requested location Nodal, Elemental or ElementalNodal |
Index of requested item. |
elemental nodal beam results are read if this pin is set to true (default is false) - |
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. - |
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. - |
Assembles a set of supports into a unique one.
+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. + |
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. + |
Read/compute FV by calling the readers defined by the datasources.
+time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. + |
nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains + |
Fields container already allocated modified inplace + |
result file container allowed to be kept open to cache data + |
result file path container, used if no streams are set + |
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. + |
prevents from reading the mesh in the result files + |
Assembles a set of supports into a unique one.
For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. |
A vector of supports to merge or supports from pin 0 to ... |
Read Global Kinetic Energy (LSDyna) by calling the readers defined by the datasources.
@@ -8270,21 +13839,7 @@result file path container, used if no streams are set |
integration point where the result will be read from. Default value: 0 (first integration point). |
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - |
Computes the element-wise Von-Mises criteria on a tensor field.
-field or fields container with only one field is expected - |
Poisson ratio to be used in equivalent strain calculation. - |
Assembles a set of fields into a field matrix.
-Either a fields container, a vector of fields to merge, or fields from pin 0 to ... - |
Read Beam Axial Plastic strain (LSDyna) by calling the readers defined by the datasources.
-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. - |
elements scoping required in output. - |
result file container allowed to be kept open to cache data - |
result file path container, used if no streams are set - |
integration point where the result will be read from. Default value: 0 (first integration point). - |
Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - |
Computes the element-wise Segalman Von-Mises criteria on a tensor field.
-field or fields container with only one field is expected - |
Read Part Eroded Internal Energy (LSDyna) by calling the readers defined by the datasources.
+Read Part Eroded Internal Energy (LSDyna) by calling the readers defined by the datasources.
result file container allowed to be kept open to cache data |
result file path container, used if no streams are set |
entity (part for matsum, interface for rcforc) where the result will be scoped @@ -8482,7 +14037,7 @@Configurating operators |
Allows to write a loop over a chunk of operators.
Either the result of the make_iterable_info operator, or the operator that must be incremented. |
Reads boundary conditions from the results files contained in the streams or data sources.
-results info +Supported file typesInputsOutputs
ConfigurationsScriptingutility: custom type field get attributeA CustomTypeField in pin 0 and a property name (string) in pin 1 are expected in input. Inputs
Outputs
ConfigurationsScriptingutility: change shell layersExtract the requested shell layers from the input fields. If the fields contain only one layer and the permissive configuration input is set to true then it returns the input fields. If permissive configuration input is set to false, any change which should not be permitted won't be achieved and the corresponding field in the output will be empty. If permissive configuration input is set to true (default), carefully check the result. -Inputs
Outputs
ConfigurationsScriptingutility: clone field to shell layerGenerates a Field from the Field in input 0 that has the same FieldDefinition with the exception of the shellLayers enum that is specified in input 1. The DataPointer is recomputed to the appropriate value. The Data of the output Field is 0.0 for all entities. Scoping can be shared or not based on the optional pin 2. -Inputs
Outputs
ConfigurationsScriptingaveraging: elemental to nodal (field)Transforms an Elemental field to a Nodal field. The result is computed on a given node's scoping.
Configurating operators |
Transforms a field into a Nodal field using an averaging process. The result is computed on a given node's scoping.
field or fields container with only one field is expected |
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. - |
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). + |
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). |
Transforms fields into Nodal fields using an averaging process. The result is computed on a given node's scoping.
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. - |
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). + |
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). |
Computes the average of a multi-entity field, (ElementalNodal -> Elemental), (NodalElemental -> Nodal).
If true, shell layers are averaged as well (default is false). |
If true you average, if false you just sum. @@ -9008,7 +14563,7 @@Configurating operators |
Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers. |
If true, the data across different shell layers is averaged as well (default is false). |
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. - |
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). + |
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). |
Transforms a Nodal field to an ElementalNodal field, The result is computed on a given element's scoping.
field or fields container with only one field is expected |
If true, the data across different shell layers is averaged as well (default is false). 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 1cc9a3d0e33..9264055e6c8 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: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false. + 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. 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: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false.""", + document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. 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: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false. + 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. 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 babc7e43a4a..88b9ca416c4 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: 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). + 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). Returns ------- @@ -182,7 +182,7 @@ def _spec() -> Specification: name="shell_layer", type_names=["int32"], optional=True, - 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).""", + 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).""", ), }, 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: 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). + 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). 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 bfe5610613f..9d858a804f1 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: 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). + 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). Returns ------- @@ -148,7 +148,7 @@ def _spec() -> Specification: name="shell_layer", type_names=["int32"], optional=True, - 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).""", + 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).""", ), }, 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: 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). + 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). 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 f8e54f41d67..fa8762a10e5 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: 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). + 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). Returns ------- @@ -154,7 +154,7 @@ def _spec() -> Specification: name="shell_layer", type_names=["int32"], optional=True, - 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).""", + 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).""", ), }, 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: 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). + 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). Returns ------- diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal.py b/src/ansys/dpf/core/operators/averaging/to_nodal.py index a400db4906a..50eab892e3f 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: 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). + 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). Returns ------- @@ -114,7 +114,7 @@ def _spec() -> Specification: name="shell_layer", type_names=["int32"], optional=True, - 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).""", + 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).""", ), }, 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: 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). + 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). 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 cc998dd971c..89adf13d1cf 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: 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). + 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). Returns ------- @@ -126,7 +126,7 @@ def _spec() -> Specification: name="shell_layer", type_names=["int32"], optional=True, - 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).""", + 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).""", ), }, 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: 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). + 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). Returns ------- diff --git a/src/ansys/dpf/core/operators/result/__init__.py b/src/ansys/dpf/core/operators/result/__init__.py index a516a72dddd..0c78f968687 100644 --- a/src/ansys/dpf/core/operators/result/__init__.py +++ b/src/ansys/dpf/core/operators/result/__init__.py @@ -125,6 +125,7 @@ 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 15d4208ce9c..5c149930a9a 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,9 +17,119 @@ class accu_eqv_creep_strain(Operator): r"""Read/compute element nodal accumulated equivalent creep strain 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal accumulated equivalent creep strain 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -552,7 +772,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -573,7 +793,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 7c06010ca8e..fd47ac6fbb6 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,9 +17,119 @@ class accu_eqv_plastic_strain(Operator): r"""Read/compute element nodal accumulated equivalent plastic strain 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal accumulated equivalent plastic strain 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -552,7 +772,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -573,7 +793,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 4f138e13550..41bdf9854da 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,9 +17,119 @@ class contact_fluid_penetration_pressure(Operator): r"""Read/compute element actual applied fluid penetration pressure 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. + 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 + ======= ====================================================== Parameters @@ -51,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -178,9 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element actual applied fluid penetration pressure 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -274,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -718,7 +938,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -739,7 +959,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 13ccc97bcfd..62e5b817223 100644 --- a/src/ansys/dpf/core/operators/result/contact_friction_stress.py +++ b/src/ansys/dpf/core/operators/result/contact_friction_stress.py @@ -17,9 +17,119 @@ class contact_friction_stress(Operator): r"""Read/compute element contact friction stress 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. + 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 + ======= ====================================================== Parameters @@ -51,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -178,9 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element contact friction stress 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -274,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -714,7 +934,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -735,7 +955,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 4d4c66f3b8d..baba8952b9a 100644 --- a/src/ansys/dpf/core/operators/result/contact_gap_distance.py +++ b/src/ansys/dpf/core/operators/result/contact_gap_distance.py @@ -17,8 +17,119 @@ class contact_gap_distance(Operator): r"""Read/compute element contact gap distance 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. + 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 + ======= ====================================================== Parameters @@ -50,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -177,8 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element contact gap distance 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -272,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -704,7 +926,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -725,7 +947,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/contact_penetration.py b/src/ansys/dpf/core/operators/result/contact_penetration.py index 6e6321dcf6e..ab4c2cb4d52 100644 --- a/src/ansys/dpf/core/operators/result/contact_penetration.py +++ b/src/ansys/dpf/core/operators/result/contact_penetration.py @@ -17,8 +17,119 @@ class contact_penetration(Operator): r"""Read/compute element contact penetration 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. + 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 + ======= ====================================================== Parameters @@ -50,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -177,8 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element contact penetration 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -272,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -700,7 +922,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -721,7 +943,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/contact_pressure.py b/src/ansys/dpf/core/operators/result/contact_pressure.py index 44ec2fad460..fd06c47ceaf 100644 --- a/src/ansys/dpf/core/operators/result/contact_pressure.py +++ b/src/ansys/dpf/core/operators/result/contact_pressure.py @@ -17,8 +17,119 @@ class contact_pressure(Operator): r"""Read/compute element contact pressure 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. + 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 + ======= ====================================================== Parameters @@ -50,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -177,8 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element contact pressure 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -272,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -696,7 +918,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -717,7 +939,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 86254a79ee9..cd6049d46e3 100644 --- a/src/ansys/dpf/core/operators/result/contact_sliding_distance.py +++ b/src/ansys/dpf/core/operators/result/contact_sliding_distance.py @@ -17,9 +17,119 @@ class contact_sliding_distance(Operator): r"""Read/compute element contact sliding distance 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. + 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 + ======= ====================================================== Parameters @@ -51,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -178,9 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element contact sliding distance 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -274,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -714,7 +934,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -735,7 +955,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/contact_status.py b/src/ansys/dpf/core/operators/result/contact_status.py index 3bf3e116ab3..6f3ac0b807a 100644 --- a/src/ansys/dpf/core/operators/result/contact_status.py +++ b/src/ansys/dpf/core/operators/result/contact_status.py @@ -17,8 +17,119 @@ class contact_status(Operator): r"""Read/compute element contact status 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. + 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 + ======= ====================================================== Parameters @@ -50,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -177,8 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element contact status 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -272,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -692,7 +914,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -713,7 +935,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 fd66d5cd00b..88e5b0f1b66 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,9 +17,119 @@ class contact_surface_heat_flux(Operator): r"""Read/compute element total heat flux at contact surface 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. + 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 + ======= ====================================================== Parameters @@ -51,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -178,9 +288,119 @@ 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. Regarding the requested location and -the input mesh scoping, the result location can be -Nodal/ElementalNodal/Elemental. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -274,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -714,7 +934,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -735,7 +955,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 c9c9c5f8ee4..fc587ac3607 100644 --- a/src/ansys/dpf/core/operators/result/contact_total_stress.py +++ b/src/ansys/dpf/core/operators/result/contact_total_stress.py @@ -17,9 +17,119 @@ class contact_total_stress(Operator): r"""Read/compute element contact total stress (pressure plus friction) 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. + 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 + ======= ====================================================== Parameters @@ -51,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -178,9 +288,119 @@ 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. Regarding the requested -location and the input mesh scoping, the result location can be -Nodal/ElementalNodal/Elemental. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -274,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -706,7 +926,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -727,7 +947,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/creep_strain.py b/src/ansys/dpf/core/operators/result/creep_strain.py index cf437119b17..03eba292c96 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain.py +++ b/src/ansys/dpf/core/operators/result/creep_strain.py @@ -17,9 +17,119 @@ class creep_strain(Operator): r"""Read/compute element nodal component creep strains 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal component creep strains 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -534,7 +754,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -555,7 +775,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 4efbb91040b..5b033dff657 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,9 +17,119 @@ class creep_strain_energy_density(Operator): r"""Read/compute element nodal creep strain energy density 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal creep strain energy density 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -552,7 +772,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -573,7 +793,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 112a514ce87..1eb4e411c5d 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_eqv.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_eqv.py @@ -17,9 +17,119 @@ class creep_strain_eqv(Operator): r"""Read/compute element nodal equivalent component creep strains 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal equivalent component creep strains 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -538,7 +758,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -559,7 +779,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/elastic_strain.py b/src/ansys/dpf/core/operators/result/elastic_strain.py index 099d071f053..70c728bc119 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain.py @@ -17,9 +17,119 @@ class elastic_strain(Operator): r"""Read/compute element nodal component elastic strains 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. + 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 + ======= ====================================================== Parameters @@ -51,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -178,9 +288,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal component elastic strains 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -274,13 +494,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -694,7 +914,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -715,7 +935,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 957c3fb3951..cb3bad4c22e 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,9 +17,119 @@ class elastic_strain_energy_density(Operator): r"""Read/compute element nodal elastic strain energy density 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal elastic strain energy density 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -554,7 +774,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -575,7 +795,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 78a327768af..9801ec3a336 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py @@ -17,9 +17,119 @@ class elastic_strain_eqv(Operator): r"""Read/compute element nodal equivalent elastic strain 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal equivalent elastic strain 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -540,7 +760,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -561,7 +781,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/electric_field.py b/src/ansys/dpf/core/operators/result/electric_field.py index 996ea2833d5..c9be72782b1 100644 --- a/src/ansys/dpf/core/operators/result/electric_field.py +++ b/src/ansys/dpf/core/operators/result/electric_field.py @@ -17,8 +17,119 @@ class electric_field(Operator): r"""Read/compute electric field 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. + 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 + ======= ====================================================== Parameters @@ -42,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -145,8 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute electric field 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -216,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -532,7 +754,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -553,7 +775,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 1dc4845c6ca..c292fa9e524 100644 --- a/src/ansys/dpf/core/operators/result/electric_flux_density.py +++ b/src/ansys/dpf/core/operators/result/electric_flux_density.py @@ -17,8 +17,119 @@ class electric_flux_density(Operator): r"""Read/compute Electric flux density 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. + 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 + ======= ====================================================== Parameters @@ -42,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -145,8 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute Electric flux density 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -216,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -550,7 +772,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -571,7 +793,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 5fbdf680eff..0a3bcec2a37 100644 --- a/src/ansys/dpf/core/operators/result/element_nodal_forces.py +++ b/src/ansys/dpf/core/operators/result/element_nodal_forces.py @@ -17,8 +17,119 @@ class element_nodal_forces(Operator): r"""Read/compute element nodal forces 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. + 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 + ======= ====================================================== Parameters @@ -50,9 +161,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 - 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. + 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. shell_layer: int, optional - 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. + 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. 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. @@ -185,8 +296,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal forces 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -280,13 +502,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), 200: PinSpecification( name="split_force_components", @@ -724,7 +946,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -745,7 +967,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/element_orientations.py b/src/ansys/dpf/core/operators/result/element_orientations.py index 21fdce94580..772d2d05c77 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations.py +++ b/src/ansys/dpf/core/operators/result/element_orientations.py @@ -17,8 +17,119 @@ class element_orientations(Operator): r"""Read/compute element euler angles 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. + 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 + ======= ====================================================== Parameters @@ -42,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -145,8 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element euler angles 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -216,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -542,7 +764,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -563,7 +785,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. 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 0096286d4de..5d6873fa82b 100644 --- a/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py +++ b/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py @@ -17,9 +17,119 @@ class eqv_stress_parameter(Operator): r"""Read/compute element nodal equivalent stress parameter 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. + 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 + ======= ====================================================== Parameters @@ -43,9 +153,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 - 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. + 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. shell_layer: int, optional - 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. + 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. Returns ------- @@ -146,9 +256,119 @@ def __init__( @staticmethod def _spec() -> Specification: description = r"""Read/compute element nodal equivalent stress parameter 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. +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 +======= ====================================================== """ spec = Specification( description=description, @@ -218,13 +438,13 @@ def _spec() -> Specification: name="split_shells", type_names=["bool"], optional=True, - 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.""", + 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.""", ), 27: PinSpecification( name="shell_layer", type_names=["int32"], optional=True, - 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.""", + 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.""", ), }, map_output_pin_spec={ @@ -544,7 +764,7 @@ def read_beams(self) -> Input: def split_shells(self) -> Input: r"""Allows to connect split_shells input to the operator. - 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. + 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. Returns ------- @@ -565,7 +785,7 @@ def split_shells(self) -> Input: def shell_layer(self) -> Input: r"""Allows to connect shell_layer input to the operator. - 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. + 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. Returns ------- diff --git a/src/ansys/dpf/core/operators/result/fluid_velocity.py b/src/ansys/dpf/core/operators/result/fluid_velocity.py new file mode 100644 index 00000000000..006584540cf --- /dev/null +++ b/src/ansys/dpf/core/operators/result/fluid_velocity.py @@ -0,0 +1,447 @@ +""" +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 |