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
16 changes: 8 additions & 8 deletions doc/source/_static/dpf_operators.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/acceleration.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class acceleration(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)
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
mesh. If cylic expansion is to be done, mesh of the base sector
read_cyclic: int, optional
Expand Down Expand Up @@ -190,7 +190,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"""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",
Expand Down Expand Up @@ -448,7 +448,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)
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
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class accu_eqv_creep_strain(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)
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
Expand Down Expand Up @@ -194,7 +194,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"""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",
Expand Down Expand Up @@ -468,7 +468,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)
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
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class accu_eqv_plastic_strain(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)
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
Expand Down Expand Up @@ -194,7 +194,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"""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",
Expand Down Expand Up @@ -468,7 +468,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)
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
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class artificial_hourglass_energy(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)
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

Expand Down Expand Up @@ -158,7 +158,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"""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",
Expand Down Expand Up @@ -384,7 +384,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)
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
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/co_energy.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class co_energy(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)
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

Expand Down Expand Up @@ -158,7 +158,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"""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",
Expand Down Expand Up @@ -372,7 +372,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)
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
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class contact_fluid_penetration_pressure(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)
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
mesh. If cylic expansion is to be done, mesh of the base sector
requested_location: str, optional
Expand Down Expand Up @@ -226,7 +226,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"""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",
Expand Down Expand Up @@ -550,7 +550,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)
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
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class contact_friction_stress(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)
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
mesh. If cylic expansion is to be done, mesh of the base sector
requested_location: str, optional
Expand Down Expand Up @@ -226,7 +226,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"""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",
Expand Down Expand Up @@ -546,7 +546,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)
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
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/contact_gap_distance.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class contact_gap_distance(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)
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
mesh. If cylic expansion is to be done, mesh of the base sector
requested_location: str, optional
Expand Down Expand Up @@ -224,7 +224,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"""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",
Expand Down Expand Up @@ -536,7 +536,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)
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
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/contact_penetration.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class contact_penetration(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)
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
mesh. If cylic expansion is to be done, mesh of the base sector
requested_location: str, optional
Expand Down Expand Up @@ -224,7 +224,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"""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",
Expand Down Expand Up @@ -532,7 +532,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)
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
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/result/contact_pressure.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class contact_pressure(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)
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
mesh. If cylic expansion is to be done, mesh of the base sector
requested_location: str, optional
Expand Down Expand Up @@ -224,7 +224,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"""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",
Expand Down Expand Up @@ -528,7 +528,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)
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
-------
Expand Down
Loading
Loading