Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 59 additions & 58 deletions doc/source/_static/dpf_operators.html

Large diffs are not rendered by default.

51 changes: 8 additions & 43 deletions src/ansys/dpf/core/operators/result/creep_strain_intensity.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@

class creep_strain_intensity(Operator):
r"""Reads/computes element nodal component creep strains, average it on
nodes (by default) and computes its invariants.
nodes (by default) and computes its invariants. This operation is
independent of the coordinate system, thus, rotation to global will be
avoided unless averaging is requested since averaging across elements
needs a shared coordinate system.
Parameters
Expand All @@ -32,8 +35,6 @@ class creep_strain_intensity(Operator):
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)
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -64,8 +65,6 @@ class creep_strain_intensity(Operator):
>>> 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()
Expand All @@ -82,7 +81,6 @@ class creep_strain_intensity(Operator):
... 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_cyclic=my_read_cyclic,
Expand All @@ -100,7 +98,6 @@ def __init__(
fields_container=None,
streams_container=None,
data_sources=None,
bool_rotate_to_global=None,
mesh=None,
requested_location=None,
read_cyclic=None,
Expand All @@ -121,8 +118,6 @@ def __init__(
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:
Expand All @@ -135,7 +130,10 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Reads/computes element nodal component creep strains, average it on
nodes (by default) and computes its invariants.
nodes (by default) and computes its invariants. This operation is
independent of the coordinate system, thus, rotation to global will be
avoided unless averaging is requested since averaging across elements
needs a shared coordinate system.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -177,12 +175,6 @@ def _spec() -> Specification:
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)""",
),
7: PinSpecification(
name="mesh",
type_names=["abstract_meshed_region", "meshes_container"],
Expand Down Expand Up @@ -281,8 +273,6 @@ class InputsCreepStrainIntensity(_Inputs):
>>> 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()
Expand Down Expand Up @@ -315,10 +305,6 @@ def __init__(self, op: Operator):
creep_strain_intensity._spec().input_pin(4), 4, op, -1
)
self._inputs.append(self._data_sources)
self._bool_rotate_to_global = Input(
creep_strain_intensity._spec().input_pin(5), 5, op, -1
)
self._inputs.append(self._bool_rotate_to_global)
self._mesh = Input(creep_strain_intensity._spec().input_pin(7), 7, op, -1)
self._inputs.append(self._mesh)
self._requested_location = Input(
Expand Down Expand Up @@ -439,27 +425,6 @@ def data_sources(self) -> Input:
"""
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)
Returns
-------
input:
An Input instance for this pin.
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.creep_strain_intensity()
>>> 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.
Expand Down
51 changes: 8 additions & 43 deletions src/ansys/dpf/core/operators/result/creep_strain_max_shear.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@

class creep_strain_max_shear(Operator):
r"""Reads/computes element nodal component creep strains, average it on
nodes (by default) and computes its invariants.
nodes (by default) and computes its invariants. This operation is
independent of the coordinate system, thus, rotation to global will be
avoided unless averaging is requested since averaging across elements
needs a shared coordinate system.
Parameters
Expand All @@ -32,8 +35,6 @@ class creep_strain_max_shear(Operator):
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)
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -64,8 +65,6 @@ class creep_strain_max_shear(Operator):
>>> 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()
Expand All @@ -82,7 +81,6 @@ class creep_strain_max_shear(Operator):
... 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_cyclic=my_read_cyclic,
Expand All @@ -100,7 +98,6 @@ def __init__(
fields_container=None,
streams_container=None,
data_sources=None,
bool_rotate_to_global=None,
mesh=None,
requested_location=None,
read_cyclic=None,
Expand All @@ -121,8 +118,6 @@ def __init__(
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:
Expand All @@ -135,7 +130,10 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Reads/computes element nodal component creep strains, average it on
nodes (by default) and computes its invariants.
nodes (by default) and computes its invariants. This operation is
independent of the coordinate system, thus, rotation to global will be
avoided unless averaging is requested since averaging across elements
needs a shared coordinate system.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -177,12 +175,6 @@ def _spec() -> Specification:
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)""",
),
7: PinSpecification(
name="mesh",
type_names=["abstract_meshed_region", "meshes_container"],
Expand Down Expand Up @@ -281,8 +273,6 @@ class InputsCreepStrainMaxShear(_Inputs):
>>> 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()
Expand Down Expand Up @@ -315,10 +305,6 @@ def __init__(self, op: Operator):
creep_strain_max_shear._spec().input_pin(4), 4, op, -1
)
self._inputs.append(self._data_sources)
self._bool_rotate_to_global = Input(
creep_strain_max_shear._spec().input_pin(5), 5, op, -1
)
self._inputs.append(self._bool_rotate_to_global)
self._mesh = Input(creep_strain_max_shear._spec().input_pin(7), 7, op, -1)
self._inputs.append(self._mesh)
self._requested_location = Input(
Expand Down Expand Up @@ -439,27 +425,6 @@ def data_sources(self) -> Input:
"""
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)
Returns
-------
input:
An Input instance for this pin.
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.creep_strain_max_shear()
>>> 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.
Expand Down
55 changes: 10 additions & 45 deletions src/ansys/dpf/core/operators/result/creep_strain_principal_1.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@
class creep_strain_principal_1(Operator):
r"""Read/compute element nodal component creep strains 1st principal
component by calling the readers defined by the datasources and
computing its eigen values. The off-diagonal strains are first converted
from Voigt notation to the standard strain values.
computing its eigen values. This operation is independent of the
coordinate system, thus, rotation to global will be avoided unless
averaging is requested since averaging across elements need a shared
coordinate system. The off-diagonal strains are first converted from
Voigt notation to the standard strain values.
Parameters
Expand All @@ -34,8 +37,6 @@ class creep_strain_principal_1(Operator):
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)
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -66,8 +67,6 @@ class creep_strain_principal_1(Operator):
>>> 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()
Expand All @@ -84,7 +83,6 @@ class creep_strain_principal_1(Operator):
... 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_cyclic=my_read_cyclic,
Expand All @@ -102,7 +100,6 @@ def __init__(
fields_container=None,
streams_container=None,
data_sources=None,
bool_rotate_to_global=None,
mesh=None,
requested_location=None,
read_cyclic=None,
Expand All @@ -123,8 +120,6 @@ def __init__(
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:
Expand All @@ -138,8 +133,11 @@ def __init__(
def _spec() -> Specification:
description = r"""Read/compute element nodal component creep strains 1st principal
component by calling the readers defined by the datasources and
computing its eigen values. The off-diagonal strains are first converted
from Voigt notation to the standard strain values.
computing its eigen values. This operation is independent of the
coordinate system, thus, rotation to global will be avoided unless
averaging is requested since averaging across elements need a shared
coordinate system. The off-diagonal strains are first converted from
Voigt notation to the standard strain values.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -181,12 +179,6 @@ def _spec() -> Specification:
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)""",
),
7: PinSpecification(
name="mesh",
type_names=["abstract_meshed_region", "meshes_container"],
Expand Down Expand Up @@ -285,8 +277,6 @@ class InputsCreepStrainPrincipal1(_Inputs):
>>> 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()
Expand Down Expand Up @@ -319,10 +309,6 @@ def __init__(self, op: Operator):
creep_strain_principal_1._spec().input_pin(4), 4, op, -1
)
self._inputs.append(self._data_sources)
self._bool_rotate_to_global = Input(
creep_strain_principal_1._spec().input_pin(5), 5, op, -1
)
self._inputs.append(self._bool_rotate_to_global)
self._mesh = Input(creep_strain_principal_1._spec().input_pin(7), 7, op, -1)
self._inputs.append(self._mesh)
self._requested_location = Input(
Expand Down Expand Up @@ -443,27 +429,6 @@ def data_sources(self) -> Input:
"""
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)
Returns
-------
input:
An Input instance for this pin.
Examples
--------
>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.result.creep_strain_principal_1()
>>> 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.
Expand Down
Loading
Loading