A PropertyField in pin 0 and a property name (string) in pin 1 are expected in input.
-
Version 0.0.0
Inputs
Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
-
Outputs
Property value.
+
Outputs
Configurations
Scripting
Changelog
utility: property field get attribute
Description
Gets a property from an input field/field container. A PropertyFieldin pin 0, a property name (string) in pin 1 are expected as inputs
+
Version 0.0.0
Inputs
Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
+
Outputs
Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
Configurations
Scripting
Changelog
result: element orientations X
Description
Read/compute element euler angles 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.
Version 0.0.0
Inputs
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
@@ -5312,7 +5312,7 @@
Configurating operators
Warning: There are multiple results named "current density".
This operator returns the elemental "Source current density", also named "JS" in MAPDL and Mechanical.
To retrieve the result named "current density" in Mechanical or "JC" in MAPDL, use the solver specific operator: mapdl::rth::JC.
-
Version 0.0.0
Supported file types
Inputs
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.
+
Version 0.0.0
Supported file types
Inputs
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
result file container allowed to be kept open to cache data
@@ -6388,10 +6388,7 @@
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).
(LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance
-
Outputs
Configurations
Scripting
Changelog
utility: set property
Description
Sets a property to an input field/field container.
-
Version 0.0.0
Inputs
Property to set
-
Property to set
-
Outputs
Configurations
Scripting
Changelog
result: electric flux density Y
Description
Read/compute Electric flux density 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.
+
Outputs
Configurations
Scripting
Changelog
result: electric flux density Y
Description
Read/compute Electric flux density 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.
Version 0.0.0
Inputs
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
Either a a vector of string fields to merge or string fields from pin 0 to ...
Outputs
Configurations
Scripting
Changelog
result: stress principal 2
Description
Read/compute element nodal component stresses 2nd principal component by calling the readers defined by the datasources and computing its eigen values.
This operation is independent of the coordinate system unless averaging across elements is requested, in which case a rotation to the global coordinate system is performed.
-
Version 1.0.0
Supported file types
Inputs
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.
+
Version 1.0.0
Supported file types
Inputs
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
result file container allowed to be kept open to cache data
@@ -7785,203 +7782,7 @@
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)
-
Outputs
Configurations
Scripting
Changelog
result: gasket deformation
Description
Read/compute elemental gasket deformation by calling the readers defined by the datasources.
-
-
The 'requested_location' and 'mesh_scoping' inputs are processed to see if they need scoping transposition or result averaging. The resulting output fields have a 'Nodal', 'ElementalNodal' or 'Elemental' location.
-
Once the need for averaging has been detected, the behavior of the combined connection of the 'split_shells' and 'shell_layer' pins is:
-
-
-
-
-
Averaging is 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.
-
-
-
-
-
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
-
-
-
-
Version 0.0.0
Supported file types
Inputs
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
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
-
requested location Nodal, Elemental or ElementalNodal
-
elemental nodal beam results are read if this pin is set to true (default is false)
-
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.
-
Outputs
Configurations
Scripting
Changelog
result: gasket deformation X
Description
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.
-
Version 0.0.0
Supported file types
Inputs
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
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)
-
prevents from reading the mesh in the result files
-
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)
-
Outputs
Configurations
Scripting
Changelog
geo: elements facets surfaces over time
Description
Calculates for a mesh, the surface of each element's facet over time for each specified time step. The output is a new mesh made with only surface elements.
-
Version 0.0.0
Inputs
Displacement field's container.
-
Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement.
-
Outputs
Surfaces field.
-
Mesh made of surface elements only.
-
Configurations
Scripting
Changelog
result: gasket deformation XY
Description
Read/compute elemental gasket deformation 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.
-
Version 0.0.0
Supported file types
Inputs
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
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)
-
prevents from reading the mesh in the result files
-
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)
-
Outputs
Configurations
Scripting
Changelog
result: creep strain X
Description
Read/compute element nodal component creep strains 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.
-
Version 0.0.0
Supported file types
Inputs
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
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)
-
prevents from reading the mesh in the result files
-
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)
-
Outputs
Configurations
Scripting
Changelog
metadata: property field provider by property name
Description
Provides the property values for a set of elements for a defined property name.
-
Version 0.0.0
Inputs
scoping that defines the set of elements to fetch the property values for. If not specified, applied on all the elements of the mesh.
-
optional if using a dataSources
-
optional if using a streamsContainer
-
property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18).
-
Outputs
property field
-
Configurations
Scripting
Changelog
result: gasket deformation XZ
Description
Read/compute elemental gasket deformation XZ shear component (02 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.
-
Version 0.0.0
Supported file types
Inputs
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
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)
-
prevents from reading the mesh in the result files
-
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)
-
Outputs
Configurations
Scripting
Changelog
mesh: mesh provider
Description
Reads a mesh from result files.
+
Outputs
Configurations
Scripting
Changelog
mesh: mesh provider
Description
Reads a mesh from result files.
Version 0.0.0
Supported file types
Inputs
Optional time/frequency set ID of the mesh, supported for adaptative meshes.
result file container allowed to be kept open to cache data
result file path container, used if no streams are set
@@ -8336,7 +8137,63 @@
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)
-
Outputs
Configurations
Scripting
Changelog
result: elastic strain X
Description
Read/compute element nodal component elastic strains 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.
+
Outputs
Configurations
Scripting
Changelog
result: gasket total closure
Description
computes the gasket total closure (sum of gasket thermal closure and gasket inelastic closure).
+
Version 1.0.1
Inputs
Outputs
Configurations
Scripting
Changelog
result: gasket total closure X
Description
Read/compute elemental gasket total 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.
+
Version 0.0.0
Inputs
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
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)
+
prevents from reading the mesh in the result files
+
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)
+
Outputs
Configurations
Scripting
Changelog
geo: elements facets surfaces over time
Description
Calculates for a mesh, the surface of each element's facet over time for each specified time step. The output is a new mesh made with only surface elements.
+
Version 0.0.0
Inputs
Displacement field's container.
+
Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement.
+
Outputs
Surfaces field.
+
Mesh made of surface elements only.
+
Configurations
Scripting
Changelog
result: gasket total closure XY
Description
Read/compute elemental gasket total 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.
+
Version 0.0.0
Inputs
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
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)
+
prevents from reading the mesh in the result files
+
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)
+
Outputs
Configurations
Scripting
Changelog
result: creep strain X
Description
Read/compute element nodal component creep strains 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.
+
Version 0.0.0
Supported file types
Inputs
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
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)
+
prevents from reading the mesh in the result files
+
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)
+
Outputs
Configurations
Scripting
Changelog
metadata: property field provider by property name
Description
Provides the property values for a set of elements for a defined property name.
+
Version 0.0.0
Inputs
scoping that defines the set of elements to fetch the property values for. If not specified, applied on all the elements of the mesh.
+
optional if using a dataSources
+
optional if using a streamsContainer
+
property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18).
+
Outputs
property field
+
Configurations
Scripting
Changelog
result: gasket total closure XZ
Description
Read/compute elemental gasket total closure XZ shear component (02 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.
+
Version 0.0.0
Inputs
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
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)
+
prevents from reading the mesh in the result files
+
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)
+
Outputs
Configurations
Scripting
Changelog
result: elastic strain X
Description
Read/compute element nodal component elastic strains 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.
Version 0.0.0
Supported file types
Inputs
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
elemental nodal beam results are read if this pin is set to true (default is false)
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.
-
Outputs
Configurations
Scripting
Changelog
result: plastic strain X
Description
Read/compute element nodal component plastic strains 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.
+
Outputs
Configurations
Scripting
Changelog
scoping: transpose
Description
Transposes the input scoping or scopings container (Elemental/Faces --> Nodal, or Nodal ---> Elemental/Faces), based on the input mesh region.
+
Version 0.0.0
Inputs
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
+
Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental.
+
Outputs
Scoping or scopings container (the input type is the output type)
+
Configurations
Scripting
Changelog
result: plastic strain X
Description
Read/compute element nodal component plastic strains 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.
Version 0.0.0
Supported file types
Inputs
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
Either the result of the make_iterable_info operator, or the operator that must be incremented.
Outputs
Configurations
Scripting
Changelog
metadata: boundary condition provider
Description
Reads boundary conditions from the results files contained in the streams or data sources.
Version 0.0.0
Supported file types
Inputs
Outputs
results info
-
Configurations
Scripting
Changelog
utility: custom type field get attribute
Description
A CustomTypeField in pin 0 and a property name (string) in pin 1 are expected in input.
-
Version 0.0.0
Inputs
Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
-
Outputs
Property value.
+
Configurations
Scripting
Changelog
utility: custom type field get attribute
Description
Gets a property from an input field/field container. A CustomTypeFieldin pin 0, a property name (string) in pin 1 are expected as inputs
+
Version 0.0.0
Inputs
Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
+
Outputs
Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
Configurations
Scripting
Changelog
utility: merge property fields
Description
Assembles a set of property fields into a unique one.
Version 0.0.0
Inputs
If true, merge the input property fields assuming that there is no repetition in their scoping ids. Default is false.
Either a property fields container, a vector of property fields to merge or property fields from pin 0 to ...
@@ -14098,16 +13960,16 @@
Configurating operators
Version 0.0.0
Inputs
Vector or tensor field that must be rotated, expressed in nodal coordinate system.
Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global.
Outputs
Rotated field
-
Configurations
Scripting
Changelog
result: global_to_nodal
Description
Rotate results from global coordinate system to local coordinate system.
-
Version 0.0.0
Inputs
Vector or tensor field that must be rotated, expressed in global coordinate system.
-
Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global.
-
Outputs
Rotated field
-
Configurations
Scripting
Changelog
min_max: min max by entity over time
Description
For each entity and component, evaluates minimum and maximum over time/frequency.
+
Configurations
Scripting
Changelog
min_max: min max by entity over time
Description
For each entity and component, evaluates minimum and maximum over time/frequency.
Input pin 4 compute_amplitude is only effective when given fields_container contains the complex label.
if given input fields_container has a time_freq_support, output pins 2 and 3 fields_container contains time/freq indices of the minimum and maximum values.
Version 0.0.0
Inputs
Calculate the absolute value of field entities before computing the min/max.
Do calculate amplitude.
-
Outputs
Configurations
Scripting
Changelog
scoping: connectivity ids
Description
Returns the ordered node ids corresponding to the element ids scoping in input. For each element the node ids are its connectivity.
+
Outputs
Configurations
Scripting
Changelog
result: global_to_nodal
Description
Rotate results from global coordinate system to local coordinate system.
+
Version 0.0.0
Inputs
Vector or tensor field that must be rotated, expressed in global coordinate system.
+
Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global.
+
Outputs
Rotated field
+
Configurations
Scripting
Changelog
scoping: connectivity ids
Description
Returns the ordered node ids corresponding to the element ids scoping in input. For each element the node ids are its connectivity.
Version 0.0.0
Inputs
Elemental scoping
the support of the scoping is expected if there is no mesh in input
default is true
@@ -14210,12 +14072,7 @@
Configurating operators
set to 0: to have skin elements in their own group, 1: merge skin and solid elements, 2: merge skin and shell elements (default)
properties to apply the filtering 'mat' and/or 'elshape' (since 2025R1 it supports any property name contained in the mesh property fields) (default is 'elshape')
Outputs
Scoping
-
Configurations
Scripting
Changelog
scoping: transpose
Description
Transposes the input scoping or scopings container (Elemental/Faces --> Nodal, or Nodal ---> Elemental/Faces), based on the input mesh region.
-
Version 0.0.0
Inputs
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
-
Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental.
-
Outputs
Scoping or scopings container (the input type is the output type)
-
Configurations
Scripting
Changelog
utility: overlap fields
Description
Take two fields and superpose them, the overlapping field will override values of base_field.
+
Configurations
Scripting
Changelog
utility: overlap fields
Description
Take two fields and superpose them, the overlapping field will override values of base_field.
Version 0.0.0
Inputs
Outputs
Configurations
Scripting
Changelog
mapping: find reduced coordinates
Description
Finds the elements corresponding to the given coordinates in input and computes their reduced coordinates in those elements.
Version 0.0.0
Inputs
If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false). If a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container.
If this pin is set to true, reduced coordinates are computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false.
@@ -14351,9 +14208,13 @@
Configurating operators
Version 0.0.0
Inputs
Supported property names are: "labels".
Value of the property to be set : vector of string or LabelSpace for "labels".
Outputs
Returns the modified FieldsContainer.
-
Configurations
Scripting
Changelog
utility: field get attribute
Description
A Field in pin 0 and a property name (string) in pin 1 are expected in input.
-
Version 0.0.0
Inputs
Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
-
Outputs
Property value.
+
Configurations
Scripting
Changelog
utility: field set property
Description
Sets a property to an input field/field container. A Fieldin pin 0, a property name (string) in pin 1 and a valid property value in pin 2 are expected as inputs
+
Version 0.0.0
Inputs
Property to set. Accepted inputs are specific strings namely: 'unit', 'name', 'time_freq_support', 'scoping', 'header'.
+
Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string.
+
Outputs
Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
+
Configurations
Scripting
Changelog
utility: field get attribute
Description
Gets a property from an input field/field container. A Fieldin pin 0, a property name (string) in pin 1 are expected as inputs
+
Version 0.0.0
Inputs
Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
+
Outputs
Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
Configurations
Scripting
Changelog
metadata: cyclic mesh expansion
Description
Expand the mesh.
Version 0.0.0
Inputs
sectors to expand (start at 0), for multistage: use scopings container with 'stage' label.
Outputs
expanded meshed region.
diff --git a/src/ansys/dpf/core/operators/result/__init__.py b/src/ansys/dpf/core/operators/result/__init__.py
index 0c78f968687..3921cfe7897 100644
--- a/src/ansys/dpf/core/operators/result/__init__.py
+++ b/src/ansys/dpf/core/operators/result/__init__.py
@@ -126,10 +126,6 @@
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
-from .gasket_deformation_XZ import gasket_deformation_XZ
from .gasket_inelastic_closure import gasket_inelastic_closure
from .gasket_inelastic_closure_X import gasket_inelastic_closure_X
from .gasket_inelastic_closure_XY import gasket_inelastic_closure_XY
@@ -142,6 +138,10 @@
from .gasket_thermal_closure_X import gasket_thermal_closure_X
from .gasket_thermal_closure_XY import gasket_thermal_closure_XY
from .gasket_thermal_closure_XZ import gasket_thermal_closure_XZ
+from .gasket_total_closure import gasket_total_closure
+from .gasket_total_closure_X import gasket_total_closure_X
+from .gasket_total_closure_XY import gasket_total_closure_XY
+from .gasket_total_closure_XZ import gasket_total_closure_XZ
from .global_added_mass import global_added_mass
from .global_added_mass_pct import global_added_mass_pct
from .global_center_mass import global_center_mass
diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation.py b/src/ansys/dpf/core/operators/result/gasket_deformation.py
deleted file mode 100644
index b46246cd53e..00000000000
--- a/src/ansys/dpf/core/operators/result/gasket_deformation.py
+++ /dev/null
@@ -1,835 +0,0 @@
-"""
-gasket_deformation
-
-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 gasket_deformation(Operator):
- r"""Read/compute elemental gasket deformation by calling the readers defined
- by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
- are processed to see if they need scoping transposition or result
- averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
- or ‘Elemental’ location. - Once the need for averaging has been
- detected, the behavior of the combined connection of the ‘split_shells’
- and ‘shell_layer’ pins is:
-
- +-------------------+-------------------+-------------+---------------+
- | Averaging is | ‘split_shells’ | ‘s | Expected |
- | needed | | hell_layer’ | output |
- +===================+===================+=============+===============+
- | No | Not | Not | Location as |
- | | connected/false | connected | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Not | Location as |
- | | | connected | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | true | Connected | Location as |
- | | | | in the result |
- | | | | file. Fields |
- | | | | split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | No | Not | Connected | Location as |
- | | connected/false | | in the result |
- | | | | file. Fields |
- | | | | with all |
- | | | | element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Not | Location as |
- | | connected/true | connected | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Not | Location as |
- | | | connected | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. All |
- | | | | shell layers |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | false | Connected | Location as |
- | | | | requested. |
- | | | | Fields with |
- | | | | all element |
- | | | | shapes |
- | | | | combined. |
- | | | | Only the |
- | | | | requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
- | Yes | Not | Connected | Location as |
- | | connected/true | | requested. |
- | | | | Fields split |
- | | | | according to |
- | | | | element |
- | | | | shapes. Only |
- | | | | the requested |
- | | | | shell layer |
- | | | | present. |
- +-------------------+-------------------+-------------+---------------+
-
- - The available ‘elshape’ values are:
-
- ======= ======================================================
- elshape Related elements
- ======= ======================================================
- 1 Shell (generic)
- 2 Solid
- 3 Beam
- 4 Skin
- 5 Contact
- 6 Load
- 7 Point
- 8 Shell with 1 result across thickness (membrane)
- 9 Shell with 2 results across thickness (top/bottom)
- 10 Shell with 3 results across thickness (top/bottom/mid)
- 11 Gasket
- 12 Multi-Point Constraint
- 13 Pretension
- ======= ======================================================
-
-
- 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
- requested_location: str, optional
- requested location Nodal, Elemental or ElementalNodal
- read_beams: bool, optional
- elemental nodal beam results are read if this pin is set to true (default is false)
- split_shells: bool, optional
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
- shell_layer: int, optional
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
-
- Returns
- -------
- fields_container: FieldsContainer
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
-
- >>> # Instantiate operator
- >>> op = dpf.operators.result.gasket_deformation()
-
- >>> # 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)
- >>> my_requested_location = str()
- >>> op.inputs.requested_location.connect(my_requested_location)
- >>> my_read_beams = bool()
- >>> op.inputs.read_beams.connect(my_read_beams)
- >>> my_split_shells = bool()
- >>> op.inputs.split_shells.connect(my_split_shells)
- >>> my_shell_layer = int()
- >>> op.inputs.shell_layer.connect(my_shell_layer)
-
- >>> # Instantiate operator and connect inputs in one line
- >>> op = dpf.operators.result.gasket_deformation(
- ... 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,
- ... requested_location=my_requested_location,
- ... read_beams=my_read_beams,
- ... split_shells=my_split_shells,
- ... shell_layer=my_shell_layer,
- ... )
-
- >>> # 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,
- requested_location=None,
- read_beams=None,
- split_shells=None,
- shell_layer=None,
- config=None,
- server=None,
- ):
- super().__init__(name="GKD", config=config, server=server)
- self._inputs = InputsGasketDeformation(self)
- self._outputs = OutputsGasketDeformation(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)
- if requested_location is not None:
- self.inputs.requested_location.connect(requested_location)
- if read_beams is not None:
- self.inputs.read_beams.connect(read_beams)
- if split_shells is not None:
- self.inputs.split_shells.connect(split_shells)
- if shell_layer is not None:
- self.inputs.shell_layer.connect(shell_layer)
-
- @staticmethod
- def _spec() -> Specification:
- description = r"""Read/compute elemental gasket deformation by calling the readers defined
-by the datasources. - The ‘requested_location’ and ‘mesh_scoping’ inputs
-are processed to see if they need scoping transposition or result
-averaging. The resulting output fields have a ‘Nodal’, ‘ElementalNodal’
-or ‘Elemental’ location. - Once the need for averaging has been
-detected, the behavior of the combined connection of the ‘split_shells’
-and ‘shell_layer’ pins is:
-
-+-------------------+-------------------+-------------+---------------+
-| Averaging is | ‘split_shells’ | ‘s | Expected |
-| needed | | hell_layer’ | output |
-+===================+===================+=============+===============+
-| No | Not | Not | Location as |
-| | connected/false | connected | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Not | Location as |
-| | | connected | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | true | Connected | Location as |
-| | | | in the result |
-| | | | file. Fields |
-| | | | split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| No | Not | Connected | Location as |
-| | connected/false | | in the result |
-| | | | file. Fields |
-| | | | with all |
-| | | | element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Not | Location as |
-| | connected/true | connected | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Not | Location as |
-| | | connected | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. All |
-| | | | shell layers |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | false | Connected | Location as |
-| | | | requested. |
-| | | | Fields with |
-| | | | all element |
-| | | | shapes |
-| | | | combined. |
-| | | | Only the |
-| | | | requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-| Yes | Not | Connected | Location as |
-| | connected/true | | requested. |
-| | | | Fields split |
-| | | | according to |
-| | | | element |
-| | | | shapes. Only |
-| | | | the requested |
-| | | | shell layer |
-| | | | present. |
-+-------------------+-------------------+-------------+---------------+
-
-- The available ‘elshape’ values are:
-
-======= ======================================================
-elshape Related elements
-======= ======================================================
-1 Shell (generic)
-2 Solid
-3 Beam
-4 Skin
-5 Contact
-6 Load
-7 Point
-8 Shell with 1 result across thickness (membrane)
-9 Shell with 2 results across thickness (top/bottom)
-10 Shell with 3 results across thickness (top/bottom/mid)
-11 Gasket
-12 Multi-Point Constraint
-13 Pretension
-======= ======================================================
-"""
- spec = Specification(
- description=description,
- map_input_pin_spec={
- 0: PinSpecification(
- name="time_scoping",
- type_names=[
- "scoping",
- "int32",
- "vector",
- "double",
- "field",
- "vector",
- ],
- optional=True,
- document=r"""time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.""",
- ),
- 1: PinSpecification(
- name="mesh_scoping",
- type_names=["scopings_container", "scoping"],
- optional=True,
- document=r"""nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains""",
- ),
- 2: PinSpecification(
- name="fields_container",
- type_names=["fields_container"],
- optional=True,
- document=r"""Fields container already allocated modified inplace""",
- ),
- 3: PinSpecification(
- name="streams_container",
- type_names=["streams_container"],
- optional=True,
- document=r"""result file container allowed to be kept open to cache data""",
- ),
- 4: PinSpecification(
- name="data_sources",
- type_names=["data_sources"],
- optional=False,
- document=r"""result file path container, used if no streams are set""",
- ),
- 5: PinSpecification(
- name="bool_rotate_to_global",
- type_names=["bool"],
- optional=True,
- document=r"""if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.""",
- ),
- 7: PinSpecification(
- name="mesh",
- type_names=["abstract_meshed_region", "meshes_container"],
- optional=True,
- document=r"""prevents from reading the mesh in the result files""",
- ),
- 9: PinSpecification(
- name="requested_location",
- type_names=["string"],
- optional=True,
- document=r"""requested location Nodal, Elemental or ElementalNodal""",
- ),
- 22: PinSpecification(
- name="read_beams",
- type_names=["bool"],
- optional=True,
- document=r"""elemental nodal beam results are read if this pin is set to true (default is false)""",
- ),
- 26: PinSpecification(
- name="split_shells",
- type_names=["bool"],
- optional=True,
- document=r"""If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.""",
- ),
- 27: PinSpecification(
- name="shell_layer",
- type_names=["int32"],
- optional=True,
- document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
- ),
- },
- map_output_pin_spec={
- 0: PinSpecification(
- name="fields_container",
- type_names=["fields_container"],
- optional=False,
- document=r"""""",
- ),
- },
- )
- return spec
-
- @staticmethod
- def default_config(server: AnyServerType = None) -> Config:
- """Returns the default config of the operator.
-
- This config can then be changed to the user needs and be used to
- instantiate the operator. The Configuration allows to customize
- how the operation will be processed by the operator.
-
- Parameters
- ----------
- server:
- Server with channel connected to the remote or local instance. When
- ``None``, attempts to use the global server.
-
- Returns
- -------
- config:
- A new Config instance equivalent to the default config for this operator.
- """
- return Operator.default_config(name="GKD", server=server)
-
- @property
- def inputs(self) -> InputsGasketDeformation:
- """Enables to connect inputs to the operator
-
- Returns
- --------
- inputs:
- An instance of InputsGasketDeformation.
- """
- return super().inputs
-
- @property
- def outputs(self) -> OutputsGasketDeformation:
- """Enables to get outputs of the operator by evaluating it
-
- Returns
- --------
- outputs:
- An instance of OutputsGasketDeformation.
- """
- return super().outputs
-
-
-class InputsGasketDeformation(_Inputs):
- """Intermediate class used to connect user inputs to
- gasket_deformation operator.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> 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)
- >>> my_requested_location = str()
- >>> op.inputs.requested_location.connect(my_requested_location)
- >>> my_read_beams = bool()
- >>> op.inputs.read_beams.connect(my_read_beams)
- >>> my_split_shells = bool()
- >>> op.inputs.split_shells.connect(my_split_shells)
- >>> my_shell_layer = int()
- >>> op.inputs.shell_layer.connect(my_shell_layer)
- """
-
- def __init__(self, op: Operator):
- super().__init__(gasket_deformation._spec().inputs, op)
- self._time_scoping = Input(gasket_deformation._spec().input_pin(0), 0, op, -1)
- self._inputs.append(self._time_scoping)
- self._mesh_scoping = Input(gasket_deformation._spec().input_pin(1), 1, op, -1)
- self._inputs.append(self._mesh_scoping)
- self._fields_container = Input(
- gasket_deformation._spec().input_pin(2), 2, op, -1
- )
- self._inputs.append(self._fields_container)
- self._streams_container = Input(
- gasket_deformation._spec().input_pin(3), 3, op, -1
- )
- self._inputs.append(self._streams_container)
- self._data_sources = Input(gasket_deformation._spec().input_pin(4), 4, op, -1)
- self._inputs.append(self._data_sources)
- self._bool_rotate_to_global = Input(
- gasket_deformation._spec().input_pin(5), 5, op, -1
- )
- self._inputs.append(self._bool_rotate_to_global)
- self._mesh = Input(gasket_deformation._spec().input_pin(7), 7, op, -1)
- self._inputs.append(self._mesh)
- self._requested_location = Input(
- gasket_deformation._spec().input_pin(9), 9, op, -1
- )
- self._inputs.append(self._requested_location)
- self._read_beams = Input(gasket_deformation._spec().input_pin(22), 22, op, -1)
- self._inputs.append(self._read_beams)
- self._split_shells = Input(gasket_deformation._spec().input_pin(26), 26, op, -1)
- self._inputs.append(self._split_shells)
- self._shell_layer = Input(gasket_deformation._spec().input_pin(27), 27, op, -1)
- self._inputs.append(self._shell_layer)
-
- @property
- def time_scoping(self) -> Input:
- r"""Allows to connect time_scoping input to the operator.
-
- time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.time_scoping.connect(my_time_scoping)
- >>> # or
- >>> op.inputs.time_scoping(my_time_scoping)
- """
- return self._time_scoping
-
- @property
- def mesh_scoping(self) -> Input:
- r"""Allows to connect mesh_scoping input to the operator.
-
- nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
- >>> # or
- >>> op.inputs.mesh_scoping(my_mesh_scoping)
- """
- return self._mesh_scoping
-
- @property
- def fields_container(self) -> Input:
- r"""Allows to connect fields_container input to the operator.
-
- Fields container already allocated modified inplace
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.fields_container.connect(my_fields_container)
- >>> # or
- >>> op.inputs.fields_container(my_fields_container)
- """
- return self._fields_container
-
- @property
- def streams_container(self) -> Input:
- r"""Allows to connect streams_container input to the operator.
-
- result file container allowed to be kept open to cache data
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.streams_container.connect(my_streams_container)
- >>> # or
- >>> op.inputs.streams_container(my_streams_container)
- """
- return self._streams_container
-
- @property
- def data_sources(self) -> Input:
- r"""Allows to connect data_sources input to the operator.
-
- result file path container, used if no streams are set
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.data_sources.connect(my_data_sources)
- >>> # or
- >>> op.inputs.data_sources(my_data_sources)
- """
- return self._data_sources
-
- @property
- def bool_rotate_to_global(self) -> Input:
- r"""Allows to connect bool_rotate_to_global input to the operator.
-
- if true the field is rotated to global coordinate system (default true). Please check your results carefully if 'false' is used for Elemental or ElementalNodal results averaged to the Nodes when adjacent elements do not share the same coordinate system, as results may be incorrect.
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
- >>> # or
- >>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
- """
- return self._bool_rotate_to_global
-
- @property
- def mesh(self) -> Input:
- r"""Allows to connect mesh input to the operator.
-
- prevents from reading the mesh in the result files
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.mesh.connect(my_mesh)
- >>> # or
- >>> op.inputs.mesh(my_mesh)
- """
- return self._mesh
-
- @property
- def requested_location(self) -> Input:
- r"""Allows to connect requested_location input to the operator.
-
- requested location Nodal, Elemental or ElementalNodal
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.requested_location.connect(my_requested_location)
- >>> # or
- >>> op.inputs.requested_location(my_requested_location)
- """
- return self._requested_location
-
- @property
- def read_beams(self) -> Input:
- r"""Allows to connect read_beams input to the operator.
-
- elemental nodal beam results are read if this pin is set to true (default is false)
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.read_beams.connect(my_read_beams)
- >>> # or
- >>> op.inputs.read_beams(my_read_beams)
- """
- return self._read_beams
-
- @property
- def split_shells(self) -> Input:
- r"""Allows to connect split_shells input to the operator.
-
- If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.split_shells.connect(my_split_shells)
- >>> # or
- >>> op.inputs.split_shells(my_split_shells)
- """
- return self._split_shells
-
- @property
- def shell_layer(self) -> Input:
- r"""Allows to connect shell_layer input to the operator.
-
- If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
-
- Returns
- -------
- input:
- An Input instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> op.inputs.shell_layer.connect(my_shell_layer)
- >>> # or
- >>> op.inputs.shell_layer(my_shell_layer)
- """
- return self._shell_layer
-
-
-class OutputsGasketDeformation(_Outputs):
- """Intermediate class used to get outputs from
- gasket_deformation operator.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> # Connect inputs : op.inputs. ...
- >>> result_fields_container = op.outputs.fields_container()
- """
-
- def __init__(self, op: Operator):
- super().__init__(gasket_deformation._spec().outputs, op)
- self._fields_container = Output(gasket_deformation._spec().output_pin(0), 0, op)
- self._outputs.append(self._fields_container)
-
- @property
- def fields_container(self) -> Output:
- r"""Allows to get fields_container output of the operator
-
- Returns
- -------
- output:
- An Output instance for this pin.
-
- Examples
- --------
- >>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation()
- >>> # Get the output from op.outputs. ...
- >>> result_fields_container = op.outputs.fields_container()
- """
- return self._fields_container
diff --git a/src/ansys/dpf/core/operators/result/gasket_total_closure.py b/src/ansys/dpf/core/operators/result/gasket_total_closure.py
new file mode 100644
index 00000000000..154db3fcc91
--- /dev/null
+++ b/src/ansys/dpf/core/operators/result/gasket_total_closure.py
@@ -0,0 +1,281 @@
+"""
+gasket_total_closure
+
+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 gasket_total_closure(Operator):
+ r"""computes the gasket total closure (sum of gasket thermal closure and
+ gasket inelastic closure).
+
+
+ Parameters
+ ----------
+ fields_container: FieldsContainer, optional
+ streams_container: StreamsContainer or Stream, optional
+ data_sources: DataSources
+
+ Returns
+ -------
+ fields_container: FieldsContainer
+
+ Examples
+ --------
+ >>> from ansys.dpf import core as dpf
+
+ >>> # Instantiate operator
+ >>> op = dpf.operators.result.gasket_total_closure()
+
+ >>> # Make input connections
+ >>> 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)
+
+ >>> # Instantiate operator and connect inputs in one line
+ >>> op = dpf.operators.result.gasket_total_closure(
+ ... fields_container=my_fields_container,
+ ... streams_container=my_streams_container,
+ ... data_sources=my_data_sources,
+ ... )
+
+ >>> # Get output data
+ >>> result_fields_container = op.outputs.fields_container()
+ """
+
+ def __init__(
+ self,
+ fields_container=None,
+ streams_container=None,
+ data_sources=None,
+ config=None,
+ server=None,
+ ):
+ super().__init__(name="GKD", config=config, server=server)
+ self._inputs = InputsGasketTotalClosure(self)
+ self._outputs = OutputsGasketTotalClosure(self)
+ 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)
+
+ @staticmethod
+ def _spec() -> Specification:
+ description = r"""computes the gasket total closure (sum of gasket thermal closure and
+gasket inelastic closure).
+"""
+ spec = Specification(
+ description=description,
+ map_input_pin_spec={
+ 2: PinSpecification(
+ name="fields_container",
+ type_names=["fields_container"],
+ optional=True,
+ document=r"""""",
+ ),
+ 3: PinSpecification(
+ name="streams_container",
+ type_names=["streams_container", "stream"],
+ optional=True,
+ document=r"""""",
+ ),
+ 4: PinSpecification(
+ name="data_sources",
+ type_names=["data_sources"],
+ optional=False,
+ document=r"""""",
+ ),
+ },
+ map_output_pin_spec={
+ 0: PinSpecification(
+ name="fields_container",
+ type_names=["fields_container"],
+ optional=False,
+ document=r"""""",
+ ),
+ },
+ )
+ return spec
+
+ @staticmethod
+ def default_config(server: AnyServerType = None) -> Config:
+ """Returns the default config of the operator.
+
+ This config can then be changed to the user needs and be used to
+ instantiate the operator. The Configuration allows to customize
+ how the operation will be processed by the operator.
+
+ Parameters
+ ----------
+ server:
+ Server with channel connected to the remote or local instance. When
+ ``None``, attempts to use the global server.
+
+ Returns
+ -------
+ config:
+ A new Config instance equivalent to the default config for this operator.
+ """
+ return Operator.default_config(name="GKD", server=server)
+
+ @property
+ def inputs(self) -> InputsGasketTotalClosure:
+ """Enables to connect inputs to the operator
+
+ Returns
+ --------
+ inputs:
+ An instance of InputsGasketTotalClosure.
+ """
+ return super().inputs
+
+ @property
+ def outputs(self) -> OutputsGasketTotalClosure:
+ """Enables to get outputs of the operator by evaluating it
+
+ Returns
+ --------
+ outputs:
+ An instance of OutputsGasketTotalClosure.
+ """
+ return super().outputs
+
+
+class InputsGasketTotalClosure(_Inputs):
+ """Intermediate class used to connect user inputs to
+ gasket_total_closure operator.
+
+ Examples
+ --------
+ >>> from ansys.dpf import core as dpf
+ >>> op = dpf.operators.result.gasket_total_closure()
+ >>> 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)
+ """
+
+ def __init__(self, op: Operator):
+ super().__init__(gasket_total_closure._spec().inputs, op)
+ self._fields_container = Input(
+ gasket_total_closure._spec().input_pin(2), 2, op, -1
+ )
+ self._inputs.append(self._fields_container)
+ self._streams_container = Input(
+ gasket_total_closure._spec().input_pin(3), 3, op, -1
+ )
+ self._inputs.append(self._streams_container)
+ self._data_sources = Input(gasket_total_closure._spec().input_pin(4), 4, op, -1)
+ self._inputs.append(self._data_sources)
+
+ @property
+ def fields_container(self) -> Input:
+ r"""Allows to connect fields_container input to the operator.
+
+ Returns
+ -------
+ input:
+ An Input instance for this pin.
+
+ Examples
+ --------
+ >>> from ansys.dpf import core as dpf
+ >>> op = dpf.operators.result.gasket_total_closure()
+ >>> op.inputs.fields_container.connect(my_fields_container)
+ >>> # or
+ >>> op.inputs.fields_container(my_fields_container)
+ """
+ return self._fields_container
+
+ @property
+ def streams_container(self) -> Input:
+ r"""Allows to connect streams_container input to the operator.
+
+ Returns
+ -------
+ input:
+ An Input instance for this pin.
+
+ Examples
+ --------
+ >>> from ansys.dpf import core as dpf
+ >>> op = dpf.operators.result.gasket_total_closure()
+ >>> op.inputs.streams_container.connect(my_streams_container)
+ >>> # or
+ >>> op.inputs.streams_container(my_streams_container)
+ """
+ return self._streams_container
+
+ @property
+ def data_sources(self) -> Input:
+ r"""Allows to connect data_sources input to the operator.
+
+ Returns
+ -------
+ input:
+ An Input instance for this pin.
+
+ Examples
+ --------
+ >>> from ansys.dpf import core as dpf
+ >>> op = dpf.operators.result.gasket_total_closure()
+ >>> op.inputs.data_sources.connect(my_data_sources)
+ >>> # or
+ >>> op.inputs.data_sources(my_data_sources)
+ """
+ return self._data_sources
+
+
+class OutputsGasketTotalClosure(_Outputs):
+ """Intermediate class used to get outputs from
+ gasket_total_closure operator.
+
+ Examples
+ --------
+ >>> from ansys.dpf import core as dpf
+ >>> op = dpf.operators.result.gasket_total_closure()
+ >>> # Connect inputs : op.inputs. ...
+ >>> result_fields_container = op.outputs.fields_container()
+ """
+
+ def __init__(self, op: Operator):
+ super().__init__(gasket_total_closure._spec().outputs, op)
+ self._fields_container = Output(
+ gasket_total_closure._spec().output_pin(0), 0, op
+ )
+ self._outputs.append(self._fields_container)
+
+ @property
+ def fields_container(self) -> Output:
+ r"""Allows to get fields_container output of the operator
+
+ Returns
+ -------
+ output:
+ An Output instance for this pin.
+
+ Examples
+ --------
+ >>> from ansys.dpf import core as dpf
+ >>> op = dpf.operators.result.gasket_total_closure()
+ >>> # Get the output from op.outputs. ...
+ >>> result_fields_container = op.outputs.fields_container()
+ """
+ return self._fields_container
diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation_X.py b/src/ansys/dpf/core/operators/result/gasket_total_closure_X.py
similarity index 88%
rename from src/ansys/dpf/core/operators/result/gasket_deformation_X.py
rename to src/ansys/dpf/core/operators/result/gasket_total_closure_X.py
index 30e42a5fe59..d3ff5ef4ba6 100644
--- a/src/ansys/dpf/core/operators/result/gasket_deformation_X.py
+++ b/src/ansys/dpf/core/operators/result/gasket_total_closure_X.py
@@ -1,5 +1,5 @@
"""
-gasket_deformation_X
+gasket_total_closure_X
Autogenerated DPF operator classes.
"""
@@ -15,8 +15,8 @@
from ansys.dpf.core.server_types import AnyServerType
-class gasket_deformation_X(Operator):
- r"""Read/compute elemental gasket deformation XX normal component (00
+class gasket_total_closure_X(Operator):
+ r"""Read/compute elemental gasket total 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.
@@ -54,7 +54,7 @@ class gasket_deformation_X(Operator):
>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> # Make input connections
>>> my_time_scoping = dpf.Scoping()
@@ -79,7 +79,7 @@ class gasket_deformation_X(Operator):
>>> op.inputs.read_beams.connect(my_read_beams)
>>> # Instantiate operator and connect inputs in one line
- >>> op = dpf.operators.result.gasket_deformation_X(
+ >>> op = dpf.operators.result.gasket_total_closure_X(
... time_scoping=my_time_scoping,
... mesh_scoping=my_mesh_scoping,
... fields_container=my_fields_container,
@@ -112,8 +112,8 @@ def __init__(
server=None,
):
super().__init__(name="GKDX", config=config, server=server)
- self._inputs = InputsGasketDeformationX(self)
- self._outputs = OutputsGasketDeformationX(self)
+ self._inputs = InputsGasketTotalClosureX(self)
+ self._outputs = OutputsGasketTotalClosureX(self)
if time_scoping is not None:
self.inputs.time_scoping.connect(time_scoping)
if mesh_scoping is not None:
@@ -137,7 +137,7 @@ def __init__(
@staticmethod
def _spec() -> Specification:
- description = r"""Read/compute elemental gasket deformation XX normal component (00
+ description = r"""Read/compute elemental gasket total 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.
@@ -246,36 +246,36 @@ def default_config(server: AnyServerType = None) -> Config:
return Operator.default_config(name="GKDX", server=server)
@property
- def inputs(self) -> InputsGasketDeformationX:
+ def inputs(self) -> InputsGasketTotalClosureX:
"""Enables to connect inputs to the operator
Returns
--------
inputs:
- An instance of InputsGasketDeformationX.
+ An instance of InputsGasketTotalClosureX.
"""
return super().inputs
@property
- def outputs(self) -> OutputsGasketDeformationX:
+ def outputs(self) -> OutputsGasketTotalClosureX:
"""Enables to get outputs of the operator by evaluating it
Returns
--------
outputs:
- An instance of OutputsGasketDeformationX.
+ An instance of OutputsGasketTotalClosureX.
"""
return super().outputs
-class InputsGasketDeformationX(_Inputs):
+class InputsGasketTotalClosureX(_Inputs):
"""Intermediate class used to connect user inputs to
- gasket_deformation_X operator.
+ gasket_total_closure_X operator.
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.ScopingsContainer()
@@ -299,36 +299,44 @@ class InputsGasketDeformationX(_Inputs):
"""
def __init__(self, op: Operator):
- super().__init__(gasket_deformation_X._spec().inputs, op)
- self._time_scoping = Input(gasket_deformation_X._spec().input_pin(0), 0, op, -1)
+ super().__init__(gasket_total_closure_X._spec().inputs, op)
+ self._time_scoping = Input(
+ gasket_total_closure_X._spec().input_pin(0), 0, op, -1
+ )
self._inputs.append(self._time_scoping)
- self._mesh_scoping = Input(gasket_deformation_X._spec().input_pin(1), 1, op, -1)
+ self._mesh_scoping = Input(
+ gasket_total_closure_X._spec().input_pin(1), 1, op, -1
+ )
self._inputs.append(self._mesh_scoping)
self._fields_container = Input(
- gasket_deformation_X._spec().input_pin(2), 2, op, -1
+ gasket_total_closure_X._spec().input_pin(2), 2, op, -1
)
self._inputs.append(self._fields_container)
self._streams_container = Input(
- gasket_deformation_X._spec().input_pin(3), 3, op, -1
+ gasket_total_closure_X._spec().input_pin(3), 3, op, -1
)
self._inputs.append(self._streams_container)
- self._data_sources = Input(gasket_deformation_X._spec().input_pin(4), 4, op, -1)
+ self._data_sources = Input(
+ gasket_total_closure_X._spec().input_pin(4), 4, op, -1
+ )
self._inputs.append(self._data_sources)
self._bool_rotate_to_global = Input(
- gasket_deformation_X._spec().input_pin(5), 5, op, -1
+ gasket_total_closure_X._spec().input_pin(5), 5, op, -1
)
self._inputs.append(self._bool_rotate_to_global)
- self._mesh = Input(gasket_deformation_X._spec().input_pin(7), 7, op, -1)
+ self._mesh = Input(gasket_total_closure_X._spec().input_pin(7), 7, op, -1)
self._inputs.append(self._mesh)
self._requested_location = Input(
- gasket_deformation_X._spec().input_pin(9), 9, op, -1
+ gasket_total_closure_X._spec().input_pin(9), 9, op, -1
)
self._inputs.append(self._requested_location)
self._read_cyclic = Input(
- gasket_deformation_X._spec().input_pin(14), 14, op, -1
+ gasket_total_closure_X._spec().input_pin(14), 14, op, -1
)
self._inputs.append(self._read_cyclic)
- self._read_beams = Input(gasket_deformation_X._spec().input_pin(22), 22, op, -1)
+ self._read_beams = Input(
+ gasket_total_closure_X._spec().input_pin(22), 22, op, -1
+ )
self._inputs.append(self._read_beams)
@property
@@ -345,7 +353,7 @@ def time_scoping(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)
@@ -366,7 +374,7 @@ def mesh_scoping(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)
@@ -387,7 +395,7 @@ def fields_container(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)
@@ -408,7 +416,7 @@ def streams_container(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)
@@ -429,7 +437,7 @@ def data_sources(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)
@@ -450,7 +458,7 @@ def bool_rotate_to_global(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> # or
>>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
@@ -471,7 +479,7 @@ def mesh(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)
@@ -492,7 +500,7 @@ def requested_location(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> # or
>>> op.inputs.requested_location(my_requested_location)
@@ -513,7 +521,7 @@ def read_cyclic(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> # or
>>> op.inputs.read_cyclic(my_read_cyclic)
@@ -534,7 +542,7 @@ def read_beams(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> op.inputs.read_beams.connect(my_read_beams)
>>> # or
>>> op.inputs.read_beams(my_read_beams)
@@ -542,22 +550,22 @@ def read_beams(self) -> Input:
return self._read_beams
-class OutputsGasketDeformationX(_Outputs):
+class OutputsGasketTotalClosureX(_Outputs):
"""Intermediate class used to get outputs from
- gasket_deformation_X operator.
+ gasket_total_closure_X operator.
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()
"""
def __init__(self, op: Operator):
- super().__init__(gasket_deformation_X._spec().outputs, op)
+ super().__init__(gasket_total_closure_X._spec().outputs, op)
self._fields_container = Output(
- gasket_deformation_X._spec().output_pin(0), 0, op
+ gasket_total_closure_X._spec().output_pin(0), 0, op
)
self._outputs.append(self._fields_container)
@@ -573,7 +581,7 @@ def fields_container(self) -> Output:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_X()
+ >>> op = dpf.operators.result.gasket_total_closure_X()
>>> # Get the output from op.outputs. ...
>>> result_fields_container = op.outputs.fields_container()
"""
diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation_XY.py b/src/ansys/dpf/core/operators/result/gasket_total_closure_XY.py
similarity index 89%
rename from src/ansys/dpf/core/operators/result/gasket_deformation_XY.py
rename to src/ansys/dpf/core/operators/result/gasket_total_closure_XY.py
index 08c0e312450..3bb6aef8e6f 100644
--- a/src/ansys/dpf/core/operators/result/gasket_deformation_XY.py
+++ b/src/ansys/dpf/core/operators/result/gasket_total_closure_XY.py
@@ -1,5 +1,5 @@
"""
-gasket_deformation_XY
+gasket_total_closure_XY
Autogenerated DPF operator classes.
"""
@@ -15,8 +15,8 @@
from ansys.dpf.core.server_types import AnyServerType
-class gasket_deformation_XY(Operator):
- r"""Read/compute elemental gasket deformation XY shear component (01
+class gasket_total_closure_XY(Operator):
+ r"""Read/compute elemental gasket total 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.
@@ -54,7 +54,7 @@ class gasket_deformation_XY(Operator):
>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> # Make input connections
>>> my_time_scoping = dpf.Scoping()
@@ -79,7 +79,7 @@ class gasket_deformation_XY(Operator):
>>> op.inputs.read_beams.connect(my_read_beams)
>>> # Instantiate operator and connect inputs in one line
- >>> op = dpf.operators.result.gasket_deformation_XY(
+ >>> op = dpf.operators.result.gasket_total_closure_XY(
... time_scoping=my_time_scoping,
... mesh_scoping=my_mesh_scoping,
... fields_container=my_fields_container,
@@ -112,8 +112,8 @@ def __init__(
server=None,
):
super().__init__(name="GKDXY", config=config, server=server)
- self._inputs = InputsGasketDeformationXy(self)
- self._outputs = OutputsGasketDeformationXy(self)
+ self._inputs = InputsGasketTotalClosureXy(self)
+ self._outputs = OutputsGasketTotalClosureXy(self)
if time_scoping is not None:
self.inputs.time_scoping.connect(time_scoping)
if mesh_scoping is not None:
@@ -137,7 +137,7 @@ def __init__(
@staticmethod
def _spec() -> Specification:
- description = r"""Read/compute elemental gasket deformation XY shear component (01
+ description = r"""Read/compute elemental gasket total 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.
@@ -246,36 +246,36 @@ def default_config(server: AnyServerType = None) -> Config:
return Operator.default_config(name="GKDXY", server=server)
@property
- def inputs(self) -> InputsGasketDeformationXy:
+ def inputs(self) -> InputsGasketTotalClosureXy:
"""Enables to connect inputs to the operator
Returns
--------
inputs:
- An instance of InputsGasketDeformationXy.
+ An instance of InputsGasketTotalClosureXy.
"""
return super().inputs
@property
- def outputs(self) -> OutputsGasketDeformationXy:
+ def outputs(self) -> OutputsGasketTotalClosureXy:
"""Enables to get outputs of the operator by evaluating it
Returns
--------
outputs:
- An instance of OutputsGasketDeformationXy.
+ An instance of OutputsGasketTotalClosureXy.
"""
return super().outputs
-class InputsGasketDeformationXy(_Inputs):
+class InputsGasketTotalClosureXy(_Inputs):
"""Intermediate class used to connect user inputs to
- gasket_deformation_XY operator.
+ gasket_total_closure_XY operator.
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.ScopingsContainer()
@@ -299,43 +299,43 @@ class InputsGasketDeformationXy(_Inputs):
"""
def __init__(self, op: Operator):
- super().__init__(gasket_deformation_XY._spec().inputs, op)
+ super().__init__(gasket_total_closure_XY._spec().inputs, op)
self._time_scoping = Input(
- gasket_deformation_XY._spec().input_pin(0), 0, op, -1
+ gasket_total_closure_XY._spec().input_pin(0), 0, op, -1
)
self._inputs.append(self._time_scoping)
self._mesh_scoping = Input(
- gasket_deformation_XY._spec().input_pin(1), 1, op, -1
+ gasket_total_closure_XY._spec().input_pin(1), 1, op, -1
)
self._inputs.append(self._mesh_scoping)
self._fields_container = Input(
- gasket_deformation_XY._spec().input_pin(2), 2, op, -1
+ gasket_total_closure_XY._spec().input_pin(2), 2, op, -1
)
self._inputs.append(self._fields_container)
self._streams_container = Input(
- gasket_deformation_XY._spec().input_pin(3), 3, op, -1
+ gasket_total_closure_XY._spec().input_pin(3), 3, op, -1
)
self._inputs.append(self._streams_container)
self._data_sources = Input(
- gasket_deformation_XY._spec().input_pin(4), 4, op, -1
+ gasket_total_closure_XY._spec().input_pin(4), 4, op, -1
)
self._inputs.append(self._data_sources)
self._bool_rotate_to_global = Input(
- gasket_deformation_XY._spec().input_pin(5), 5, op, -1
+ gasket_total_closure_XY._spec().input_pin(5), 5, op, -1
)
self._inputs.append(self._bool_rotate_to_global)
- self._mesh = Input(gasket_deformation_XY._spec().input_pin(7), 7, op, -1)
+ self._mesh = Input(gasket_total_closure_XY._spec().input_pin(7), 7, op, -1)
self._inputs.append(self._mesh)
self._requested_location = Input(
- gasket_deformation_XY._spec().input_pin(9), 9, op, -1
+ gasket_total_closure_XY._spec().input_pin(9), 9, op, -1
)
self._inputs.append(self._requested_location)
self._read_cyclic = Input(
- gasket_deformation_XY._spec().input_pin(14), 14, op, -1
+ gasket_total_closure_XY._spec().input_pin(14), 14, op, -1
)
self._inputs.append(self._read_cyclic)
self._read_beams = Input(
- gasket_deformation_XY._spec().input_pin(22), 22, op, -1
+ gasket_total_closure_XY._spec().input_pin(22), 22, op, -1
)
self._inputs.append(self._read_beams)
@@ -353,7 +353,7 @@ def time_scoping(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)
@@ -374,7 +374,7 @@ def mesh_scoping(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)
@@ -395,7 +395,7 @@ def fields_container(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)
@@ -416,7 +416,7 @@ def streams_container(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)
@@ -437,7 +437,7 @@ def data_sources(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)
@@ -458,7 +458,7 @@ def bool_rotate_to_global(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> # or
>>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
@@ -479,7 +479,7 @@ def mesh(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)
@@ -500,7 +500,7 @@ def requested_location(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> # or
>>> op.inputs.requested_location(my_requested_location)
@@ -521,7 +521,7 @@ def read_cyclic(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> # or
>>> op.inputs.read_cyclic(my_read_cyclic)
@@ -542,7 +542,7 @@ def read_beams(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> op.inputs.read_beams.connect(my_read_beams)
>>> # or
>>> op.inputs.read_beams(my_read_beams)
@@ -550,22 +550,22 @@ def read_beams(self) -> Input:
return self._read_beams
-class OutputsGasketDeformationXy(_Outputs):
+class OutputsGasketTotalClosureXy(_Outputs):
"""Intermediate class used to get outputs from
- gasket_deformation_XY operator.
+ gasket_total_closure_XY operator.
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()
"""
def __init__(self, op: Operator):
- super().__init__(gasket_deformation_XY._spec().outputs, op)
+ super().__init__(gasket_total_closure_XY._spec().outputs, op)
self._fields_container = Output(
- gasket_deformation_XY._spec().output_pin(0), 0, op
+ gasket_total_closure_XY._spec().output_pin(0), 0, op
)
self._outputs.append(self._fields_container)
@@ -581,7 +581,7 @@ def fields_container(self) -> Output:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XY()
+ >>> op = dpf.operators.result.gasket_total_closure_XY()
>>> # Get the output from op.outputs. ...
>>> result_fields_container = op.outputs.fields_container()
"""
diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation_XZ.py b/src/ansys/dpf/core/operators/result/gasket_total_closure_XZ.py
similarity index 89%
rename from src/ansys/dpf/core/operators/result/gasket_deformation_XZ.py
rename to src/ansys/dpf/core/operators/result/gasket_total_closure_XZ.py
index 54218fb6e1a..1bede411b42 100644
--- a/src/ansys/dpf/core/operators/result/gasket_deformation_XZ.py
+++ b/src/ansys/dpf/core/operators/result/gasket_total_closure_XZ.py
@@ -1,5 +1,5 @@
"""
-gasket_deformation_XZ
+gasket_total_closure_XZ
Autogenerated DPF operator classes.
"""
@@ -15,8 +15,8 @@
from ansys.dpf.core.server_types import AnyServerType
-class gasket_deformation_XZ(Operator):
- r"""Read/compute elemental gasket deformation XZ shear component (02
+class gasket_total_closure_XZ(Operator):
+ r"""Read/compute elemental gasket total closure XZ shear component (02
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.
@@ -54,7 +54,7 @@ class gasket_deformation_XZ(Operator):
>>> from ansys.dpf import core as dpf
>>> # Instantiate operator
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> # Make input connections
>>> my_time_scoping = dpf.Scoping()
@@ -79,7 +79,7 @@ class gasket_deformation_XZ(Operator):
>>> op.inputs.read_beams.connect(my_read_beams)
>>> # Instantiate operator and connect inputs in one line
- >>> op = dpf.operators.result.gasket_deformation_XZ(
+ >>> op = dpf.operators.result.gasket_total_closure_XZ(
... time_scoping=my_time_scoping,
... mesh_scoping=my_mesh_scoping,
... fields_container=my_fields_container,
@@ -112,8 +112,8 @@ def __init__(
server=None,
):
super().__init__(name="GKDXZ", config=config, server=server)
- self._inputs = InputsGasketDeformationXz(self)
- self._outputs = OutputsGasketDeformationXz(self)
+ self._inputs = InputsGasketTotalClosureXz(self)
+ self._outputs = OutputsGasketTotalClosureXz(self)
if time_scoping is not None:
self.inputs.time_scoping.connect(time_scoping)
if mesh_scoping is not None:
@@ -137,7 +137,7 @@ def __init__(
@staticmethod
def _spec() -> Specification:
- description = r"""Read/compute elemental gasket deformation XZ shear component (02
+ description = r"""Read/compute elemental gasket total closure XZ shear component (02
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.
@@ -246,36 +246,36 @@ def default_config(server: AnyServerType = None) -> Config:
return Operator.default_config(name="GKDXZ", server=server)
@property
- def inputs(self) -> InputsGasketDeformationXz:
+ def inputs(self) -> InputsGasketTotalClosureXz:
"""Enables to connect inputs to the operator
Returns
--------
inputs:
- An instance of InputsGasketDeformationXz.
+ An instance of InputsGasketTotalClosureXz.
"""
return super().inputs
@property
- def outputs(self) -> OutputsGasketDeformationXz:
+ def outputs(self) -> OutputsGasketTotalClosureXz:
"""Enables to get outputs of the operator by evaluating it
Returns
--------
outputs:
- An instance of OutputsGasketDeformationXz.
+ An instance of OutputsGasketTotalClosureXz.
"""
return super().outputs
-class InputsGasketDeformationXz(_Inputs):
+class InputsGasketTotalClosureXz(_Inputs):
"""Intermediate class used to connect user inputs to
- gasket_deformation_XZ operator.
+ gasket_total_closure_XZ operator.
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> my_time_scoping = dpf.Scoping()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> my_mesh_scoping = dpf.ScopingsContainer()
@@ -299,43 +299,43 @@ class InputsGasketDeformationXz(_Inputs):
"""
def __init__(self, op: Operator):
- super().__init__(gasket_deformation_XZ._spec().inputs, op)
+ super().__init__(gasket_total_closure_XZ._spec().inputs, op)
self._time_scoping = Input(
- gasket_deformation_XZ._spec().input_pin(0), 0, op, -1
+ gasket_total_closure_XZ._spec().input_pin(0), 0, op, -1
)
self._inputs.append(self._time_scoping)
self._mesh_scoping = Input(
- gasket_deformation_XZ._spec().input_pin(1), 1, op, -1
+ gasket_total_closure_XZ._spec().input_pin(1), 1, op, -1
)
self._inputs.append(self._mesh_scoping)
self._fields_container = Input(
- gasket_deformation_XZ._spec().input_pin(2), 2, op, -1
+ gasket_total_closure_XZ._spec().input_pin(2), 2, op, -1
)
self._inputs.append(self._fields_container)
self._streams_container = Input(
- gasket_deformation_XZ._spec().input_pin(3), 3, op, -1
+ gasket_total_closure_XZ._spec().input_pin(3), 3, op, -1
)
self._inputs.append(self._streams_container)
self._data_sources = Input(
- gasket_deformation_XZ._spec().input_pin(4), 4, op, -1
+ gasket_total_closure_XZ._spec().input_pin(4), 4, op, -1
)
self._inputs.append(self._data_sources)
self._bool_rotate_to_global = Input(
- gasket_deformation_XZ._spec().input_pin(5), 5, op, -1
+ gasket_total_closure_XZ._spec().input_pin(5), 5, op, -1
)
self._inputs.append(self._bool_rotate_to_global)
- self._mesh = Input(gasket_deformation_XZ._spec().input_pin(7), 7, op, -1)
+ self._mesh = Input(gasket_total_closure_XZ._spec().input_pin(7), 7, op, -1)
self._inputs.append(self._mesh)
self._requested_location = Input(
- gasket_deformation_XZ._spec().input_pin(9), 9, op, -1
+ gasket_total_closure_XZ._spec().input_pin(9), 9, op, -1
)
self._inputs.append(self._requested_location)
self._read_cyclic = Input(
- gasket_deformation_XZ._spec().input_pin(14), 14, op, -1
+ gasket_total_closure_XZ._spec().input_pin(14), 14, op, -1
)
self._inputs.append(self._read_cyclic)
self._read_beams = Input(
- gasket_deformation_XZ._spec().input_pin(22), 22, op, -1
+ gasket_total_closure_XZ._spec().input_pin(22), 22, op, -1
)
self._inputs.append(self._read_beams)
@@ -353,7 +353,7 @@ def time_scoping(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.time_scoping.connect(my_time_scoping)
>>> # or
>>> op.inputs.time_scoping(my_time_scoping)
@@ -374,7 +374,7 @@ def mesh_scoping(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.mesh_scoping.connect(my_mesh_scoping)
>>> # or
>>> op.inputs.mesh_scoping(my_mesh_scoping)
@@ -395,7 +395,7 @@ def fields_container(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)
@@ -416,7 +416,7 @@ def streams_container(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)
@@ -437,7 +437,7 @@ def data_sources(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)
@@ -458,7 +458,7 @@ def bool_rotate_to_global(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global)
>>> # or
>>> op.inputs.bool_rotate_to_global(my_bool_rotate_to_global)
@@ -479,7 +479,7 @@ def mesh(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.mesh.connect(my_mesh)
>>> # or
>>> op.inputs.mesh(my_mesh)
@@ -500,7 +500,7 @@ def requested_location(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.requested_location.connect(my_requested_location)
>>> # or
>>> op.inputs.requested_location(my_requested_location)
@@ -521,7 +521,7 @@ def read_cyclic(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.read_cyclic.connect(my_read_cyclic)
>>> # or
>>> op.inputs.read_cyclic(my_read_cyclic)
@@ -542,7 +542,7 @@ def read_beams(self) -> Input:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> op.inputs.read_beams.connect(my_read_beams)
>>> # or
>>> op.inputs.read_beams(my_read_beams)
@@ -550,22 +550,22 @@ def read_beams(self) -> Input:
return self._read_beams
-class OutputsGasketDeformationXz(_Outputs):
+class OutputsGasketTotalClosureXz(_Outputs):
"""Intermediate class used to get outputs from
- gasket_deformation_XZ operator.
+ gasket_total_closure_XZ operator.
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> # Connect inputs : op.inputs. ...
>>> result_fields_container = op.outputs.fields_container()
"""
def __init__(self, op: Operator):
- super().__init__(gasket_deformation_XZ._spec().outputs, op)
+ super().__init__(gasket_total_closure_XZ._spec().outputs, op)
self._fields_container = Output(
- gasket_deformation_XZ._spec().output_pin(0), 0, op
+ gasket_total_closure_XZ._spec().output_pin(0), 0, op
)
self._outputs.append(self._fields_container)
@@ -581,7 +581,7 @@ def fields_container(self) -> Output:
Examples
--------
>>> from ansys.dpf import core as dpf
- >>> op = dpf.operators.result.gasket_deformation_XZ()
+ >>> op = dpf.operators.result.gasket_total_closure_XZ()
>>> # Get the output from op.outputs. ...
>>> result_fields_container = op.outputs.fields_container()
"""
diff --git a/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py b/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py
index 253272cc7de..6e2658bbe94 100644
--- a/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py
+++ b/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py
@@ -17,20 +17,20 @@
class customtypefield_get_attribute(Operator):
- r"""A CustomTypeField in pin 0 and a property name (string) in pin 1 are
- expected in input.
+ r"""Gets a property from an input field/field container. A CustomTypeFieldin
+ pin 0, a property name (string) in pin 1 are expected as inputs
Parameters
----------
- custom_type_field: CustomTypeField
+ custom_type_field: CustomTypeField or CustomTypeFieldsContainer
property_name: str
- Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
+ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
Returns
-------
- property: TimeFreqSupport or Scoping or DataTree
- Property value.
+ property: str or TimeFreqSupport or Scoping or DataTree
+ Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
Examples
--------
@@ -70,15 +70,15 @@ def __init__(
@staticmethod
def _spec() -> Specification:
- description = r"""A CustomTypeField in pin 0 and a property name (string) in pin 1 are
-expected in input.
+ description = r"""Gets a property from an input field/field container. A CustomTypeFieldin
+pin 0, a property name (string) in pin 1 are expected as inputs
"""
spec = Specification(
description=description,
map_input_pin_spec={
0: PinSpecification(
name="custom_type_field",
- type_names=["custom_type_field"],
+ type_names=["custom_type_field", "custom_type_fields_container"],
optional=False,
document=r"""""",
),
@@ -86,15 +86,20 @@ def _spec() -> Specification:
name="property_name",
type_names=["string"],
optional=False,
- document=r"""Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.""",
+ document=r"""Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.""",
),
},
map_output_pin_spec={
0: PinSpecification(
name="property",
- type_names=["time_freq_support", "scoping", "abstract_data_tree"],
+ type_names=[
+ "string",
+ "time_freq_support",
+ "scoping",
+ "abstract_data_tree",
+ ],
optional=False,
- document=r"""Property value.""",
+ document=r"""Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.""",
),
},
)
@@ -194,7 +199,7 @@ def custom_type_field(self) -> Input:
def property_name(self) -> Input:
r"""Allows to connect property_name input to the operator.
- Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
+ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
Returns
-------
@@ -226,6 +231,14 @@ class OutputsCustomtypefieldGetAttribute(_Outputs):
def __init__(self, op: Operator):
super().__init__(customtypefield_get_attribute._spec().outputs, op)
+ self.property_as_string = Output(
+ _modify_output_spec_with_one_type(
+ customtypefield_get_attribute._spec().output_pin(0), "string"
+ ),
+ 0,
+ op,
+ )
+ self._outputs.append(self.property_as_string)
self.property_as_time_freq_support = Output(
_modify_output_spec_with_one_type(
customtypefield_get_attribute._spec().output_pin(0), "time_freq_support"
diff --git a/src/ansys/dpf/core/operators/utility/field_get_attribute.py b/src/ansys/dpf/core/operators/utility/field_get_attribute.py
index 958e24fbf98..8bb38a7b80d 100644
--- a/src/ansys/dpf/core/operators/utility/field_get_attribute.py
+++ b/src/ansys/dpf/core/operators/utility/field_get_attribute.py
@@ -17,20 +17,20 @@
class field_get_attribute(Operator):
- r"""A Field in pin 0 and a property name (string) in pin 1 are expected in
- input.
+ r"""Gets a property from an input field/field container. A Fieldin pin 0, a
+ property name (string) in pin 1 are expected as inputs
Parameters
----------
- field: Field
+ field: Field or FieldsContainer
property_name: str
- Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
+ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
Returns
-------
- property: TimeFreqSupport or Scoping or DataTree
- Property value.
+ property: str or TimeFreqSupport or Scoping or DataTree
+ Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
Examples
--------
@@ -66,15 +66,15 @@ def __init__(self, field=None, property_name=None, config=None, server=None):
@staticmethod
def _spec() -> Specification:
- description = r"""A Field in pin 0 and a property name (string) in pin 1 are expected in
-input.
+ description = r"""Gets a property from an input field/field container. A Fieldin pin 0, a
+property name (string) in pin 1 are expected as inputs
"""
spec = Specification(
description=description,
map_input_pin_spec={
0: PinSpecification(
name="field",
- type_names=["field"],
+ type_names=["field", "fields_container"],
optional=False,
document=r"""""",
),
@@ -82,15 +82,20 @@ def _spec() -> Specification:
name="property_name",
type_names=["string"],
optional=False,
- document=r"""Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.""",
+ document=r"""Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.""",
),
},
map_output_pin_spec={
0: PinSpecification(
name="property",
- type_names=["time_freq_support", "scoping", "abstract_data_tree"],
+ type_names=[
+ "string",
+ "time_freq_support",
+ "scoping",
+ "abstract_data_tree",
+ ],
optional=False,
- document=r"""Property value.""",
+ document=r"""Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.""",
),
},
)
@@ -184,7 +189,7 @@ def field(self) -> Input:
def property_name(self) -> Input:
r"""Allows to connect property_name input to the operator.
- Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
+ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
Returns
-------
@@ -216,6 +221,14 @@ class OutputsFieldGetAttribute(_Outputs):
def __init__(self, op: Operator):
super().__init__(field_get_attribute._spec().outputs, op)
+ self.property_as_string = Output(
+ _modify_output_spec_with_one_type(
+ field_get_attribute._spec().output_pin(0), "string"
+ ),
+ 0,
+ op,
+ )
+ self._outputs.append(self.property_as_string)
self.property_as_time_freq_support = Output(
_modify_output_spec_with_one_type(
field_get_attribute._spec().output_pin(0), "time_freq_support"
diff --git a/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py b/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py
index f45c8787e56..0645c7abf03 100644
--- a/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py
+++ b/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py
@@ -17,20 +17,20 @@
class propertyfield_get_attribute(Operator):
- r"""A PropertyField in pin 0 and a property name (string) in pin 1 are
- expected in input.
+ r"""Gets a property from an input field/field container. A PropertyFieldin
+ pin 0, a property name (string) in pin 1 are expected as inputs
Parameters
----------
- property_field: PropertyField
+ property_field: PropertyField or PropertyFieldsContainer
property_name: str
- Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
+ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
Returns
-------
- property: TimeFreqSupport or Scoping or DataTree
- Property value.
+ property: str or TimeFreqSupport or Scoping or DataTree
+ Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
Examples
--------
@@ -70,15 +70,15 @@ def __init__(
@staticmethod
def _spec() -> Specification:
- description = r"""A PropertyField in pin 0 and a property name (string) in pin 1 are
-expected in input.
+ description = r"""Gets a property from an input field/field container. A PropertyFieldin
+pin 0, a property name (string) in pin 1 are expected as inputs
"""
spec = Specification(
description=description,
map_input_pin_spec={
0: PinSpecification(
name="property_field",
- type_names=["property_field"],
+ type_names=["property_field", "property_fields_container"],
optional=False,
document=r"""""",
),
@@ -86,15 +86,20 @@ def _spec() -> Specification:
name="property_name",
type_names=["string"],
optional=False,
- document=r"""Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.""",
+ document=r"""Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.""",
),
},
map_output_pin_spec={
0: PinSpecification(
name="property",
- type_names=["time_freq_support", "scoping", "abstract_data_tree"],
+ type_names=[
+ "string",
+ "time_freq_support",
+ "scoping",
+ "abstract_data_tree",
+ ],
optional=False,
- document=r"""Property value.""",
+ document=r"""Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.""",
),
},
)
@@ -194,7 +199,7 @@ def property_field(self) -> Input:
def property_name(self) -> Input:
r"""Allows to connect property_name input to the operator.
- Accepted inputs are: 'time_freq_support', 'scoping' and 'header'.
+ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'.
Returns
-------
@@ -226,6 +231,14 @@ class OutputsPropertyfieldGetAttribute(_Outputs):
def __init__(self, op: Operator):
super().__init__(propertyfield_get_attribute._spec().outputs, op)
+ self.property_as_string = Output(
+ _modify_output_spec_with_one_type(
+ propertyfield_get_attribute._spec().output_pin(0), "string"
+ ),
+ 0,
+ op,
+ )
+ self._outputs.append(self.property_as_string)
self.property_as_time_freq_support = Output(
_modify_output_spec_with_one_type(
propertyfield_get_attribute._spec().output_pin(0), "time_freq_support"
diff --git a/src/ansys/dpf/core/operators/utility/set_property.py b/src/ansys/dpf/core/operators/utility/set_property.py
index c3c51f15903..f3b54943531 100644
--- a/src/ansys/dpf/core/operators/utility/set_property.py
+++ b/src/ansys/dpf/core/operators/utility/set_property.py
@@ -17,20 +17,24 @@
class set_property(Operator):
- r"""Sets a property to an input field/field container.
+ r"""Sets a property to an input field/field container. A Fieldin pin 0, a
+ property name (string) in pin 1 and a valid property value in pin 2 are
+ expected as inputs
Parameters
----------
field: Field or FieldsContainer
property_name: str
- Property to set
- property_value: str or int or float
- Property to set
+ Property to set. Accepted inputs are specific strings namely: 'unit', 'name', 'time_freq_support', 'scoping', 'header'.
+ property: str or TimeFreqSupport or Scoping or DataTree or int or
+ float
+ Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string.
Returns
-------
field: Field or FieldsContainer
+ Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.
Examples
--------
@@ -44,14 +48,14 @@ class set_property(Operator):
>>> op.inputs.field.connect(my_field)
>>> my_property_name = str()
>>> op.inputs.property_name.connect(my_property_name)
- >>> my_property_value = str()
- >>> op.inputs.property_value.connect(my_property_value)
+ >>> my_property = str()
+ >>> op.inputs.property.connect(my_property)
>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.utility.set_property(
... field=my_field,
... property_name=my_property_name,
- ... property_value=my_property_value,
+ ... property=my_property,
... )
>>> # Get output data
@@ -59,12 +63,7 @@ class set_property(Operator):
"""
def __init__(
- self,
- field=None,
- property_name=None,
- property_value=None,
- config=None,
- server=None,
+ self, field=None, property_name=None, property=None, config=None, server=None
):
super().__init__(name="field::set_property", config=config, server=server)
self._inputs = InputsSetProperty(self)
@@ -73,12 +72,14 @@ def __init__(
self.inputs.field.connect(field)
if property_name is not None:
self.inputs.property_name.connect(property_name)
- if property_value is not None:
- self.inputs.property_value.connect(property_value)
+ if property is not None:
+ self.inputs.property.connect(property)
@staticmethod
def _spec() -> Specification:
- description = r"""Sets a property to an input field/field container.
+ description = r"""Sets a property to an input field/field container. A Fieldin pin 0, a
+property name (string) in pin 1 and a valid property value in pin 2 are
+expected as inputs
"""
spec = Specification(
description=description,
@@ -93,13 +94,20 @@ def _spec() -> Specification:
name="property_name",
type_names=["string"],
optional=False,
- document=r"""Property to set""",
+ document=r"""Property to set. Accepted inputs are specific strings namely: 'unit', 'name', 'time_freq_support', 'scoping', 'header'.""",
),
2: PinSpecification(
- name="property_value",
- type_names=["string", "int32", "double"],
+ name="property",
+ type_names=[
+ "string",
+ "time_freq_support",
+ "scoping",
+ "abstract_data_tree",
+ "int32",
+ "double",
+ ],
optional=False,
- document=r"""Property to set""",
+ document=r"""Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string.""",
),
},
map_output_pin_spec={
@@ -107,7 +115,7 @@ def _spec() -> Specification:
name="field",
type_names=["field", "fields_container"],
optional=False,
- document=r"""""",
+ document=r"""Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers.""",
),
},
)
@@ -169,8 +177,8 @@ class InputsSetProperty(_Inputs):
>>> op.inputs.field.connect(my_field)
>>> my_property_name = str()
>>> op.inputs.property_name.connect(my_property_name)
- >>> my_property_value = str()
- >>> op.inputs.property_value.connect(my_property_value)
+ >>> my_property = str()
+ >>> op.inputs.property.connect(my_property)
"""
def __init__(self, op: Operator):
@@ -179,8 +187,8 @@ def __init__(self, op: Operator):
self._inputs.append(self._field)
self._property_name = Input(set_property._spec().input_pin(1), 1, op, -1)
self._inputs.append(self._property_name)
- self._property_value = Input(set_property._spec().input_pin(2), 2, op, -1)
- self._inputs.append(self._property_value)
+ self._property = Input(set_property._spec().input_pin(2), 2, op, -1)
+ self._inputs.append(self._property)
@property
def field(self) -> Input:
@@ -205,7 +213,7 @@ def field(self) -> Input:
def property_name(self) -> Input:
r"""Allows to connect property_name input to the operator.
- Property to set
+ Property to set. Accepted inputs are specific strings namely: 'unit', 'name', 'time_freq_support', 'scoping', 'header'.
Returns
-------
@@ -223,10 +231,10 @@ def property_name(self) -> Input:
return self._property_name
@property
- def property_value(self) -> Input:
- r"""Allows to connect property_value input to the operator.
+ def property(self) -> Input:
+ r"""Allows to connect property input to the operator.
- Property to set
+ Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string.
Returns
-------
@@ -237,11 +245,11 @@ def property_value(self) -> Input:
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_property()
- >>> op.inputs.property_value.connect(my_property_value)
+ >>> op.inputs.property.connect(my_property)
>>> # or
- >>> op.inputs.property_value(my_property_value)
+ >>> op.inputs.property(my_property)
"""
- return self._property_value
+ return self._property
class OutputsSetProperty(_Outputs):
diff --git a/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll b/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll
index 88fd1a81036..f22c8e33c17 100644
Binary files a/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll and b/src/ansys/dpf/gatebin/Ans.Dpf.GrpcClient.dll differ
diff --git a/src/ansys/dpf/gatebin/DPFClientAPI.dll b/src/ansys/dpf/gatebin/DPFClientAPI.dll
index 609d545659f..a0f00248b9c 100644
Binary files a/src/ansys/dpf/gatebin/DPFClientAPI.dll and b/src/ansys/dpf/gatebin/DPFClientAPI.dll differ
diff --git a/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so b/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so
index 4e91a80e937..ad306dfffae 100644
Binary files a/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so and b/src/ansys/dpf/gatebin/libAns.Dpf.GrpcClient.so differ
diff --git a/src/ansys/dpf/gatebin/libDPFClientAPI.so b/src/ansys/dpf/gatebin/libDPFClientAPI.so
index f47bdfe8014..ad4f4f8139b 100644
Binary files a/src/ansys/dpf/gatebin/libDPFClientAPI.so and b/src/ansys/dpf/gatebin/libDPFClientAPI.so differ