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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ class elemental_difference(Operator):
element scoping.


Parameters
----------
Inputs
------
field: Field or FieldsContainer
field or fields container with only one field is expected
mesh_scoping: Scoping, optional
Expand All @@ -32,7 +32,7 @@ class elemental_difference(Operator):
through_layers: bool, optional
The maximum elemental difference is taken through the different shell layers if true (default is false).

Returns
Outputs
-------
field: Field

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ class elemental_difference_fc(Operator):
the output fields container has an elshape label.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion or MeshesContainer, optional
The mesh region in this pin is used to perform the averaging, used if there is no fields support.
Expand All @@ -35,7 +35,7 @@ class elemental_difference_fc(Operator):
collapse_shell_layers: bool, optional
If true, the data across different shell layers is averaged as well (default is false).

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ class elemental_fraction_fc(Operator):
average. The result is computed on a given element’s scoping.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion, optional
The mesh region in this pin is used to perform the averaging. It is used if there is no fields support.
Expand All @@ -33,7 +33,7 @@ class elemental_fraction_fc(Operator):
collapse_shell_layers: bool, optional
If true, the data across different shell layers is averaged as well (default is false).

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/elemental_mean.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ class elemental_mean(Operator):
Elemental), (NodalElemental -> Nodal).


Parameters
----------
Inputs
------
field: Field
collapse_shell_layers: bool, optional
If true, shell layers are averaged as well (default is false).
Expand All @@ -30,7 +30,7 @@ class elemental_mean(Operator):
scoping: Scoping, optional
Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers.

Returns
Outputs
-------
field: Field

Expand Down
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 @@ -27,8 +27,8 @@ class elemental_mean_fc(Operator):
layers are collapsed and shells and solid fields are always merged.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
collapse_shell_layers: bool, optional
If true, the data across different shell layers is averaged as well (default is false).
Expand All @@ -43,7 +43,7 @@ class elemental_mean_fc(Operator):
e_shell_layer: int, optional
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ class elemental_nodal_to_nodal(Operator):
averaging process. The result is computed on a given node’s scoping.


Parameters
----------
Inputs
------
field: Field or FieldsContainer
field or fields container with only one field is expected
mesh_scoping: Scoping, optional
Expand All @@ -34,7 +34,7 @@ class elemental_nodal_to_nodal(Operator):
Extends weights to mid nodes (when available). Default is false.
mesh: MeshedRegion, optional

Returns
Outputs
-------
field: Field
weight: PropertyField
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ class elemental_nodal_to_nodal_elemental(Operator):
computed on a given node’s scoping.


Parameters
----------
Inputs
------
field: Field or FieldsContainer
field or fields container with only one field is expected
mesh_scoping: Scoping, optional

Returns
Outputs
-------
field: Field

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ class elemental_nodal_to_nodal_elemental_fc(Operator):
is computed on a given node’s scoping.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh_scoping: Scoping, optional

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ class elemental_nodal_to_nodal_fc(Operator):
merge_solid_shell input.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion or MeshesContainer, optional
The mesh region in this pin is used to perform the averaging. It is used if there is no fields support.
Expand All @@ -41,7 +41,7 @@ class elemental_nodal_to_nodal_fc(Operator):
shell_layer: int, optional
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
Outputs
-------
fields_container: FieldsContainer
weights: Class Dataprocessing::Dpftypecollection<Class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ class elemental_to_elemental_nodal(Operator):
r"""Transforms an Elemental field to an Elemental Nodal field.


Parameters
----------
Inputs
------
field: Field or FieldsContainer
field or fields container with only one field is expected
mesh_scoping: Scoping, optional
average only on these entities
mesh: MeshedRegion, optional

Returns
Outputs
-------
field: Field

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ class elemental_to_elemental_nodal_fc(Operator):
r"""Transforms Elemental field to Elemental Nodal field.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion, optional
mesh_scoping: Scoping, optional

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ class elemental_to_nodal(Operator):
used.


Parameters
----------
Inputs
------
field: Field or FieldsContainer
field or fields container with only one field is expected
mesh_scoping: Scoping, optional
Expand All @@ -47,7 +47,7 @@ class elemental_to_nodal(Operator):
algorithm: int, optional
Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh).

Returns
Outputs
-------
field: Field

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ class elemental_to_nodal_fc(Operator):
used.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion or MeshesContainer, optional
force_averaging: int, optional
Expand All @@ -45,7 +45,7 @@ class elemental_to_nodal_fc(Operator):
algorithm: int, optional
Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of mesh).

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ class extend_to_mid_nodes(Operator):
field defined also on the mid nodes.


Parameters
----------
Inputs
------
field: Field or FieldsContainer
field or fields container with only one field is expected
mesh: MeshedRegion, optional

Returns
Outputs
-------
field: Field

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ class extend_to_mid_nodes_fc(Operator):
Elemental Nodal fields defined also on the mid nodes.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion, optional
The mesh region in this pin is used to perform the averaging. It is used if there is no fields support.

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/force_summation.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ class force_summation(Operator):
structural degrees of freedom.


Parameters
----------
Inputs
------
time_scoping: Scoping, optional
default = all time steps
nodal_scoping: Scoping or ScopingsContainer, optional
Expand All @@ -39,7 +39,7 @@ class force_summation(Operator):
spoint: Field or FieldsContainer, optional
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).

Returns
Outputs
-------
force_accumulation: FieldsContainer
moment_accumulation: FieldsContainer
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/force_summation_psd.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ class force_summation_psd(Operator):
FSUM/NFORCE.


Parameters
----------
Inputs
------
nodal_scoping: Scoping or ScopingsContainer, optional
Nodal scoping or scopings container with a single label. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes.
elemental_scoping: Scoping or ScopingsContainer, optional
Expand All @@ -38,7 +38,7 @@ class force_summation_psd(Operator):
signif: float, optional
Significance threshold, defaults to 0.0001. Any mode with a significance level above this value will be included in the combination.The significance level is defined as the modal covariance matrix term, divided by the maximum modal covariance matrix term.

Returns
Outputs
-------
force_accumulation: FieldsContainer
Returns the sum of forces for the 1-sigma displacement solution on the scoped nodes/elements.
Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/gauss_to_node_fc.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ class gauss_to_node_fc(Operator):
linear tetrahedral, and quadratic tetrahedral.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion or MeshesContainer, optional
The mesh region in this pin is used for extrapolating results available at Gauss or quadrature points to nodal points.
scoping: Scoping, optional
Extrapolating results on the selected scoping. If it is a scoping container, the label must correspond to the one of the fields containers.

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/nodal_difference.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ class nodal_difference(Operator):
given node’s scoping.


Parameters
----------
Inputs
------
field: Field or FieldsContainer
field or fields container with only one field is expected
mesh_scoping: Scoping, optional
average only on these entities
mesh: MeshedRegion, optional

Returns
Outputs
-------
field: Field

Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ class nodal_difference_fc(Operator):
elshape label.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion or MeshesContainer, optional
The mesh region in this pin is used to perform the averaging. It is used if there is no fields support.
scoping: Scoping or ScopingsContainer, optional
Average only on these nodes. If it is a scoping container, the label must correspond to the one of the fields containers.

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
6 changes: 3 additions & 3 deletions src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ class nodal_fraction_fc(Operator):
result is computed on a given node’s scoping.


Parameters
----------
Inputs
------
fields_container: FieldsContainer
mesh: MeshedRegion, optional
The mesh region in this pin is used to perform the averaging. It is used if there is no fields support.
Expand All @@ -31,7 +31,7 @@ class nodal_fraction_fc(Operator):
denominator: FieldsContainer, optional
If a fields container is set in this pin, it is used as the denominator of the fraction instead of elemental_nodal_To_nodal_fc.

Returns
Outputs
-------
fields_container: FieldsContainer

Expand Down
Loading
Loading