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
5,875 changes: 5,715 additions & 160 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/averaging/elemental_mean_fc.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class elemental_mean_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). This pin only has an effect when collapse_shell_layers is false and a value for e_shell_layer is provided.
e_shell_layer: int, optional
0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false.
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.

Returns
-------
Expand Down Expand Up @@ -170,7 +170,7 @@ def _spec() -> Specification:
name="e_shell_layer",
type_names=["int32"],
optional=True,
document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false.""",
document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -405,7 +405,7 @@ def merge_solid_shell(self) -> Input:
def e_shell_layer(self) -> Input:
r"""Allows to connect e_shell_layer input to the operator.

0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. This pin only has an effect when collapse_shell_layers is false.
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.

Returns
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class elemental_nodal_to_nodal_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified.
shell_layer: int, optional
0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down Expand Up @@ -182,7 +182,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -458,7 +458,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.

0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class nodal_to_elemental_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified.
shell_layer: int, optional
0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down Expand Up @@ -148,7 +148,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -358,7 +358,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.

0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/to_elemental_fc.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class to_elemental_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true and collapse_shell_layers is false, a shell_layer needs to be specified.
shell_layer: int, optional
0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down Expand Up @@ -154,7 +154,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -381,7 +381,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.

0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/to_nodal.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class to_nodal(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified.
shell_layer: int, optional
0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down Expand Up @@ -114,7 +114,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -266,7 +266,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.

0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/to_nodal_fc.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class to_nodal_fc(Operator):
merge_solid_shell: bool, optional
For shell/solid mixed fields, group in the same field all solids and shells (false by default). If this pin is true, a shell_layer needs to be specified.
shell_layer: int, optional
0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down Expand Up @@ -126,7 +126,7 @@ def _spec() -> Specification:
name="shell_layer",
type_names=["int32"],
optional=True,
document=r"""0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
document=r"""0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -299,7 +299,7 @@ def merge_solid_shell(self) -> Input:
def shell_layer(self) -> Input:
r"""Allows to connect shell_layer input to the operator.

0: Top, 1: Bottom, 2: BottomTop, 3: Mid, 4: BottomTopMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).

Returns
-------
Expand Down
1 change: 1 addition & 0 deletions src/ansys/dpf/core/operators/result/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@
from .erp_radiation_efficiency import erp_radiation_efficiency
from .euler_load_buckling import euler_load_buckling
from .euler_nodes import euler_nodes
from .fluid_velocity import fluid_velocity
from .gasket_deformation import gasket_deformation
from .gasket_deformation_X import gasket_deformation_X
from .gasket_deformation_XY import gasket_deformation_XY
Expand Down
Loading
Loading