Skip to content
Merged
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
2,939 changes: 1,501 additions & 1,438 deletions doc/source/_static/dpf_operators.html

Large diffs are not rendered by default.

16 changes: 11 additions & 5 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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.


Parameters
Expand All @@ -33,7 +36,7 @@ class creep_strain_intensity(Operator):
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)
This pin is removed for versions >25.2. An error is raised if connected.
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -135,7 +138,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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -181,7 +187,7 @@ def _spec() -> Specification:
name="bool_rotate_to_global",
type_names=["bool"],
optional=True,
document=r"""if true the field is rotated to global coordinate system (default true)""",
document=r"""This pin is removed for versions >25.2. An error is raised if connected.""",
),
7: PinSpecification(
name="mesh",
Expand Down Expand Up @@ -443,7 +449,7 @@ def data_sources(self) -> Input:
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)
This pin is removed for versions >25.2. An error is raised if connected.

Returns
-------
Expand Down
16 changes: 11 additions & 5 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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.


Parameters
Expand All @@ -33,7 +36,7 @@ class creep_strain_max_shear(Operator):
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)
This pin is removed for versions >25.2. An error is raised if connected.
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -135,7 +138,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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -181,7 +187,7 @@ def _spec() -> Specification:
name="bool_rotate_to_global",
type_names=["bool"],
optional=True,
document=r"""if true the field is rotated to global coordinate system (default true)""",
document=r"""This pin is removed for versions >25.2. An error is raised if connected.""",
),
7: PinSpecification(
name="mesh",
Expand Down Expand Up @@ -443,7 +449,7 @@ def data_sources(self) -> Input:
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)
This pin is removed for versions >25.2. An error is raised if connected.

Returns
-------
Expand Down
20 changes: 13 additions & 7 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 unless averaging across elements is requested, in
which case a rotation to the global coordinate system is performed. The
off-diagonal strains are first converted from Voigt notation to the
standard strain values.


Parameters
Expand All @@ -35,7 +38,7 @@ class creep_strain_principal_1(Operator):
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)
This pin is removed for versions >25.2. An error is raised if connected.
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -138,8 +141,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 unless averaging across elements is requested, in
which case a rotation to the global coordinate system is performed. The
off-diagonal strains are first converted from Voigt notation to the
standard strain values.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -185,7 +191,7 @@ def _spec() -> Specification:
name="bool_rotate_to_global",
type_names=["bool"],
optional=True,
document=r"""if true the field is rotated to global coordinate system (default true)""",
document=r"""This pin is removed for versions >25.2. An error is raised if connected.""",
),
7: PinSpecification(
name="mesh",
Expand Down Expand Up @@ -447,7 +453,7 @@ def data_sources(self) -> Input:
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)
This pin is removed for versions >25.2. An error is raised if connected.

Returns
-------
Expand Down
20 changes: 13 additions & 7 deletions src/ansys/dpf/core/operators/result/creep_strain_principal_2.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@
class creep_strain_principal_2(Operator):
r"""Read/compute element nodal component creep strains 2nd principal
component by calling the readers defined by the datasources and
computing its eigen values. The off-diagonal strains are first converted
from Voigt notation to the standard strain values.
computing its eigen values. This operation is independent of the
coordinate system unless averaging across elements is requested, in
which case a rotation to the global coordinate system is performed. The
off-diagonal strains are first converted from Voigt notation to the
standard strain values.


Parameters
Expand All @@ -35,7 +38,7 @@ class creep_strain_principal_2(Operator):
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)
This pin is removed for versions >25.2. An error is raised if connected.
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -138,8 +141,11 @@ def __init__(
def _spec() -> Specification:
description = r"""Read/compute element nodal component creep strains 2nd principal
component by calling the readers defined by the datasources and
computing its eigen values. The off-diagonal strains are first converted
from Voigt notation to the standard strain values.
computing its eigen values. This operation is independent of the
coordinate system unless averaging across elements is requested, in
which case a rotation to the global coordinate system is performed. The
off-diagonal strains are first converted from Voigt notation to the
standard strain values.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -185,7 +191,7 @@ def _spec() -> Specification:
name="bool_rotate_to_global",
type_names=["bool"],
optional=True,
document=r"""if true the field is rotated to global coordinate system (default true)""",
document=r"""This pin is removed for versions >25.2. An error is raised if connected.""",
),
7: PinSpecification(
name="mesh",
Expand Down Expand Up @@ -447,7 +453,7 @@ def data_sources(self) -> Input:
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)
This pin is removed for versions >25.2. An error is raised if connected.

Returns
-------
Expand Down
20 changes: 13 additions & 7 deletions src/ansys/dpf/core/operators/result/creep_strain_principal_3.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@
class creep_strain_principal_3(Operator):
r"""Read/compute element nodal component creep strains 3rd 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 unless averaging across elements is requested, in
which case a rotation to the global coordinate system is performed. The
off-diagonal strains are first converted from Voigt notation to the
standard strain values.


Parameters
Expand All @@ -35,7 +38,7 @@ class creep_strain_principal_3(Operator):
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)
This pin is removed for versions >25.2. An error is raised if connected.
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -138,8 +141,11 @@ def __init__(
def _spec() -> Specification:
description = r"""Read/compute element nodal component creep strains 3rd 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 unless averaging across elements is requested, in
which case a rotation to the global coordinate system is performed. The
off-diagonal strains are first converted from Voigt notation to the
standard strain values.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -185,7 +191,7 @@ def _spec() -> Specification:
name="bool_rotate_to_global",
type_names=["bool"],
optional=True,
document=r"""if true the field is rotated to global coordinate system (default true)""",
document=r"""This pin is removed for versions >25.2. An error is raised if connected.""",
),
7: PinSpecification(
name="mesh",
Expand Down Expand Up @@ -447,7 +453,7 @@ def data_sources(self) -> Input:
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)
This pin is removed for versions >25.2. An error is raised if connected.

Returns
-------
Expand Down
16 changes: 11 additions & 5 deletions src/ansys/dpf/core/operators/result/elastic_strain_intensity.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@

class elastic_strain_intensity(Operator):
r"""Reads/computes element nodal component elastic 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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.


Parameters
Expand All @@ -33,7 +36,7 @@ class elastic_strain_intensity(Operator):
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)
This pin is removed for versions >25.2. An error is raised if connected.
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -135,7 +138,10 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Reads/computes element nodal component elastic 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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -181,7 +187,7 @@ def _spec() -> Specification:
name="bool_rotate_to_global",
type_names=["bool"],
optional=True,
document=r"""if true the field is rotated to global coordinate system (default true)""",
document=r"""This pin is removed for versions >25.2. An error is raised if connected.""",
),
7: PinSpecification(
name="mesh",
Expand Down Expand Up @@ -443,7 +449,7 @@ def data_sources(self) -> Input:
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)
This pin is removed for versions >25.2. An error is raised if connected.

Returns
-------
Expand Down
16 changes: 11 additions & 5 deletions src/ansys/dpf/core/operators/result/elastic_strain_max_shear.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@

class elastic_strain_max_shear(Operator):
r"""Reads/computes element nodal component elastic 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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.


Parameters
Expand All @@ -33,7 +36,7 @@ class elastic_strain_max_shear(Operator):
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)
This pin is removed for versions >25.2. An error is raised if connected.
mesh: MeshedRegion or MeshesContainer, optional
prevents from reading the mesh in the result files
requested_location: str, optional
Expand Down Expand Up @@ -135,7 +138,10 @@ def __init__(
@staticmethod
def _spec() -> Specification:
description = r"""Reads/computes element nodal component elastic 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 unless averaging across elements is
requested, in which case a rotation to the global coordinate system is
performed.
"""
spec = Specification(
description=description,
Expand Down Expand Up @@ -181,7 +187,7 @@ def _spec() -> Specification:
name="bool_rotate_to_global",
type_names=["bool"],
optional=True,
document=r"""if true the field is rotated to global coordinate system (default true)""",
document=r"""This pin is removed for versions >25.2. An error is raised if connected.""",
),
7: PinSpecification(
name="mesh",
Expand Down Expand Up @@ -443,7 +449,7 @@ def data_sources(self) -> Input:
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)
This pin is removed for versions >25.2. An error is raised if connected.

Returns
-------
Expand Down
Loading
Loading