diff --git a/src/ansys/dpf/core/operators/averaging/elemental_difference.py b/src/ansys/dpf/core/operators/averaging/elemental_difference.py index 28a2f89dd24..78598ed60cb 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_difference.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_difference.py @@ -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 @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py index 13b7b555201..8b34334140f 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py @@ -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. @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py index 36ad301a93c..c2f1387e2bd 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py @@ -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. @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_mean.py b/src/ansys/dpf/core/operators/averaging/elemental_mean.py index 1f611ec05c6..198df3d5491 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_mean.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_mean.py @@ -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). @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py index bbb653791c2..4f44ba4bf73 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py @@ -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). @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py index fe385863e7a..2cbae6d0111 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py @@ -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 @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py index 50a3e35ecc7..0900632b0b3 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py index e5aa05a3a36..9eae9fca6d2 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py index 996775f8eb8..bfa5cba3b14 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py @@ -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. @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py b/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py index 298e32bfc8a..f16dbdd943b 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal_fc.py index 6da735dfb3d..55d5ab80d20 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal_fc.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py b/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py index f204a0474c9..baffe12e232 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py @@ -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 @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_to_nodal_fc.py index 31c17e447a8..76e1344ab9f 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_to_nodal_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_to_nodal_fc.py @@ -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 @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py b/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py index 74803cf7ae7..63472439e08 100644 --- a/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py +++ b/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes_fc.py b/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes_fc.py index 2a3447411ee..9b234ea5d09 100644 --- a/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes_fc.py +++ b/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes_fc.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/force_summation.py b/src/ansys/dpf/core/operators/averaging/force_summation.py index 8e3ae6c0ee7..785732fe604 100644 --- a/src/ansys/dpf/core/operators/averaging/force_summation.py +++ b/src/ansys/dpf/core/operators/averaging/force_summation.py @@ -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 @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/force_summation_psd.py b/src/ansys/dpf/core/operators/averaging/force_summation_psd.py index 40a01cfb9ca..2d2f25ad5bd 100644 --- a/src/ansys/dpf/core/operators/averaging/force_summation_psd.py +++ b/src/ansys/dpf/core/operators/averaging/force_summation_psd.py @@ -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 @@ -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. diff --git a/src/ansys/dpf/core/operators/averaging/gauss_to_node_fc.py b/src/ansys/dpf/core/operators/averaging/gauss_to_node_fc.py index fecc6f542ec..d2efe05a5d3 100644 --- a/src/ansys/dpf/core/operators/averaging/gauss_to_node_fc.py +++ b/src/ansys/dpf/core/operators/averaging/gauss_to_node_fc.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/nodal_difference.py b/src/ansys/dpf/core/operators/averaging/nodal_difference.py index 7cbe430548a..1bc0f857837 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_difference.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_difference.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py index 1a17c816b08..01f1bb15142 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py index 20cea6cf8b5..1fed6f0c89a 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py @@ -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. @@ -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 diff --git a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py index 032e7c6025a..71493922fe5 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py @@ -20,15 +20,15 @@ class nodal_to_elemental(Operator): on a given element’s scoping. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected mesh_scoping: Scoping, optional collapse_shell_layers: bool, optional If true, the data across different shell layers is averaged as well (default is false). - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py index d9d6f9d07c9..3e125031e63 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py @@ -23,8 +23,8 @@ class nodal_to_elemental_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. It is used if there is no fields support. @@ -37,7 +37,7 @@ class nodal_to_elemental_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 diff --git a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal.py b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal.py index bd131ba98b0..d6596251a60 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal.py @@ -20,15 +20,15 @@ class nodal_to_elemental_nodal(Operator): computed on a given element’s scoping. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected mesh_scoping: Scoping, optional collapse_shell_layers: bool, optional If true, the data across different shell layers is averaged as well (default is false). - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal_fc.py index ce26e992361..2b1f7f69879 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal_fc.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_nodal_fc.py @@ -19,13 +19,13 @@ class nodal_to_elemental_nodal_fc(Operator): r"""Transforms Nodal fields_container to Elemental Nodal fields_container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer mesh: MeshedRegion, optional mesh_scoping: Scoping, optional - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py index a2c27b50991..4f5fde6559e 100644 --- a/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py +++ b/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py @@ -20,8 +20,8 @@ class to_elemental_fc(Operator): process. The result is computed on a given element’s scoping. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer mesh: MeshedRegion, optional mesh_scoping: Scoping, optional @@ -34,7 +34,7 @@ class to_elemental_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 diff --git a/src/ansys/dpf/core/operators/averaging/to_elemental_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/to_elemental_nodal_fc.py index 7d24adda7e4..2967d29dcc4 100644 --- a/src/ansys/dpf/core/operators/averaging/to_elemental_nodal_fc.py +++ b/src/ansys/dpf/core/operators/averaging/to_elemental_nodal_fc.py @@ -20,13 +20,13 @@ class to_elemental_nodal_fc(Operator): process. The result is computed on a given element’s scoping. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer mesh_scoping: Scoping, optional mesh: MeshedRegion, optional - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal.py b/src/ansys/dpf/core/operators/averaging/to_nodal.py index 953c2feb312..2787079ff2d 100644 --- a/src/ansys/dpf/core/operators/averaging/to_nodal.py +++ b/src/ansys/dpf/core/operators/averaging/to_nodal.py @@ -20,8 +20,8 @@ class to_nodal(Operator): 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 @@ -30,7 +30,7 @@ class to_nodal(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 ------- field: Field diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py index 9e450a237c9..5a975f7166a 100644 --- a/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py +++ b/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py @@ -20,8 +20,8 @@ class to_nodal_fc(Operator): result is computed on a given node’s scoping. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer mesh: MeshedRegion, optional mesh_scoping: Scoping, optional @@ -30,7 +30,7 @@ class 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 diff --git a/src/ansys/dpf/core/operators/compression/apply_svd.py b/src/ansys/dpf/core/operators/compression/apply_svd.py index 91e7d8c4da8..9cca7bbfaae 100644 --- a/src/ansys/dpf/core/operators/compression/apply_svd.py +++ b/src/ansys/dpf/core/operators/compression/apply_svd.py @@ -20,8 +20,8 @@ class apply_svd(Operator): r"""Computes the coefficients (=U*Sigma) and VT components from SVD. - Parameters - ---------- + Inputs + ------ field_contaner_to_compress: FieldsContainer Fields container with data to be compressed scalar_int: int, optional @@ -31,7 +31,7 @@ class apply_svd(Operator): boolean: bool, optional Apply SVD on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions). - Returns + Outputs ------- us_svd: FieldsContainer The output entity is a fields container (time dependant); it contains the product of two matrices, U and S, where A=U.S.Vt diff --git a/src/ansys/dpf/core/operators/compression/apply_zfp.py b/src/ansys/dpf/core/operators/compression/apply_zfp.py index b7d4e4895fa..c1424e4e44c 100644 --- a/src/ansys/dpf/core/operators/compression/apply_zfp.py +++ b/src/ansys/dpf/core/operators/compression/apply_zfp.py @@ -19,8 +19,8 @@ class apply_zfp(Operator): r"""Compressing input data using one of zfp compression algorithm modes. - Parameters - ---------- + Inputs + ------ dataIn: Field or FieldsContainer field or fields container to be compressed mode: str or Char @@ -36,7 +36,7 @@ class apply_zfp(Operator): double_relthreshold: float, optional Double relative threshold. Values smaller than (v1 - v2) < max(small value, v1 * relativeTol) are considered identical (default value: 1.0e-10). - Returns + Outputs ------- compress_speed: float the output entity is a double, containing compression speed of the input data: for ElementalNodal location - [elements/sec], for Nodal location - [nodes/sec] diff --git a/src/ansys/dpf/core/operators/compression/kmeans_clustering.py b/src/ansys/dpf/core/operators/compression/kmeans_clustering.py index f84d30f36d6..796e5ed687e 100644 --- a/src/ansys/dpf/core/operators/compression/kmeans_clustering.py +++ b/src/ansys/dpf/core/operators/compression/kmeans_clustering.py @@ -20,8 +20,8 @@ class kmeans_clustering(Operator): non-linearity. - Parameters - ---------- + Inputs + ------ clusters_number: int, optional number of the clusters (dafault is 3) formula: str, optional @@ -31,7 +31,7 @@ class kmeans_clustering(Operator): component_number: int, optional component number as an int (default is 0), ex '0' for X-displacement, '1' for Y-displacement,... - Returns + Outputs ------- scoping_clusters: ScopingsContainer Scopings container with the space scoping (entities' ids) corresponding to each of k-clusters diff --git a/src/ansys/dpf/core/operators/compression/quantization.py b/src/ansys/dpf/core/operators/compression/quantization.py index d25baf4533b..c93ba51274b 100644 --- a/src/ansys/dpf/core/operators/compression/quantization.py +++ b/src/ansys/dpf/core/operators/compression/quantization.py @@ -20,8 +20,8 @@ class quantization(Operator): values to the unit. - Parameters - ---------- + Inputs + ------ input_field: Field Field to quantize. threshold: float or Field @@ -32,7 +32,7 @@ class quantization(Operator): Case field with the same number of values than the input field : quantization is performed component-wise. - Returns + Outputs ------- output_field: Field Scaled and rounded field diff --git a/src/ansys/dpf/core/operators/compression/quantization_fc.py b/src/ansys/dpf/core/operators/compression/quantization_fc.py index 8ef1e20a7bc..2c9525c884d 100644 --- a/src/ansys/dpf/core/operators/compression/quantization_fc.py +++ b/src/ansys/dpf/core/operators/compression/quantization_fc.py @@ -20,8 +20,8 @@ class quantization_fc(Operator): threshold, then rounds all the values to the unit. - Parameters - ---------- + Inputs + ------ input_fc: FieldsContainer Fields container to be quantized. threshold: float or Field or FieldsContainer @@ -31,7 +31,7 @@ class quantization_fc(Operator): Case fields container : the corresponding threshold field is found by matching label. - Returns + Outputs ------- output_fc: FieldsContainer Quantized fields container. diff --git a/src/ansys/dpf/core/operators/compression/zfp_decompress.py b/src/ansys/dpf/core/operators/compression/zfp_decompress.py index 884e72c6e29..d742e38506d 100644 --- a/src/ansys/dpf/core/operators/compression/zfp_decompress.py +++ b/src/ansys/dpf/core/operators/compression/zfp_decompress.py @@ -21,12 +21,12 @@ class zfp_decompress(Operator): the properties of the field(s) - Parameters - ---------- + Inputs + ------ dataIn: CustomTypeFieldsContainer custom type field container from zfp_compression operator to decompress - Returns + Outputs ------- dataOut: Field or FieldsContainer the output entity is a field or a fields container; it contains decompressed data diff --git a/src/ansys/dpf/core/operators/filter/abc_weightings.py b/src/ansys/dpf/core/operators/filter/abc_weightings.py index 92955dd1829..4deef12117b 100644 --- a/src/ansys/dpf/core/operators/filter/abc_weightings.py +++ b/src/ansys/dpf/core/operators/filter/abc_weightings.py @@ -19,8 +19,8 @@ class abc_weightings(Operator): r"""Computes ABC-weightings for the amplitude spectrum in dB units. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer data to be weighted in dB units. weighting_type: int @@ -28,7 +28,7 @@ class abc_weightings(Operator): shape_by_tf_scoping: bool if this pin is set to true, each field of the input fields container is defined by time freq scoping and not by ids. Default is false - Returns + Outputs ------- weightings: FieldsContainer weighted data in dB units. diff --git a/src/ansys/dpf/core/operators/filter/field_band_pass.py b/src/ansys/dpf/core/operators/filter/field_band_pass.py index e6089a6af2b..bf58c4abfe0 100644 --- a/src/ansys/dpf/core/operators/filter/field_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/field_band_pass.py @@ -21,8 +21,8 @@ class field_band_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected min_threshold: float or Field @@ -30,7 +30,7 @@ class field_band_pass(Operator): max_threshold: float or Field, optional A maximum threshold scalar or a field containing one value is expected. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/filter/field_band_pass_fc.py b/src/ansys/dpf/core/operators/filter/field_band_pass_fc.py index 467c6d02ebe..e2a573377ce 100644 --- a/src/ansys/dpf/core/operators/filter/field_band_pass_fc.py +++ b/src/ansys/dpf/core/operators/filter/field_band_pass_fc.py @@ -21,8 +21,8 @@ class field_band_pass_fc(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected min_threshold: float or Field @@ -30,7 +30,7 @@ class field_band_pass_fc(Operator): max_threshold: float or Field, optional A maximum threshold scalar or a field containing one value is expected. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/filter/field_high_pass.py b/src/ansys/dpf/core/operators/filter/field_high_pass.py index 929d905ac42..3ba49521557 100644 --- a/src/ansys/dpf/core/operators/filter/field_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/field_high_pass.py @@ -20,8 +20,8 @@ class field_high_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class field_high_pass(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/filter/field_high_pass_fc.py b/src/ansys/dpf/core/operators/filter/field_high_pass_fc.py index 558f7f709e4..f6036337bf4 100644 --- a/src/ansys/dpf/core/operators/filter/field_high_pass_fc.py +++ b/src/ansys/dpf/core/operators/filter/field_high_pass_fc.py @@ -20,8 +20,8 @@ class field_high_pass_fc(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class field_high_pass_fc(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/filter/field_low_pass.py b/src/ansys/dpf/core/operators/filter/field_low_pass.py index 25c0e6b81c5..6e50ae45d02 100644 --- a/src/ansys/dpf/core/operators/filter/field_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/field_low_pass.py @@ -20,8 +20,8 @@ class field_low_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class field_low_pass(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/filter/field_low_pass_fc.py b/src/ansys/dpf/core/operators/filter/field_low_pass_fc.py index 9d8ebeee586..96e75cf7a22 100644 --- a/src/ansys/dpf/core/operators/filter/field_low_pass_fc.py +++ b/src/ansys/dpf/core/operators/filter/field_low_pass_fc.py @@ -20,8 +20,8 @@ class field_low_pass_fc(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class field_low_pass_fc(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/filter/field_signed_high_pass.py b/src/ansys/dpf/core/operators/filter/field_signed_high_pass.py index 51d994658d1..079c684b5f0 100644 --- a/src/ansys/dpf/core/operators/filter/field_signed_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/field_signed_high_pass.py @@ -20,8 +20,8 @@ class field_signed_high_pass(Operator): value to the threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class field_signed_high_pass(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/filter/field_signed_high_pass_fc.py b/src/ansys/dpf/core/operators/filter/field_signed_high_pass_fc.py index 44badf1d494..e1ecfea3139 100644 --- a/src/ansys/dpf/core/operators/filter/field_signed_high_pass_fc.py +++ b/src/ansys/dpf/core/operators/filter/field_signed_high_pass_fc.py @@ -20,8 +20,8 @@ class field_signed_high_pass_fc(Operator): value to the threshold value in input. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class field_signed_high_pass_fc(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/filter/filtering_max_over_time.py b/src/ansys/dpf/core/operators/filter/filtering_max_over_time.py index c283c576e80..e8355c7b242 100644 --- a/src/ansys/dpf/core/operators/filter/filtering_max_over_time.py +++ b/src/ansys/dpf/core/operators/filter/filtering_max_over_time.py @@ -20,8 +20,8 @@ class filtering_max_over_time(Operator): threshold of a selected invariant. - Parameters - ---------- + Inputs + ------ invariant_fc_operator: str Name of the invariant operator to be used to calculate filter (available: eqv_fc, invariants_deriv_fc, invariants_fc). output_pin: int, optional @@ -31,7 +31,7 @@ class filtering_max_over_time(Operator): threshold: float, optional Threshold from which the operator will filter. - Returns + Outputs ------- workflow: Workflow diff --git a/src/ansys/dpf/core/operators/filter/scoping_band_pass.py b/src/ansys/dpf/core/operators/filter/scoping_band_pass.py index 226ed9c9ad9..5e5c4f892e3 100644 --- a/src/ansys/dpf/core/operators/filter/scoping_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/scoping_band_pass.py @@ -21,8 +21,8 @@ class scoping_band_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected min_threshold: float or Field @@ -30,7 +30,7 @@ class scoping_band_pass(Operator): max_threshold: float or Field, optional A maximum threshold scalar or a field containing one value is expected. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/scoping_high_pass.py b/src/ansys/dpf/core/operators/filter/scoping_high_pass.py index 222997946b9..087f6e4693c 100644 --- a/src/ansys/dpf/core/operators/filter/scoping_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/scoping_high_pass.py @@ -20,8 +20,8 @@ class scoping_high_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class scoping_high_pass(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/scoping_low_pass.py b/src/ansys/dpf/core/operators/filter/scoping_low_pass.py index 5d713666959..190bc8d79ac 100644 --- a/src/ansys/dpf/core/operators/filter/scoping_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/scoping_low_pass.py @@ -20,8 +20,8 @@ class scoping_low_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class scoping_low_pass(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/scoping_signed_high_pass.py b/src/ansys/dpf/core/operators/filter/scoping_signed_high_pass.py index c760c2ed55d..e4f7e30e4bb 100644 --- a/src/ansys/dpf/core/operators/filter/scoping_signed_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/scoping_signed_high_pass.py @@ -20,8 +20,8 @@ class scoping_signed_high_pass(Operator): value to the threshold value in input. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected threshold: float or Field @@ -29,7 +29,7 @@ class scoping_signed_high_pass(Operator): both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timefreq_band_pass.py b/src/ansys/dpf/core/operators/filter/timefreq_band_pass.py index 8dbd243453f..37cf417e1ad 100644 --- a/src/ansys/dpf/core/operators/filter/timefreq_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/timefreq_band_pass.py @@ -21,15 +21,15 @@ class timefreq_band_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport min_threshold: float or Field A minimum threshold scalar or a field containing one value is expected. max_threshold: float or Field, optional A maximum threshold scalar or a field containing one value is expected. - Returns + Outputs ------- time_freq_support: TimeFreqSupport scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timefreq_high_pass.py b/src/ansys/dpf/core/operators/filter/timefreq_high_pass.py index 841993ae2e5..d0719f2d14f 100644 --- a/src/ansys/dpf/core/operators/filter/timefreq_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/timefreq_high_pass.py @@ -20,15 +20,15 @@ class timefreq_high_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport threshold: float or Field A threshold scalar or a field containing one value is expected. both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- time_freq_support: TimeFreqSupport scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timefreq_low_pass.py b/src/ansys/dpf/core/operators/filter/timefreq_low_pass.py index 1cfe415cfde..3d3e9566c71 100644 --- a/src/ansys/dpf/core/operators/filter/timefreq_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/timefreq_low_pass.py @@ -20,15 +20,15 @@ class timefreq_low_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport threshold: float or Field a threshold scalar or a field containing one value is expected both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- time_freq_support: TimeFreqSupport scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timefreq_signed_high_pass.py b/src/ansys/dpf/core/operators/filter/timefreq_signed_high_pass.py index 774307f7323..c80b9674eea 100644 --- a/src/ansys/dpf/core/operators/filter/timefreq_signed_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/timefreq_signed_high_pass.py @@ -20,15 +20,15 @@ class timefreq_signed_high_pass(Operator): value to the threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport threshold: float or Field A threshold scalar or a field containing one value is expected. both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- time_freq_support: TimeFreqSupport scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timescoping_band_pass.py b/src/ansys/dpf/core/operators/filter/timescoping_band_pass.py index afe1311566d..406e1044150 100644 --- a/src/ansys/dpf/core/operators/filter/timescoping_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/timescoping_band_pass.py @@ -21,15 +21,15 @@ class timescoping_band_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport min_threshold: float or Field A minimum threshold scalar or a field containing one value is expected. max_threshold: float or Field, optional A maximum threshold scalar or a field containing one value is expected. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timescoping_high_pass.py b/src/ansys/dpf/core/operators/filter/timescoping_high_pass.py index e445d9b06d0..9b430c62330 100644 --- a/src/ansys/dpf/core/operators/filter/timescoping_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/timescoping_high_pass.py @@ -20,15 +20,15 @@ class timescoping_high_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport threshold: float or Field A threshold scalar or a field containing one value is expected. both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timescoping_low_pass.py b/src/ansys/dpf/core/operators/filter/timescoping_low_pass.py index 5ab99d0df99..ce9eabe05ad 100644 --- a/src/ansys/dpf/core/operators/filter/timescoping_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/timescoping_low_pass.py @@ -20,15 +20,15 @@ class timescoping_low_pass(Operator): threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport threshold: float or Field a threshold scalar or a field containing one value is expected both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/filter/timescoping_signed_high_pass.py b/src/ansys/dpf/core/operators/filter/timescoping_signed_high_pass.py index 206dd809ff5..f6d44956d84 100644 --- a/src/ansys/dpf/core/operators/filter/timescoping_signed_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/timescoping_signed_high_pass.py @@ -20,15 +20,15 @@ class timescoping_signed_high_pass(Operator): value to the threshold value in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport threshold: float or Field A threshold scalar or a field containing one value is expected. both: bool, optional The default is false. If set to true, the complement of the filtered fields container is returned on output pin 1. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/geo/cartesian_to_spherical.py b/src/ansys/dpf/core/operators/geo/cartesian_to_spherical.py index 22d3780a096..5a967eb8130 100644 --- a/src/ansys/dpf/core/operators/geo/cartesian_to_spherical.py +++ b/src/ansys/dpf/core/operators/geo/cartesian_to_spherical.py @@ -19,11 +19,11 @@ class cartesian_to_spherical(Operator): r"""Converts 3D field from cartesian coordinates to spherical coordinates. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/cartesian_to_spherical_fc.py b/src/ansys/dpf/core/operators/geo/cartesian_to_spherical_fc.py index fc57721fbfc..9334caa6aa0 100644 --- a/src/ansys/dpf/core/operators/geo/cartesian_to_spherical_fc.py +++ b/src/ansys/dpf/core/operators/geo/cartesian_to_spherical_fc.py @@ -19,11 +19,11 @@ class cartesian_to_spherical_fc(Operator): r"""Converts 3D field from cartesian coordinates to spherical coordinates. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/geo/element_nodal_contribution.py b/src/ansys/dpf/core/operators/geo/element_nodal_contribution.py index ab6eac96cb9..4c6f85ed060 100644 --- a/src/ansys/dpf/core/operators/geo/element_nodal_contribution.py +++ b/src/ansys/dpf/core/operators/geo/element_nodal_contribution.py @@ -23,15 +23,15 @@ class element_nodal_contribution(Operator): node within each element. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion scoping: Scoping, optional Integrate the input field over a specific scoping. volume_fraction: bool, optional If true, returns influence volume, area or length. If false, the values are normalized with the element volume, area or length. Default: true. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/elements_facets_surfaces_over_time.py b/src/ansys/dpf/core/operators/geo/elements_facets_surfaces_over_time.py index d5b0999bfda..cbd1c9f934e 100644 --- a/src/ansys/dpf/core/operators/geo/elements_facets_surfaces_over_time.py +++ b/src/ansys/dpf/core/operators/geo/elements_facets_surfaces_over_time.py @@ -21,15 +21,15 @@ class elements_facets_surfaces_over_time(Operator): surface elements. - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional displacement: FieldsContainer, optional Displacement field's container. mesh: MeshedRegion, optional Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement. - Returns + Outputs ------- fields_container: FieldsContainer Surfaces field. diff --git a/src/ansys/dpf/core/operators/geo/elements_volume.py b/src/ansys/dpf/core/operators/geo/elements_volume.py index 14210370945..831d59f531f 100644 --- a/src/ansys/dpf/core/operators/geo/elements_volume.py +++ b/src/ansys/dpf/core/operators/geo/elements_volume.py @@ -21,13 +21,13 @@ class elements_volume(Operator): except for polyhedrons. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion mesh_scoping: Scoping If not provided, the measure of all elements for the mesh is computed. If provided, the Scoping needs to have "Elemental" location. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/elements_volumes_over_time.py b/src/ansys/dpf/core/operators/geo/elements_volumes_over_time.py index d00a87fa56a..03674f3d5e1 100644 --- a/src/ansys/dpf/core/operators/geo/elements_volumes_over_time.py +++ b/src/ansys/dpf/core/operators/geo/elements_volumes_over_time.py @@ -20,15 +20,15 @@ class elements_volumes_over_time(Operator): specified time step. - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional displacement: FieldsContainer, optional Displacement field's container. Must contain the mesh if mesh not specified in input. mesh: MeshedRegion, optional Mesh must be defined if the displacement field's container does not contain it, or if there is no displacement. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/geo/faces_area.py b/src/ansys/dpf/core/operators/geo/faces_area.py index d37c77c6ff1..8dbe2b21832 100644 --- a/src/ansys/dpf/core/operators/geo/faces_area.py +++ b/src/ansys/dpf/core/operators/geo/faces_area.py @@ -21,13 +21,13 @@ class faces_area(Operator): for polygons. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion mesh_scoping: Scoping If not provided, the measure of all Faces in the mesh is computed. If provided, the Scoping needs to have "Faces" location. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/gauss_to_node.py b/src/ansys/dpf/core/operators/geo/gauss_to_node.py index 16c66e4f882..436f2d32a72 100644 --- a/src/ansys/dpf/core/operators/geo/gauss_to_node.py +++ b/src/ansys/dpf/core/operators/geo/gauss_to_node.py @@ -22,15 +22,15 @@ class gauss_to_node(Operator): tetrahedral, and quadratic tetrahedral - Parameters - ---------- + Inputs + ------ field: Field scoping: Scoping, optional Scoping to integrate on, if not provided, the one from input field is provided. mesh: MeshedRegion, optional Mesh to integrate on. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/integrate_over_elements.py b/src/ansys/dpf/core/operators/geo/integrate_over_elements.py index 40e7b3c5699..15cb8db82a4 100644 --- a/src/ansys/dpf/core/operators/geo/integrate_over_elements.py +++ b/src/ansys/dpf/core/operators/geo/integrate_over_elements.py @@ -19,15 +19,15 @@ class integrate_over_elements(Operator): r"""Integration of an input field over mesh. - Parameters - ---------- + Inputs + ------ field: Field scoping: Scoping, optional Integrate the input field over a specific scoping. mesh: MeshedRegion, optional Mesh to integrate on. If not provided, the one from input field is employed. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/normals.py b/src/ansys/dpf/core/operators/geo/normals.py index 8bec73b9cce..2319a751336 100644 --- a/src/ansys/dpf/core/operators/geo/normals.py +++ b/src/ansys/dpf/core/operators/geo/normals.py @@ -21,13 +21,13 @@ class normals(Operator): shell elements) - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion, optional mesh_scoping: Scoping, optional field: Field, optional - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/normals_provider_nl.py b/src/ansys/dpf/core/operators/geo/normals_provider_nl.py index bbd36b3c775..6df29fa6e72 100644 --- a/src/ansys/dpf/core/operators/geo/normals_provider_nl.py +++ b/src/ansys/dpf/core/operators/geo/normals_provider_nl.py @@ -20,8 +20,8 @@ class normals_provider_nl(Operator): (more accurate for non-linear elements) on a skin mesh. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion Skin, face, or shell mesh region. mesh_scoping: Scoping, optional @@ -29,7 +29,7 @@ class normals_provider_nl(Operator): requested_location: str, optional If no scoping, specifies location. If scoping is Elemental or ElementalNodal this overrides scoping. Default is Elemental. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/rotate.py b/src/ansys/dpf/core/operators/geo/rotate.py index 9003ff183bc..80a3591629f 100644 --- a/src/ansys/dpf/core/operators/geo/rotate.py +++ b/src/ansys/dpf/core/operators/geo/rotate.py @@ -19,14 +19,14 @@ class rotate(Operator): r"""Applies a transformation (rotation) matrix on a field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected field_rotation_matrix: Field 3-3 rotation matrix - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/rotate_fc.py b/src/ansys/dpf/core/operators/geo/rotate_fc.py index 844499495a1..550991d5395 100644 --- a/src/ansys/dpf/core/operators/geo/rotate_fc.py +++ b/src/ansys/dpf/core/operators/geo/rotate_fc.py @@ -20,13 +20,13 @@ class rotate_fc(Operator): container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer coordinate_system: Field 3-3 rotation matrix - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs.py b/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs.py index bc6e5c7af74..7f39a53fe21 100644 --- a/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs.py +++ b/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs.py @@ -22,8 +22,8 @@ class rotate_in_cylindrical_cs(Operator): is rotated on each node following the local polar coordinate system. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected coordinate_system: Field, optional @@ -31,7 +31,7 @@ class rotate_in_cylindrical_cs(Operator): mesh: MeshedRegion, optional Mesh support of the input field. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs_fc.py b/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs_fc.py index 6a634fdfaa2..011e2b780be 100644 --- a/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs_fc.py +++ b/src/ansys/dpf/core/operators/geo/rotate_in_cylindrical_cs_fc.py @@ -24,15 +24,15 @@ class rotate_in_cylindrical_cs_fc(Operator): coordinate system. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer coordinate_system: Field, optional 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. mesh: MeshedRegion, optional Mesh support of the input fields_container, in case it does not have one defined. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/geo/spherical_to_cartesian.py b/src/ansys/dpf/core/operators/geo/spherical_to_cartesian.py index 740cdd2b316..d13501c2872 100644 --- a/src/ansys/dpf/core/operators/geo/spherical_to_cartesian.py +++ b/src/ansys/dpf/core/operators/geo/spherical_to_cartesian.py @@ -19,11 +19,11 @@ class spherical_to_cartesian(Operator): r"""Converts 3D field from spherical coordinates to cartesian coordinates. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/geo/spherical_to_cartesian_fc.py b/src/ansys/dpf/core/operators/geo/spherical_to_cartesian_fc.py index 4b3a07105bc..3a9437a0e9c 100644 --- a/src/ansys/dpf/core/operators/geo/spherical_to_cartesian_fc.py +++ b/src/ansys/dpf/core/operators/geo/spherical_to_cartesian_fc.py @@ -19,11 +19,11 @@ class spherical_to_cartesian_fc(Operator): r"""Converts 3D field from spherical coordinates to cartesian coordinates. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/geo/to_polar_coordinates.py b/src/ansys/dpf/core/operators/geo/to_polar_coordinates.py index 36b39257267..4d9b338e5b7 100644 --- a/src/ansys/dpf/core/operators/geo/to_polar_coordinates.py +++ b/src/ansys/dpf/core/operators/geo/to_polar_coordinates.py @@ -21,14 +21,14 @@ class to_polar_coordinates(Operator): defines the rotation axis and the origin. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected coordinate_system: Field, optional 3-3 rotation matrix and origin coordinates must be set here to define a coordinate system. By default, the rotation axis is the z axis and the origin is [0,0,0]. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/invariant/convertnum_bcs_to_nod.py b/src/ansys/dpf/core/operators/invariant/convertnum_bcs_to_nod.py index b5ec983bff8..b4701d18f00 100644 --- a/src/ansys/dpf/core/operators/invariant/convertnum_bcs_to_nod.py +++ b/src/ansys/dpf/core/operators/invariant/convertnum_bcs_to_nod.py @@ -19,14 +19,14 @@ class convertnum_bcs_to_nod(Operator): r"""Converts a fields container from BCS to NOD ordering. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields_container data_sources: DataSources Data_sources (must contain the full file). - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/invariant/convertnum_nod_to_bcs.py b/src/ansys/dpf/core/operators/invariant/convertnum_nod_to_bcs.py index 262dcb47103..59b654e5c1d 100644 --- a/src/ansys/dpf/core/operators/invariant/convertnum_nod_to_bcs.py +++ b/src/ansys/dpf/core/operators/invariant/convertnum_nod_to_bcs.py @@ -19,14 +19,14 @@ class convertnum_nod_to_bcs(Operator): r"""Converts a fields container from NOD to BCS ordering. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields_container data_sources: DataSources Data_sources (must contain the full file). - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/invariant/convertnum_op.py b/src/ansys/dpf/core/operators/invariant/convertnum_op.py index fc197e2b399..861dedf39e2 100644 --- a/src/ansys/dpf/core/operators/invariant/convertnum_op.py +++ b/src/ansys/dpf/core/operators/invariant/convertnum_op.py @@ -20,8 +20,8 @@ class convertnum_op(Operator): ordering. Supported mapdl ordering are BCS=0, FUL=1, NOD=2. - Parameters - ---------- + Inputs + ------ input_ordering: int Input ordering number output_ordering: int @@ -31,7 +31,7 @@ class convertnum_op(Operator): data_sources: DataSources Data_sources (must contain the full file). - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/invariant/eigen_values.py b/src/ansys/dpf/core/operators/invariant/eigen_values.py index 6d350f20a36..ad56ea0e827 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_values.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_values.py @@ -19,12 +19,12 @@ class eigen_values(Operator): r"""Computes the element-wise Eigen values of a tensor field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/invariant/eigen_values_fc.py b/src/ansys/dpf/core/operators/invariant/eigen_values_fc.py index 8cabe78bab6..ec0ab9d3e57 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_values_fc.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_values_fc.py @@ -20,11 +20,11 @@ class eigen_values_fc(Operator): fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/invariant/eigen_vectors.py b/src/ansys/dpf/core/operators/invariant/eigen_vectors.py index e4c4d5a32d1..a2d3aa3fe16 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_vectors.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_vectors.py @@ -19,12 +19,12 @@ class eigen_vectors(Operator): r"""Computes the element-wise Eigen vectors for each tensor in the field. - Parameters - ---------- + Inputs + ------ field: FieldsContainer or Field field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/invariant/eigen_vectors_fc.py b/src/ansys/dpf/core/operators/invariant/eigen_vectors_fc.py index a657840fdbf..08998471414 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_vectors_fc.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_vectors_fc.py @@ -20,11 +20,11 @@ class eigen_vectors_fc(Operator): the field container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer or Field - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/invariant/invariants.py b/src/ansys/dpf/core/operators/invariant/invariants.py index 7d954588980..5d600961fe2 100644 --- a/src/ansys/dpf/core/operators/invariant/invariants.py +++ b/src/ansys/dpf/core/operators/invariant/invariants.py @@ -19,11 +19,11 @@ class invariants(Operator): r"""Computes the element-wise invariants of a tensor field. - Parameters - ---------- + Inputs + ------ field: Field - Returns + Outputs ------- field_int: Field stress intensity field diff --git a/src/ansys/dpf/core/operators/invariant/invariants_fc.py b/src/ansys/dpf/core/operators/invariant/invariants_fc.py index f5a31417221..054df7fe625 100644 --- a/src/ansys/dpf/core/operators/invariant/invariants_fc.py +++ b/src/ansys/dpf/core/operators/invariant/invariants_fc.py @@ -20,11 +20,11 @@ class invariants_fc(Operator): fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_int: FieldsContainer stress intensity field diff --git a/src/ansys/dpf/core/operators/invariant/principal_invariants.py b/src/ansys/dpf/core/operators/invariant/principal_invariants.py index 1466320ae61..ce52c40b4b4 100644 --- a/src/ansys/dpf/core/operators/invariant/principal_invariants.py +++ b/src/ansys/dpf/core/operators/invariant/principal_invariants.py @@ -19,11 +19,11 @@ class principal_invariants(Operator): r"""Computes the element-wise Eigen values of a tensor field. - Parameters - ---------- + Inputs + ------ field: Field - Returns + Outputs ------- field_eig_1: Field first eigen value field diff --git a/src/ansys/dpf/core/operators/invariant/principal_invariants_fc.py b/src/ansys/dpf/core/operators/invariant/principal_invariants_fc.py index 48d46ff8542..ed18412e210 100644 --- a/src/ansys/dpf/core/operators/invariant/principal_invariants_fc.py +++ b/src/ansys/dpf/core/operators/invariant/principal_invariants_fc.py @@ -20,11 +20,11 @@ class principal_invariants_fc(Operator): fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_eig_1: FieldsContainer first eigen value fields diff --git a/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv.py b/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv.py index 3eb0e286cce..018ac03c92b 100644 --- a/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv.py +++ b/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv.py @@ -19,12 +19,12 @@ class segalman_von_mises_eqv(Operator): r"""Computes the element-wise Segalman Von-Mises criteria on a tensor field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv_fc.py b/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv_fc.py index 55926d631a4..38316479c62 100644 --- a/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv_fc.py +++ b/src/ansys/dpf/core/operators/invariant/segalman_von_mises_eqv_fc.py @@ -20,11 +20,11 @@ class segalman_von_mises_eqv_fc(Operator): fields of a fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/invariant/von_mises_eqv.py b/src/ansys/dpf/core/operators/invariant/von_mises_eqv.py index 893511eb787..7e22baf6c65 100644 --- a/src/ansys/dpf/core/operators/invariant/von_mises_eqv.py +++ b/src/ansys/dpf/core/operators/invariant/von_mises_eqv.py @@ -19,14 +19,14 @@ class von_mises_eqv(Operator): r"""Computes the element-wise Von-Mises criteria on a tensor field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected poisson_ratio: float or int Poisson ratio to be used in equivalent strain calculation. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/invariant/von_mises_eqv_fc.py b/src/ansys/dpf/core/operators/invariant/von_mises_eqv_fc.py index 8d85271f247..8eaf11eb174 100644 --- a/src/ansys/dpf/core/operators/invariant/von_mises_eqv_fc.py +++ b/src/ansys/dpf/core/operators/invariant/von_mises_eqv_fc.py @@ -20,13 +20,13 @@ class von_mises_eqv_fc(Operator): a fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer poisson_ratio: float or int Poisson ratio to be used in equivalent strain calculation. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/logic/ascending_sort.py b/src/ansys/dpf/core/operators/logic/ascending_sort.py index ecb395827d7..1f5fc2a34bc 100644 --- a/src/ansys/dpf/core/operators/logic/ascending_sort.py +++ b/src/ansys/dpf/core/operators/logic/ascending_sort.py @@ -21,8 +21,8 @@ class ascending_sort(Operator): operator does not support multiple elementary data per entity. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected component_priority_table: optional @@ -30,7 +30,7 @@ class ascending_sort(Operator): sort_by_scoping: bool, optional if true, uses scoping to sort the field (default is false) - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/logic/ascending_sort_fc.py b/src/ansys/dpf/core/operators/logic/ascending_sort_fc.py index 438c450a5e3..caa6e78c5a6 100644 --- a/src/ansys/dpf/core/operators/logic/ascending_sort_fc.py +++ b/src/ansys/dpf/core/operators/logic/ascending_sort_fc.py @@ -21,8 +21,8 @@ class ascending_sort_fc(Operator): operator does not support multiple elementary data per entity. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected component_priority_table: optional @@ -30,7 +30,7 @@ class ascending_sort_fc(Operator): sort_by_scoping: bool, optional if true, uses scoping to sort the field (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/logic/component_selector.py b/src/ansys/dpf/core/operators/logic/component_selector.py index 560860cfb26..fce488b701b 100644 --- a/src/ansys/dpf/core/operators/logic/component_selector.py +++ b/src/ansys/dpf/core/operators/logic/component_selector.py @@ -19,15 +19,15 @@ class component_selector(Operator): r"""Creates a scalar/vector field based on the selected component. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer component_number: int One or several component index that will be extracted from the initial field. default_value: float, optional Set a default value for components that do not exist. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/logic/component_selector_fc.py b/src/ansys/dpf/core/operators/logic/component_selector_fc.py index 71fe5c65f13..1227a064c9b 100644 --- a/src/ansys/dpf/core/operators/logic/component_selector_fc.py +++ b/src/ansys/dpf/core/operators/logic/component_selector_fc.py @@ -20,13 +20,13 @@ class component_selector_fc(Operator): each field. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer or Field component_number: int one or several component index that will be extracted from the initial field. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/logic/component_transformer.py b/src/ansys/dpf/core/operators/logic/component_transformer.py index bb65026538f..02c987a750f 100644 --- a/src/ansys/dpf/core/operators/logic/component_transformer.py +++ b/src/ansys/dpf/core/operators/logic/component_transformer.py @@ -20,15 +20,15 @@ class component_transformer(Operator): components. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer component_number: int One or several component index that will be modified from the initial field. default_value: float, optional Set a default value for components selected. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/logic/component_transformer_fc.py b/src/ansys/dpf/core/operators/logic/component_transformer_fc.py index 4a1c73bef36..6f4bd0c5e3d 100644 --- a/src/ansys/dpf/core/operators/logic/component_transformer_fc.py +++ b/src/ansys/dpf/core/operators/logic/component_transformer_fc.py @@ -20,15 +20,15 @@ class component_transformer_fc(Operator): components. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer component_number: int One or several component index that will be modified from the initial field. default_value: float, optional Set a default value for components selected. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/logic/descending_sort.py b/src/ansys/dpf/core/operators/logic/descending_sort.py index 6f990020095..dfd8e570e69 100644 --- a/src/ansys/dpf/core/operators/logic/descending_sort.py +++ b/src/ansys/dpf/core/operators/logic/descending_sort.py @@ -21,8 +21,8 @@ class descending_sort(Operator): operator doesn’t support multiple elementary data per entity. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected component_priority_table: optional @@ -30,7 +30,7 @@ class descending_sort(Operator): sort_by_scoping: bool, optional if true, uses scoping to sort the field (default is false) - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/logic/descending_sort_fc.py b/src/ansys/dpf/core/operators/logic/descending_sort_fc.py index 2b2c3279aaf..2eb3bc5d8b5 100644 --- a/src/ansys/dpf/core/operators/logic/descending_sort_fc.py +++ b/src/ansys/dpf/core/operators/logic/descending_sort_fc.py @@ -21,8 +21,8 @@ class descending_sort_fc(Operator): operator doesn’t support multiple elementary data per entity. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected component_priority_table: optional @@ -30,7 +30,7 @@ class descending_sort_fc(Operator): sort_by_scoping: bool, optional if true, uses scoping to sort the field (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/logic/elementary_data_selector.py b/src/ansys/dpf/core/operators/logic/elementary_data_selector.py index 532172316fd..84b5679226b 100644 --- a/src/ansys/dpf/core/operators/logic/elementary_data_selector.py +++ b/src/ansys/dpf/core/operators/logic/elementary_data_selector.py @@ -19,8 +19,8 @@ class elementary_data_selector(Operator): r"""Creates a scalar/vector field based on the selected elementary data. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer elementary_data_index: int One or several elementary data index that will be extracted from the initial field. For field with nature matrix, this is the line indices to extract. @@ -29,7 +29,7 @@ class elementary_data_selector(Operator): elementary_data_index_2: int, optional For field with nature matrix, this is the column indices to extract. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/logic/elementary_data_selector_fc.py b/src/ansys/dpf/core/operators/logic/elementary_data_selector_fc.py index 3728ca13632..a076126bd8a 100644 --- a/src/ansys/dpf/core/operators/logic/elementary_data_selector_fc.py +++ b/src/ansys/dpf/core/operators/logic/elementary_data_selector_fc.py @@ -20,15 +20,15 @@ class elementary_data_selector_fc(Operator): for each field. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer or Field elementary_data_index: int one or several elementary data indices that will be extracted from the initial field. For a field with a nature matrix, this extracts the line indices. elementary_data_index_2: int, optional For a field with nature matrix, this extracts the column indices. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/logic/enrich_materials.py b/src/ansys/dpf/core/operators/logic/enrich_materials.py index 52a9db98ead..0536888a344 100644 --- a/src/ansys/dpf/core/operators/logic/enrich_materials.py +++ b/src/ansys/dpf/core/operators/logic/enrich_materials.py @@ -20,13 +20,13 @@ class enrich_materials(Operator): MaterialContainer using stream data. - Parameters - ---------- + Inputs + ------ MaterialContainer: streams: StreamsContainer or FieldsContainer streams_mapping: PropertyFieldsContainer - Returns + Outputs ------- MaterialContainer: bool diff --git a/src/ansys/dpf/core/operators/logic/identical_anys.py b/src/ansys/dpf/core/operators/logic/identical_anys.py index b83a12e6a61..3c803ce35a5 100644 --- a/src/ansys/dpf/core/operators/logic/identical_anys.py +++ b/src/ansys/dpf/core/operators/logic/identical_anys.py @@ -24,8 +24,8 @@ class identical_anys(Operator): property check. - Parameters - ---------- + Inputs + ------ anyA: Any anyB: Any double_value: float @@ -35,7 +35,7 @@ class identical_anys(Operator): compare_auxiliary: bool For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. - Returns + Outputs ------- included: bool bool (true if belongs...) diff --git a/src/ansys/dpf/core/operators/logic/identical_fc.py b/src/ansys/dpf/core/operators/logic/identical_fc.py index 2314c7d1ec5..92e5ce61a3d 100644 --- a/src/ansys/dpf/core/operators/logic/identical_fc.py +++ b/src/ansys/dpf/core/operators/logic/identical_fc.py @@ -19,8 +19,8 @@ class identical_fc(Operator): r"""Checks if two fields_container are identical. - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer fields_containerB: FieldsContainer small_value: float, optional @@ -28,7 +28,7 @@ class identical_fc(Operator): tolerance: float, optional Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical (v1-v2)/v2 < relativeTol (default is 0.001). - Returns + Outputs ------- boolean: bool bool (true if identical...) diff --git a/src/ansys/dpf/core/operators/logic/identical_fields.py b/src/ansys/dpf/core/operators/logic/identical_fields.py index b4e44f5e1ea..2c2b47f9782 100644 --- a/src/ansys/dpf/core/operators/logic/identical_fields.py +++ b/src/ansys/dpf/core/operators/logic/identical_fields.py @@ -19,8 +19,8 @@ class identical_fields(Operator): r"""Check if two fields are identical. - Parameters - ---------- + Inputs + ------ fieldA: Field fieldB: Field double_value: float, optional @@ -28,7 +28,7 @@ class identical_fields(Operator): double_tolerance: float, optional Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1 - v2) / v2 < relativeTol. Default is 0.001. - Returns + Outputs ------- boolean: bool bool (true if identical...) diff --git a/src/ansys/dpf/core/operators/logic/identical_generic_data_containers.py b/src/ansys/dpf/core/operators/logic/identical_generic_data_containers.py index 832eb309230..1d2aacdfb31 100644 --- a/src/ansys/dpf/core/operators/logic/identical_generic_data_containers.py +++ b/src/ansys/dpf/core/operators/logic/identical_generic_data_containers.py @@ -24,8 +24,8 @@ class identical_generic_data_containers(Operator): check. - Parameters - ---------- + Inputs + ------ generic_data_containerA: GenericDataContainer generic_data_containerB: GenericDataContainer double_value: float @@ -35,7 +35,7 @@ class identical_generic_data_containers(Operator): compare_auxiliary: bool For meshes and meshescontainer: compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. - Returns + Outputs ------- included: bool bool (true if belongs...) diff --git a/src/ansys/dpf/core/operators/logic/identical_mc.py b/src/ansys/dpf/core/operators/logic/identical_mc.py index 798bfa01d4b..228ca13a966 100644 --- a/src/ansys/dpf/core/operators/logic/identical_mc.py +++ b/src/ansys/dpf/core/operators/logic/identical_mc.py @@ -19,8 +19,8 @@ class identical_mc(Operator): r"""Checks if two meshes_container are identical. - Parameters - ---------- + Inputs + ------ meshes_containerA: MeshesContainer meshes_containerB: MeshesContainer small_value: float, optional @@ -30,7 +30,7 @@ class identical_mc(Operator): compare_auxiliary: bool compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. - Returns + Outputs ------- boolean: bool bool (true if identical...) diff --git a/src/ansys/dpf/core/operators/logic/identical_meshes.py b/src/ansys/dpf/core/operators/logic/identical_meshes.py index 6e1d4dea272..6bdd9c1adb2 100644 --- a/src/ansys/dpf/core/operators/logic/identical_meshes.py +++ b/src/ansys/dpf/core/operators/logic/identical_meshes.py @@ -21,8 +21,8 @@ class identical_meshes(Operator): the first mesh (pin 0) are included in the second mesh (pin 1). - Parameters - ---------- + Inputs + ------ meshA: MeshedRegion meshB: MeshedRegion small_value: float, optional @@ -32,7 +32,7 @@ class identical_meshes(Operator): compare_auxiliary: bool compare auxiliary data (i.e property fields, scopings...). Default value is 'false'. - Returns + Outputs ------- are_identical: bool diff --git a/src/ansys/dpf/core/operators/logic/identical_pfc.py b/src/ansys/dpf/core/operators/logic/identical_pfc.py index b453afe0d7f..7ffb127a141 100644 --- a/src/ansys/dpf/core/operators/logic/identical_pfc.py +++ b/src/ansys/dpf/core/operators/logic/identical_pfc.py @@ -19,12 +19,12 @@ class identical_pfc(Operator): r"""Checks if two property_fields_container are identical. - Parameters - ---------- + Inputs + ------ property_fields_containerA: PropertyFieldsContainer property_fields_containerB: PropertyFieldsContainer - Returns + Outputs ------- boolean: bool bool (true if identical...) diff --git a/src/ansys/dpf/core/operators/logic/identical_property_fields.py b/src/ansys/dpf/core/operators/logic/identical_property_fields.py index 541d8953800..b0edc313f36 100644 --- a/src/ansys/dpf/core/operators/logic/identical_property_fields.py +++ b/src/ansys/dpf/core/operators/logic/identical_property_fields.py @@ -19,12 +19,12 @@ class identical_property_fields(Operator): r"""Takes two property fields and compares them. - Parameters - ---------- + Inputs + ------ property_fieldA: MeshedRegion property_fieldB: MeshedRegion - Returns + Outputs ------- are_identical: bool information: str diff --git a/src/ansys/dpf/core/operators/logic/identical_sc.py b/src/ansys/dpf/core/operators/logic/identical_sc.py index 54476fb18ee..4c482572571 100644 --- a/src/ansys/dpf/core/operators/logic/identical_sc.py +++ b/src/ansys/dpf/core/operators/logic/identical_sc.py @@ -19,12 +19,12 @@ class identical_sc(Operator): r"""Checks if two scopings_container are identical. - Parameters - ---------- + Inputs + ------ scopings_containerA: ScopingsContainer scopings_containerB: ScopingsContainer - Returns + Outputs ------- boolean: bool bool (true if identical...) diff --git a/src/ansys/dpf/core/operators/logic/identical_scopings.py b/src/ansys/dpf/core/operators/logic/identical_scopings.py index 2b832020b5a..29636ce3440 100644 --- a/src/ansys/dpf/core/operators/logic/identical_scopings.py +++ b/src/ansys/dpf/core/operators/logic/identical_scopings.py @@ -19,12 +19,12 @@ class identical_scopings(Operator): r"""Check if two scopings are identical. - Parameters - ---------- + Inputs + ------ scopingA: Scoping scopingB: Scoping - Returns + Outputs ------- boolean: bool bool (true if identical...) diff --git a/src/ansys/dpf/core/operators/logic/identical_string_fields.py b/src/ansys/dpf/core/operators/logic/identical_string_fields.py index 3ba3109dfc2..7ea55d7a1a2 100644 --- a/src/ansys/dpf/core/operators/logic/identical_string_fields.py +++ b/src/ansys/dpf/core/operators/logic/identical_string_fields.py @@ -19,12 +19,12 @@ class identical_string_fields(Operator): r"""Takes two string fields and compares them. - Parameters - ---------- + Inputs + ------ string_fieldA: StringField string_fieldB: StringField - Returns + Outputs ------- are_identical: bool information: str diff --git a/src/ansys/dpf/core/operators/logic/included_fields.py b/src/ansys/dpf/core/operators/logic/included_fields.py index 9ae3e60b226..c028cac9b33 100644 --- a/src/ansys/dpf/core/operators/logic/included_fields.py +++ b/src/ansys/dpf/core/operators/logic/included_fields.py @@ -19,8 +19,8 @@ class included_fields(Operator): r"""Checks if one field belongs to another. - Parameters - ---------- + Inputs + ------ fieldA: Field fieldB: Field double_value: float @@ -28,7 +28,7 @@ class included_fields(Operator): double_tolerance: float, optional Double relative tolerance. Maximum tolerance gap between two compared values. Values within relative tolerance are considered identical. Formula is (v1-v2)/v2 < relativeTol. Default is 0.001. - Returns + Outputs ------- included: bool bool (true if belongs...) diff --git a/src/ansys/dpf/core/operators/logic/solid_shell_fields.py b/src/ansys/dpf/core/operators/logic/solid_shell_fields.py index be53fb55ab7..2a8f0b419ae 100644 --- a/src/ansys/dpf/core/operators/logic/solid_shell_fields.py +++ b/src/ansys/dpf/core/operators/logic/solid_shell_fields.py @@ -20,11 +20,11 @@ class solid_shell_fields(Operator): container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/logic/split_data_sources.py b/src/ansys/dpf/core/operators/logic/split_data_sources.py index a47262884c3..8f7c903cde7 100644 --- a/src/ansys/dpf/core/operators/logic/split_data_sources.py +++ b/src/ansys/dpf/core/operators/logic/split_data_sources.py @@ -21,14 +21,14 @@ class split_data_sources(Operator): ouputs. - Parameters - ---------- + Inputs + ------ data_sources: DataSources Data sources to split. output_count: int Number of desired outputs. - Returns + Outputs ------- output_count: int Actual number of outputs. diff --git a/src/ansys/dpf/core/operators/logic/split_streams.py b/src/ansys/dpf/core/operators/logic/split_streams.py index c320b7cce8f..63ec8cd8683 100644 --- a/src/ansys/dpf/core/operators/logic/split_streams.py +++ b/src/ansys/dpf/core/operators/logic/split_streams.py @@ -20,14 +20,14 @@ class split_streams(Operator): outputs is always less or equal to the given desired number of ouputs. - Parameters - ---------- + Inputs + ------ streams: StreamsContainer Streams to split. output_count: int Number of desired outputs. - Returns + Outputs ------- output_count: int Actual number of outputs. diff --git a/src/ansys/dpf/core/operators/mapping/fft.py b/src/ansys/dpf/core/operators/mapping/fft.py index 61bf974e3ec..f0fba574b4c 100644 --- a/src/ansys/dpf/core/operators/mapping/fft.py +++ b/src/ansys/dpf/core/operators/mapping/fft.py @@ -27,8 +27,8 @@ class fft(Operator): coefficient will be returned). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer Field or Fields Container. scale_forward_transform: float, optional @@ -42,7 +42,7 @@ class fft(Operator): scale_right_amplitude: bool, optional If set to true (default is false), 2/field_num_entities scaling will be applied, to have right amplitude values. - Returns + Outputs ------- fields_container: FieldsContainer Output Complex Fields Container with labels matching input Fields Container. No supports binded, but prepare_sampling_fft provides it. diff --git a/src/ansys/dpf/core/operators/mapping/find_reduced_coordinates.py b/src/ansys/dpf/core/operators/mapping/find_reduced_coordinates.py index 2bdbd6d6207..6ef55ead003 100644 --- a/src/ansys/dpf/core/operators/mapping/find_reduced_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/find_reduced_coordinates.py @@ -20,15 +20,15 @@ class find_reduced_coordinates(Operator): computes their reduced coordinates in those elements. - Parameters - ---------- + Inputs + ------ coordinates: Field or FieldsContainer or MeshedRegion or MeshesContainer mesh: MeshedRegion or MeshesContainer, optional If the first field in input has no mesh in support, then the mesh in this pin is expected (default is false). If a meshes container with several meshes is set, it should be on the same label spaces as the coordinates fields container. use_quadratic_elements: bool, optional If this pin is set to true, reduced coordinates are computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. - Returns + Outputs ------- reduced_coordinates: FieldsContainer coordinates in the reference elements diff --git a/src/ansys/dpf/core/operators/mapping/on_coordinates.py b/src/ansys/dpf/core/operators/mapping/on_coordinates.py index ee290a06a96..b1ad6619ffb 100644 --- a/src/ansys/dpf/core/operators/mapping/on_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/on_coordinates.py @@ -20,8 +20,8 @@ class on_coordinates(Operator): elements with shape functions). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer coordinates: Field or FieldsContainer or MeshedRegion or MeshesContainer create_support: bool, optional @@ -35,7 +35,7 @@ class on_coordinates(Operator): use_quadratic_elements: bool, optional If this pin is set to true, the element search for each coordinate is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/mapping/on_reduced_coordinates.py b/src/ansys/dpf/core/operators/mapping/on_reduced_coordinates.py index 72d1b07f2bf..a4e175c6507 100644 --- a/src/ansys/dpf/core/operators/mapping/on_reduced_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/on_reduced_coordinates.py @@ -20,8 +20,8 @@ class on_reduced_coordinates(Operator): (interpolates results inside elements with shape functions). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer reduced_coordinates: Field or FieldsContainer coordinates in the reference elements to find (found with the operator "find_reduced_coordinates") @@ -32,7 +32,7 @@ class on_reduced_coordinates(Operator): use_quadratic_elements: bool, optional If this pin is set to true, the interpolation is computed on the quadratic element if the element is quadratic (more precise but less performant). Default is false. To use only when results have mid side nodes values. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/mapping/prep_sampling_fft.py b/src/ansys/dpf/core/operators/mapping/prep_sampling_fft.py index b2d01713aa0..c0bdca49eaf 100644 --- a/src/ansys/dpf/core/operators/mapping/prep_sampling_fft.py +++ b/src/ansys/dpf/core/operators/mapping/prep_sampling_fft.py @@ -20,8 +20,8 @@ class prep_sampling_fft(Operator): frequencies in output. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport Initial time domain TimeFreqSupport. cutoff_frequency: float, optional @@ -29,7 +29,7 @@ class prep_sampling_fft(Operator): number_sampling_point: int, optional For number of sampling point (calculation with cutoff_frequency is ignored). - Returns + Outputs ------- time_tfs_sampled: TimeFreqSupport Optimum sampled time domain TimeFreqSupport. diff --git a/src/ansys/dpf/core/operators/mapping/prepare_mapping_workflow.py b/src/ansys/dpf/core/operators/mapping/prepare_mapping_workflow.py index c19a60ff31f..11d6627a9d6 100644 --- a/src/ansys/dpf/core/operators/mapping/prepare_mapping_workflow.py +++ b/src/ansys/dpf/core/operators/mapping/prepare_mapping_workflow.py @@ -19,15 +19,15 @@ class prepare_mapping_workflow(Operator): r"""Generates a workflow that can map results from a support to another one. - Parameters - ---------- + Inputs + ------ input_support: Field or MeshedRegion output_support: Field or MeshedRegion filter_radius: float Radius size for the RBF filter influence_box: float, optional - Returns + Outputs ------- mapping_workflow: Workflow diff --git a/src/ansys/dpf/core/operators/mapping/scoping_on_coordinates.py b/src/ansys/dpf/core/operators/mapping/scoping_on_coordinates.py index 75ecf99648d..e0799b4c1df 100644 --- a/src/ansys/dpf/core/operators/mapping/scoping_on_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/scoping_on_coordinates.py @@ -19,12 +19,12 @@ class scoping_on_coordinates(Operator): r"""Finds the Elemental scoping of a set of coordinates. - Parameters - ---------- + Inputs + ------ coordinates: Field mesh: MeshedRegion - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/mapping/solid_to_skin.py b/src/ansys/dpf/core/operators/mapping/solid_to_skin.py index 20f1c0dafe2..c9ab5a7aaf6 100644 --- a/src/ansys/dpf/core/operators/mapping/solid_to_skin.py +++ b/src/ansys/dpf/core/operators/mapping/solid_to_skin.py @@ -25,8 +25,8 @@ class solid_to_skin(Operator): mesh for each element face and the nodes associated with it. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected mesh: MeshedRegion @@ -34,7 +34,7 @@ class solid_to_skin(Operator): solid_mesh: MeshedRegion, optional Solid mesh support (optional). - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/mapping/solid_to_skin_fc.py b/src/ansys/dpf/core/operators/mapping/solid_to_skin_fc.py index 28020d39767..07bcecc6be2 100644 --- a/src/ansys/dpf/core/operators/mapping/solid_to_skin_fc.py +++ b/src/ansys/dpf/core/operators/mapping/solid_to_skin_fc.py @@ -25,15 +25,15 @@ class solid_to_skin_fc(Operator): skin mesh for each element face and the nodes associated with it. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer mesh: MeshedRegion skin mesh region expected solid_mesh: MeshedRegion, optional Solid mesh support (optional). - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/absolute_value_by_component.py b/src/ansys/dpf/core/operators/math/absolute_value_by_component.py index 0c0e810e13c..1e098e2d486 100644 --- a/src/ansys/dpf/core/operators/math/absolute_value_by_component.py +++ b/src/ansys/dpf/core/operators/math/absolute_value_by_component.py @@ -20,12 +20,12 @@ class absolute_value_by_component(Operator): norm performed. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/absolute_value_by_component_fc.py b/src/ansys/dpf/core/operators/math/absolute_value_by_component_fc.py index 16aa9ce6216..8c523d422af 100644 --- a/src/ansys/dpf/core/operators/math/absolute_value_by_component_fc.py +++ b/src/ansys/dpf/core/operators/math/absolute_value_by_component_fc.py @@ -20,12 +20,12 @@ class absolute_value_by_component_fc(Operator): norm performed. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/accumulate.py b/src/ansys/dpf/core/operators/math/accumulate.py index 3bc69d17cf1..925463686a3 100644 --- a/src/ansys/dpf/core/operators/math/accumulate.py +++ b/src/ansys/dpf/core/operators/math/accumulate.py @@ -20,8 +20,8 @@ class accumulate(Operator): point. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected weights: Field, optional @@ -29,7 +29,7 @@ class accumulate(Operator): time_scoping: Scoping, optional time_scoping - Returns + Outputs ------- field: Field Field containing the (weighted) sum for each component in an elementary data diff --git a/src/ansys/dpf/core/operators/math/accumulate_fc.py b/src/ansys/dpf/core/operators/math/accumulate_fc.py index 4b928b34c42..9a92e3985e7 100644 --- a/src/ansys/dpf/core/operators/math/accumulate_fc.py +++ b/src/ansys/dpf/core/operators/math/accumulate_fc.py @@ -20,8 +20,8 @@ class accumulate_fc(Operator): point. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected weights: Field, optional @@ -29,7 +29,7 @@ class accumulate_fc(Operator): time_scoping: Scoping, optional time_scoping - Returns + Outputs ------- fields_container: FieldsContainer Field containing the (weighted) sum for each component in an elementary data diff --git a/src/ansys/dpf/core/operators/math/accumulate_level_over_label_fc.py b/src/ansys/dpf/core/operators/math/accumulate_level_over_label_fc.py index e183a3f44bc..85e8dd0d877 100644 --- a/src/ansys/dpf/core/operators/math/accumulate_level_over_label_fc.py +++ b/src/ansys/dpf/core/operators/math/accumulate_level_over_label_fc.py @@ -24,13 +24,13 @@ class accumulate_level_over_label_fc(Operator): inputs. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer label: str, optional Label of the fields container where it should operate. If not defined and the input Fields Container has only one Label, the operation will be done over all the fields. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/accumulate_min_over_label_fc.py b/src/ansys/dpf/core/operators/math/accumulate_min_over_label_fc.py index 3f26665743b..35300321be3 100644 --- a/src/ansys/dpf/core/operators/math/accumulate_min_over_label_fc.py +++ b/src/ansys/dpf/core/operators/math/accumulate_min_over_label_fc.py @@ -23,13 +23,13 @@ class accumulate_min_over_label_fc(Operator): be on all the connected inputs. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer label: str, optional Label of the fields container where it should operate. If not defined and the input Fields Container has only one Label, the operation will be done over all the fields. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/accumulate_over_label_fc.py b/src/ansys/dpf/core/operators/math/accumulate_over_label_fc.py index dded7a898e0..7a15927ae57 100644 --- a/src/ansys/dpf/core/operators/math/accumulate_over_label_fc.py +++ b/src/ansys/dpf/core/operators/math/accumulate_over_label_fc.py @@ -23,13 +23,13 @@ class accumulate_over_label_fc(Operator): connected inputs. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer label: str, optional Label of the fields container where it should operate. If not defined and the input Fields Container has only one Label, the operation will be done over all the fields. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/accumulation_per_scoping.py b/src/ansys/dpf/core/operators/math/accumulation_per_scoping.py index 910f1817202..202fd1b97f8 100644 --- a/src/ansys/dpf/core/operators/math/accumulation_per_scoping.py +++ b/src/ansys/dpf/core/operators/math/accumulation_per_scoping.py @@ -20,8 +20,8 @@ class accumulation_per_scoping(Operator): input fields container for each scoping of the scopings container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer mesh_scoping: Scoping, optional Master scoping. All scopings in the Scopings Container will be intersected with this scoping. @@ -30,7 +30,7 @@ class accumulation_per_scoping(Operator): scopings_container: ScopingsContainer The intersection between the of the first will be used. - Returns + Outputs ------- accumulation_per_scoping: FieldsContainer accumulation_per_scoping_percentage: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/add.py b/src/ansys/dpf/core/operators/math/add.py index 1ce3a54e2ab..f4ba6be92c9 100644 --- a/src/ansys/dpf/core/operators/math/add.py +++ b/src/ansys/dpf/core/operators/math/add.py @@ -23,14 +23,14 @@ class add(Operator): use ‘inplace’ to reuse one of the fields. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer or float field or fields container with only one field is expected fieldB: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/add_constant.py b/src/ansys/dpf/core/operators/math/add_constant.py index 88582015d91..4c9558f3ae9 100644 --- a/src/ansys/dpf/core/operators/math/add_constant.py +++ b/src/ansys/dpf/core/operators/math/add_constant.py @@ -19,14 +19,14 @@ class add_constant(Operator): r"""Computes the sum of a field (in 0) and a scalar (in 1). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected weights: float double or vector of double - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/add_constant_fc.py b/src/ansys/dpf/core/operators/math/add_constant_fc.py index 49039882bb1..00d69bbdab6 100644 --- a/src/ansys/dpf/core/operators/math/add_constant_fc.py +++ b/src/ansys/dpf/core/operators/math/add_constant_fc.py @@ -19,14 +19,14 @@ class add_constant_fc(Operator): r"""Computes the sum of a field (in 0) and a scalar (in 1). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected weights: float double or vector of double - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/add_fc.py b/src/ansys/dpf/core/operators/math/add_fc.py index 436b709f927..1e70a6751c2 100644 --- a/src/ansys/dpf/core/operators/math/add_fc.py +++ b/src/ansys/dpf/core/operators/math/add_fc.py @@ -21,12 +21,12 @@ class add_fc(Operator): doubles, are put in input they are added to all the fields. - Parameters - ---------- + Inputs + ------ fields_container1: FieldsContainer or Field or float fields_container2: FieldsContainer or Field or float - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/amplitude.py b/src/ansys/dpf/core/operators/math/amplitude.py index 0983697da5c..06ee825831f 100644 --- a/src/ansys/dpf/core/operators/math/amplitude.py +++ b/src/ansys/dpf/core/operators/math/amplitude.py @@ -19,14 +19,14 @@ class amplitude(Operator): r"""Computes amplitude of a real and an imaginary field. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/amplitude_fc.py b/src/ansys/dpf/core/operators/math/amplitude_fc.py index 2567a1fc2c9..167755193e2 100644 --- a/src/ansys/dpf/core/operators/math/amplitude_fc.py +++ b/src/ansys/dpf/core/operators/math/amplitude_fc.py @@ -19,11 +19,11 @@ class amplitude_fc(Operator): r"""Computes the amplitude of a real and an imaginary field. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/average_over_label_fc.py b/src/ansys/dpf/core/operators/math/average_over_label_fc.py index 1b9a2fc7b56..9fe54b41902 100644 --- a/src/ansys/dpf/core/operators/math/average_over_label_fc.py +++ b/src/ansys/dpf/core/operators/math/average_over_label_fc.py @@ -23,13 +23,13 @@ class average_over_label_fc(Operator): be on all the connected inputs. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer label: str, optional Label of the fields container where it should operate. If not defined and the input Fields Container has only one Label, the operation will be done over all the fields. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/centroid.py b/src/ansys/dpf/core/operators/math/centroid.py index c62bbc2197f..dc4d46a610d 100644 --- a/src/ansys/dpf/core/operators/math/centroid.py +++ b/src/ansys/dpf/core/operators/math/centroid.py @@ -20,8 +20,8 @@ class centroid(Operator): field1\ *(1.-fact)+field2*\ (fact). Only works by index. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer @@ -29,7 +29,7 @@ class centroid(Operator): factor: float Scalar - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/centroid_fc.py b/src/ansys/dpf/core/operators/math/centroid_fc.py index 5afd4925be0..1520bd8ca8c 100644 --- a/src/ansys/dpf/core/operators/math/centroid_fc.py +++ b/src/ansys/dpf/core/operators/math/centroid_fc.py @@ -21,14 +21,14 @@ class centroid_fc(Operator): field1\ *(1.-fact)+field2*\ (fact). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer time_freq: float step: int, optional time_freq_support: TimeFreqSupport, optional - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/component_wise_divide.py b/src/ansys/dpf/core/operators/math/component_wise_divide.py index c5f33b01109..ca38ce1fe2b 100644 --- a/src/ansys/dpf/core/operators/math/component_wise_divide.py +++ b/src/ansys/dpf/core/operators/math/component_wise_divide.py @@ -23,14 +23,14 @@ class component_wise_divide(Operator): fields. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/component_wise_divide_fc.py b/src/ansys/dpf/core/operators/math/component_wise_divide_fc.py index c9ce086a27a..5f28f9c3319 100644 --- a/src/ansys/dpf/core/operators/math/component_wise_divide_fc.py +++ b/src/ansys/dpf/core/operators/math/component_wise_divide_fc.py @@ -23,12 +23,12 @@ class component_wise_divide_fc(Operator): entirely. - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer fields_containerB: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/component_wise_product.py b/src/ansys/dpf/core/operators/math/component_wise_product.py index 38c642ac874..19ad670f812 100644 --- a/src/ansys/dpf/core/operators/math/component_wise_product.py +++ b/src/ansys/dpf/core/operators/math/component_wise_product.py @@ -23,14 +23,14 @@ class component_wise_product(Operator): fields. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/component_wise_product_fc.py b/src/ansys/dpf/core/operators/math/component_wise_product_fc.py index 740ef216624..73a94e61254 100644 --- a/src/ansys/dpf/core/operators/math/component_wise_product_fc.py +++ b/src/ansys/dpf/core/operators/math/component_wise_product_fc.py @@ -23,14 +23,14 @@ class component_wise_product_fc(Operator): fields. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/compute_residual_and_error.py b/src/ansys/dpf/core/operators/math/compute_residual_and_error.py index 98d2727e3d6..d4157579a9c 100644 --- a/src/ansys/dpf/core/operators/math/compute_residual_and_error.py +++ b/src/ansys/dpf/core/operators/math/compute_residual_and_error.py @@ -26,8 +26,8 @@ class compute_residual_and_error(Operator): of error norm (L1 vs L2), and pin 3 which entity to use as a reference - Parameters - ---------- + Inputs + ------ field_or_fields_container1: Field or FieldsContainer field or fields container - compulsory normalization_type: int, optional @@ -45,7 +45,7 @@ class compute_residual_and_error(Operator): field_or_fields_container2: Field or FieldsContainer, optional field or fields container of same dimensionality as entry 1 - optional - Returns + Outputs ------- residuals: Field or FieldsContainer 0: normalized residuals (aka field 1 - field 2) as a field or field container, normalized depending on the normalization type diff --git a/src/ansys/dpf/core/operators/math/conjugate.py b/src/ansys/dpf/core/operators/math/conjugate.py index 1bb19a59c61..d5ce6357990 100644 --- a/src/ansys/dpf/core/operators/math/conjugate.py +++ b/src/ansys/dpf/core/operators/math/conjugate.py @@ -20,11 +20,11 @@ class conjugate(Operator): fields. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/correlation.py b/src/ansys/dpf/core/operators/math/correlation.py index 172b72735a3..e8c6660230b 100644 --- a/src/ansys/dpf/core/operators/math/correlation.py +++ b/src/ansys/dpf/core/operators/math/correlation.py @@ -21,8 +21,8 @@ class correlation(Operator): container), correlation is computed for each of them. - Parameters - ---------- + Inputs + ------ fieldA: Field or float Field a. The reference field. fieldB: Field or FieldsContainer @@ -32,7 +32,7 @@ class correlation(Operator): absoluteValue: bool If true, correlation factor is ||aMb||/(||aMa||.||bMb||) - Returns + Outputs ------- field: Field Correlation factor for each input field b. diff --git a/src/ansys/dpf/core/operators/math/cos.py b/src/ansys/dpf/core/operators/math/cos.py index ee1baa2b3ba..6a8a0730173 100644 --- a/src/ansys/dpf/core/operators/math/cos.py +++ b/src/ansys/dpf/core/operators/math/cos.py @@ -19,12 +19,12 @@ class cos(Operator): r"""Computes element-wise cos(field[i]). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/cos_fc.py b/src/ansys/dpf/core/operators/math/cos_fc.py index d743f1044e2..0a48de07cc6 100644 --- a/src/ansys/dpf/core/operators/math/cos_fc.py +++ b/src/ansys/dpf/core/operators/math/cos_fc.py @@ -19,12 +19,12 @@ class cos_fc(Operator): r"""Computes element-wise cos(field[i]). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/cplx_derive.py b/src/ansys/dpf/core/operators/math/cplx_derive.py index 85368e55097..7d7b4496c9c 100644 --- a/src/ansys/dpf/core/operators/math/cplx_derive.py +++ b/src/ansys/dpf/core/operators/math/cplx_derive.py @@ -19,11 +19,11 @@ class cplx_derive(Operator): r"""Derives field containers containing complex fields. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/cplx_divide.py b/src/ansys/dpf/core/operators/math/cplx_divide.py index 700b12a31e2..3ac51fc6382 100644 --- a/src/ansys/dpf/core/operators/math/cplx_divide.py +++ b/src/ansys/dpf/core/operators/math/cplx_divide.py @@ -20,12 +20,12 @@ class cplx_divide(Operator): fields. - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer fields_containerB: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/cplx_dot.py b/src/ansys/dpf/core/operators/math/cplx_dot.py index 05df448b8f4..f6223697080 100644 --- a/src/ansys/dpf/core/operators/math/cplx_dot.py +++ b/src/ansys/dpf/core/operators/math/cplx_dot.py @@ -19,12 +19,12 @@ class cplx_dot(Operator): r"""Computes product between two field containers containing complex fields. - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer fields_containerB: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/cplx_multiply.py b/src/ansys/dpf/core/operators/math/cplx_multiply.py index fae09f296b8..21569499b62 100644 --- a/src/ansys/dpf/core/operators/math/cplx_multiply.py +++ b/src/ansys/dpf/core/operators/math/cplx_multiply.py @@ -20,12 +20,12 @@ class cplx_multiply(Operator): fields. - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer fields_containerB: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/cross_product.py b/src/ansys/dpf/core/operators/math/cross_product.py index 5e38dc6823d..90704582471 100644 --- a/src/ansys/dpf/core/operators/math/cross_product.py +++ b/src/ansys/dpf/core/operators/math/cross_product.py @@ -20,14 +20,14 @@ class cross_product(Operator): same location or Elemental Nodal and Nodal locations. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer or float field or fields container with only one field is expected fieldB: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/cross_product_fc.py b/src/ansys/dpf/core/operators/math/cross_product_fc.py index 0c9a378bfdb..d28d02a4c91 100644 --- a/src/ansys/dpf/core/operators/math/cross_product_fc.py +++ b/src/ansys/dpf/core/operators/math/cross_product_fc.py @@ -20,14 +20,14 @@ class cross_product_fc(Operator): same location or Elemental Nodal and Nodal locations. - Parameters - ---------- + Inputs + ------ field_or_fields_container_A: Field or FieldsContainer or float field or fields container with only one field is expected field_or_fields_container_B: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/dot.py b/src/ansys/dpf/core/operators/math/dot.py index 17fbcc0e182..d0942bedf76 100644 --- a/src/ansys/dpf/core/operators/math/dot.py +++ b/src/ansys/dpf/core/operators/math/dot.py @@ -24,14 +24,14 @@ class dot(Operator): fields are scalar. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/dot_tensor.py b/src/ansys/dpf/core/operators/math/dot_tensor.py index e7c8e05fefa..8630431e9f7 100644 --- a/src/ansys/dpf/core/operators/math/dot_tensor.py +++ b/src/ansys/dpf/core/operators/math/dot_tensor.py @@ -20,14 +20,14 @@ class dot_tensor(Operator): dot product between two tensor fields. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/entity_extractor.py b/src/ansys/dpf/core/operators/math/entity_extractor.py index e7f16d76d12..0fc4910ace7 100644 --- a/src/ansys/dpf/core/operators/math/entity_extractor.py +++ b/src/ansys/dpf/core/operators/math/entity_extractor.py @@ -19,12 +19,12 @@ class entity_extractor(Operator): r"""Extracts an entity from a field, based on its ID. - Parameters - ---------- + Inputs + ------ fieldA: Field scalar_int: int - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/expansion_psd.py b/src/ansys/dpf/core/operators/math/expansion_psd.py index 26d0e008bc3..c8b40239938 100644 --- a/src/ansys/dpf/core/operators/math/expansion_psd.py +++ b/src/ansys/dpf/core/operators/math/expansion_psd.py @@ -19,8 +19,8 @@ class expansion_psd(Operator): r"""Computes the PSD response for one-sigma solution. - Parameters - ---------- + Inputs + ------ mode_shapes: FieldsContainer Fields container containing the mode shapes from modal analysis file: mode shapes for dynamic and pseudo-static displacements static_shapes: FieldsContainer, optional @@ -32,7 +32,7 @@ class expansion_psd(Operator): rel_stat_covar_matrix: FieldsContainer, optional Fields container containing covariance matrices from a psd file: covariance matrix terms for displacement/velocity/acceleration mode-static shapes - Returns + Outputs ------- psd: FieldsContainer PSD solution per label diff --git a/src/ansys/dpf/core/operators/math/exponential.py b/src/ansys/dpf/core/operators/math/exponential.py index 9273ac147d2..c10da668fd8 100644 --- a/src/ansys/dpf/core/operators/math/exponential.py +++ b/src/ansys/dpf/core/operators/math/exponential.py @@ -19,12 +19,12 @@ class exponential(Operator): r"""Computes element-wise exp(field[i]). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/exponential_fc.py b/src/ansys/dpf/core/operators/math/exponential_fc.py index 2678e57a50f..bfdf9dc055c 100644 --- a/src/ansys/dpf/core/operators/math/exponential_fc.py +++ b/src/ansys/dpf/core/operators/math/exponential_fc.py @@ -19,12 +19,12 @@ class exponential_fc(Operator): r"""Computes element-wise exp(field[i]). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/fft_approx.py b/src/ansys/dpf/core/operators/math/fft_approx.py index 907dda43756..34706adb981 100644 --- a/src/ansys/dpf/core/operators/math/fft_approx.py +++ b/src/ansys/dpf/core/operators/math/fft_approx.py @@ -21,8 +21,8 @@ class fft_approx(Operator): first and the second derivatives of the curve. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional A time scoping to rescope / split the fields container given as input. mesh_scoping: Scoping or ScopingsContainer, optional @@ -40,7 +40,7 @@ class fft_approx(Operator): cutoff_fr: float or int, optional Cutoff frequency. - Returns + Outputs ------- fitted_entity_y: FieldsContainer The fitted entity is fitted using FFT along the space scoping (node i: x=time, y=data). Fitted Y is expected to be close to the input data. diff --git a/src/ansys/dpf/core/operators/math/fft_eval.py b/src/ansys/dpf/core/operators/math/fft_eval.py index 7801b742729..43976542cb4 100644 --- a/src/ansys/dpf/core/operators/math/fft_eval.py +++ b/src/ansys/dpf/core/operators/math/fft_eval.py @@ -19,14 +19,14 @@ class fft_eval(Operator): r"""Evaluate the fast fourier transforms at a given set of fields. - Parameters - ---------- + Inputs + ------ field_t: Field field of values to evaluate time_scoping: Scoping, optional if specified only the results at these set ids are used - Returns + Outputs ------- field: Field offset: Field diff --git a/src/ansys/dpf/core/operators/math/fft_gradient_eval.py b/src/ansys/dpf/core/operators/math/fft_gradient_eval.py index bedda038587..183cd636476 100644 --- a/src/ansys/dpf/core/operators/math/fft_gradient_eval.py +++ b/src/ansys/dpf/core/operators/math/fft_gradient_eval.py @@ -20,15 +20,15 @@ class fft_gradient_eval(Operator): using gradient method for adaptative time step. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer time_scoping: Scoping, optional if specified only the results at these set ids are used fs_ratio: int, optional default value = 20 - Returns + Outputs ------- coefficients: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/fft_multi_harmonic_minmax.py b/src/ansys/dpf/core/operators/math/fft_multi_harmonic_minmax.py index 311dccbdc41..d9a5834c04f 100644 --- a/src/ansys/dpf/core/operators/math/fft_multi_harmonic_minmax.py +++ b/src/ansys/dpf/core/operators/math/fft_multi_harmonic_minmax.py @@ -21,8 +21,8 @@ class fft_multi_harmonic_minmax(Operator): using the gradient method for adaptive time steping - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer rpm_scoping: Scoping, optional rpm scoping, by default the fourier series sum is evaluated using all the rpms @@ -41,7 +41,7 @@ class fft_multi_harmonic_minmax(Operator): substeps_selector: optional substeps to evaluate (frequencies), by default the operator is evaluated using all the available steps - Returns + Outputs ------- field_min: FieldsContainer field_max: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/generalized_inner_product.py b/src/ansys/dpf/core/operators/math/generalized_inner_product.py index 3d201757c30..ba35128a2ee 100644 --- a/src/ansys/dpf/core/operators/math/generalized_inner_product.py +++ b/src/ansys/dpf/core/operators/math/generalized_inner_product.py @@ -20,14 +20,14 @@ class generalized_inner_product(Operator): possibly different dimensionality. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer or float field or fields container with only one field is expected fieldB: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/generalized_inner_product_fc.py b/src/ansys/dpf/core/operators/math/generalized_inner_product_fc.py index b23e427596c..d6274c1114d 100644 --- a/src/ansys/dpf/core/operators/math/generalized_inner_product_fc.py +++ b/src/ansys/dpf/core/operators/math/generalized_inner_product_fc.py @@ -20,14 +20,14 @@ class generalized_inner_product_fc(Operator): possibly different dimensionality. - Parameters - ---------- + Inputs + ------ field_or_fields_container_A: Field or FieldsContainer or float field or fields container with only one field is expected field_or_fields_container_B: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/img_part.py b/src/ansys/dpf/core/operators/math/img_part.py index 7cdad119bcd..dea6ae9de7f 100644 --- a/src/ansys/dpf/core/operators/math/img_part.py +++ b/src/ansys/dpf/core/operators/math/img_part.py @@ -20,11 +20,11 @@ class img_part(Operator): complex fields. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/invert.py b/src/ansys/dpf/core/operators/math/invert.py index b6cb2eaf18b..ab27823ed36 100644 --- a/src/ansys/dpf/core/operators/math/invert.py +++ b/src/ansys/dpf/core/operators/math/invert.py @@ -20,12 +20,12 @@ class invert(Operator): component-wise inverse of a field (1./x). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/invert_fc.py b/src/ansys/dpf/core/operators/math/invert_fc.py index 893727c8b10..efa8c50e989 100644 --- a/src/ansys/dpf/core/operators/math/invert_fc.py +++ b/src/ansys/dpf/core/operators/math/invert_fc.py @@ -20,12 +20,12 @@ class invert_fc(Operator): component-wise inverse of a field (1./x). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/kronecker_prod.py b/src/ansys/dpf/core/operators/math/kronecker_prod.py index 65540b7caea..a6e05b00765 100644 --- a/src/ansys/dpf/core/operators/math/kronecker_prod.py +++ b/src/ansys/dpf/core/operators/math/kronecker_prod.py @@ -19,14 +19,14 @@ class kronecker_prod(Operator): r"""Computes element-wise Kronecker product between two tensor fields. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/linear_combination.py b/src/ansys/dpf/core/operators/math/linear_combination.py index 9e6bb87b69e..d0452e5f286 100644 --- a/src/ansys/dpf/core/operators/math/linear_combination.py +++ b/src/ansys/dpf/core/operators/math/linear_combination.py @@ -20,8 +20,8 @@ class linear_combination(Operator): are complex numbers. - Parameters - ---------- + Inputs + ------ a: float Double fields_containerA: FieldsContainer @@ -30,7 +30,7 @@ class linear_combination(Operator): Double fields_containerC: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/ln.py b/src/ansys/dpf/core/operators/math/ln.py index 96632c82e4f..326e760242e 100644 --- a/src/ansys/dpf/core/operators/math/ln.py +++ b/src/ansys/dpf/core/operators/math/ln.py @@ -19,12 +19,12 @@ class ln(Operator): r"""Computes element-wise ln(field[i]). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/ln_fc.py b/src/ansys/dpf/core/operators/math/ln_fc.py index 8528bf5416b..ee0fbc9f4ff 100644 --- a/src/ansys/dpf/core/operators/math/ln_fc.py +++ b/src/ansys/dpf/core/operators/math/ln_fc.py @@ -19,12 +19,12 @@ class ln_fc(Operator): r"""Computes element-wise ln(field[i]). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/mac.py b/src/ansys/dpf/core/operators/math/mac.py index 30dd82ab32f..74a38531e1b 100644 --- a/src/ansys/dpf/core/operators/math/mac.py +++ b/src/ansys/dpf/core/operators/math/mac.py @@ -22,8 +22,8 @@ class mac(Operator): an user responsability. - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer Fields Container A. fields_containerB: FieldsContainer @@ -31,7 +31,7 @@ class mac(Operator): weights: Field Field M, optional weighting for MAC Matrix computation. - Returns + Outputs ------- field: Field MAC Matrix for all the combinations between mode fields of Field Container A and Field Container B. Results listed row by row. diff --git a/src/ansys/dpf/core/operators/math/make_one_on_comp.py b/src/ansys/dpf/core/operators/math/make_one_on_comp.py index f4d8c667848..f14b9bce1c8 100644 --- a/src/ansys/dpf/core/operators/math/make_one_on_comp.py +++ b/src/ansys/dpf/core/operators/math/make_one_on_comp.py @@ -20,12 +20,12 @@ class make_one_on_comp(Operator): except for the indexes from pin 1 that will hold 1.0. - Parameters - ---------- + Inputs + ------ fieldA: Field scalar_int: int - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/matrix_inverse.py b/src/ansys/dpf/core/operators/math/matrix_inverse.py index cbce3e1ec9e..0996a5cdd8c 100644 --- a/src/ansys/dpf/core/operators/math/matrix_inverse.py +++ b/src/ansys/dpf/core/operators/math/matrix_inverse.py @@ -20,12 +20,12 @@ class matrix_inverse(Operator): container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields_container - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/min_max_over_time.py b/src/ansys/dpf/core/operators/math/min_max_over_time.py index 6b337ffb193..7ac6667f64e 100644 --- a/src/ansys/dpf/core/operators/math/min_max_over_time.py +++ b/src/ansys/dpf/core/operators/math/min_max_over_time.py @@ -19,13 +19,13 @@ class min_max_over_time(Operator): r"""Evaluates minimum/maximum over time/frequency. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer int32: int Define min or max. - Returns + Outputs ------- field_container_1: FieldsContainer field_container_2: FieldsContainer, optional diff --git a/src/ansys/dpf/core/operators/math/minus.py b/src/ansys/dpf/core/operators/math/minus.py index baba64d0959..620dc960db5 100644 --- a/src/ansys/dpf/core/operators/math/minus.py +++ b/src/ansys/dpf/core/operators/math/minus.py @@ -22,14 +22,14 @@ class minus(Operator): ‘inplace’ to reuse one of the fields. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer or float field or fields container with only one field is expected fieldB: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/minus_fc.py b/src/ansys/dpf/core/operators/math/minus_fc.py index 24c4f430c53..fa0e9ff656c 100644 --- a/src/ansys/dpf/core/operators/math/minus_fc.py +++ b/src/ansys/dpf/core/operators/math/minus_fc.py @@ -22,14 +22,14 @@ class minus_fc(Operator): ‘inplace’ to reuse one of the fields. - Parameters - ---------- + Inputs + ------ field_or_fields_container_A: Field or FieldsContainer or float field or fields container with only one field is expected field_or_fields_container_B: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/modal_damping_ratio.py b/src/ansys/dpf/core/operators/math/modal_damping_ratio.py index 0f97ce6f5ec..dd3a7797c68 100644 --- a/src/ansys/dpf/core/operators/math/modal_damping_ratio.py +++ b/src/ansys/dpf/core/operators/math/modal_damping_ratio.py @@ -20,8 +20,8 @@ class modal_damping_ratio(Operator): m_coefficient / (2\ *omega_i) + k_coefficient* omega_i/2. - Parameters - ---------- + Inputs + ------ natural_freq: input vector expects natural frequencies. const_ratio: float, optional @@ -33,7 +33,7 @@ class modal_damping_ratio(Operator): k_coefficient: float global stiffness matrix multiplier - Returns + Outputs ------- field: Field field of modal damping ratio. diff --git a/src/ansys/dpf/core/operators/math/modal_superposition.py b/src/ansys/dpf/core/operators/math/modal_superposition.py index 32b1993cbe7..eca623d4efa 100644 --- a/src/ansys/dpf/core/operators/math/modal_superposition.py +++ b/src/ansys/dpf/core/operators/math/modal_superposition.py @@ -21,8 +21,8 @@ class modal_superposition(Operator): (coefficients for each mode for each time/frequency) (in 1). - Parameters - ---------- + Inputs + ------ modal_basis: FieldsContainer One field by mode with each field representing a mode shape on nodes or elements. solution_in_modal_space: FieldsContainer @@ -34,7 +34,7 @@ class modal_superposition(Operator): mesh_scoping: Scoping or ScopingsContainer, optional Compute the result on a subset of the space domain defined in the modal_basis fields container. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/modulus.py b/src/ansys/dpf/core/operators/math/modulus.py index 6d80ebdd382..8a5acefd5dd 100644 --- a/src/ansys/dpf/core/operators/math/modulus.py +++ b/src/ansys/dpf/core/operators/math/modulus.py @@ -20,11 +20,11 @@ class modulus(Operator): fields. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/norm.py b/src/ansys/dpf/core/operators/math/norm.py index b976204c84e..b65967ca145 100644 --- a/src/ansys/dpf/core/operators/math/norm.py +++ b/src/ansys/dpf/core/operators/math/norm.py @@ -20,14 +20,14 @@ class norm(Operator): Lp=L2 - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected scalar_int: int, optional Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/norm_fc.py b/src/ansys/dpf/core/operators/math/norm_fc.py index b746319e632..03d1e98f9d2 100644 --- a/src/ansys/dpf/core/operators/math/norm_fc.py +++ b/src/ansys/dpf/core/operators/math/norm_fc.py @@ -20,13 +20,13 @@ class norm_fc(Operator): process is applied on each field of the input fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer scalar_int: int, optional Lp normalisation type, p = 1, 2, ...n - Default Lp=2 - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/outer_product.py b/src/ansys/dpf/core/operators/math/outer_product.py index 779f469bc82..cc81e94b48a 100644 --- a/src/ansys/dpf/core/operators/math/outer_product.py +++ b/src/ansys/dpf/core/operators/math/outer_product.py @@ -19,14 +19,14 @@ class outer_product(Operator): r"""Computes the outer product of two vector fields. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer or float field or fields container with only one field is expected fieldB: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/overall_dot.py b/src/ansys/dpf/core/operators/math/overall_dot.py index 8de00fda1e2..9c74348aa3f 100644 --- a/src/ansys/dpf/core/operators/math/overall_dot.py +++ b/src/ansys/dpf/core/operators/math/overall_dot.py @@ -20,12 +20,12 @@ class overall_dot(Operator): large vector) and returns a scalar. - Parameters - ---------- + Inputs + ------ fieldA: Field fieldB: Field - Returns + Outputs ------- field: Field Field defined on over-all location, contains a unique scalar value diff --git a/src/ansys/dpf/core/operators/math/phase.py b/src/ansys/dpf/core/operators/math/phase.py index 822d7ce822d..d2af3639f66 100644 --- a/src/ansys/dpf/core/operators/math/phase.py +++ b/src/ansys/dpf/core/operators/math/phase.py @@ -19,14 +19,14 @@ class phase(Operator): r"""Computes the phase (in rad) between a real and an imaginary field. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/phase_fc.py b/src/ansys/dpf/core/operators/math/phase_fc.py index 17a5114d8a7..708e188ac53 100644 --- a/src/ansys/dpf/core/operators/math/phase_fc.py +++ b/src/ansys/dpf/core/operators/math/phase_fc.py @@ -19,11 +19,11 @@ class phase_fc(Operator): r"""Computes phase (in rad) between real and imaginary fields. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/polar_to_cplx.py b/src/ansys/dpf/core/operators/math/polar_to_cplx.py index 9efa3b491e5..7c555c880bb 100644 --- a/src/ansys/dpf/core/operators/math/polar_to_cplx.py +++ b/src/ansys/dpf/core/operators/math/polar_to_cplx.py @@ -19,11 +19,11 @@ class polar_to_cplx(Operator): r"""Converts a complex number from polar form to complex. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/pow.py b/src/ansys/dpf/core/operators/math/pow.py index 08f31176c18..8f56a30434c 100644 --- a/src/ansys/dpf/core/operators/math/pow.py +++ b/src/ansys/dpf/core/operators/math/pow.py @@ -19,12 +19,12 @@ class pow(Operator): r"""Computes element-wise field[i]^p. - Parameters - ---------- + Inputs + ------ field: Field factor: float - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/pow_fc.py b/src/ansys/dpf/core/operators/math/pow_fc.py index 1f5f40dd039..0d30bad2ff2 100644 --- a/src/ansys/dpf/core/operators/math/pow_fc.py +++ b/src/ansys/dpf/core/operators/math/pow_fc.py @@ -19,12 +19,12 @@ class pow_fc(Operator): r"""Computes element-wise field[i]^p. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer factor: float - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/qr_solve.py b/src/ansys/dpf/core/operators/math/qr_solve.py index 34d494a0cff..3fb306b0185 100644 --- a/src/ansys/dpf/core/operators/math/qr_solve.py +++ b/src/ansys/dpf/core/operators/math/qr_solve.py @@ -19,14 +19,14 @@ class qr_solve(Operator): r"""Computes the solution using QR factorization. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields_container rhs: FieldsContainer fields_container - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/real_part.py b/src/ansys/dpf/core/operators/math/real_part.py index 817e3f736c0..81097b050b9 100644 --- a/src/ansys/dpf/core/operators/math/real_part.py +++ b/src/ansys/dpf/core/operators/math/real_part.py @@ -20,11 +20,11 @@ class real_part(Operator): fields. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/relative_error.py b/src/ansys/dpf/core/operators/math/relative_error.py index 4d1d910924e..b18b0f3da27 100644 --- a/src/ansys/dpf/core/operators/math/relative_error.py +++ b/src/ansys/dpf/core/operators/math/relative_error.py @@ -20,14 +20,14 @@ class relative_error(Operator): scalar field. - Parameters - ---------- + Inputs + ------ value: Field or FieldsContainer or float field or fields container with only one field is expected reference: Field or FieldsContainer or float field or fields container with only one field is expected - Returns + Outputs ------- field: Field zero_ref_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/math/scale.py b/src/ansys/dpf/core/operators/math/scale.py index 5636dbd490f..4c95bc1a052 100644 --- a/src/ansys/dpf/core/operators/math/scale.py +++ b/src/ansys/dpf/core/operators/math/scale.py @@ -22,8 +22,8 @@ class scale(Operator): dimensionality - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected weights: float or Field @@ -33,7 +33,7 @@ class scale(Operator): algorithm: int, optional Default is 0 use mkl. If set to 1, don't - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/scale_by_field.py b/src/ansys/dpf/core/operators/math/scale_by_field.py index 40b6b7e47d7..928d66ea814 100644 --- a/src/ansys/dpf/core/operators/math/scale_by_field.py +++ b/src/ansys/dpf/core/operators/math/scale_by_field.py @@ -21,14 +21,14 @@ class scale_by_field(Operator): field’s values are applied on the other field entirely. - Parameters - ---------- + Inputs + ------ fieldA: Field or FieldsContainer field or fields container with only one field is expected fieldB: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/scale_by_field_fc.py b/src/ansys/dpf/core/operators/math/scale_by_field_fc.py index db1d588e0fa..a31a6039167 100644 --- a/src/ansys/dpf/core/operators/math/scale_by_field_fc.py +++ b/src/ansys/dpf/core/operators/math/scale_by_field_fc.py @@ -21,14 +21,14 @@ class scale_by_field_fc(Operator): field’s values are applied on the other field entirely. - Parameters - ---------- + Inputs + ------ field_or_fields_container_A: Field or FieldsContainer field or fields container with only one field is expected field_or_fields_container_B: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/scale_fc.py b/src/ansys/dpf/core/operators/math/scale_fc.py index 791f9af3344..7dac236c4e8 100644 --- a/src/ansys/dpf/core/operators/math/scale_fc.py +++ b/src/ansys/dpf/core/operators/math/scale_fc.py @@ -22,8 +22,8 @@ class scale_fc(Operator): corresponding to the input field dimensionality - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields container to be scaled weights: float or Field or FieldsContainer @@ -33,7 +33,7 @@ class scale_fc(Operator): algorithm: int, optional Default is 0 use mkl. If set to 1, don't - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/sin.py b/src/ansys/dpf/core/operators/math/sin.py index 32a56ade816..3d4371f50fd 100644 --- a/src/ansys/dpf/core/operators/math/sin.py +++ b/src/ansys/dpf/core/operators/math/sin.py @@ -19,11 +19,11 @@ class sin(Operator): r"""Computes element-wise sin(field[i]). - Parameters - ---------- + Inputs + ------ field: Field - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/sin_fc.py b/src/ansys/dpf/core/operators/math/sin_fc.py index 7d64d6e5c71..7daa5a8b62f 100644 --- a/src/ansys/dpf/core/operators/math/sin_fc.py +++ b/src/ansys/dpf/core/operators/math/sin_fc.py @@ -19,11 +19,11 @@ class sin_fc(Operator): r"""Computes element-wise sin(field[i]). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/sqr.py b/src/ansys/dpf/core/operators/math/sqr.py index f4fba729bdd..ff30cf6464c 100644 --- a/src/ansys/dpf/core/operators/math/sqr.py +++ b/src/ansys/dpf/core/operators/math/sqr.py @@ -19,12 +19,12 @@ class sqr(Operator): r"""Computes element-wise field[i]^2. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/sqr_fc.py b/src/ansys/dpf/core/operators/math/sqr_fc.py index 06cd726380b..d92d20ea515 100644 --- a/src/ansys/dpf/core/operators/math/sqr_fc.py +++ b/src/ansys/dpf/core/operators/math/sqr_fc.py @@ -19,12 +19,12 @@ class sqr_fc(Operator): r"""Computes element-wise field[i]^2. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/sqrt.py b/src/ansys/dpf/core/operators/math/sqrt.py index 4e84d5a18c8..cce91f5c010 100644 --- a/src/ansys/dpf/core/operators/math/sqrt.py +++ b/src/ansys/dpf/core/operators/math/sqrt.py @@ -19,12 +19,12 @@ class sqrt(Operator): r"""Computes element-wise sqrt(field1). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/sqrt_fc.py b/src/ansys/dpf/core/operators/math/sqrt_fc.py index 5eade71e0b7..02e220e286d 100644 --- a/src/ansys/dpf/core/operators/math/sqrt_fc.py +++ b/src/ansys/dpf/core/operators/math/sqrt_fc.py @@ -19,12 +19,12 @@ class sqrt_fc(Operator): r"""Computes element-wise sqrt(field1). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/svd.py b/src/ansys/dpf/core/operators/math/svd.py index d97c9475108..e60d8685194 100644 --- a/src/ansys/dpf/core/operators/math/svd.py +++ b/src/ansys/dpf/core/operators/math/svd.py @@ -20,12 +20,12 @@ class svd(Operator): the given fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields_container - Returns + Outputs ------- s_svd: FieldsContainer Singular values of the input data, where A=U.S.Vt diff --git a/src/ansys/dpf/core/operators/math/sweeping_phase.py b/src/ansys/dpf/core/operators/math/sweeping_phase.py index 42d199d15ee..23191b1de6b 100644 --- a/src/ansys/dpf/core/operators/math/sweeping_phase.py +++ b/src/ansys/dpf/core/operators/math/sweeping_phase.py @@ -22,8 +22,8 @@ class sweeping_phase(Operator): imaginary_field\ ``*``\ sin(angle). - Parameters - ---------- + Inputs + ------ real_field: Field or FieldsContainer field or fields container with only one field is expected imaginary_field: Field or FieldsContainer @@ -35,7 +35,7 @@ class sweeping_phase(Operator): imaginary_part_null: bool If the imaginary part field is empty and this pin is true, then the imaginary part is supposed to be 0 (default is false). - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/sweeping_phase_fc.py b/src/ansys/dpf/core/operators/math/sweeping_phase_fc.py index 3362c3cf2fb..d2d5022b298 100644 --- a/src/ansys/dpf/core/operators/math/sweeping_phase_fc.py +++ b/src/ansys/dpf/core/operators/math/sweeping_phase_fc.py @@ -23,15 +23,15 @@ class sweeping_phase_fc(Operator): imaginary_field\ ``*``\ sin(angle). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer angle: float unit_name: str, optional String Unit. Supported values: "deg" or "rad". Default: "rad". abs_value: bool - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/time_derivation.py b/src/ansys/dpf/core/operators/math/time_derivation.py index 69a1db95bf0..63558325cff 100644 --- a/src/ansys/dpf/core/operators/math/time_derivation.py +++ b/src/ansys/dpf/core/operators/math/time_derivation.py @@ -19,14 +19,14 @@ class time_derivation(Operator): r"""Derives a field of time varying quantities with respect to time - Parameters - ---------- + Inputs + ------ field: Field field spline_fitting: bool, optional Uses spline fitting on the input field to compute smooth derivatives - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/time_freq_interpolation.py b/src/ansys/dpf/core/operators/math/time_freq_interpolation.py index 13e69eb1360..2dd7dac20da 100644 --- a/src/ansys/dpf/core/operators/math/time_freq_interpolation.py +++ b/src/ansys/dpf/core/operators/math/time_freq_interpolation.py @@ -24,8 +24,8 @@ class time_freq_interpolation(Operator): fields container - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer time_freq_values: float or Field list of frequencies or times needed. To specify load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". @@ -37,7 +37,7 @@ class time_freq_interpolation(Operator): If set to true, the output fields container will always have a new time freq support rescoped to the output time_freq_values (default is false). If set to false, the time freq support is only recreated when time or frequency values are between existing ones. time_freq_support: TimeFreqSupport, optional - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/time_integration.py b/src/ansys/dpf/core/operators/math/time_integration.py index de009789174..77bcad3444f 100644 --- a/src/ansys/dpf/core/operators/math/time_integration.py +++ b/src/ansys/dpf/core/operators/math/time_integration.py @@ -19,8 +19,8 @@ class time_integration(Operator): r"""Integrates a field of time varying quantities over time - Parameters - ---------- + Inputs + ------ field: Field field resample_output: bool, optional @@ -32,7 +32,7 @@ class time_integration(Operator): integration_constant: float, optional Constant to be added to the integrated field - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/math/unit_convert.py b/src/ansys/dpf/core/operators/math/unit_convert.py index 627d79a8779..6aa740eed6a 100644 --- a/src/ansys/dpf/core/operators/math/unit_convert.py +++ b/src/ansys/dpf/core/operators/math/unit_convert.py @@ -21,13 +21,13 @@ class unit_convert(Operator): another unit. - Parameters - ---------- + Inputs + ------ entity_to_convert: Field or FieldsContainer or MeshedRegion or MeshesContainer unit_name: str or int or Field unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's ID, or a field from which expected unit will be extracted. - Returns + Outputs ------- converted_entity: Field or FieldsContainer or MeshedRegion or MeshesContainer the output entity is the same as the input (inplace operator) diff --git a/src/ansys/dpf/core/operators/math/unit_convert_fc.py b/src/ansys/dpf/core/operators/math/unit_convert_fc.py index cf21b330d59..ee86af52599 100644 --- a/src/ansys/dpf/core/operators/math/unit_convert_fc.py +++ b/src/ansys/dpf/core/operators/math/unit_convert_fc.py @@ -19,13 +19,13 @@ class unit_convert_fc(Operator): r"""Converts an input fields container of a given unit to another unit. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer unit_name: str unit as a string, ex 'm' for meter, 'Pa' for pascal,... - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_bartlett.py b/src/ansys/dpf/core/operators/math/window_bartlett.py index 50e8194d51c..ab0f7976208 100644 --- a/src/ansys/dpf/core/operators/math/window_bartlett.py +++ b/src/ansys/dpf/core/operators/math/window_bartlett.py @@ -22,11 +22,11 @@ class window_bartlett(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field or FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_bartlett_fc.py b/src/ansys/dpf/core/operators/math/window_bartlett_fc.py index 5d419691639..e46a4b2fea6 100644 --- a/src/ansys/dpf/core/operators/math/window_bartlett_fc.py +++ b/src/ansys/dpf/core/operators/math/window_bartlett_fc.py @@ -21,11 +21,11 @@ class window_bartlett_fc(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_blackman.py b/src/ansys/dpf/core/operators/math/window_blackman.py index 1c373c11ce4..d531162b87b 100644 --- a/src/ansys/dpf/core/operators/math/window_blackman.py +++ b/src/ansys/dpf/core/operators/math/window_blackman.py @@ -22,11 +22,11 @@ class window_blackman(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field or FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_blackman_fc.py b/src/ansys/dpf/core/operators/math/window_blackman_fc.py index 202e9526860..4eb75e6c532 100644 --- a/src/ansys/dpf/core/operators/math/window_blackman_fc.py +++ b/src/ansys/dpf/core/operators/math/window_blackman_fc.py @@ -21,11 +21,11 @@ class window_blackman_fc(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_hamming.py b/src/ansys/dpf/core/operators/math/window_hamming.py index d3c843b871c..233957d1515 100644 --- a/src/ansys/dpf/core/operators/math/window_hamming.py +++ b/src/ansys/dpf/core/operators/math/window_hamming.py @@ -22,11 +22,11 @@ class window_hamming(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field or FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_hamming_fc.py b/src/ansys/dpf/core/operators/math/window_hamming_fc.py index 1cadd861f2a..36ab5bbb218 100644 --- a/src/ansys/dpf/core/operators/math/window_hamming_fc.py +++ b/src/ansys/dpf/core/operators/math/window_hamming_fc.py @@ -21,11 +21,11 @@ class window_hamming_fc(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_hanning.py b/src/ansys/dpf/core/operators/math/window_hanning.py index 57bca04ced1..5ba1a4830f3 100644 --- a/src/ansys/dpf/core/operators/math/window_hanning.py +++ b/src/ansys/dpf/core/operators/math/window_hanning.py @@ -22,11 +22,11 @@ class window_hanning(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field or FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_hanning_fc.py b/src/ansys/dpf/core/operators/math/window_hanning_fc.py index c410a87c173..6c885aff12b 100644 --- a/src/ansys/dpf/core/operators/math/window_hanning_fc.py +++ b/src/ansys/dpf/core/operators/math/window_hanning_fc.py @@ -21,11 +21,11 @@ class window_hanning_fc(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_triangular.py b/src/ansys/dpf/core/operators/math/window_triangular.py index dcb26fe1513..6d1b4ad54ea 100644 --- a/src/ansys/dpf/core/operators/math/window_triangular.py +++ b/src/ansys/dpf/core/operators/math/window_triangular.py @@ -22,11 +22,11 @@ class window_triangular(Operator): (use time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field or FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_triangular_fc.py b/src/ansys/dpf/core/operators/math/window_triangular_fc.py index f2c11b678c9..e9d27f293a1 100644 --- a/src/ansys/dpf/core/operators/math/window_triangular_fc.py +++ b/src/ansys/dpf/core/operators/math/window_triangular_fc.py @@ -21,11 +21,11 @@ class window_triangular_fc(Operator): (use time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_welch.py b/src/ansys/dpf/core/operators/math/window_welch.py index a436e5f5f49..98c7f504ae9 100644 --- a/src/ansys/dpf/core/operators/math/window_welch.py +++ b/src/ansys/dpf/core/operators/math/window_welch.py @@ -22,11 +22,11 @@ class window_welch(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer - Returns + Outputs ------- field: Field or FieldsContainer diff --git a/src/ansys/dpf/core/operators/math/window_welch_fc.py b/src/ansys/dpf/core/operators/math/window_welch_fc.py index 27ee3c55acb..8ba72d89f8c 100644 --- a/src/ansys/dpf/core/operators/math/window_welch_fc.py +++ b/src/ansys/dpf/core/operators/math/window_welch_fc.py @@ -21,11 +21,11 @@ class window_welch_fc(Operator): time_freq_interpolation before otherwise). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/mesh/acmo_mesh_provider.py b/src/ansys/dpf/core/operators/mesh/acmo_mesh_provider.py index 635ec866f80..1dbf93965bf 100644 --- a/src/ansys/dpf/core/operators/mesh/acmo_mesh_provider.py +++ b/src/ansys/dpf/core/operators/mesh/acmo_mesh_provider.py @@ -19,12 +19,12 @@ class acmo_mesh_provider(Operator): r"""Converts an Assembly Mesh into a DPF Meshes container - Parameters - ---------- + Inputs + ------ assembly_mesh: AnsDispatchHolder or Struct Iansdispatch unit: str, optional - Returns + Outputs ------- meshes_container: MeshesContainer diff --git a/src/ansys/dpf/core/operators/mesh/beam_properties.py b/src/ansys/dpf/core/operators/mesh/beam_properties.py index 4fd396ea4d6..59e8c487c8e 100644 --- a/src/ansys/dpf/core/operators/mesh/beam_properties.py +++ b/src/ansys/dpf/core/operators/mesh/beam_properties.py @@ -20,14 +20,14 @@ class beam_properties(Operator): streams or data sources. - Parameters - ---------- + Inputs + ------ streams: StreamsContainer, optional Result file container allowed to be kept open to cache data. data_sources: DataSources Result file path container, used if no streams are set. - Returns + Outputs ------- mesh_out: MeshedRegion This mesh updates a new map containing a field of the beam's properties if there is at least one beam in mesh. diff --git a/src/ansys/dpf/core/operators/mesh/change_cs.py b/src/ansys/dpf/core/operators/mesh/change_cs.py index 9718d0f465b..bcd490a5985 100644 --- a/src/ansys/dpf/core/operators/mesh/change_cs.py +++ b/src/ansys/dpf/core/operators/mesh/change_cs.py @@ -21,13 +21,13 @@ class change_cs(Operator): meshes container. - Parameters - ---------- + Inputs + ------ meshes: MeshedRegion or MeshesContainer coordinate_system: Field 3-3 rotation matrix + 3 translations (X, Y, Z) - Returns + Outputs ------- meshed_region: MeshedRegion or MeshesContainer diff --git a/src/ansys/dpf/core/operators/mesh/combine_levelset.py b/src/ansys/dpf/core/operators/mesh/combine_levelset.py index d1f900bd272..1c458e6f38e 100644 --- a/src/ansys/dpf/core/operators/mesh/combine_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/combine_levelset.py @@ -19,12 +19,12 @@ class combine_levelset(Operator): r"""Takes two level sets and computes their binary union. - Parameters - ---------- + Inputs + ------ fieldA: Field fieldB: Field - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/mesh/decimate_mesh.py b/src/ansys/dpf/core/operators/mesh/decimate_mesh.py index 8f6d64f532f..b3ac40e1381 100644 --- a/src/ansys/dpf/core/operators/mesh/decimate_mesh.py +++ b/src/ansys/dpf/core/operators/mesh/decimate_mesh.py @@ -19,8 +19,8 @@ class decimate_mesh(Operator): r"""Decimate a meshed region - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion Mesh to decimate preservation_ratio: float, optional @@ -28,7 +28,7 @@ class decimate_mesh(Operator): aggressiveness: int, optional Quality measure for the resulting decimated mesh. Lower aggresiveness will provide a higher quality mesh with the tradeoff of higher execution time. Value range is 0 to 150, default is 0. - Returns + Outputs ------- mesh: MeshedRegion Decimated mesh with triangle elements diff --git a/src/ansys/dpf/core/operators/mesh/exclude_levelset.py b/src/ansys/dpf/core/operators/mesh/exclude_levelset.py index 7801a244975..30437eeb0e6 100644 --- a/src/ansys/dpf/core/operators/mesh/exclude_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/exclude_levelset.py @@ -19,12 +19,12 @@ class exclude_levelset(Operator): r"""Takes two level sets and excludes the second one from the first. - Parameters - ---------- + Inputs + ------ fieldA: Field fieldB: Field - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/mesh/external_layer.py b/src/ansys/dpf/core/operators/mesh/external_layer.py index 36ea3284d84..e4f7536c517 100644 --- a/src/ansys/dpf/core/operators/mesh/external_layer.py +++ b/src/ansys/dpf/core/operators/mesh/external_layer.py @@ -20,11 +20,11 @@ class external_layer(Operator): new meshed region. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion - Returns + Outputs ------- mesh: MeshedRegion nodes_mesh_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/mesh/from_field.py b/src/ansys/dpf/core/operators/mesh/from_field.py index def4d260018..f63ec5e19ef 100644 --- a/src/ansys/dpf/core/operators/mesh/from_field.py +++ b/src/ansys/dpf/core/operators/mesh/from_field.py @@ -19,11 +19,11 @@ class from_field(Operator): r"""Returns the meshed region contained in the support of the mesh. - Parameters - ---------- + Inputs + ------ field: Field - Returns + Outputs ------- mesh: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/from_scoping.py b/src/ansys/dpf/core/operators/mesh/from_scoping.py index 52d889c2860..290a531dc3b 100644 --- a/src/ansys/dpf/core/operators/mesh/from_scoping.py +++ b/src/ansys/dpf/core/operators/mesh/from_scoping.py @@ -24,8 +24,8 @@ class from_scoping(Operator): the rest of the property fields are not present in the output mesh. - Parameters - ---------- + Inputs + ------ scoping: Scoping if nodal/face scoping, then the scoping is transposed respecting the inclusive pin inclusive: int, optional @@ -34,7 +34,7 @@ class from_scoping(Operator): returns mesh with nodes only (without any elements or property fields). Default is false. mesh: MeshedRegion - Returns + Outputs ------- mesh: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/from_scopings.py b/src/ansys/dpf/core/operators/mesh/from_scopings.py index 4612a5d5cb1..5ebac9d24e6 100644 --- a/src/ansys/dpf/core/operators/mesh/from_scopings.py +++ b/src/ansys/dpf/core/operators/mesh/from_scopings.py @@ -20,8 +20,8 @@ class from_scopings(Operator): MeshesContainer - Parameters - ---------- + Inputs + ------ scopings_container: ScopingsContainer if nodal scoping, then the scoping is transposed respecting the inclusive pin inclusive: int, optional @@ -30,7 +30,7 @@ class from_scopings(Operator): returns mesh with nodes only (without any elements). Default is false. mesh: MeshedRegion - Returns + Outputs ------- meshes: MeshesContainer diff --git a/src/ansys/dpf/core/operators/mesh/iso_surfaces.py b/src/ansys/dpf/core/operators/mesh/iso_surfaces.py index 388ed499955..2ed7b9aa719 100644 --- a/src/ansys/dpf/core/operators/mesh/iso_surfaces.py +++ b/src/ansys/dpf/core/operators/mesh/iso_surfaces.py @@ -23,8 +23,8 @@ class iso_surfaces(Operator): are stored into a FieldsContainer. - Parameters - ---------- + Inputs + ------ field: Field Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. num_surfaces: int, optional @@ -36,7 +36,7 @@ class iso_surfaces(Operator): vector_iso_values: optional If provided, user defined iso_values to compute. If not provided, iso_values are linearly compute between the min and the max of the field of results. - Returns + Outputs ------- meshes: MeshesContainer fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/mesh/make_plane_levelset.py b/src/ansys/dpf/core/operators/mesh/make_plane_levelset.py index 53c7cb99078..0cb1335a45e 100644 --- a/src/ansys/dpf/core/operators/mesh/make_plane_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/make_plane_levelset.py @@ -19,15 +19,15 @@ class make_plane_levelset(Operator): r"""Computes the level set for a plane using coordinates. - Parameters - ---------- + Inputs + ------ coordinates: MeshedRegion or Field normal: Field An overall 3D vector that gives the normal direction of the plane. origin: Field An overall 3d vector that gives a point of the plane. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/mesh/make_sphere_levelset.py b/src/ansys/dpf/core/operators/mesh/make_sphere_levelset.py index 46a616b3d6a..40ff9cbdfd3 100644 --- a/src/ansys/dpf/core/operators/mesh/make_sphere_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/make_sphere_levelset.py @@ -19,15 +19,15 @@ class make_sphere_levelset(Operator): r"""Computes the level set for a sphere using coordinates. - Parameters - ---------- + Inputs + ------ coordinates: MeshedRegion or Field origin: Field An overall 3d vector that gives a point of the plane. radius: float Sphere radius. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/mesh/mesh_clip.py b/src/ansys/dpf/core/operators/mesh/mesh_clip.py index 386ec712eb5..2528ab1510c 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_clip.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_clip.py @@ -20,8 +20,8 @@ class mesh_clip(Operator): defined by v < x. - Parameters - ---------- + Inputs + ------ field: Field iso_value: float iso value @@ -31,7 +31,7 @@ class mesh_clip(Operator): slice_surfaces: bool True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. - Returns + Outputs ------- field: Field mesh: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/mesh_cut.py b/src/ansys/dpf/core/operators/mesh/mesh_cut.py index 8db5161d253..2321986cec8 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_cut.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_cut.py @@ -19,8 +19,8 @@ class mesh_cut(Operator): r"""Extracts a skin of the mesh in triangles in a new meshed region. - Parameters - ---------- + Inputs + ------ field: Field Field containing the values for the iso-surface computation. The mesh can be retrieved from this field's support or through pin 2. iso_value: float @@ -32,7 +32,7 @@ class mesh_cut(Operator): slice_surfaces: bool True: slicing will also take into account shell and skin elements. False: slicing will ignore shell and skin elements. The default is true. - Returns + Outputs ------- mesh: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/mesh_extraction.py b/src/ansys/dpf/core/operators/mesh/mesh_extraction.py index 59698c3ebca..ea411031acc 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_extraction.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_extraction.py @@ -20,14 +20,14 @@ class mesh_extraction(Operator): that contains this selection only. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion mesh_scoping: Scoping extension: int, optional Number of extension layer - Returns + Outputs ------- abstract_meshed_region: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/mesh_get_attribute.py b/src/ansys/dpf/core/operators/mesh/mesh_get_attribute.py index 5221e63ccc8..b180855dfd0 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_get_attribute.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_get_attribute.py @@ -21,15 +21,15 @@ class mesh_get_attribute(Operator): input. - Parameters - ---------- + Inputs + ------ abstract_meshed_region: MeshedRegion property_name: str Supported property names are: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), "coordinates", "named_selection", "num_named_selections", "named_selection_names", "named_selection_locations", "node_scoping", "element_scoping", "face_scoping"... property_identifier: int or str, optional Can be used to get a property at a given index, example: a named selection's number or by name, example: a named selection's name. - Returns + Outputs ------- property: Scoping or Field or PropertyField or int or StringField Returns a property field for properties: "connectivity", "reverse_connectivity", "mat", "faces_nodes_connectivity", "elements_faces_connectivity" (or any mesh's property field), a field for property: "coordinates", a scoping for properties:"named_selection", "node_scoping", "element_scoping", "face_scoping", a string field for properties: "named_selection_names", "named_selection_locations" and an int for property: "num_named_selections". diff --git a/src/ansys/dpf/core/operators/mesh/mesh_plan_clip.py b/src/ansys/dpf/core/operators/mesh/mesh_plan_clip.py index 54494d333c4..69b32ec7016 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_plan_clip.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_plan_clip.py @@ -19,15 +19,15 @@ class mesh_plan_clip(Operator): r"""Clips a volume mesh along a plane and keeps one side. - Parameters - ---------- + Inputs + ------ mesh_or_field: MeshedRegion or Field normal: Field An overall 3D vector that gives the normal direction of the plane. origin: Field An overall 3D vector that gives a point of the plane. - Returns + Outputs ------- field: Field mesh: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/mesh_provider.py b/src/ansys/dpf/core/operators/mesh/mesh_provider.py index def0a0136da..ff112cfa7f3 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_provider.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_provider.py @@ -19,8 +19,8 @@ class mesh_provider(Operator): r"""Reads a mesh from result files. - Parameters - ---------- + Inputs + ------ time_scoping: int, optional Optional time/frequency set ID of the mesh, supported for adaptative meshes. streams_container: StreamsContainer, optional @@ -37,7 +37,7 @@ class mesh_provider(Operator): - all mesh property fields "mat", "named_selection", "apdl_element_type", "section"-> if set to 1 these properties will not be read and a workflow will be bounded to the properties to be evaluated on demand, with 0 they are read (default is 0). - "all_available_properties" option set to 0 will return all possible properties - Returns + Outputs ------- mesh: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/mesh_to_graphics.py b/src/ansys/dpf/core/operators/mesh/mesh_to_graphics.py index ec9787ef553..2b9a7ab5aa6 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_to_graphics.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_to_graphics.py @@ -19,14 +19,14 @@ class mesh_to_graphics(Operator): r"""Generate tessellation for input mesh - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping, optional node_normals: bool, optional average element normals for node normals (default no, use element normals for node normals) mesh: MeshedRegion - Returns + Outputs ------- nodes: Field node coordinates diff --git a/src/ansys/dpf/core/operators/mesh/mesh_to_graphics_edges.py b/src/ansys/dpf/core/operators/mesh/mesh_to_graphics_edges.py index 2f16179f7f5..6fbb95f4389 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_to_graphics_edges.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_to_graphics_edges.py @@ -19,13 +19,13 @@ class mesh_to_graphics_edges(Operator): r"""Generate edges of surface elements for input mesh - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping, optional include_mid_nodes: bool, optional mesh: MeshedRegion - Returns + Outputs ------- nodes: Field node coordinates diff --git a/src/ansys/dpf/core/operators/mesh/mesh_to_pyvista.py b/src/ansys/dpf/core/operators/mesh/mesh_to_pyvista.py index 644349928fa..ede1c3452ad 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_to_pyvista.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_to_pyvista.py @@ -19,8 +19,8 @@ class mesh_to_pyvista(Operator): r"""Export a MeshedRegion in the pyVista format. - Parameters - ---------- + Inputs + ------ coordinates: Field, optional Node coordinates. If not set, the node coordinates of the mesh are employed. as_linear: bool, optional @@ -32,7 +32,7 @@ class mesh_to_pyvista(Operator): as_poly: bool, optional Export elements as polyhedrons (cell-face-node representation). Default false. - Returns + Outputs ------- nodes: Field Node coordinates double vector diff --git a/src/ansys/dpf/core/operators/mesh/mesh_to_tetra.py b/src/ansys/dpf/core/operators/mesh/mesh_to_tetra.py index 262d2f29df0..c1f33b63214 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_to_tetra.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_to_tetra.py @@ -22,12 +22,12 @@ class mesh_to_tetra(Operator): input mesh are provided, output pins (1) & (2) respectively. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion Mesh with arbitrary element types. - Returns + Outputs ------- mesh: MeshedRegion Tetrahedralized mesh. diff --git a/src/ansys/dpf/core/operators/mesh/meshes_provider.py b/src/ansys/dpf/core/operators/mesh/meshes_provider.py index bc824f9d1ce..1cb87835832 100644 --- a/src/ansys/dpf/core/operators/mesh/meshes_provider.py +++ b/src/ansys/dpf/core/operators/mesh/meshes_provider.py @@ -20,8 +20,8 @@ class meshes_provider(Operator): varying. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int, optional Time/frequency set IDs required in output. streams_container: StreamsContainer, optional @@ -33,7 +33,7 @@ class meshes_provider(Operator): region_scoping: Scoping or int, optional region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results). - Returns + Outputs ------- meshes: MeshesContainer diff --git a/src/ansys/dpf/core/operators/mesh/node_coordinates.py b/src/ansys/dpf/core/operators/mesh/node_coordinates.py index afbe4ec9157..4176c995662 100644 --- a/src/ansys/dpf/core/operators/mesh/node_coordinates.py +++ b/src/ansys/dpf/core/operators/mesh/node_coordinates.py @@ -20,11 +20,11 @@ class node_coordinates(Operator): r"""Returns the node coordinates of the mesh(es) in input. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion or MeshesContainer - Returns + Outputs ------- coordinates: Field or FieldsContainer if the input is a meshed region, a field of coordinates is the output, else if the input is a meshes container, a fields container (one field by mesh) is the output diff --git a/src/ansys/dpf/core/operators/mesh/points_from_coordinates.py b/src/ansys/dpf/core/operators/mesh/points_from_coordinates.py index 1e00daa36fa..a59550934af 100644 --- a/src/ansys/dpf/core/operators/mesh/points_from_coordinates.py +++ b/src/ansys/dpf/core/operators/mesh/points_from_coordinates.py @@ -20,12 +20,12 @@ class points_from_coordinates(Operator): meshes coordinates on the input scopings. - Parameters - ---------- + Inputs + ------ nodes_to_keep: Scoping or ScopingsContainer mesh: MeshedRegion or MeshesContainer - Returns + Outputs ------- abstract_meshed_region: MeshedRegion diff --git a/src/ansys/dpf/core/operators/mesh/skin.py b/src/ansys/dpf/core/operators/mesh/skin.py index 2f451a1aa06..dd93af55952 100644 --- a/src/ansys/dpf/core/operators/mesh/skin.py +++ b/src/ansys/dpf/core/operators/mesh/skin.py @@ -20,8 +20,8 @@ class skin(Operator): initial elements are propagated to their facets. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion mesh_scoping: Scoping, optional Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. @@ -30,7 +30,7 @@ class skin(Operator): add_beam_point: bool, optional If input mesh contains beam or point elements, output mesh beam point elements (boolean = 1) are added or (boolean = 0) are ignored. Default: False - Returns + Outputs ------- mesh: MeshedRegion Skin meshed region with facets and facets_to_ele property fields. diff --git a/src/ansys/dpf/core/operators/mesh/split_fields.py b/src/ansys/dpf/core/operators/mesh/split_fields.py index 77d11cb4155..3735a152d4b 100644 --- a/src/ansys/dpf/core/operators/mesh/split_fields.py +++ b/src/ansys/dpf/core/operators/mesh/split_fields.py @@ -20,13 +20,13 @@ class split_fields(Operator): regions - Parameters - ---------- + Inputs + ------ field_or_fields_container: Field or FieldsContainer meshes: MeshesContainer body meshes in the mesh controller cannot be mixed shell/solid - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/mesh/split_mesh.py b/src/ansys/dpf/core/operators/mesh/split_mesh.py index ad06e818bbf..7221e0bfc52 100644 --- a/src/ansys/dpf/core/operators/mesh/split_mesh.py +++ b/src/ansys/dpf/core/operators/mesh/split_mesh.py @@ -20,14 +20,14 @@ class split_mesh(Operator): (material property be default) - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping, optional Scoping mesh: MeshedRegion property: str - Returns + Outputs ------- meshes: MeshesContainer diff --git a/src/ansys/dpf/core/operators/mesh/stl_export.py b/src/ansys/dpf/core/operators/mesh/stl_export.py index 723e67fa521..a0e91b691b2 100644 --- a/src/ansys/dpf/core/operators/mesh/stl_export.py +++ b/src/ansys/dpf/core/operators/mesh/stl_export.py @@ -19,12 +19,12 @@ class stl_export(Operator): r"""export a mesh into a stl file. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion file_path: str - Returns + Outputs ------- data_sources: DataSources diff --git a/src/ansys/dpf/core/operators/mesh/tri_mesh_skin.py b/src/ansys/dpf/core/operators/mesh/tri_mesh_skin.py index 029756e5421..59c437b6320 100644 --- a/src/ansys/dpf/core/operators/mesh/tri_mesh_skin.py +++ b/src/ansys/dpf/core/operators/mesh/tri_mesh_skin.py @@ -19,15 +19,15 @@ class tri_mesh_skin(Operator): r"""Extracts a skin of the mesh in triangles in a new meshed region. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion include_surfaces: bool, optional True: meshing will also take into account shell and skin elements. False: meshing will ignore shell and skin elements. The default is false. mesh_scoping: Scoping, optional Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a skin element is added to the skin mesh if all its nodes are in the scoping. - Returns + Outputs ------- mesh: MeshedRegion nodes_mesh_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/mesh/wireframe.py b/src/ansys/dpf/core/operators/mesh/wireframe.py index 0b839ade258..87e32ef40b9 100644 --- a/src/ansys/dpf/core/operators/mesh/wireframe.py +++ b/src/ansys/dpf/core/operators/mesh/wireframe.py @@ -20,13 +20,13 @@ class wireframe(Operator): threshold angle. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion threshold: float angle threshold in radian that will trigger an edge detection. - Returns + Outputs ------- wireframe: MeshedRegion diff --git a/src/ansys/dpf/core/operators/metadata/boundary_condition_provider.py b/src/ansys/dpf/core/operators/metadata/boundary_condition_provider.py index fa147da5cb3..956e60215b9 100644 --- a/src/ansys/dpf/core/operators/metadata/boundary_condition_provider.py +++ b/src/ansys/dpf/core/operators/metadata/boundary_condition_provider.py @@ -21,12 +21,12 @@ class boundary_condition_provider(Operator): streams or data sources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional data_sources: DataSources - Returns + Outputs ------- results_info: Field or FieldsContainer results info diff --git a/src/ansys/dpf/core/operators/metadata/coordinate_system_data_provider.py b/src/ansys/dpf/core/operators/metadata/coordinate_system_data_provider.py index 7922ae56472..84f08b51986 100644 --- a/src/ansys/dpf/core/operators/metadata/coordinate_system_data_provider.py +++ b/src/ansys/dpf/core/operators/metadata/coordinate_system_data_provider.py @@ -20,8 +20,8 @@ class coordinate_system_data_provider(Operator): streams or data sources. - Parameters - ---------- + Inputs + ------ solver_coordinate_system_ids: int, optional Coorfinate System ids to recover used by the solver. If not set, all available materials to be recovered. streams: StreamsContainer, optional @@ -29,7 +29,7 @@ class coordinate_system_data_provider(Operator): data_sources: DataSources Result file path container, used if no streams are set. - Returns + Outputs ------- coordinate_system_data1: GenericDataContainer coordinate_system_data2: GenericDataContainer diff --git a/src/ansys/dpf/core/operators/metadata/cyclic_mesh_expansion.py b/src/ansys/dpf/core/operators/metadata/cyclic_mesh_expansion.py index 0633922a745..e93b064ecaf 100644 --- a/src/ansys/dpf/core/operators/metadata/cyclic_mesh_expansion.py +++ b/src/ansys/dpf/core/operators/metadata/cyclic_mesh_expansion.py @@ -19,14 +19,14 @@ class cyclic_mesh_expansion(Operator): r"""Expand the mesh. - Parameters - ---------- + Inputs + ------ sector_meshed_region: MeshedRegion or MeshesContainer, optional cyclic_support: CyclicSupport sectors_to_expand: Scoping or ScopingsContainer, optional sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. - Returns + Outputs ------- meshed_region: MeshedRegion expanded meshed region. diff --git a/src/ansys/dpf/core/operators/metadata/cyclic_support_provider.py b/src/ansys/dpf/core/operators/metadata/cyclic_support_provider.py index e6d39789c39..0f7ee96b3bf 100644 --- a/src/ansys/dpf/core/operators/metadata/cyclic_support_provider.py +++ b/src/ansys/dpf/core/operators/metadata/cyclic_support_provider.py @@ -21,8 +21,8 @@ class cyclic_support_provider(Operator): expansions) and expands the mesh. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional Streams containing the result file. data_sources: DataSources @@ -34,7 +34,7 @@ class cyclic_support_provider(Operator): sectors_to_expand: Scoping or ScopingsContainer, optional sectors to expand (start at 0), for multistage: use scopings container with 'stage' label. - Returns + Outputs ------- cyclic_support: CyclicSupport sector_meshes: MeshesContainer diff --git a/src/ansys/dpf/core/operators/metadata/datasources_provider.py b/src/ansys/dpf/core/operators/metadata/datasources_provider.py index 6f6a376ca50..e888283c807 100644 --- a/src/ansys/dpf/core/operators/metadata/datasources_provider.py +++ b/src/ansys/dpf/core/operators/metadata/datasources_provider.py @@ -19,11 +19,11 @@ class datasources_provider(Operator): r"""Creates a DataSources by expanding another. - Parameters - ---------- + Inputs + ------ data_sources: DataSources - Returns + Outputs ------- data_sources: DataSources diff --git a/src/ansys/dpf/core/operators/metadata/element_types_provider.py b/src/ansys/dpf/core/operators/metadata/element_types_provider.py index b06081d5d80..efde8f71489 100644 --- a/src/ansys/dpf/core/operators/metadata/element_types_provider.py +++ b/src/ansys/dpf/core/operators/metadata/element_types_provider.py @@ -32,8 +32,8 @@ class element_types_provider(Operator): documented in ansys/customize/include/elccmt.inc. - Parameters - ---------- + Inputs + ------ solver_element_types_ids: int, optional Element Type ids to recover used by the solver. If not set, all available element types are recovered. streams: StreamsContainer, optional @@ -43,7 +43,7 @@ class element_types_provider(Operator): output_type: int, optional Get the output as a GenericDataContainer (pin value 1, default) or as a PropertyField (pin value 2). - Returns + Outputs ------- element_types_data: GenericDataContainer or PropertyField diff --git a/src/ansys/dpf/core/operators/metadata/integrate_over_time_freq.py b/src/ansys/dpf/core/operators/metadata/integrate_over_time_freq.py index b27fa3e01d5..8c2f1178988 100644 --- a/src/ansys/dpf/core/operators/metadata/integrate_over_time_freq.py +++ b/src/ansys/dpf/core/operators/metadata/integrate_over_time_freq.py @@ -19,15 +19,15 @@ class integrate_over_time_freq(Operator): r"""Integration of an input field over timefreq. - Parameters - ---------- + Inputs + ------ field: Field scoping: Scoping, optional Integrate the input field over a specific scoping. time_freq_support: TimeFreqSupport, optional Time Freq to integrate on, otherwise time freq support from the input field is taken. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/metadata/is_cyclic.py b/src/ansys/dpf/core/operators/metadata/is_cyclic.py index e132be2653b..a8a32820b99 100644 --- a/src/ansys/dpf/core/operators/metadata/is_cyclic.py +++ b/src/ansys/dpf/core/operators/metadata/is_cyclic.py @@ -19,14 +19,14 @@ class is_cyclic(Operator): r"""Reads if the model is cyclic from the result file. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional streams (result file container) (optional) data_sources: DataSources If the stream is null, retrieves the file path from the data sources. - Returns + Outputs ------- file_path: str returns 'single_stage' or 'multi_stage' or an empty string for non cyclic model diff --git a/src/ansys/dpf/core/operators/metadata/material_support_provider.py b/src/ansys/dpf/core/operators/metadata/material_support_provider.py index 6ad2a1e8ab0..a184e409e22 100644 --- a/src/ansys/dpf/core/operators/metadata/material_support_provider.py +++ b/src/ansys/dpf/core/operators/metadata/material_support_provider.py @@ -19,14 +19,14 @@ class material_support_provider(Operator): r"""Reads the material support. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional Streams result file container (optional). data_sources: DataSources if the stream is null, get the file path from the data sources. - Returns + Outputs ------- abstract_field_support: AbstractFieldSupport diff --git a/src/ansys/dpf/core/operators/metadata/mesh_info_provider.py b/src/ansys/dpf/core/operators/metadata/mesh_info_provider.py index 9719f397df8..1f0e381f405 100644 --- a/src/ansys/dpf/core/operators/metadata/mesh_info_provider.py +++ b/src/ansys/dpf/core/operators/metadata/mesh_info_provider.py @@ -21,8 +21,8 @@ class mesh_info_provider(Operator): plugins) on files contained in the streams or data sources. - Parameters - ---------- + Inputs + ------ time_scoping: int, optional Optional time/frequency set ID of the mesh. streams_container: StreamsContainer, optional @@ -30,7 +30,7 @@ class mesh_info_provider(Operator): data_sources: DataSources If the stream is null, retrieves the file path from the data sources. - Returns + Outputs ------- mesh_info: GenericDataContainer diff --git a/src/ansys/dpf/core/operators/metadata/mesh_property_provider.py b/src/ansys/dpf/core/operators/metadata/mesh_property_provider.py index d5b229257ad..79b5d884ad9 100644 --- a/src/ansys/dpf/core/operators/metadata/mesh_property_provider.py +++ b/src/ansys/dpf/core/operators/metadata/mesh_property_provider.py @@ -22,8 +22,8 @@ class mesh_property_provider(Operator): fill in the mesh. - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping, optional Retrieves a property field on a subset of elements or nodes. streams_container: StreamsContainer, optional @@ -35,7 +35,7 @@ class mesh_property_provider(Operator): property_identifier: int or str, optional Retrieves a property at a given index or by name. For example, a named selection's number or a named selection's name. - Returns + Outputs ------- property: Scoping or PropertyField or StringField Returns a property field for properties: "mat", "apdl_element_type", "section", "elprops", "keyopt_1" to "keyopt_18" (or any mesh's property field), a scoping for properties:"named_selection", a string field for properties: "named_selection_names". diff --git a/src/ansys/dpf/core/operators/metadata/mesh_selection_manager_provider.py b/src/ansys/dpf/core/operators/metadata/mesh_selection_manager_provider.py index 367addf66ac..c64ee304aa8 100644 --- a/src/ansys/dpf/core/operators/metadata/mesh_selection_manager_provider.py +++ b/src/ansys/dpf/core/operators/metadata/mesh_selection_manager_provider.py @@ -21,14 +21,14 @@ class mesh_selection_manager_provider(Operator): selection manager in output. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional streams (result file container) (optional) data_sources: DataSources If the stream is null, retrieves the file path from the data sources. - Returns + Outputs ------- mesh_selection_manager: MeshSelectionManager diff --git a/src/ansys/dpf/core/operators/metadata/mesh_support_provider.py b/src/ansys/dpf/core/operators/metadata/mesh_support_provider.py index e84862c1004..19d7e0c8dad 100644 --- a/src/ansys/dpf/core/operators/metadata/mesh_support_provider.py +++ b/src/ansys/dpf/core/operators/metadata/mesh_support_provider.py @@ -19,14 +19,14 @@ class mesh_support_provider(Operator): r"""Reads the mesh support. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional Streams (result file container) (optional). data_sources: DataSources If the stream is null, retrieves the file path from the data sources. - Returns + Outputs ------- abstract_field_support: AbstractFieldSupport diff --git a/src/ansys/dpf/core/operators/metadata/property_field_provider_by_name.py b/src/ansys/dpf/core/operators/metadata/property_field_provider_by_name.py index 3e5fd85bccc..a624fc5e702 100644 --- a/src/ansys/dpf/core/operators/metadata/property_field_provider_by_name.py +++ b/src/ansys/dpf/core/operators/metadata/property_field_provider_by_name.py @@ -20,8 +20,8 @@ class property_field_provider_by_name(Operator): property name. - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping, optional scoping that defines the set of elements to fetch the property values for. If not specified, applied on all the elements of the mesh. streams_container: StreamsContainer, optional @@ -31,7 +31,7 @@ class property_field_provider_by_name(Operator): property_name: str property to read, that can be the following: elements_connectivity, nodes_connectivity, material, element_type, apdl_section_id, apdl_real_id, apdl_esys_id, mapdl_element_type, mapdl_element_type_id, harmonic_index, step, substep, keyopt_i (i = 1 -> 18). - Returns + Outputs ------- property_field: PropertyField property field diff --git a/src/ansys/dpf/core/operators/metadata/real_constants_provider.py b/src/ansys/dpf/core/operators/metadata/real_constants_provider.py index 7c6a4f78145..79c8b375bb1 100644 --- a/src/ansys/dpf/core/operators/metadata/real_constants_provider.py +++ b/src/ansys/dpf/core/operators/metadata/real_constants_provider.py @@ -20,8 +20,8 @@ class real_constants_provider(Operator): data sources. - Parameters - ---------- + Inputs + ------ solver_real_constants_ids: int, optional Real Constant ids to recover used by the solver. If not set, all available real constants to be recovered. streams: StreamsContainer, optional @@ -29,7 +29,7 @@ class real_constants_provider(Operator): data_sources: DataSources Result file path container, used if no streams are set. - Returns + Outputs ------- real_constants: Field diff --git a/src/ansys/dpf/core/operators/metadata/result_info_provider.py b/src/ansys/dpf/core/operators/metadata/result_info_provider.py index 1f74f336660..c3714c8453a 100644 --- a/src/ansys/dpf/core/operators/metadata/result_info_provider.py +++ b/src/ansys/dpf/core/operators/metadata/result_info_provider.py @@ -20,14 +20,14 @@ class result_info_provider(Operator): from the results files contained in the streams or data sources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional streams (result file container) (optional) data_sources: DataSources If the stream is null, retrieves the file path from the data sources. - Returns + Outputs ------- result_info: ResultInfo diff --git a/src/ansys/dpf/core/operators/metadata/streams_provider.py b/src/ansys/dpf/core/operators/metadata/streams_provider.py index 6d9cc70828b..b9273ab7361 100644 --- a/src/ansys/dpf/core/operators/metadata/streams_provider.py +++ b/src/ansys/dpf/core/operators/metadata/streams_provider.py @@ -19,11 +19,11 @@ class streams_provider(Operator): r"""Creates streams (files with cache) from the data sources. - Parameters - ---------- + Inputs + ------ data_sources: DataSources - Returns + Outputs ------- streams_container: StreamsContainer diff --git a/src/ansys/dpf/core/operators/metadata/time_freq_provider.py b/src/ansys/dpf/core/operators/metadata/time_freq_provider.py index 2f14b1d95c5..fe3b6783295 100644 --- a/src/ansys/dpf/core/operators/metadata/time_freq_provider.py +++ b/src/ansys/dpf/core/operators/metadata/time_freq_provider.py @@ -20,14 +20,14 @@ class time_freq_provider(Operator): streams or data sources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional streams (result file container) (optional) data_sources: DataSources If the stream is null, retrieves the file path from the data sources. - Returns + Outputs ------- time_freq_support: TimeFreqSupport diff --git a/src/ansys/dpf/core/operators/metadata/time_freq_support_get_attribute.py b/src/ansys/dpf/core/operators/metadata/time_freq_support_get_attribute.py index c3a29de567d..9cc7f319612 100644 --- a/src/ansys/dpf/core/operators/metadata/time_freq_support_get_attribute.py +++ b/src/ansys/dpf/core/operators/metadata/time_freq_support_get_attribute.py @@ -21,8 +21,8 @@ class time_freq_support_get_attribute(Operator): in input. - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport property_name: str Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index". @@ -31,7 +31,7 @@ class time_freq_support_get_attribute(Operator): property_identifier_2: int, optional Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered). - Returns + Outputs ------- property: float or Field or Scoping Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", an int for "step_id_from_harmonic_index" and a Field otherwise. diff --git a/src/ansys/dpf/core/operators/min_max/max_by_component.py b/src/ansys/dpf/core/operators/min_max/max_by_component.py index b6b119847a8..66f129ba537 100644 --- a/src/ansys/dpf/core/operators/min_max/max_by_component.py +++ b/src/ansys/dpf/core/operators/min_max/max_by_component.py @@ -19,8 +19,8 @@ class max_by_component(Operator): r"""Give the maximum for each element rank by comparing several fields. - Parameters - ---------- + Inputs + ------ use_absolute_value: bool use_absolute_value field1: Field or FieldsContainer @@ -28,7 +28,7 @@ class max_by_component(Operator): field2: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/min_max/max_over_phase.py b/src/ansys/dpf/core/operators/min_max/max_over_phase.py index d4a60021168..351faea68a7 100644 --- a/src/ansys/dpf/core/operators/min_max/max_over_phase.py +++ b/src/ansys/dpf/core/operators/min_max/max_over_phase.py @@ -21,8 +21,8 @@ class max_over_phase(Operator): increment in input. - Parameters - ---------- + Inputs + ------ real_field: Field imaginary_field: Field abs_value: bool, optional @@ -30,7 +30,7 @@ class max_over_phase(Operator): phase_increment: float, optional Phase increment (default is 10.0 degrees). - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/min_max/max_over_time_by_entity.py b/src/ansys/dpf/core/operators/min_max/max_over_time_by_entity.py index a2e7a575bed..ef17502bd3b 100644 --- a/src/ansys/dpf/core/operators/min_max/max_over_time_by_entity.py +++ b/src/ansys/dpf/core/operators/min_max/max_over_time_by_entity.py @@ -19,15 +19,15 @@ class max_over_time_by_entity(Operator): r"""Evaluates maximum over time/frequency. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer abs_value: bool, optional Should use absolute value. compute_amplitude: bool, optional Do calculate amplitude. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/min_max/min_by_component.py b/src/ansys/dpf/core/operators/min_max/min_by_component.py index 9c780fcbcdd..a29e79c6066 100644 --- a/src/ansys/dpf/core/operators/min_max/min_by_component.py +++ b/src/ansys/dpf/core/operators/min_max/min_by_component.py @@ -19,8 +19,8 @@ class min_by_component(Operator): r"""Give the minimum for each element rank by comparing several fields. - Parameters - ---------- + Inputs + ------ use_absolute_value: bool use_absolute_value field1: Field or FieldsContainer @@ -28,7 +28,7 @@ class min_by_component(Operator): field2: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/min_max/min_max.py b/src/ansys/dpf/core/operators/min_max/min_max.py index ae14305cd0d..fe70266c0a1 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max.py +++ b/src/ansys/dpf/core/operators/min_max/min_max.py @@ -20,12 +20,12 @@ class min_max(Operator): field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field_min: Field field_max: Field diff --git a/src/ansys/dpf/core/operators/min_max/min_max_by_entity.py b/src/ansys/dpf/core/operators/min_max/min_max_by_entity.py index 4dce8705c69..9d3dc166b74 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max_by_entity.py +++ b/src/ansys/dpf/core/operators/min_max/min_max_by_entity.py @@ -20,11 +20,11 @@ class min_max_by_entity(Operator): fields of a fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- field_min: Field field_max: Field diff --git a/src/ansys/dpf/core/operators/min_max/min_max_by_time.py b/src/ansys/dpf/core/operators/min_max/min_max_by_time.py index 1edf71fc3cc..fd6f7175a3f 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max_by_time.py +++ b/src/ansys/dpf/core/operators/min_max/min_max_by_time.py @@ -20,13 +20,13 @@ class min_max_by_time(Operator): each field - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer compute_absolute_value: bool, optional Calculate the absolute value of field entities before computing the min/max. - Returns + Outputs ------- min: FieldsContainer max: FieldsContainer diff --git a/src/ansys/dpf/core/operators/min_max/min_max_fc.py b/src/ansys/dpf/core/operators/min_max/min_max_fc.py index bd438a9d11e..51b3d5a49d2 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max_fc.py +++ b/src/ansys/dpf/core/operators/min_max/min_max_fc.py @@ -20,11 +20,11 @@ class min_max_fc(Operator): fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- field_min: Field field_max: Field diff --git a/src/ansys/dpf/core/operators/min_max/min_max_fc_inc.py b/src/ansys/dpf/core/operators/min_max/min_max_fc_inc.py index 49cb9ec4ae5..9385a0b1eb9 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max_fc_inc.py +++ b/src/ansys/dpf/core/operators/min_max/min_max_fc_inc.py @@ -20,11 +20,11 @@ class min_max_fc_inc(Operator): fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer - Returns + Outputs ------- field_min: Field field_max: Field diff --git a/src/ansys/dpf/core/operators/min_max/min_max_inc.py b/src/ansys/dpf/core/operators/min_max/min_max_inc.py index 6644cf5999e..42acccf0c36 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max_inc.py +++ b/src/ansys/dpf/core/operators/min_max/min_max_inc.py @@ -20,12 +20,12 @@ class min_max_inc(Operator): coming fields. - Parameters - ---------- + Inputs + ------ field: Field domain_id: int, optional - Returns + Outputs ------- field_min: Field field_max: Field diff --git a/src/ansys/dpf/core/operators/min_max/min_max_over_label_fc.py b/src/ansys/dpf/core/operators/min_max/min_max_over_label_fc.py index defa7898260..479d0d49ea8 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max_over_label_fc.py +++ b/src/ansys/dpf/core/operators/min_max/min_max_over_label_fc.py @@ -28,13 +28,13 @@ class min_max_over_label_fc(Operator): (max). - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer label: str label name from the fields container - Returns + Outputs ------- field_min: Field field_max: Field diff --git a/src/ansys/dpf/core/operators/min_max/min_max_over_time_by_entity.py b/src/ansys/dpf/core/operators/min_max/min_max_over_time_by_entity.py index e1416df9944..d7231021f18 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max_over_time_by_entity.py +++ b/src/ansys/dpf/core/operators/min_max/min_max_over_time_by_entity.py @@ -25,15 +25,15 @@ class min_max_over_time_by_entity(Operator): the minimum and maximum values. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer compute_absolute_value: bool, optional Calculate the absolute value of field entities before computing the min/max. compute_amplitude: bool, optional Do calculate amplitude. - Returns + Outputs ------- min: FieldsContainer max: FieldsContainer diff --git a/src/ansys/dpf/core/operators/min_max/min_over_time_by_entity.py b/src/ansys/dpf/core/operators/min_max/min_over_time_by_entity.py index b74e3a13c2e..596c5bb792d 100644 --- a/src/ansys/dpf/core/operators/min_max/min_over_time_by_entity.py +++ b/src/ansys/dpf/core/operators/min_max/min_over_time_by_entity.py @@ -19,15 +19,15 @@ class min_over_time_by_entity(Operator): r"""Evaluates minimum over time/frequency. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer abs_value: bool, optional Should use absolute value. compute_amplitude: bool, optional Do calculate amplitude. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/min_max/phase_of_max.py b/src/ansys/dpf/core/operators/min_max/phase_of_max.py index 9533b72ac5e..1d528d86772 100644 --- a/src/ansys/dpf/core/operators/min_max/phase_of_max.py +++ b/src/ansys/dpf/core/operators/min_max/phase_of_max.py @@ -19,8 +19,8 @@ class phase_of_max(Operator): r"""Evaluates phase of maximum. - Parameters - ---------- + Inputs + ------ real_field: Field imaginary_field: Field abs_value: bool, optional @@ -28,7 +28,7 @@ class phase_of_max(Operator): phase_increment: float Phase increment. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/min_max/time_of_max_by_entity.py b/src/ansys/dpf/core/operators/min_max/time_of_max_by_entity.py index ecc21bcff43..3efbf84b081 100644 --- a/src/ansys/dpf/core/operators/min_max/time_of_max_by_entity.py +++ b/src/ansys/dpf/core/operators/min_max/time_of_max_by_entity.py @@ -19,15 +19,15 @@ class time_of_max_by_entity(Operator): r"""Evaluates time/frequency of maximum. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer abs_value: bool, optional Should use absolute value. compute_amplitude: bool, optional Do calculate amplitude. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/min_max/time_of_min_by_entity.py b/src/ansys/dpf/core/operators/min_max/time_of_min_by_entity.py index afdf7368a94..cf549b386f6 100644 --- a/src/ansys/dpf/core/operators/min_max/time_of_min_by_entity.py +++ b/src/ansys/dpf/core/operators/min_max/time_of_min_by_entity.py @@ -19,15 +19,15 @@ class time_of_min_by_entity(Operator): r"""Evaluates time/frequency of minimum. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer abs_value: bool, optional Should use absolute value. compute_amplitude: bool, optional Do calculate amplitude. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/acceleration.py b/src/ansys/dpf/core/operators/result/acceleration.py index be3fb30b5ae..238984797f4 100644 --- a/src/ansys/dpf/core/operators/result/acceleration.py +++ b/src/ansys/dpf/core/operators/result/acceleration.py @@ -20,8 +20,8 @@ class acceleration(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class acceleration(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/acceleration_X.py b/src/ansys/dpf/core/operators/result/acceleration_X.py index 2cab67b4f12..cff3ad4043d 100644 --- a/src/ansys/dpf/core/operators/result/acceleration_X.py +++ b/src/ansys/dpf/core/operators/result/acceleration_X.py @@ -20,8 +20,8 @@ class acceleration_X(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class acceleration_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/acceleration_Y.py b/src/ansys/dpf/core/operators/result/acceleration_Y.py index 8c9bcd53bdb..a3beac4cf17 100644 --- a/src/ansys/dpf/core/operators/result/acceleration_Y.py +++ b/src/ansys/dpf/core/operators/result/acceleration_Y.py @@ -20,8 +20,8 @@ class acceleration_Y(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class acceleration_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/acceleration_Z.py b/src/ansys/dpf/core/operators/result/acceleration_Z.py index c30849f3ed5..051d941f186 100644 --- a/src/ansys/dpf/core/operators/result/acceleration_Z.py +++ b/src/ansys/dpf/core/operators/result/acceleration_Z.py @@ -20,8 +20,8 @@ class acceleration_Z(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class acceleration_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py b/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py index 6bc619091f1..f77f11f5395 100644 --- a/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py +++ b/src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py @@ -132,8 +132,8 @@ class accu_eqv_creep_strain(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class accu_eqv_creep_strain(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py b/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py index b56bbab866b..cb1736d73c6 100644 --- a/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py +++ b/src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py @@ -132,8 +132,8 @@ class accu_eqv_plastic_strain(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class accu_eqv_plastic_strain(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/add_rigid_body_motion.py b/src/ansys/dpf/core/operators/result/add_rigid_body_motion.py index d559b0fe445..c6c8a34daf2 100644 --- a/src/ansys/dpf/core/operators/result/add_rigid_body_motion.py +++ b/src/ansys/dpf/core/operators/result/add_rigid_body_motion.py @@ -21,8 +21,8 @@ class add_rigid_body_motion(Operator): displacement field has to be in the global coordinate system - Parameters - ---------- + Inputs + ------ displacement_field: Field translation_field: Field rotation_field: Field @@ -30,7 +30,7 @@ class add_rigid_body_motion(Operator): mesh: MeshedRegion, optional default is the mesh in the support - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/result/add_rigid_body_motion_fc.py b/src/ansys/dpf/core/operators/result/add_rigid_body_motion_fc.py index 0e056fae2cf..26fbb3e2f58 100644 --- a/src/ansys/dpf/core/operators/result/add_rigid_body_motion_fc.py +++ b/src/ansys/dpf/core/operators/result/add_rigid_body_motion_fc.py @@ -21,8 +21,8 @@ class add_rigid_body_motion_fc(Operator): displacement field has to be in the global coordinate system - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer translation_field: Field rotation_field: Field @@ -30,7 +30,7 @@ class add_rigid_body_motion_fc(Operator): mesh: MeshedRegion, optional default is the mesh in the support - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/artificial_hourglass_energy.py b/src/ansys/dpf/core/operators/result/artificial_hourglass_energy.py index 17569ae7719..f6a1ba1eea2 100644 --- a/src/ansys/dpf/core/operators/result/artificial_hourglass_energy.py +++ b/src/ansys/dpf/core/operators/result/artificial_hourglass_energy.py @@ -20,8 +20,8 @@ class artificial_hourglass_energy(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class artificial_hourglass_energy(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_axial_force.py b/src/ansys/dpf/core/operators/result/beam_axial_force.py index 742f4f81aef..dd7f5eb44b2 100644 --- a/src/ansys/dpf/core/operators/result/beam_axial_force.py +++ b/src/ansys/dpf/core/operators/result/beam_axial_force.py @@ -20,8 +20,8 @@ class beam_axial_force(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -33,7 +33,7 @@ class beam_axial_force(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_axial_plastic_strain.py b/src/ansys/dpf/core/operators/result/beam_axial_plastic_strain.py index cdd1891f6e4..f9da51d16ac 100644 --- a/src/ansys/dpf/core/operators/result/beam_axial_plastic_strain.py +++ b/src/ansys/dpf/core/operators/result/beam_axial_plastic_strain.py @@ -20,8 +20,8 @@ class beam_axial_plastic_strain(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -35,7 +35,7 @@ class beam_axial_plastic_strain(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_axial_stress.py b/src/ansys/dpf/core/operators/result/beam_axial_stress.py index 04d2b10c71c..bb74034ecd7 100644 --- a/src/ansys/dpf/core/operators/result/beam_axial_stress.py +++ b/src/ansys/dpf/core/operators/result/beam_axial_stress.py @@ -20,8 +20,8 @@ class beam_axial_stress(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -35,7 +35,7 @@ class beam_axial_stress(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_axial_total_strain.py b/src/ansys/dpf/core/operators/result/beam_axial_total_strain.py index dee0e97ad73..c8c81aae592 100644 --- a/src/ansys/dpf/core/operators/result/beam_axial_total_strain.py +++ b/src/ansys/dpf/core/operators/result/beam_axial_total_strain.py @@ -20,8 +20,8 @@ class beam_axial_total_strain(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -35,7 +35,7 @@ class beam_axial_total_strain(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_rs_shear_stress.py b/src/ansys/dpf/core/operators/result/beam_rs_shear_stress.py index 761cbafb8df..a0d1b84bfb3 100644 --- a/src/ansys/dpf/core/operators/result/beam_rs_shear_stress.py +++ b/src/ansys/dpf/core/operators/result/beam_rs_shear_stress.py @@ -20,8 +20,8 @@ class beam_rs_shear_stress(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -35,7 +35,7 @@ class beam_rs_shear_stress(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_s_bending_moment.py b/src/ansys/dpf/core/operators/result/beam_s_bending_moment.py index 9613f3dea32..8d519755afb 100644 --- a/src/ansys/dpf/core/operators/result/beam_s_bending_moment.py +++ b/src/ansys/dpf/core/operators/result/beam_s_bending_moment.py @@ -20,8 +20,8 @@ class beam_s_bending_moment(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -33,7 +33,7 @@ class beam_s_bending_moment(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_s_shear_force.py b/src/ansys/dpf/core/operators/result/beam_s_shear_force.py index a2b3485a479..c3dbc7a10d0 100644 --- a/src/ansys/dpf/core/operators/result/beam_s_shear_force.py +++ b/src/ansys/dpf/core/operators/result/beam_s_shear_force.py @@ -20,8 +20,8 @@ class beam_s_shear_force(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -33,7 +33,7 @@ class beam_s_shear_force(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_t_bending_moment.py b/src/ansys/dpf/core/operators/result/beam_t_bending_moment.py index 4863fdca134..d9d48370c7e 100644 --- a/src/ansys/dpf/core/operators/result/beam_t_bending_moment.py +++ b/src/ansys/dpf/core/operators/result/beam_t_bending_moment.py @@ -20,8 +20,8 @@ class beam_t_bending_moment(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -33,7 +33,7 @@ class beam_t_bending_moment(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_t_shear_force.py b/src/ansys/dpf/core/operators/result/beam_t_shear_force.py index 8dae4cafec4..ae4b738c24a 100644 --- a/src/ansys/dpf/core/operators/result/beam_t_shear_force.py +++ b/src/ansys/dpf/core/operators/result/beam_t_shear_force.py @@ -20,8 +20,8 @@ class beam_t_shear_force(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -33,7 +33,7 @@ class beam_t_shear_force(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_torsional_moment.py b/src/ansys/dpf/core/operators/result/beam_torsional_moment.py index 60b46a058ff..1287918941a 100644 --- a/src/ansys/dpf/core/operators/result/beam_torsional_moment.py +++ b/src/ansys/dpf/core/operators/result/beam_torsional_moment.py @@ -20,8 +20,8 @@ class beam_torsional_moment(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -33,7 +33,7 @@ class beam_torsional_moment(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/beam_tr_shear_stress.py b/src/ansys/dpf/core/operators/result/beam_tr_shear_stress.py index 4201e5297fa..7d93560aad7 100644 --- a/src/ansys/dpf/core/operators/result/beam_tr_shear_stress.py +++ b/src/ansys/dpf/core/operators/result/beam_tr_shear_stress.py @@ -20,8 +20,8 @@ class beam_tr_shear_stress(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -35,7 +35,7 @@ class beam_tr_shear_stress(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/cgns_result_provider.py b/src/ansys/dpf/core/operators/result/cgns_result_provider.py index cba361e196a..6b586589a88 100644 --- a/src/ansys/dpf/core/operators/result/cgns_result_provider.py +++ b/src/ansys/dpf/core/operators/result/cgns_result_provider.py @@ -19,8 +19,8 @@ class cgns_result_provider(Operator): r"""Read/compute names result from result streams. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output mesh_scoping: Scoping or ScopingsContainer, optional @@ -34,7 +34,7 @@ class cgns_result_provider(Operator): region_scoping: Scoping or int, optional Optional zone name/Id of the mesh. - Returns + Outputs ------- fields: FieldsContainer Results diff --git a/src/ansys/dpf/core/operators/result/cms_dst_table_provider.py b/src/ansys/dpf/core/operators/result/cms_dst_table_provider.py index 4856e8c283e..f509984a484 100644 --- a/src/ansys/dpf/core/operators/result/cms_dst_table_provider.py +++ b/src/ansys/dpf/core/operators/result/cms_dst_table_provider.py @@ -19,12 +19,12 @@ class cms_dst_table_provider(Operator): r"""Read CST table from a subfile. - Parameters - ---------- + Inputs + ------ data_sources: DataSources Data_sources (must contain at least one subfile). - Returns + Outputs ------- dst_table: PropertyField returns integer values of the dst table diff --git a/src/ansys/dpf/core/operators/result/cms_matrices_provider.py b/src/ansys/dpf/core/operators/result/cms_matrices_provider.py index 7d9b6b648e4..f46f257d3e1 100644 --- a/src/ansys/dpf/core/operators/result/cms_matrices_provider.py +++ b/src/ansys/dpf/core/operators/result/cms_matrices_provider.py @@ -20,14 +20,14 @@ class cms_matrices_provider(Operator): matrices and load vector from a subfile. - Parameters - ---------- + Inputs + ------ data_sources: DataSources Data_sources (must contain at list one subfile). matrix_form: bool If this pin i set to true, data are return as matrix form. - Returns + Outputs ------- fields_container: FieldsContainer Fields container containing in this order : stiffness, damping, mass matrices, and then load vector. But if pin 200 is set to true, it's in matrix form. diff --git a/src/ansys/dpf/core/operators/result/cms_subfile_info_provider.py b/src/ansys/dpf/core/operators/result/cms_subfile_info_provider.py index e5845923fc2..28891ba77b9 100644 --- a/src/ansys/dpf/core/operators/result/cms_subfile_info_provider.py +++ b/src/ansys/dpf/core/operators/result/cms_subfile_info_provider.py @@ -19,8 +19,8 @@ class cms_subfile_info_provider(Operator): r"""Read required information from a subfile. - Parameters - ---------- + Inputs + ------ data_sources: DataSources Data_sources (must contain at least one subfile). cms_subfile_data: bool @@ -28,7 +28,7 @@ class cms_subfile_info_provider(Operator): output_maxdof_on_masternodes: bool, optional If this pin is set to true, compute and add field with max degrees of freedom on master nodes - Returns + Outputs ------- int32: int returns integer values in the order : unit system used, stiffness matrix present key, damping matrix present key, mass matrix present key, number of master nodes, number of virtual nodes diff --git a/src/ansys/dpf/core/operators/result/co_energy.py b/src/ansys/dpf/core/operators/result/co_energy.py index 7d2287d973a..c7b7f0714f9 100644 --- a/src/ansys/dpf/core/operators/result/co_energy.py +++ b/src/ansys/dpf/core/operators/result/co_energy.py @@ -20,8 +20,8 @@ class co_energy(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class co_energy(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/compute_invariant_terms_motion.py b/src/ansys/dpf/core/operators/result/compute_invariant_terms_motion.py index 4a9679f6375..fd10bbe836e 100644 --- a/src/ansys/dpf/core/operators/result/compute_invariant_terms_motion.py +++ b/src/ansys/dpf/core/operators/result/compute_invariant_terms_motion.py @@ -20,8 +20,8 @@ class compute_invariant_terms_motion(Operator): matrices, lumped mass matrix, modes …) - Parameters - ---------- + Inputs + ------ rom_matrices: FieldsContainer FieldsContainers containing the reduced matrices mode_shapes: FieldsContainer @@ -36,7 +36,7 @@ class compute_invariant_terms_motion(Operator): phi_ortho: FieldsContainer, optional Orthonormalizated modes transformation - Returns + Outputs ------- model_data: PropertyField data describing the finite element model diff --git a/src/ansys/dpf/core/operators/result/compute_invariant_terms_rbd.py b/src/ansys/dpf/core/operators/result/compute_invariant_terms_rbd.py index ffccd21fd0b..297f83988d1 100644 --- a/src/ansys/dpf/core/operators/result/compute_invariant_terms_rbd.py +++ b/src/ansys/dpf/core/operators/result/compute_invariant_terms_rbd.py @@ -20,8 +20,8 @@ class compute_invariant_terms_rbd(Operator): matrices, lumped mass matrix, modes …) - Parameters - ---------- + Inputs + ------ rom_matrices: FieldsContainer FieldsContainers containing the reduced matrices mode_shapes: FieldsContainer @@ -41,7 +41,7 @@ class compute_invariant_terms_rbd(Operator): constraint_mode_check: bool, optional if true, the orthogonality of the constraint modes are checked. Default is false. - Returns + Outputs ------- model_data: PropertyField data describing the finite element model diff --git a/src/ansys/dpf/core/operators/result/compute_stress.py b/src/ansys/dpf/core/operators/result/compute_stress.py index e60eb9f41ec..2923237c42b 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress.py +++ b/src/ansys/dpf/core/operators/result/compute_stress.py @@ -20,8 +20,8 @@ class compute_stress(Operator): limitations are applicable for stress computation - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -33,7 +33,7 @@ class compute_stress(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_1.py b/src/ansys/dpf/core/operators/result/compute_stress_1.py index 15058048f65..0fc077a9b2d 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_1.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_1.py @@ -21,8 +21,8 @@ class compute_stress_1(Operator): component. - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_1(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_2.py b/src/ansys/dpf/core/operators/result/compute_stress_2.py index dfdf7ac9672..93b04b20286 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_2.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_2.py @@ -21,8 +21,8 @@ class compute_stress_2(Operator): component. - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_2(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_3.py b/src/ansys/dpf/core/operators/result/compute_stress_3.py index 47f7f1e169a..b4674c8d385 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_3.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_3.py @@ -21,8 +21,8 @@ class compute_stress_3(Operator): component. - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_3(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_X.py b/src/ansys/dpf/core/operators/result/compute_stress_X.py index 3132903a648..5cdcc5420af 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_X.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_X.py @@ -21,8 +21,8 @@ class compute_stress_X(Operator): component (00 component). - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_X(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_XY.py b/src/ansys/dpf/core/operators/result/compute_stress_XY.py index 9782dde9f0b..259ef1e2e9d 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_XY.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_XY.py @@ -21,8 +21,8 @@ class compute_stress_XY(Operator): component (01 component). - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_XY(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_XZ.py b/src/ansys/dpf/core/operators/result/compute_stress_XZ.py index be0479d5498..196b873f724 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_XZ.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_XZ.py @@ -21,8 +21,8 @@ class compute_stress_XZ(Operator): component (02 component). - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_XZ(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_Y.py b/src/ansys/dpf/core/operators/result/compute_stress_Y.py index fb72314a54d..116e9b47ee7 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_Y.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_Y.py @@ -21,8 +21,8 @@ class compute_stress_Y(Operator): component (11 component). - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_Y(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_YZ.py b/src/ansys/dpf/core/operators/result/compute_stress_YZ.py index 67b94ff6b80..2d307a2da17 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_YZ.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_YZ.py @@ -21,8 +21,8 @@ class compute_stress_YZ(Operator): component (12 component). - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_YZ(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_Z.py b/src/ansys/dpf/core/operators/result/compute_stress_Z.py index 8cda5718ebe..30376fbb496 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_Z.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_Z.py @@ -21,8 +21,8 @@ class compute_stress_Z(Operator): component (22 component). - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_Z(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_stress_von_mises.py b/src/ansys/dpf/core/operators/result/compute_stress_von_mises.py index 1650e309a5f..5d9f1cb920e 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_von_mises.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_von_mises.py @@ -21,8 +21,8 @@ class compute_stress_von_mises(Operator): equivalent stress. - Parameters - ---------- + Inputs + ------ scoping: Scoping, optional The element scoping on which the result is computed. streams_container: StreamsContainer, optional @@ -34,7 +34,7 @@ class compute_stress_von_mises(Operator): strain: FieldsContainer or Field Field/or fields container containing only the elastic strain field (element nodal). - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain.py b/src/ansys/dpf/core/operators/result/compute_total_strain.py index 41343b2af5c..ec9ce379071 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain.py @@ -27,8 +27,8 @@ class compute_total_strain(Operator): the database. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_1.py b/src/ansys/dpf/core/operators/result/compute_total_strain_1.py index bb4e21c735a..8cada982a2b 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_1.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_1.py @@ -27,8 +27,8 @@ class compute_total_strain_1(Operator): the database. Get the 1st principal component. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_1(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_2.py b/src/ansys/dpf/core/operators/result/compute_total_strain_2.py index e632ebc8ea2..c28a277b5ef 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_2.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_2.py @@ -27,8 +27,8 @@ class compute_total_strain_2(Operator): the database. Get the 2nd principal component. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_2(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_3.py b/src/ansys/dpf/core/operators/result/compute_total_strain_3.py index ec588722935..63375edeb38 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_3.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_3.py @@ -27,8 +27,8 @@ class compute_total_strain_3(Operator): the database. Get the 3rd principal component. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_3(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_X.py b/src/ansys/dpf/core/operators/result/compute_total_strain_X.py index f37e4ac94d6..9b770d80e14 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_X.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_X.py @@ -27,8 +27,8 @@ class compute_total_strain_X(Operator): the database. Get the XX normal component (00 component). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_X(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_XY.py b/src/ansys/dpf/core/operators/result/compute_total_strain_XY.py index 5b45c42cc9d..bd9fec4c60d 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_XY.py @@ -27,8 +27,8 @@ class compute_total_strain_XY(Operator): the database. Get the XY shear component (01 component). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_XY(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_XZ.py b/src/ansys/dpf/core/operators/result/compute_total_strain_XZ.py index 1824875e3b8..4b905a0b016 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_XZ.py @@ -27,8 +27,8 @@ class compute_total_strain_XZ(Operator): the database. Get the XZ shear component (02 component). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_XZ(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_Y.py b/src/ansys/dpf/core/operators/result/compute_total_strain_Y.py index 6289e2b5395..ad9f1ea9dbb 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_Y.py @@ -27,8 +27,8 @@ class compute_total_strain_Y(Operator): the database. Get the YY normal component (11 component). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_Y(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_YZ.py b/src/ansys/dpf/core/operators/result/compute_total_strain_YZ.py index 47ce8183c5c..2bf0051b5a7 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_YZ.py @@ -27,8 +27,8 @@ class compute_total_strain_YZ(Operator): the database. Get the YZ shear component (12 component). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_YZ(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/compute_total_strain_Z.py b/src/ansys/dpf/core/operators/result/compute_total_strain_Z.py index 783485eca2e..4cda111f956 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain_Z.py @@ -27,8 +27,8 @@ class compute_total_strain_Z(Operator): the database. Get the ZZ normal component (22 component). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1.. Will only be used if no displacement input is given (will be applied on displacement operator). scoping: Scoping, optional @@ -48,7 +48,7 @@ class compute_total_strain_Z(Operator): displacement: FieldsContainer or Field, optional Field/or fields container containing only the displacement field (nodal). If none specified, read displacements from result file using the data_sources. - Returns + Outputs ------- fields_container: FieldsContainer The computed result fields container (elemental nodal). diff --git a/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py b/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py index 7ee9777aa93..346a7f2e899 100644 --- a/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py +++ b/src/ansys/dpf/core/operators/result/contact_fluid_penetration_pressure.py @@ -132,8 +132,8 @@ class contact_fluid_penetration_pressure(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_fluid_penetration_pressure(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_friction_stress.py b/src/ansys/dpf/core/operators/result/contact_friction_stress.py index b1d723530e0..d2f59fa3e0a 100644 --- a/src/ansys/dpf/core/operators/result/contact_friction_stress.py +++ b/src/ansys/dpf/core/operators/result/contact_friction_stress.py @@ -132,8 +132,8 @@ class contact_friction_stress(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_friction_stress(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_gap_distance.py b/src/ansys/dpf/core/operators/result/contact_gap_distance.py index 22cb8c9aa4b..0f4ab2663e4 100644 --- a/src/ansys/dpf/core/operators/result/contact_gap_distance.py +++ b/src/ansys/dpf/core/operators/result/contact_gap_distance.py @@ -132,8 +132,8 @@ class contact_gap_distance(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_gap_distance(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_penetration.py b/src/ansys/dpf/core/operators/result/contact_penetration.py index d3e7dd9b151..b2ec7ecd21a 100644 --- a/src/ansys/dpf/core/operators/result/contact_penetration.py +++ b/src/ansys/dpf/core/operators/result/contact_penetration.py @@ -132,8 +132,8 @@ class contact_penetration(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_penetration(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_pressure.py b/src/ansys/dpf/core/operators/result/contact_pressure.py index 6b2407ef71e..55f426aa53a 100644 --- a/src/ansys/dpf/core/operators/result/contact_pressure.py +++ b/src/ansys/dpf/core/operators/result/contact_pressure.py @@ -132,8 +132,8 @@ class contact_pressure(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_pressure(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_sliding_distance.py b/src/ansys/dpf/core/operators/result/contact_sliding_distance.py index df082c6d75e..b9ed6fbbea2 100644 --- a/src/ansys/dpf/core/operators/result/contact_sliding_distance.py +++ b/src/ansys/dpf/core/operators/result/contact_sliding_distance.py @@ -132,8 +132,8 @@ class contact_sliding_distance(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_sliding_distance(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_status.py b/src/ansys/dpf/core/operators/result/contact_status.py index ae92cd3534a..3bba0c902c0 100644 --- a/src/ansys/dpf/core/operators/result/contact_status.py +++ b/src/ansys/dpf/core/operators/result/contact_status.py @@ -132,8 +132,8 @@ class contact_status(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_status(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py b/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py index 7b35cc01a62..3fc27616a20 100644 --- a/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py +++ b/src/ansys/dpf/core/operators/result/contact_surface_heat_flux.py @@ -132,8 +132,8 @@ class contact_surface_heat_flux(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_surface_heat_flux(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/contact_total_stress.py b/src/ansys/dpf/core/operators/result/contact_total_stress.py index bcbe035a62e..132e2bf6ee6 100644 --- a/src/ansys/dpf/core/operators/result/contact_total_stress.py +++ b/src/ansys/dpf/core/operators/result/contact_total_stress.py @@ -132,8 +132,8 @@ class contact_total_stress(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class contact_total_stress(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/coordinate_system.py b/src/ansys/dpf/core/operators/result/coordinate_system.py index 224f483b655..925ea98ae56 100644 --- a/src/ansys/dpf/core/operators/result/coordinate_system.py +++ b/src/ansys/dpf/core/operators/result/coordinate_system.py @@ -20,13 +20,13 @@ class coordinate_system(Operator): r"""Extracts the Rotation Matrix and Origin of a specific coordinate system. - Parameters - ---------- + Inputs + ------ cs_id: int streams_container: StreamsContainer, optional data_sources: DataSources - Returns + Outputs ------- field: Field the first 9 double are the rotation (3x3 matrix) and the last 3 is the translation vector diff --git a/src/ansys/dpf/core/operators/result/coordinates.py b/src/ansys/dpf/core/operators/result/coordinates.py index 9774dffce4c..feff61b1357 100644 --- a/src/ansys/dpf/core/operators/result/coordinates.py +++ b/src/ansys/dpf/core/operators/result/coordinates.py @@ -20,8 +20,8 @@ class coordinates(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class coordinates(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain.py b/src/ansys/dpf/core/operators/result/creep_strain.py index 4eab545b95b..de5a88db046 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain.py +++ b/src/ansys/dpf/core/operators/result/creep_strain.py @@ -132,8 +132,8 @@ class creep_strain(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class creep_strain(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_X.py b/src/ansys/dpf/core/operators/result/creep_strain_X.py index ce23623e182..803d29f0f64 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_X.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_X.py @@ -22,8 +22,8 @@ class creep_strain_X(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_XY.py b/src/ansys/dpf/core/operators/result/creep_strain_XY.py index 9e78a390ccf..baac38241e3 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_XY.py @@ -22,8 +22,8 @@ class creep_strain_XY(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_XY(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_XZ.py b/src/ansys/dpf/core/operators/result/creep_strain_XZ.py index a44a61c3ae3..118480a68ca 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_XZ.py @@ -22,8 +22,8 @@ class creep_strain_XZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_XZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_Y.py b/src/ansys/dpf/core/operators/result/creep_strain_Y.py index d3e615ac8cf..584dbbeee51 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_Y.py @@ -22,8 +22,8 @@ class creep_strain_Y(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_YZ.py b/src/ansys/dpf/core/operators/result/creep_strain_YZ.py index e5d53079db2..08aa6326844 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_YZ.py @@ -22,8 +22,8 @@ class creep_strain_YZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_YZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_Z.py b/src/ansys/dpf/core/operators/result/creep_strain_Z.py index 36c9bef846c..bff559388a0 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_Z.py @@ -22,8 +22,8 @@ class creep_strain_Z(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py b/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py index e28bc993f81..f8df12d726e 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_energy_density.py @@ -132,8 +132,8 @@ class creep_strain_energy_density(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class creep_strain_energy_density(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_eqv.py b/src/ansys/dpf/core/operators/result/creep_strain_eqv.py index e7e9118d8b6..3667213652c 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_eqv.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_eqv.py @@ -132,8 +132,8 @@ class creep_strain_eqv(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class creep_strain_eqv(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_intensity.py b/src/ansys/dpf/core/operators/result/creep_strain_intensity.py index cb34cde8bd9..7892cc0ef38 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_intensity.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_intensity.py @@ -23,8 +23,8 @@ class creep_strain_intensity(Operator): performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_intensity(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_max_shear.py b/src/ansys/dpf/core/operators/result/creep_strain_max_shear.py index 4a994c21c0f..053776aef77 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_max_shear.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_max_shear.py @@ -23,8 +23,8 @@ class creep_strain_max_shear(Operator): performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class creep_strain_max_shear(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_principal_1.py b/src/ansys/dpf/core/operators/result/creep_strain_principal_1.py index c33c32187f5..32335eccb7e 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_principal_1.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_principal_1.py @@ -25,8 +25,8 @@ class creep_strain_principal_1(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class creep_strain_principal_1(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_principal_2.py b/src/ansys/dpf/core/operators/result/creep_strain_principal_2.py index 23c10058717..1266e2c6f48 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_principal_2.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_principal_2.py @@ -25,8 +25,8 @@ class creep_strain_principal_2(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class creep_strain_principal_2(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/creep_strain_principal_3.py b/src/ansys/dpf/core/operators/result/creep_strain_principal_3.py index f578a6621db..5478aa7ff37 100644 --- a/src/ansys/dpf/core/operators/result/creep_strain_principal_3.py +++ b/src/ansys/dpf/core/operators/result/creep_strain_principal_3.py @@ -25,8 +25,8 @@ class creep_strain_principal_3(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class creep_strain_principal_3(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/current_density.py b/src/ansys/dpf/core/operators/result/current_density.py index 244716df586..42173cb02f9 100644 --- a/src/ansys/dpf/core/operators/result/current_density.py +++ b/src/ansys/dpf/core/operators/result/current_density.py @@ -28,8 +28,8 @@ class current_density(Operator): MAPDL, use the solver specific operator: ``mapdl::rth::JC``. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class current_density(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/cyclic_analytic_seqv_max.py b/src/ansys/dpf/core/operators/result/cyclic_analytic_seqv_max.py index cd47f57a839..b01d4460a4c 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_analytic_seqv_max.py +++ b/src/ansys/dpf/core/operators/result/cyclic_analytic_seqv_max.py @@ -20,8 +20,8 @@ class cyclic_analytic_seqv_max(Operator): expected on 360 degrees - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional mesh_scoping: ScopingsContainer or Scoping, optional fields_container: FieldsContainer @@ -30,7 +30,7 @@ class cyclic_analytic_seqv_max(Operator): default is true cyclic_support: CyclicSupport - Returns + Outputs ------- fields_container: FieldsContainer FieldsContainer filled in diff --git a/src/ansys/dpf/core/operators/result/cyclic_analytic_usum_max.py b/src/ansys/dpf/core/operators/result/cyclic_analytic_usum_max.py index 3098f8e30af..85217802f4c 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_analytic_usum_max.py +++ b/src/ansys/dpf/core/operators/result/cyclic_analytic_usum_max.py @@ -20,8 +20,8 @@ class cyclic_analytic_usum_max(Operator): degrees - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional mesh_scoping: ScopingsContainer or Scoping, optional fields_container: FieldsContainer @@ -30,7 +30,7 @@ class cyclic_analytic_usum_max(Operator): default is true cyclic_support: CyclicSupport - Returns + Outputs ------- fields_container: FieldsContainer FieldsContainer filled in diff --git a/src/ansys/dpf/core/operators/result/cyclic_expansion.py b/src/ansys/dpf/core/operators/result/cyclic_expansion.py index 618606bec05..5216d301e3c 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expansion.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expansion.py @@ -20,8 +20,8 @@ class cyclic_expansion(Operator): scoping (optionals). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional mesh_scoping: ScopingsContainer or Scoping, optional fields_container: FieldsContainer @@ -39,7 +39,7 @@ class cyclic_expansion(Operator): phi: float, optional angle phi in degrees (default value 0.0) - Returns + Outputs ------- fields_container: FieldsContainer FieldsContainer filled in diff --git a/src/ansys/dpf/core/operators/result/density.py b/src/ansys/dpf/core/operators/result/density.py index 2d655aa8a43..f454cc57335 100644 --- a/src/ansys/dpf/core/operators/result/density.py +++ b/src/ansys/dpf/core/operators/result/density.py @@ -19,8 +19,8 @@ class density(Operator): r"""Read Density by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class density(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/displacement.py b/src/ansys/dpf/core/operators/result/displacement.py index df04fe5a7d8..4d0bca2746f 100644 --- a/src/ansys/dpf/core/operators/result/displacement.py +++ b/src/ansys/dpf/core/operators/result/displacement.py @@ -20,8 +20,8 @@ class displacement(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class displacement(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/displacement_X.py b/src/ansys/dpf/core/operators/result/displacement_X.py index 380421d177c..8014d9566cc 100644 --- a/src/ansys/dpf/core/operators/result/displacement_X.py +++ b/src/ansys/dpf/core/operators/result/displacement_X.py @@ -20,8 +20,8 @@ class displacement_X(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class displacement_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/displacement_Y.py b/src/ansys/dpf/core/operators/result/displacement_Y.py index 0c9e2138076..6548f5c5237 100644 --- a/src/ansys/dpf/core/operators/result/displacement_Y.py +++ b/src/ansys/dpf/core/operators/result/displacement_Y.py @@ -20,8 +20,8 @@ class displacement_Y(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class displacement_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/displacement_Z.py b/src/ansys/dpf/core/operators/result/displacement_Z.py index 97472e12130..2598ea88994 100644 --- a/src/ansys/dpf/core/operators/result/displacement_Z.py +++ b/src/ansys/dpf/core/operators/result/displacement_Z.py @@ -20,8 +20,8 @@ class displacement_Z(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class displacement_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/div_lighthill_tensor.py b/src/ansys/dpf/core/operators/result/div_lighthill_tensor.py index 2daeb7adeb3..ca6e99b2a0e 100644 --- a/src/ansys/dpf/core/operators/result/div_lighthill_tensor.py +++ b/src/ansys/dpf/core/operators/result/div_lighthill_tensor.py @@ -20,8 +20,8 @@ class div_lighthill_tensor(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class div_lighthill_tensor(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/dynamic_viscosity.py b/src/ansys/dpf/core/operators/result/dynamic_viscosity.py index 5169f1f6668..af86d8343a8 100644 --- a/src/ansys/dpf/core/operators/result/dynamic_viscosity.py +++ b/src/ansys/dpf/core/operators/result/dynamic_viscosity.py @@ -20,8 +20,8 @@ class dynamic_viscosity(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class dynamic_viscosity(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain.py b/src/ansys/dpf/core/operators/result/elastic_strain.py index aae2b96dc91..ff8b4c00830 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain.py @@ -132,8 +132,8 @@ class elastic_strain(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class elastic_strain(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_X.py b/src/ansys/dpf/core/operators/result/elastic_strain_X.py index f2d5a6c1aef..39c254facca 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_X.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_X.py @@ -22,8 +22,8 @@ class elastic_strain_X(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_XY.py b/src/ansys/dpf/core/operators/result/elastic_strain_XY.py index 391d96fea29..35f9795b9d2 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_XY.py @@ -22,8 +22,8 @@ class elastic_strain_XY(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_XY(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_XZ.py b/src/ansys/dpf/core/operators/result/elastic_strain_XZ.py index de17f99fe87..b5832863a72 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_XZ.py @@ -22,8 +22,8 @@ class elastic_strain_XZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_XZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_Y.py b/src/ansys/dpf/core/operators/result/elastic_strain_Y.py index f227c5f804a..778c3aa62f9 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_Y.py @@ -22,8 +22,8 @@ class elastic_strain_Y(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_YZ.py b/src/ansys/dpf/core/operators/result/elastic_strain_YZ.py index 906435b5a16..7fa4e884d02 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_YZ.py @@ -22,8 +22,8 @@ class elastic_strain_YZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_YZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_Z.py b/src/ansys/dpf/core/operators/result/elastic_strain_Z.py index 39e46756140..48846d57dc1 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_Z.py @@ -22,8 +22,8 @@ class elastic_strain_Z(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py b/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py index a9f1f88d3d7..0aed53cb5b4 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_energy_density.py @@ -132,8 +132,8 @@ class elastic_strain_energy_density(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class elastic_strain_energy_density(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py b/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py index a8e35cb4931..9667defe197 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py @@ -132,8 +132,8 @@ class elastic_strain_eqv(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class elastic_strain_eqv(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_intensity.py b/src/ansys/dpf/core/operators/result/elastic_strain_intensity.py index daac187d8a2..57cd685554e 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_intensity.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_intensity.py @@ -23,8 +23,8 @@ class elastic_strain_intensity(Operator): performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_intensity(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_max_shear.py b/src/ansys/dpf/core/operators/result/elastic_strain_max_shear.py index 254997003c2..bade30cc6f5 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_max_shear.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_max_shear.py @@ -23,8 +23,8 @@ class elastic_strain_max_shear(Operator): performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elastic_strain_max_shear(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_principal_1.py b/src/ansys/dpf/core/operators/result/elastic_strain_principal_1.py index e0ca56cfc77..c2d0ad82256 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_principal_1.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_principal_1.py @@ -25,8 +25,8 @@ class elastic_strain_principal_1(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class elastic_strain_principal_1(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_principal_2.py b/src/ansys/dpf/core/operators/result/elastic_strain_principal_2.py index 012b74aefd0..ff68d52d7c5 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_principal_2.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_principal_2.py @@ -25,8 +25,8 @@ class elastic_strain_principal_2(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class elastic_strain_principal_2(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_principal_3.py b/src/ansys/dpf/core/operators/result/elastic_strain_principal_3.py index 334c8db479a..58b012d825f 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_principal_3.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_principal_3.py @@ -25,8 +25,8 @@ class elastic_strain_principal_3(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class elastic_strain_principal_3(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elastic_strain_rotation_by_euler_nodes.py b/src/ansys/dpf/core/operators/result/elastic_strain_rotation_by_euler_nodes.py index 9166963f815..eda9fd562a4 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_rotation_by_euler_nodes.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_rotation_by_euler_nodes.py @@ -20,14 +20,14 @@ class elastic_strain_rotation_by_euler_nodes(Operator): in the fieldsContainer. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer, optional streams_container: StreamsContainer or Stream or Class Dataprocessing::Crstfilewrapper, optional data_sources: DataSources - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_field.py b/src/ansys/dpf/core/operators/result/electric_field.py index a6eb7a0cef6..8d4f15bfa8f 100644 --- a/src/ansys/dpf/core/operators/result/electric_field.py +++ b/src/ansys/dpf/core/operators/result/electric_field.py @@ -132,8 +132,8 @@ class electric_field(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class electric_field(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_field_X.py b/src/ansys/dpf/core/operators/result/electric_field_X.py index 159f579785e..8f9d3fcc7f1 100644 --- a/src/ansys/dpf/core/operators/result/electric_field_X.py +++ b/src/ansys/dpf/core/operators/result/electric_field_X.py @@ -22,8 +22,8 @@ class electric_field_X(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class electric_field_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_field_Y.py b/src/ansys/dpf/core/operators/result/electric_field_Y.py index 31a40422824..74d61013a5d 100644 --- a/src/ansys/dpf/core/operators/result/electric_field_Y.py +++ b/src/ansys/dpf/core/operators/result/electric_field_Y.py @@ -22,8 +22,8 @@ class electric_field_Y(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class electric_field_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_field_Z.py b/src/ansys/dpf/core/operators/result/electric_field_Z.py index 54aef14fe7d..715eafd6314 100644 --- a/src/ansys/dpf/core/operators/result/electric_field_Z.py +++ b/src/ansys/dpf/core/operators/result/electric_field_Z.py @@ -22,8 +22,8 @@ class electric_field_Z(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class electric_field_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density.py b/src/ansys/dpf/core/operators/result/electric_flux_density.py index 4ee9c0973a3..82823b7dddd 100644 --- a/src/ansys/dpf/core/operators/result/electric_flux_density.py +++ b/src/ansys/dpf/core/operators/result/electric_flux_density.py @@ -132,8 +132,8 @@ class electric_flux_density(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class electric_flux_density(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density_X.py b/src/ansys/dpf/core/operators/result/electric_flux_density_X.py index 9719842b9a8..2ba8dc497c6 100644 --- a/src/ansys/dpf/core/operators/result/electric_flux_density_X.py +++ b/src/ansys/dpf/core/operators/result/electric_flux_density_X.py @@ -22,8 +22,8 @@ class electric_flux_density_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class electric_flux_density_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density_Y.py b/src/ansys/dpf/core/operators/result/electric_flux_density_Y.py index 93efdc4bd4b..3a54ff7c6e3 100644 --- a/src/ansys/dpf/core/operators/result/electric_flux_density_Y.py +++ b/src/ansys/dpf/core/operators/result/electric_flux_density_Y.py @@ -22,8 +22,8 @@ class electric_flux_density_Y(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class electric_flux_density_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_flux_density_Z.py b/src/ansys/dpf/core/operators/result/electric_flux_density_Z.py index 9c2703ea4ce..4768f9c528d 100644 --- a/src/ansys/dpf/core/operators/result/electric_flux_density_Z.py +++ b/src/ansys/dpf/core/operators/result/electric_flux_density_Z.py @@ -22,8 +22,8 @@ class electric_flux_density_Z(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class electric_flux_density_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/electric_potential.py b/src/ansys/dpf/core/operators/result/electric_potential.py index 19405221217..4e7dccd5fbb 100644 --- a/src/ansys/dpf/core/operators/result/electric_potential.py +++ b/src/ansys/dpf/core/operators/result/electric_potential.py @@ -20,8 +20,8 @@ class electric_potential(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class electric_potential(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/element_centroids.py b/src/ansys/dpf/core/operators/result/element_centroids.py index e1f21d10421..e3a614bccb9 100644 --- a/src/ansys/dpf/core/operators/result/element_centroids.py +++ b/src/ansys/dpf/core/operators/result/element_centroids.py @@ -20,8 +20,8 @@ class element_centroids(Operator): readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class element_centroids(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/element_nodal_forces.py b/src/ansys/dpf/core/operators/result/element_nodal_forces.py index 42a25dc8699..5cb72522bad 100644 --- a/src/ansys/dpf/core/operators/result/element_nodal_forces.py +++ b/src/ansys/dpf/core/operators/result/element_nodal_forces.py @@ -132,8 +132,8 @@ class element_nodal_forces(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -169,7 +169,7 @@ class element_nodal_forces(Operator): split_force_components: bool, optional If this pin is set to true, the output fields container splits the ENF by degree of freedom ("dof" label, 0 for translation, 1 for rotation, 2 for temperature) and derivative order ("derivative_order" label, 0 for stiffness terms, 1 for damping terms and 2 for inertial terms). Default is false. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/element_orientations.py b/src/ansys/dpf/core/operators/result/element_orientations.py index e113604f4bd..b43286a62f4 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations.py +++ b/src/ansys/dpf/core/operators/result/element_orientations.py @@ -132,8 +132,8 @@ class element_orientations(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class element_orientations(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/element_orientations_X.py b/src/ansys/dpf/core/operators/result/element_orientations_X.py index 5ecb3d5e19c..dbacbcfbedc 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations_X.py +++ b/src/ansys/dpf/core/operators/result/element_orientations_X.py @@ -22,8 +22,8 @@ class element_orientations_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class element_orientations_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/element_orientations_Y.py b/src/ansys/dpf/core/operators/result/element_orientations_Y.py index 82675d974aa..e864dc5e44a 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations_Y.py +++ b/src/ansys/dpf/core/operators/result/element_orientations_Y.py @@ -22,8 +22,8 @@ class element_orientations_Y(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class element_orientations_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/element_orientations_Z.py b/src/ansys/dpf/core/operators/result/element_orientations_Z.py index d500019f76f..4268e56e842 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations_Z.py +++ b/src/ansys/dpf/core/operators/result/element_orientations_Z.py @@ -22,8 +22,8 @@ class element_orientations_Z(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class element_orientations_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elemental_heat_generation.py b/src/ansys/dpf/core/operators/result/elemental_heat_generation.py index c2f1ae5aaa1..e15738e45d1 100644 --- a/src/ansys/dpf/core/operators/result/elemental_heat_generation.py +++ b/src/ansys/dpf/core/operators/result/elemental_heat_generation.py @@ -20,8 +20,8 @@ class elemental_heat_generation(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class elemental_heat_generation(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elemental_mass.py b/src/ansys/dpf/core/operators/result/elemental_mass.py index bb90945541f..7085f109c33 100644 --- a/src/ansys/dpf/core/operators/result/elemental_mass.py +++ b/src/ansys/dpf/core/operators/result/elemental_mass.py @@ -20,8 +20,8 @@ class elemental_mass(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class elemental_mass(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/elemental_volume.py b/src/ansys/dpf/core/operators/result/elemental_volume.py index 11642910b57..2f8bbd4a26b 100644 --- a/src/ansys/dpf/core/operators/result/elemental_volume.py +++ b/src/ansys/dpf/core/operators/result/elemental_volume.py @@ -20,8 +20,8 @@ class elemental_volume(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class elemental_volume(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/enf_rotation_by_euler_nodes.py b/src/ansys/dpf/core/operators/result/enf_rotation_by_euler_nodes.py index 2814d66af68..0ccebfda8b0 100644 --- a/src/ansys/dpf/core/operators/result/enf_rotation_by_euler_nodes.py +++ b/src/ansys/dpf/core/operators/result/enf_rotation_by_euler_nodes.py @@ -20,14 +20,14 @@ class enf_rotation_by_euler_nodes(Operator): in the fieldsContainer. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer, optional streams_container: StreamsContainer or Stream or Class Dataprocessing::Crstfilewrapper, optional data_sources: DataSources - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/enthalpy.py b/src/ansys/dpf/core/operators/result/enthalpy.py index 008672da8f4..3799a341d9d 100644 --- a/src/ansys/dpf/core/operators/result/enthalpy.py +++ b/src/ansys/dpf/core/operators/result/enthalpy.py @@ -19,8 +19,8 @@ class enthalpy(Operator): r"""Read Enthalpy by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class enthalpy(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/entropy.py b/src/ansys/dpf/core/operators/result/entropy.py index 123e7f0450c..75cf0ef848b 100644 --- a/src/ansys/dpf/core/operators/result/entropy.py +++ b/src/ansys/dpf/core/operators/result/entropy.py @@ -19,8 +19,8 @@ class entropy(Operator): r"""Read Entropy by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class entropy(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/epsilon.py b/src/ansys/dpf/core/operators/result/epsilon.py index 72092e69e3e..ec37d0d4d61 100644 --- a/src/ansys/dpf/core/operators/result/epsilon.py +++ b/src/ansys/dpf/core/operators/result/epsilon.py @@ -20,8 +20,8 @@ class epsilon(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class epsilon(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/equivalent_mass.py b/src/ansys/dpf/core/operators/result/equivalent_mass.py index 98392ed4ff4..29bc4ba7d97 100644 --- a/src/ansys/dpf/core/operators/result/equivalent_mass.py +++ b/src/ansys/dpf/core/operators/result/equivalent_mass.py @@ -20,8 +20,8 @@ class equivalent_mass(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class equivalent_mass(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/equivalent_radiated_power.py b/src/ansys/dpf/core/operators/result/equivalent_radiated_power.py index dd9d79a51c2..fa75771f98d 100644 --- a/src/ansys/dpf/core/operators/result/equivalent_radiated_power.py +++ b/src/ansys/dpf/core/operators/result/equivalent_radiated_power.py @@ -19,8 +19,8 @@ class equivalent_radiated_power(Operator): r"""Compute the Equivalent Radiated Power (ERP) - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer the input field container expects displacements fields mesh: MeshedRegion or MeshesContainer @@ -38,7 +38,7 @@ class equivalent_radiated_power(Operator): factor: float erp reference value. Default is 1E-12 - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py b/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py index 40ee0a4c3d8..7b074442152 100644 --- a/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py +++ b/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py @@ -132,8 +132,8 @@ class eqv_stress_parameter(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class eqv_stress_parameter(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/erp_radiation_efficiency.py b/src/ansys/dpf/core/operators/result/erp_radiation_efficiency.py index 777a1d80205..56167a20da5 100644 --- a/src/ansys/dpf/core/operators/result/erp_radiation_efficiency.py +++ b/src/ansys/dpf/core/operators/result/erp_radiation_efficiency.py @@ -19,8 +19,8 @@ class erp_radiation_efficiency(Operator): r"""Compute the radiation efficiency (enhanced erp divided by classical erp) - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer the input field container expects displacements fields mesh: MeshedRegion or MeshesContainer @@ -32,7 +32,7 @@ class erp_radiation_efficiency(Operator): speed_of_sound: float speed of sound (if it's not specified, default value of the speed of sound in the air is applied). - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/euler_load_buckling.py b/src/ansys/dpf/core/operators/result/euler_load_buckling.py index 91566f43b6c..f2c7109e702 100644 --- a/src/ansys/dpf/core/operators/result/euler_load_buckling.py +++ b/src/ansys/dpf/core/operators/result/euler_load_buckling.py @@ -20,8 +20,8 @@ class euler_load_buckling(Operator): /(L*L) - Parameters - ---------- + Inputs + ------ field_beam_end_condition: DataSources or Field This pin contains file csv or field of beam's end condition added by the user. If there's no file added, it would take value of all beam's end condition as 1. field_beam_moment_inertia: Field @@ -31,7 +31,7 @@ class euler_load_buckling(Operator): field_beam_length: Field Field of beam's length - Returns + Outputs ------- field_euler_critical_load: Field This field contains Euler's Critical Load about the principle axis of the cross section having the least moment of inertia. diff --git a/src/ansys/dpf/core/operators/result/euler_nodes.py b/src/ansys/dpf/core/operators/result/euler_nodes.py index 47185b5206d..6a21c80db78 100644 --- a/src/ansys/dpf/core/operators/result/euler_nodes.py +++ b/src/ansys/dpf/core/operators/result/euler_nodes.py @@ -20,8 +20,8 @@ class euler_nodes(Operator): from the result file. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer or Stream, optional data_sources: DataSources filter_zeros: bool @@ -30,7 +30,7 @@ class euler_nodes(Operator): if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else there is only the Euler angles (default is true). mesh: MeshedRegion, optional - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/fluid_velocity.py b/src/ansys/dpf/core/operators/result/fluid_velocity.py index a7b506779ee..77765fd48d5 100644 --- a/src/ansys/dpf/core/operators/result/fluid_velocity.py +++ b/src/ansys/dpf/core/operators/result/fluid_velocity.py @@ -19,8 +19,8 @@ class fluid_velocity(Operator): r"""Read/compute FV by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -36,7 +36,7 @@ class fluid_velocity(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py index 3defc39c8ee..11ffbe15959 100644 --- a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py +++ b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py @@ -132,8 +132,8 @@ class gasket_inelastic_closure(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -157,7 +157,7 @@ class gasket_inelastic_closure(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_X.py b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_X.py index aa702285733..dcef88a093a 100644 --- a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_X.py +++ b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_X.py @@ -22,8 +22,8 @@ class gasket_inelastic_closure_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_inelastic_closure_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XY.py b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XY.py index 539d0aefe42..c202c14e19c 100644 --- a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XY.py +++ b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XY.py @@ -22,8 +22,8 @@ class gasket_inelastic_closure_XY(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_inelastic_closure_XY(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XZ.py b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XZ.py index 448b36e06d9..f6d4370d215 100644 --- a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XZ.py +++ b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure_XZ.py @@ -22,8 +22,8 @@ class gasket_inelastic_closure_XZ(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_inelastic_closure_XZ(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_stress.py b/src/ansys/dpf/core/operators/result/gasket_stress.py index c4e2e51d699..7e454790a4d 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress.py @@ -132,8 +132,8 @@ class gasket_stress(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -157,7 +157,7 @@ class gasket_stress(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_stress_X.py b/src/ansys/dpf/core/operators/result/gasket_stress_X.py index dca300e15b5..5ac24d6ef2d 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress_X.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress_X.py @@ -22,8 +22,8 @@ class gasket_stress_X(Operator): be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_stress_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_stress_XY.py b/src/ansys/dpf/core/operators/result/gasket_stress_XY.py index 7d79a67744d..ed85b3621c9 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress_XY.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress_XY.py @@ -22,8 +22,8 @@ class gasket_stress_XY(Operator): be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_stress_XY(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_stress_XZ.py b/src/ansys/dpf/core/operators/result/gasket_stress_XZ.py index d1dd352ab1a..31d6b3c9da7 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress_XZ.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress_XZ.py @@ -22,8 +22,8 @@ class gasket_stress_XZ(Operator): be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_stress_XZ(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py b/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py index 14796be3633..365fe7e8bc6 100644 --- a/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py +++ b/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py @@ -132,8 +132,8 @@ class gasket_thermal_closure(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -157,7 +157,7 @@ class gasket_thermal_closure(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_thermal_closure_X.py b/src/ansys/dpf/core/operators/result/gasket_thermal_closure_X.py index 5ada6f9bc3c..48c2b13d699 100644 --- a/src/ansys/dpf/core/operators/result/gasket_thermal_closure_X.py +++ b/src/ansys/dpf/core/operators/result/gasket_thermal_closure_X.py @@ -22,8 +22,8 @@ class gasket_thermal_closure_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_thermal_closure_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XY.py b/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XY.py index c941ceb2f79..d59c478063b 100644 --- a/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XY.py +++ b/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XY.py @@ -22,8 +22,8 @@ class gasket_thermal_closure_XY(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_thermal_closure_XY(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XZ.py b/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XZ.py index 44911aac773..bd1f8316671 100644 --- a/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XZ.py +++ b/src/ansys/dpf/core/operators/result/gasket_thermal_closure_XZ.py @@ -22,8 +22,8 @@ class gasket_thermal_closure_XZ(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_thermal_closure_XZ(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_total_closure.py b/src/ansys/dpf/core/operators/result/gasket_total_closure.py index ff566cd1b6c..3715b1cc719 100644 --- a/src/ansys/dpf/core/operators/result/gasket_total_closure.py +++ b/src/ansys/dpf/core/operators/result/gasket_total_closure.py @@ -20,8 +20,8 @@ class gasket_total_closure(Operator): gasket inelastic closure). - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -41,7 +41,7 @@ class gasket_total_closure(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_total_closure_X.py b/src/ansys/dpf/core/operators/result/gasket_total_closure_X.py index 02a2529e4b8..5d1d51a2e1f 100644 --- a/src/ansys/dpf/core/operators/result/gasket_total_closure_X.py +++ b/src/ansys/dpf/core/operators/result/gasket_total_closure_X.py @@ -22,8 +22,8 @@ class gasket_total_closure_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_total_closure_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_total_closure_XY.py b/src/ansys/dpf/core/operators/result/gasket_total_closure_XY.py index e4e70e33abe..4f07402ffa5 100644 --- a/src/ansys/dpf/core/operators/result/gasket_total_closure_XY.py +++ b/src/ansys/dpf/core/operators/result/gasket_total_closure_XY.py @@ -22,8 +22,8 @@ class gasket_total_closure_XY(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_total_closure_XY(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/gasket_total_closure_XZ.py b/src/ansys/dpf/core/operators/result/gasket_total_closure_XZ.py index 51fac183a64..550601c6873 100644 --- a/src/ansys/dpf/core/operators/result/gasket_total_closure_XZ.py +++ b/src/ansys/dpf/core/operators/result/gasket_total_closure_XZ.py @@ -22,8 +22,8 @@ class gasket_total_closure_XZ(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -43,7 +43,7 @@ class gasket_total_closure_XZ(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_added_mass.py b/src/ansys/dpf/core/operators/result/global_added_mass.py index fd4fa7d8e42..29375c3b274 100644 --- a/src/ansys/dpf/core/operators/result/global_added_mass.py +++ b/src/ansys/dpf/core/operators/result/global_added_mass.py @@ -20,8 +20,8 @@ class global_added_mass(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_added_mass(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_added_mass_pct.py b/src/ansys/dpf/core/operators/result/global_added_mass_pct.py index 8c11fe706e3..09904f3f6f3 100644 --- a/src/ansys/dpf/core/operators/result/global_added_mass_pct.py +++ b/src/ansys/dpf/core/operators/result/global_added_mass_pct.py @@ -20,8 +20,8 @@ class global_added_mass_pct(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_added_mass_pct(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_center_mass.py b/src/ansys/dpf/core/operators/result/global_center_mass.py index aef7e56325f..4f7c600ed13 100644 --- a/src/ansys/dpf/core/operators/result/global_center_mass.py +++ b/src/ansys/dpf/core/operators/result/global_center_mass.py @@ -20,8 +20,8 @@ class global_center_mass(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_center_mass(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_energy_ratio.py b/src/ansys/dpf/core/operators/result/global_energy_ratio.py index 6b2cdecf416..66f23267c60 100644 --- a/src/ansys/dpf/core/operators/result/global_energy_ratio.py +++ b/src/ansys/dpf/core/operators/result/global_energy_ratio.py @@ -20,8 +20,8 @@ class global_energy_ratio(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_energy_ratio(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_energy_ratio_wo_eroded.py b/src/ansys/dpf/core/operators/result/global_energy_ratio_wo_eroded.py index 6bf7b7f9e4c..07af3ddddf9 100644 --- a/src/ansys/dpf/core/operators/result/global_energy_ratio_wo_eroded.py +++ b/src/ansys/dpf/core/operators/result/global_energy_ratio_wo_eroded.py @@ -20,8 +20,8 @@ class global_energy_ratio_wo_eroded(Operator): readers defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_energy_ratio_wo_eroded(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_eroded_hourglass_energy.py b/src/ansys/dpf/core/operators/result/global_eroded_hourglass_energy.py index e83f3fcc230..dd0d4e7309d 100644 --- a/src/ansys/dpf/core/operators/result/global_eroded_hourglass_energy.py +++ b/src/ansys/dpf/core/operators/result/global_eroded_hourglass_energy.py @@ -20,8 +20,8 @@ class global_eroded_hourglass_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_eroded_hourglass_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_eroded_internal_energy.py b/src/ansys/dpf/core/operators/result/global_eroded_internal_energy.py index fcabb19b578..5e124f26118 100644 --- a/src/ansys/dpf/core/operators/result/global_eroded_internal_energy.py +++ b/src/ansys/dpf/core/operators/result/global_eroded_internal_energy.py @@ -20,8 +20,8 @@ class global_eroded_internal_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_eroded_internal_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_eroded_kinetic_energy.py b/src/ansys/dpf/core/operators/result/global_eroded_kinetic_energy.py index c870c9f4d43..5d80a16c974 100644 --- a/src/ansys/dpf/core/operators/result/global_eroded_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/global_eroded_kinetic_energy.py @@ -20,8 +20,8 @@ class global_eroded_kinetic_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_eroded_kinetic_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_external_work.py b/src/ansys/dpf/core/operators/result/global_external_work.py index 26b115432f4..be46c1305f9 100644 --- a/src/ansys/dpf/core/operators/result/global_external_work.py +++ b/src/ansys/dpf/core/operators/result/global_external_work.py @@ -20,8 +20,8 @@ class global_external_work(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_external_work(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_hourglass_energy.py b/src/ansys/dpf/core/operators/result/global_hourglass_energy.py index 998c89a32c9..be2381f5412 100644 --- a/src/ansys/dpf/core/operators/result/global_hourglass_energy.py +++ b/src/ansys/dpf/core/operators/result/global_hourglass_energy.py @@ -20,8 +20,8 @@ class global_hourglass_energy(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_hourglass_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_internal_energy.py b/src/ansys/dpf/core/operators/result/global_internal_energy.py index 162811f51b8..2c7e7e8621a 100644 --- a/src/ansys/dpf/core/operators/result/global_internal_energy.py +++ b/src/ansys/dpf/core/operators/result/global_internal_energy.py @@ -20,8 +20,8 @@ class global_internal_energy(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_internal_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_joint_internal_energy.py b/src/ansys/dpf/core/operators/result/global_joint_internal_energy.py index 96b58bd5dcb..da6ad154c14 100644 --- a/src/ansys/dpf/core/operators/result/global_joint_internal_energy.py +++ b/src/ansys/dpf/core/operators/result/global_joint_internal_energy.py @@ -20,8 +20,8 @@ class global_joint_internal_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_joint_internal_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_kinetic_energy.py b/src/ansys/dpf/core/operators/result/global_kinetic_energy.py index ba1a054dccf..e4449c5b1b5 100644 --- a/src/ansys/dpf/core/operators/result/global_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/global_kinetic_energy.py @@ -20,8 +20,8 @@ class global_kinetic_energy(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_kinetic_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_rigid_body_stopper_energy.py b/src/ansys/dpf/core/operators/result/global_rigid_body_stopper_energy.py index bd8eb840b30..11672f7f92d 100644 --- a/src/ansys/dpf/core/operators/result/global_rigid_body_stopper_energy.py +++ b/src/ansys/dpf/core/operators/result/global_rigid_body_stopper_energy.py @@ -20,8 +20,8 @@ class global_rigid_body_stopper_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_rigid_body_stopper_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_sliding_interface_energy.py b/src/ansys/dpf/core/operators/result/global_sliding_interface_energy.py index f1ed0aa9bf3..6b07858025d 100644 --- a/src/ansys/dpf/core/operators/result/global_sliding_interface_energy.py +++ b/src/ansys/dpf/core/operators/result/global_sliding_interface_energy.py @@ -20,8 +20,8 @@ class global_sliding_interface_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_sliding_interface_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_spring_damper_energy.py b/src/ansys/dpf/core/operators/result/global_spring_damper_energy.py index 71fca67fd71..db60aadfb43 100644 --- a/src/ansys/dpf/core/operators/result/global_spring_damper_energy.py +++ b/src/ansys/dpf/core/operators/result/global_spring_damper_energy.py @@ -20,8 +20,8 @@ class global_spring_damper_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_spring_damper_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_system_damping_energy.py b/src/ansys/dpf/core/operators/result/global_system_damping_energy.py index 93e30c6f382..0496a65b492 100644 --- a/src/ansys/dpf/core/operators/result/global_system_damping_energy.py +++ b/src/ansys/dpf/core/operators/result/global_system_damping_energy.py @@ -20,8 +20,8 @@ class global_system_damping_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_system_damping_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_time_step.py b/src/ansys/dpf/core/operators/result/global_time_step.py index 2dd0e88710e..4e4bc3c048b 100644 --- a/src/ansys/dpf/core/operators/result/global_time_step.py +++ b/src/ansys/dpf/core/operators/result/global_time_step.py @@ -20,8 +20,8 @@ class global_time_step(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_time_step(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_to_nodal.py b/src/ansys/dpf/core/operators/result/global_to_nodal.py index 9855263603d..e4302f805d8 100644 --- a/src/ansys/dpf/core/operators/result/global_to_nodal.py +++ b/src/ansys/dpf/core/operators/result/global_to_nodal.py @@ -19,14 +19,14 @@ class global_to_nodal(Operator): r"""Rotate results from global coordinate system to local coordinate system. - Parameters - ---------- + Inputs + ------ fieldA: Field Vector or tensor field that must be rotated, expressed in global coordinate system. fieldB: Field Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global. - Returns + Outputs ------- field: Field Rotated field diff --git a/src/ansys/dpf/core/operators/result/global_total_energy.py b/src/ansys/dpf/core/operators/result/global_total_energy.py index a8b216cdbb6..dadfcdff1e5 100644 --- a/src/ansys/dpf/core/operators/result/global_total_energy.py +++ b/src/ansys/dpf/core/operators/result/global_total_energy.py @@ -20,8 +20,8 @@ class global_total_energy(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_total_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_total_mass.py b/src/ansys/dpf/core/operators/result/global_total_mass.py index c03f0cc2f25..e9fc6df292c 100644 --- a/src/ansys/dpf/core/operators/result/global_total_mass.py +++ b/src/ansys/dpf/core/operators/result/global_total_mass.py @@ -20,8 +20,8 @@ class global_total_mass(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_total_mass(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/global_velocity.py b/src/ansys/dpf/core/operators/result/global_velocity.py index a0ae487ee1c..8d2c49cc878 100644 --- a/src/ansys/dpf/core/operators/result/global_velocity.py +++ b/src/ansys/dpf/core/operators/result/global_velocity.py @@ -20,8 +20,8 @@ class global_velocity(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -29,7 +29,7 @@ class global_velocity(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/heat_flux.py b/src/ansys/dpf/core/operators/result/heat_flux.py index 042ed0adb5c..5082ee1102b 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux.py +++ b/src/ansys/dpf/core/operators/result/heat_flux.py @@ -132,8 +132,8 @@ class heat_flux(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class heat_flux(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/heat_flux_X.py b/src/ansys/dpf/core/operators/result/heat_flux_X.py index c5bca505d00..01b753026e6 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux_X.py +++ b/src/ansys/dpf/core/operators/result/heat_flux_X.py @@ -22,8 +22,8 @@ class heat_flux_X(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class heat_flux_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/heat_flux_Y.py b/src/ansys/dpf/core/operators/result/heat_flux_Y.py index 2b478686833..96f8a21632b 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux_Y.py +++ b/src/ansys/dpf/core/operators/result/heat_flux_Y.py @@ -22,8 +22,8 @@ class heat_flux_Y(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class heat_flux_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/heat_flux_Z.py b/src/ansys/dpf/core/operators/result/heat_flux_Z.py index 1068dbba3b8..1c64cdb53fd 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux_Z.py +++ b/src/ansys/dpf/core/operators/result/heat_flux_Z.py @@ -22,8 +22,8 @@ class heat_flux_Z(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class heat_flux_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py b/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py index 9878e2de70b..b350e1ba598 100644 --- a/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py +++ b/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py @@ -132,8 +132,8 @@ class hydrostatic_pressure(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class hydrostatic_pressure(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/incremental_energy.py b/src/ansys/dpf/core/operators/result/incremental_energy.py index 0b1cf8b3762..51f6b41dc24 100644 --- a/src/ansys/dpf/core/operators/result/incremental_energy.py +++ b/src/ansys/dpf/core/operators/result/incremental_energy.py @@ -20,8 +20,8 @@ class incremental_energy(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class incremental_energy(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/initial_coordinates.py b/src/ansys/dpf/core/operators/result/initial_coordinates.py index eab57a9c36b..5f1e3d1e266 100644 --- a/src/ansys/dpf/core/operators/result/initial_coordinates.py +++ b/src/ansys/dpf/core/operators/result/initial_coordinates.py @@ -20,8 +20,8 @@ class initial_coordinates(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class initial_coordinates(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/interface_contact_area.py b/src/ansys/dpf/core/operators/result/interface_contact_area.py index 8c92e994c78..5ad5dcd6c2e 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_area.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_area.py @@ -20,8 +20,8 @@ class interface_contact_area(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class interface_contact_area(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/interface_contact_force.py b/src/ansys/dpf/core/operators/result/interface_contact_force.py index 492c83c3ae5..e140a6a3da8 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_force.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_force.py @@ -20,8 +20,8 @@ class interface_contact_force(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class interface_contact_force(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/interface_contact_mass.py b/src/ansys/dpf/core/operators/result/interface_contact_mass.py index 7f128ebcc09..e216420cde4 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_mass.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_mass.py @@ -20,8 +20,8 @@ class interface_contact_mass(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class interface_contact_mass(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/interface_contact_moment.py b/src/ansys/dpf/core/operators/result/interface_contact_moment.py index c8382566775..33ffe9af166 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_moment.py @@ -20,8 +20,8 @@ class interface_contact_moment(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class interface_contact_moment(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/interface_resultant_contact_force.py b/src/ansys/dpf/core/operators/result/interface_resultant_contact_force.py index 4d65a128988..f372d5371e6 100644 --- a/src/ansys/dpf/core/operators/result/interface_resultant_contact_force.py +++ b/src/ansys/dpf/core/operators/result/interface_resultant_contact_force.py @@ -20,8 +20,8 @@ class interface_resultant_contact_force(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class interface_resultant_contact_force(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_force_reaction.py b/src/ansys/dpf/core/operators/result/joint_force_reaction.py index 18a78b810ba..12aa021a7ed 100644 --- a/src/ansys/dpf/core/operators/result/joint_force_reaction.py +++ b/src/ansys/dpf/core/operators/result/joint_force_reaction.py @@ -20,8 +20,8 @@ class joint_force_reaction(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_force_reaction(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_moment_reaction.py b/src/ansys/dpf/core/operators/result/joint_moment_reaction.py index d4aa8250c44..8aab871b623 100644 --- a/src/ansys/dpf/core/operators/result/joint_moment_reaction.py +++ b/src/ansys/dpf/core/operators/result/joint_moment_reaction.py @@ -20,8 +20,8 @@ class joint_moment_reaction(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_moment_reaction(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_relative_acceleration.py b/src/ansys/dpf/core/operators/result/joint_relative_acceleration.py index e4931f29dfa..73c61ed4733 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_acceleration.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_acceleration.py @@ -20,8 +20,8 @@ class joint_relative_acceleration(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_relative_acceleration(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_relative_angular_acceleration.py b/src/ansys/dpf/core/operators/result/joint_relative_angular_acceleration.py index 192f89587a6..6b92decbd80 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_angular_acceleration.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_angular_acceleration.py @@ -20,8 +20,8 @@ class joint_relative_angular_acceleration(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_relative_angular_acceleration(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_relative_angular_velocity.py b/src/ansys/dpf/core/operators/result/joint_relative_angular_velocity.py index 0b1144a0736..e4e4dc1e6df 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_angular_velocity.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_angular_velocity.py @@ -20,8 +20,8 @@ class joint_relative_angular_velocity(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_relative_angular_velocity(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_relative_displacement.py b/src/ansys/dpf/core/operators/result/joint_relative_displacement.py index 240819fc990..10eb3382322 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_displacement.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_displacement.py @@ -20,8 +20,8 @@ class joint_relative_displacement(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_relative_displacement(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_relative_rotation.py b/src/ansys/dpf/core/operators/result/joint_relative_rotation.py index 1e4c45a841a..c03c51bc1ab 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_rotation.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_rotation.py @@ -20,8 +20,8 @@ class joint_relative_rotation(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_relative_rotation(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/joint_relative_velocity.py b/src/ansys/dpf/core/operators/result/joint_relative_velocity.py index c429fdd7b2c..aa8f21c9b2e 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_velocity.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_velocity.py @@ -20,8 +20,8 @@ class joint_relative_velocity(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class joint_relative_velocity(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/kinetic_energy.py b/src/ansys/dpf/core/operators/result/kinetic_energy.py index c7e73517f32..4905aa55bce 100644 --- a/src/ansys/dpf/core/operators/result/kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/kinetic_energy.py @@ -20,8 +20,8 @@ class kinetic_energy(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class kinetic_energy(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/mach_number.py b/src/ansys/dpf/core/operators/result/mach_number.py index 24918179208..deecc36cfb9 100644 --- a/src/ansys/dpf/core/operators/result/mach_number.py +++ b/src/ansys/dpf/core/operators/result/mach_number.py @@ -19,8 +19,8 @@ class mach_number(Operator): r"""Read Mach Number by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class mach_number(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_field.py b/src/ansys/dpf/core/operators/result/magnetic_field.py index 9c91fb7866f..616ca77f083 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_field.py +++ b/src/ansys/dpf/core/operators/result/magnetic_field.py @@ -132,8 +132,8 @@ class magnetic_field(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class magnetic_field(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_field_X.py b/src/ansys/dpf/core/operators/result/magnetic_field_X.py index a21d9dfc399..0db9982b85c 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_field_X.py +++ b/src/ansys/dpf/core/operators/result/magnetic_field_X.py @@ -22,8 +22,8 @@ class magnetic_field_X(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class magnetic_field_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_field_Y.py b/src/ansys/dpf/core/operators/result/magnetic_field_Y.py index c36a7803eb0..8c1a46026c8 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_field_Y.py +++ b/src/ansys/dpf/core/operators/result/magnetic_field_Y.py @@ -22,8 +22,8 @@ class magnetic_field_Y(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class magnetic_field_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_field_Z.py b/src/ansys/dpf/core/operators/result/magnetic_field_Z.py index 40e8ae0df77..0ee2d057182 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_field_Z.py +++ b/src/ansys/dpf/core/operators/result/magnetic_field_Z.py @@ -22,8 +22,8 @@ class magnetic_field_Z(Operator): Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class magnetic_field_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density.py index 5f80e65c047..6b1111c3b4a 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_flux_density.py +++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density.py @@ -132,8 +132,8 @@ class magnetic_flux_density(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class magnetic_flux_density(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density_X.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density_X.py index 49a9a39b16e..91e7c624d18 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_flux_density_X.py +++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density_X.py @@ -22,8 +22,8 @@ class magnetic_flux_density_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class magnetic_flux_density_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density_Y.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Y.py index 7ea4c90b48e..f3bbe265ce1 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_flux_density_Y.py +++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Y.py @@ -22,8 +22,8 @@ class magnetic_flux_density_Y(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class magnetic_flux_density_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_flux_density_Z.py b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Z.py index eedb1a0107e..23b298ba0fb 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_flux_density_Z.py +++ b/src/ansys/dpf/core/operators/result/magnetic_flux_density_Z.py @@ -22,8 +22,8 @@ class magnetic_flux_density_Z(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class magnetic_flux_density_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_scalar_potential.py b/src/ansys/dpf/core/operators/result/magnetic_scalar_potential.py index bf23887f686..c89787fc883 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_scalar_potential.py +++ b/src/ansys/dpf/core/operators/result/magnetic_scalar_potential.py @@ -20,8 +20,8 @@ class magnetic_scalar_potential(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class magnetic_scalar_potential(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/magnetic_vector_potential.py b/src/ansys/dpf/core/operators/result/magnetic_vector_potential.py index 39718387b40..abb43a8d13d 100644 --- a/src/ansys/dpf/core/operators/result/magnetic_vector_potential.py +++ b/src/ansys/dpf/core/operators/result/magnetic_vector_potential.py @@ -20,8 +20,8 @@ class magnetic_vector_potential(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class magnetic_vector_potential(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/mapdl_material_properties.py b/src/ansys/dpf/core/operators/result/mapdl_material_properties.py index 7f38dd22ce0..14dd78c64e2 100644 --- a/src/ansys/dpf/core/operators/result/mapdl_material_properties.py +++ b/src/ansys/dpf/core/operators/result/mapdl_material_properties.py @@ -30,15 +30,15 @@ class mapdl_material_properties(Operator): (key: EMIS). - Parameters - ---------- + Inputs + ------ properties_name: str materials: PropertyField Property field that contains a material id per element. streams_container: StreamsContainer data_sources: DataSources - Returns + Outputs ------- properties_value: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/mapdl_section.py b/src/ansys/dpf/core/operators/result/mapdl_section.py index edfe06c914a..10ec3af0bde 100644 --- a/src/ansys/dpf/core/operators/result/mapdl_section.py +++ b/src/ansys/dpf/core/operators/result/mapdl_section.py @@ -23,8 +23,8 @@ class mapdl_section(Operator): Orientation, NumIntPoints. - Parameters - ---------- + Inputs + ------ properties_name: str section: PropertyField, optional Property field that contains a section id per element.(optional) @@ -35,7 +35,7 @@ class mapdl_section(Operator): layers_requested: optional Array with layers requested for the section. Default = AllLayers. - Returns + Outputs ------- properties_value: FieldsContainer layers_per_section: PropertyField diff --git a/src/ansys/dpf/core/operators/result/mapdl_split_on_facet_indices.py b/src/ansys/dpf/core/operators/result/mapdl_split_on_facet_indices.py index aaec715161e..3aac534d516 100644 --- a/src/ansys/dpf/core/operators/result/mapdl_split_on_facet_indices.py +++ b/src/ansys/dpf/core/operators/result/mapdl_split_on_facet_indices.py @@ -25,8 +25,8 @@ class mapdl_split_on_facet_indices(Operator): indices in the solid mesh. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer Fields container to split, with generic number of labels (e.g. time, zone, complex...), and the Fields of the FieldsContainer will have location Elemental and the Scoping Ids will be the Element Ids on the skin mesh. property_field_new_elements_to_old: PropertyField @@ -40,7 +40,7 @@ class mapdl_split_on_facet_indices(Operator): non_degenerated_tets: Scoping, optional Elemental scoping of tet elements. If connected, the tets in the scoping are treated as non-degenerated tets (SOLID285), and the rest as degenerated tets (SOLID185). Pins 185 and 285 are mutually exclusionary (they cannot be connected at the same time), and if none of them is connected, all tets are treated as non-degenerated (SOLID285). - Returns + Outputs ------- fields_container: FieldsContainer Output splitted fields containter diff --git a/src/ansys/dpf/core/operators/result/mapdl_split_to_acmo_facet_indices.py b/src/ansys/dpf/core/operators/result/mapdl_split_to_acmo_facet_indices.py index 58e7975fcd4..1f39c35da55 100644 --- a/src/ansys/dpf/core/operators/result/mapdl_split_to_acmo_facet_indices.py +++ b/src/ansys/dpf/core/operators/result/mapdl_split_to_acmo_facet_indices.py @@ -22,14 +22,14 @@ class mapdl_split_to_acmo_facet_indices(Operator): to the appropriate entity. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer Fields container to split, with generic number of labels (e.g. time, zone, complex...), 'facet' label is compulsory.The Fields of the FieldsContainer will have location Elemental and the Scoping Ids will be the Element Ids on the skin mesh. property_fields_container_element_types: PropertyFieldsContainer It should only have the 'facet' label. For each facet, it stores a PropertyField with the element types of the corresponding elements.The scoping should be the same as the scoping of the corresponding Field in input 0. - Returns + Outputs ------- fields_container: FieldsContainer Output splitted fields containter diff --git a/src/ansys/dpf/core/operators/result/mass_flow_rate.py b/src/ansys/dpf/core/operators/result/mass_flow_rate.py index 3c3c7861dee..a7d28472179 100644 --- a/src/ansys/dpf/core/operators/result/mass_flow_rate.py +++ b/src/ansys/dpf/core/operators/result/mass_flow_rate.py @@ -19,8 +19,8 @@ class mass_flow_rate(Operator): r"""Read Mass Flow Rate by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class mass_flow_rate(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/mass_fraction.py b/src/ansys/dpf/core/operators/result/mass_fraction.py index 5597ad9dc66..4aabee28429 100644 --- a/src/ansys/dpf/core/operators/result/mass_fraction.py +++ b/src/ansys/dpf/core/operators/result/mass_fraction.py @@ -19,8 +19,8 @@ class mass_fraction(Operator): r"""Read Mass Fraction by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class mass_fraction(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/material_property_of_element.py b/src/ansys/dpf/core/operators/result/material_property_of_element.py index 69a321769ce..f6ad48e9f51 100644 --- a/src/ansys/dpf/core/operators/result/material_property_of_element.py +++ b/src/ansys/dpf/core/operators/result/material_property_of_element.py @@ -20,12 +20,12 @@ class material_property_of_element(Operator): material properties. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional data_sources: DataSources - Returns + Outputs ------- material_properties: Field material properties diff --git a/src/ansys/dpf/core/operators/result/mean_static_pressure.py b/src/ansys/dpf/core/operators/result/mean_static_pressure.py index 5da904f36ff..1ab2622b903 100644 --- a/src/ansys/dpf/core/operators/result/mean_static_pressure.py +++ b/src/ansys/dpf/core/operators/result/mean_static_pressure.py @@ -20,8 +20,8 @@ class mean_static_pressure(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class mean_static_pressure(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/mean_temperature.py b/src/ansys/dpf/core/operators/result/mean_temperature.py index 7e9153b67e0..ce53db0cc8e 100644 --- a/src/ansys/dpf/core/operators/result/mean_temperature.py +++ b/src/ansys/dpf/core/operators/result/mean_temperature.py @@ -19,8 +19,8 @@ class mean_temperature(Operator): r"""Read Mean Temperature by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class mean_temperature(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/mean_velocity.py b/src/ansys/dpf/core/operators/result/mean_velocity.py index 3447af87b9b..a703f1d40e6 100644 --- a/src/ansys/dpf/core/operators/result/mean_velocity.py +++ b/src/ansys/dpf/core/operators/result/mean_velocity.py @@ -19,8 +19,8 @@ class mean_velocity(Operator): r"""Read Mean Velocity by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class mean_velocity(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/members_in_bending_not_certified.py b/src/ansys/dpf/core/operators/result/members_in_bending_not_certified.py index cb5c3357f9c..8ee6f736c3d 100644 --- a/src/ansys/dpf/core/operators/result/members_in_bending_not_certified.py +++ b/src/ansys/dpf/core/operators/result/members_in_bending_not_certified.py @@ -25,8 +25,8 @@ class members_in_bending_not_certified(Operator): Angle L-beam, unequal hollow rectangular beam) not supported. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int, optional field_yield_strength: Field This pin contains field of beam's Yield Strength defined by the user. @@ -45,7 +45,7 @@ class members_in_bending_not_certified(Operator): bending_moment_z: FieldsContainer Fields Container of bending moment on axis z defined by user - Returns + Outputs ------- buckling_resistance_bending_yy: FieldsContainer Fields Container of buckling resistance factor on axis y-y in case of bending(M). These factors should be less than 1 and positive. diff --git a/src/ansys/dpf/core/operators/result/members_in_compression_not_certified.py b/src/ansys/dpf/core/operators/result/members_in_compression_not_certified.py index d0e24b18f0b..4960dab7241 100644 --- a/src/ansys/dpf/core/operators/result/members_in_compression_not_certified.py +++ b/src/ansys/dpf/core/operators/result/members_in_compression_not_certified.py @@ -24,8 +24,8 @@ class members_in_compression_not_certified(Operator): responsibility for the use of this operator. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int, optional time/freq set ids (use ints or scoping) field_yield_strength: DataSources or Field @@ -47,7 +47,7 @@ class members_in_compression_not_certified(Operator): fabrication_type: bool If there is beam I in the structure, please define its fabrication type. True: Rolled section, False: Welded section - Returns + Outputs ------- buckling_resistance_compression_yy: FieldsContainer Fields Container of buckling resistance factor on axis y-y in case of compression. These factors should be less than 1 and positive. diff --git a/src/ansys/dpf/core/operators/result/members_in_linear_compression_bending_not_certified.py b/src/ansys/dpf/core/operators/result/members_in_linear_compression_bending_not_certified.py index 821b85fac9b..2a9d7a12ed2 100644 --- a/src/ansys/dpf/core/operators/result/members_in_linear_compression_bending_not_certified.py +++ b/src/ansys/dpf/core/operators/result/members_in_linear_compression_bending_not_certified.py @@ -25,8 +25,8 @@ class members_in_linear_compression_bending_not_certified(Operator): ANSYS declines all responsibility for the use of this operator. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int, optional field_yield_strength: Field This pin contains field of beam's Yield Strength defined by the user. @@ -53,7 +53,7 @@ class members_in_linear_compression_bending_not_certified(Operator): fabrication_type: bool, optional Selection of fabrication's type if there are beams I in the structure. TRUE: Rolled Section, False: Welded Section. Default: Rolled Section. - Returns + Outputs ------- buckling_resistance_linear_summation_utilization_ratios: FieldsContainer Linear summation of the utilization ratios in all members submitted under a combination of both bending and compression. These factors should be less than 1 and positive. diff --git a/src/ansys/dpf/core/operators/result/migrate_to_h5dpf.py b/src/ansys/dpf/core/operators/result/migrate_to_h5dpf.py index 99fd88245b2..27fab3820c1 100644 --- a/src/ansys/dpf/core/operators/result/migrate_to_h5dpf.py +++ b/src/ansys/dpf/core/operators/result/migrate_to_h5dpf.py @@ -23,8 +23,8 @@ class migrate_to_h5dpf(Operator): {EUL: wf2}, {ENG_SE: wf3}}. - Parameters - ---------- + Inputs + ------ h5_chunk_size: int or GenericDataContainer, optional Size of each HDF5 chunk in kilobytes (KB). Default: 1 MB when compression is enabled; for uncompressed datasets, the default is the full dataset size x dimension. dataset_size_compression_threshold: int or GenericDataContainer, optional @@ -48,7 +48,7 @@ class migrate_to_h5dpf(Operator): filtering_workflow: Workflow or GenericDataContainer, optional Applies input filtering workflow. - Returns + Outputs ------- migrated_file: DataSources diff --git a/src/ansys/dpf/core/operators/result/modal_acceleration.py b/src/ansys/dpf/core/operators/result/modal_acceleration.py index f79c0951b0a..15c3dc0bdca 100644 --- a/src/ansys/dpf/core/operators/result/modal_acceleration.py +++ b/src/ansys/dpf/core/operators/result/modal_acceleration.py @@ -20,8 +20,8 @@ class modal_acceleration(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class modal_acceleration(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/modal_basis.py b/src/ansys/dpf/core/operators/result/modal_basis.py index 37ee6925ebe..d9646b6cf99 100644 --- a/src/ansys/dpf/core/operators/result/modal_basis.py +++ b/src/ansys/dpf/core/operators/result/modal_basis.py @@ -20,8 +20,8 @@ class modal_basis(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class modal_basis(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/modal_coordinate.py b/src/ansys/dpf/core/operators/result/modal_coordinate.py index ceeee77b7da..e11093a8cb2 100644 --- a/src/ansys/dpf/core/operators/result/modal_coordinate.py +++ b/src/ansys/dpf/core/operators/result/modal_coordinate.py @@ -21,8 +21,8 @@ class modal_coordinate(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class modal_coordinate(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/modal_velocity.py b/src/ansys/dpf/core/operators/result/modal_velocity.py index 494ce56bfec..04d290be152 100644 --- a/src/ansys/dpf/core/operators/result/modal_velocity.py +++ b/src/ansys/dpf/core/operators/result/modal_velocity.py @@ -20,8 +20,8 @@ class modal_velocity(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class modal_velocity(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nmisc.py b/src/ansys/dpf/core/operators/result/nmisc.py index 166e7649302..d33fa1462c6 100644 --- a/src/ansys/dpf/core/operators/result/nmisc.py +++ b/src/ansys/dpf/core/operators/result/nmisc.py @@ -23,8 +23,8 @@ class nmisc(Operator): results cannot be summed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -52,7 +52,7 @@ class nmisc(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_force.py b/src/ansys/dpf/core/operators/result/nodal_force.py index 60d5d7f09cc..7a991c14365 100644 --- a/src/ansys/dpf/core/operators/result/nodal_force.py +++ b/src/ansys/dpf/core/operators/result/nodal_force.py @@ -20,8 +20,8 @@ class nodal_force(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class nodal_force(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_moment.py b/src/ansys/dpf/core/operators/result/nodal_moment.py index 095fb7a876b..90fafe634a9 100644 --- a/src/ansys/dpf/core/operators/result/nodal_moment.py +++ b/src/ansys/dpf/core/operators/result/nodal_moment.py @@ -20,8 +20,8 @@ class nodal_moment(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class nodal_moment(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotation.py b/src/ansys/dpf/core/operators/result/nodal_rotation.py index 54cbff9298f..61f90b076ac 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotation.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotation.py @@ -20,8 +20,8 @@ class nodal_rotation(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class nodal_rotation(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotation_X.py b/src/ansys/dpf/core/operators/result/nodal_rotation_X.py index 71766909b22..45038a90e8a 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotation_X.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotation_X.py @@ -20,8 +20,8 @@ class nodal_rotation_X(Operator): calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotation_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotation_Y.py b/src/ansys/dpf/core/operators/result/nodal_rotation_Y.py index 1c283af64fb..dd7c8f4d681 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotation_Y.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotation_Y.py @@ -20,8 +20,8 @@ class nodal_rotation_Y(Operator): calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotation_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotation_Z.py b/src/ansys/dpf/core/operators/result/nodal_rotation_Z.py index 4385568087a..fc9c3cff0ab 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotation_Z.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotation_Z.py @@ -20,8 +20,8 @@ class nodal_rotation_Z(Operator): calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotation_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration.py b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration.py index 46e4bc2331b..2d3a66be7f9 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration.py @@ -20,8 +20,8 @@ class nodal_rotational_acceleration(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class nodal_rotational_acceleration(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_X.py b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_X.py index 30853b6f9b9..5c2adc6481b 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_X.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_X.py @@ -20,8 +20,8 @@ class nodal_rotational_acceleration_X(Operator): (1st component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotational_acceleration_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Y.py b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Y.py index 30a05f7dfd7..06509f65db8 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Y.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Y.py @@ -20,8 +20,8 @@ class nodal_rotational_acceleration_Y(Operator): (2nd component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotational_acceleration_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Z.py b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Z.py index 5f9590ee6d1..914c3a430ae 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Z.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_acceleration_Z.py @@ -20,8 +20,8 @@ class nodal_rotational_acceleration_Z(Operator): (3rd component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotational_acceleration_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity.py b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity.py index 08d49a4cd07..b0a7003983c 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity.py @@ -20,8 +20,8 @@ class nodal_rotational_velocity(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class nodal_rotational_velocity(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_X.py b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_X.py index f2ad944961d..3634047ab02 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_X.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_X.py @@ -20,8 +20,8 @@ class nodal_rotational_velocity_X(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotational_velocity_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Y.py b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Y.py index 302fa68bfd5..de3f70c575a 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Y.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Y.py @@ -20,8 +20,8 @@ class nodal_rotational_velocity_Y(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotational_velocity_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Z.py b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Z.py index ff62dd47b4c..5c7b0f4d26a 100644 --- a/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Z.py +++ b/src/ansys/dpf/core/operators/result/nodal_rotational_velocity_Z.py @@ -20,8 +20,8 @@ class nodal_rotational_velocity_Z(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class nodal_rotational_velocity_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/nodal_to_global.py b/src/ansys/dpf/core/operators/result/nodal_to_global.py index ba998171f27..afd9ae6ea47 100644 --- a/src/ansys/dpf/core/operators/result/nodal_to_global.py +++ b/src/ansys/dpf/core/operators/result/nodal_to_global.py @@ -19,14 +19,14 @@ class nodal_to_global(Operator): r"""Rotates nodal elemental results to global coordinate system - Parameters - ---------- + Inputs + ------ fieldA: Field Vector or tensor field that must be rotated, expressed in nodal coordinate system. fieldB: Field Nodal euler angles defined from a result file. Those must be the rotations from Nodal to Global. - Returns + Outputs ------- field: Field Rotated field diff --git a/src/ansys/dpf/core/operators/result/node_orientations.py b/src/ansys/dpf/core/operators/result/node_orientations.py index b5faca66955..1bf1599cf70 100644 --- a/src/ansys/dpf/core/operators/result/node_orientations.py +++ b/src/ansys/dpf/core/operators/result/node_orientations.py @@ -20,8 +20,8 @@ class node_orientations(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class node_orientations(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/node_orientations_X.py b/src/ansys/dpf/core/operators/result/node_orientations_X.py index 50b6372e318..0950c72dc45 100644 --- a/src/ansys/dpf/core/operators/result/node_orientations_X.py +++ b/src/ansys/dpf/core/operators/result/node_orientations_X.py @@ -20,8 +20,8 @@ class node_orientations_X(Operator): by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class node_orientations_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/node_orientations_Y.py b/src/ansys/dpf/core/operators/result/node_orientations_Y.py index eadfe7910e6..234a1f4ee35 100644 --- a/src/ansys/dpf/core/operators/result/node_orientations_Y.py +++ b/src/ansys/dpf/core/operators/result/node_orientations_Y.py @@ -20,8 +20,8 @@ class node_orientations_Y(Operator): by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class node_orientations_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/node_orientations_Z.py b/src/ansys/dpf/core/operators/result/node_orientations_Z.py index 6a1ba0abb0f..fc156a585a0 100644 --- a/src/ansys/dpf/core/operators/result/node_orientations_Z.py +++ b/src/ansys/dpf/core/operators/result/node_orientations_Z.py @@ -20,8 +20,8 @@ class node_orientations_Z(Operator): by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class node_orientations_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/normal_contact_force.py b/src/ansys/dpf/core/operators/result/normal_contact_force.py index 5e295e902e4..4d1b002bc9f 100644 --- a/src/ansys/dpf/core/operators/result/normal_contact_force.py +++ b/src/ansys/dpf/core/operators/result/normal_contact_force.py @@ -20,8 +20,8 @@ class normal_contact_force(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class normal_contact_force(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/normal_contact_moment.py b/src/ansys/dpf/core/operators/result/normal_contact_moment.py index 8a330aeda2f..4eccfdd7cae 100644 --- a/src/ansys/dpf/core/operators/result/normal_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/normal_contact_moment.py @@ -20,8 +20,8 @@ class normal_contact_moment(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class normal_contact_moment(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/num_surface_status_changes.py b/src/ansys/dpf/core/operators/result/num_surface_status_changes.py index 1246c5d0bf6..8bcc99ed6ea 100644 --- a/src/ansys/dpf/core/operators/result/num_surface_status_changes.py +++ b/src/ansys/dpf/core/operators/result/num_surface_status_changes.py @@ -132,8 +132,8 @@ class num_surface_status_changes(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class num_surface_status_changes(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/omega.py b/src/ansys/dpf/core/operators/result/omega.py index 0621045680b..0f47574662f 100644 --- a/src/ansys/dpf/core/operators/result/omega.py +++ b/src/ansys/dpf/core/operators/result/omega.py @@ -20,8 +20,8 @@ class omega(Operator): defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class omega(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_added_mass.py b/src/ansys/dpf/core/operators/result/part_added_mass.py index 977dbc62759..92a3c88f5af 100644 --- a/src/ansys/dpf/core/operators/result/part_added_mass.py +++ b/src/ansys/dpf/core/operators/result/part_added_mass.py @@ -20,8 +20,8 @@ class part_added_mass(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_added_mass(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_eroded_internal_energy.py b/src/ansys/dpf/core/operators/result/part_eroded_internal_energy.py index b1bf4d16b0d..9d510ffb098 100644 --- a/src/ansys/dpf/core/operators/result/part_eroded_internal_energy.py +++ b/src/ansys/dpf/core/operators/result/part_eroded_internal_energy.py @@ -20,8 +20,8 @@ class part_eroded_internal_energy(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_eroded_internal_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_eroded_kinetic_energy.py b/src/ansys/dpf/core/operators/result/part_eroded_kinetic_energy.py index 096639cdbf2..6e3f5e2f4f2 100644 --- a/src/ansys/dpf/core/operators/result/part_eroded_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/part_eroded_kinetic_energy.py @@ -20,8 +20,8 @@ class part_eroded_kinetic_energy(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_eroded_kinetic_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_hourglass_energy.py b/src/ansys/dpf/core/operators/result/part_hourglass_energy.py index 61fde9df150..f79f3d0a61b 100644 --- a/src/ansys/dpf/core/operators/result/part_hourglass_energy.py +++ b/src/ansys/dpf/core/operators/result/part_hourglass_energy.py @@ -20,8 +20,8 @@ class part_hourglass_energy(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_hourglass_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_internal_energy.py b/src/ansys/dpf/core/operators/result/part_internal_energy.py index 8d3012308ec..338866054ee 100644 --- a/src/ansys/dpf/core/operators/result/part_internal_energy.py +++ b/src/ansys/dpf/core/operators/result/part_internal_energy.py @@ -20,8 +20,8 @@ class part_internal_energy(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_internal_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_kinetic_energy.py b/src/ansys/dpf/core/operators/result/part_kinetic_energy.py index 89bdf0e7825..e96b0eac2e5 100644 --- a/src/ansys/dpf/core/operators/result/part_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/part_kinetic_energy.py @@ -20,8 +20,8 @@ class part_kinetic_energy(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_kinetic_energy(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_momentum.py b/src/ansys/dpf/core/operators/result/part_momentum.py index f4eab99f22a..1bbd73d8426 100644 --- a/src/ansys/dpf/core/operators/result/part_momentum.py +++ b/src/ansys/dpf/core/operators/result/part_momentum.py @@ -20,8 +20,8 @@ class part_momentum(Operator): datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_momentum(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/part_rigid_body_velocity.py b/src/ansys/dpf/core/operators/result/part_rigid_body_velocity.py index 9990fdb79cb..14b6fcaa0f4 100644 --- a/src/ansys/dpf/core/operators/result/part_rigid_body_velocity.py +++ b/src/ansys/dpf/core/operators/result/part_rigid_body_velocity.py @@ -20,8 +20,8 @@ class part_rigid_body_velocity(Operator): the datasources. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional result file container allowed to be kept open to cache data data_sources: DataSources @@ -31,7 +31,7 @@ class part_rigid_body_velocity(Operator): unit_system: int or str or UnitSystem, optional (LSDyna) Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_state_variable.py b/src/ansys/dpf/core/operators/result/plastic_state_variable.py index d27693f4427..42c8c842b54 100644 --- a/src/ansys/dpf/core/operators/result/plastic_state_variable.py +++ b/src/ansys/dpf/core/operators/result/plastic_state_variable.py @@ -132,8 +132,8 @@ class plastic_state_variable(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class plastic_state_variable(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain.py b/src/ansys/dpf/core/operators/result/plastic_strain.py index a4e459140a4..7064ce230a8 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain.py @@ -132,8 +132,8 @@ class plastic_strain(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class plastic_strain(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_X.py b/src/ansys/dpf/core/operators/result/plastic_strain_X.py index 80986f62cc0..399d586f151 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_X.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_X.py @@ -22,8 +22,8 @@ class plastic_strain_X(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_XY.py b/src/ansys/dpf/core/operators/result/plastic_strain_XY.py index f260f5f529b..11e5379fe69 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_XY.py @@ -22,8 +22,8 @@ class plastic_strain_XY(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_XY(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_XZ.py b/src/ansys/dpf/core/operators/result/plastic_strain_XZ.py index aefc01f36fb..56528d1aed4 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_XZ.py @@ -22,8 +22,8 @@ class plastic_strain_XZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_XZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_Y.py b/src/ansys/dpf/core/operators/result/plastic_strain_Y.py index b163ac670dd..3d13e47b6fb 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_Y.py @@ -22,8 +22,8 @@ class plastic_strain_Y(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_YZ.py b/src/ansys/dpf/core/operators/result/plastic_strain_YZ.py index 016f53830bd..2db889954db 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_YZ.py @@ -22,8 +22,8 @@ class plastic_strain_YZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_YZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_Z.py b/src/ansys/dpf/core/operators/result/plastic_strain_Z.py index b2124b343a2..05f74a55996 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_Z.py @@ -22,8 +22,8 @@ class plastic_strain_Z(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py b/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py index 29483217ef4..26d35b3c417 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_energy_density.py @@ -132,8 +132,8 @@ class plastic_strain_energy_density(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class plastic_strain_energy_density(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py b/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py index 25b2686cfcb..6f6c738ee90 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py @@ -132,8 +132,8 @@ class plastic_strain_eqv(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class plastic_strain_eqv(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_intensity.py b/src/ansys/dpf/core/operators/result/plastic_strain_intensity.py index c04c3903734..39443850020 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_intensity.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_intensity.py @@ -23,8 +23,8 @@ class plastic_strain_intensity(Operator): performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_intensity(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_max_shear.py b/src/ansys/dpf/core/operators/result/plastic_strain_max_shear.py index 38cd1c23406..97e0a2d9b5d 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_max_shear.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_max_shear.py @@ -23,8 +23,8 @@ class plastic_strain_max_shear(Operator): performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class plastic_strain_max_shear(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_principal_1.py b/src/ansys/dpf/core/operators/result/plastic_strain_principal_1.py index ed06646cd3a..68ace62df59 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_principal_1.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_principal_1.py @@ -25,8 +25,8 @@ class plastic_strain_principal_1(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class plastic_strain_principal_1(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_principal_2.py b/src/ansys/dpf/core/operators/result/plastic_strain_principal_2.py index 654b7771a67..7fcf85b66ce 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_principal_2.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_principal_2.py @@ -25,8 +25,8 @@ class plastic_strain_principal_2(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class plastic_strain_principal_2(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_principal_3.py b/src/ansys/dpf/core/operators/result/plastic_strain_principal_3.py index 0c149bba04d..71640e6e2a3 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_principal_3.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_principal_3.py @@ -25,8 +25,8 @@ class plastic_strain_principal_3(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class plastic_strain_principal_3(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/plastic_strain_rotation_by_euler_nodes.py b/src/ansys/dpf/core/operators/result/plastic_strain_rotation_by_euler_nodes.py index c690cea8058..cceb48b8b42 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_rotation_by_euler_nodes.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_rotation_by_euler_nodes.py @@ -20,14 +20,14 @@ class plastic_strain_rotation_by_euler_nodes(Operator): in the fieldsContainer. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer, optional streams_container: StreamsContainer or Stream or Class Dataprocessing::Crstfilewrapper, optional data_sources: DataSources - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/poynting_vector.py b/src/ansys/dpf/core/operators/result/poynting_vector.py index 2e81cbae995..489fd7736af 100644 --- a/src/ansys/dpf/core/operators/result/poynting_vector.py +++ b/src/ansys/dpf/core/operators/result/poynting_vector.py @@ -19,8 +19,8 @@ class poynting_vector(Operator): r"""Compute the Poynting Vector - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer fields_containerB: FieldsContainer fields_containerC: FieldsContainer @@ -30,7 +30,7 @@ class poynting_vector(Operator): int32: int, optional load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/poynting_vector_surface.py b/src/ansys/dpf/core/operators/result/poynting_vector_surface.py index b85a86faecb..255fe9ca413 100644 --- a/src/ansys/dpf/core/operators/result/poynting_vector_surface.py +++ b/src/ansys/dpf/core/operators/result/poynting_vector_surface.py @@ -19,8 +19,8 @@ class poynting_vector_surface(Operator): r"""Compute the Poynting Vector surface integral - Parameters - ---------- + Inputs + ------ fields_containerA: FieldsContainer fields_containerB: FieldsContainer fields_containerC: FieldsContainer @@ -30,7 +30,7 @@ class poynting_vector_surface(Operator): int32: int, optional load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/pres_to_field.py b/src/ansys/dpf/core/operators/result/pres_to_field.py index 0ba8f995b5c..94f367a4aed 100644 --- a/src/ansys/dpf/core/operators/result/pres_to_field.py +++ b/src/ansys/dpf/core/operators/result/pres_to_field.py @@ -19,14 +19,14 @@ class pres_to_field(Operator): r"""Read the presol generated file from mapdl. - Parameters - ---------- + Inputs + ------ filepath: str filepath columns_to_read: int, optional columns_to_read - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/result/pressure.py b/src/ansys/dpf/core/operators/result/pressure.py index 27e4c6f7ed8..45c72037b01 100644 --- a/src/ansys/dpf/core/operators/result/pressure.py +++ b/src/ansys/dpf/core/operators/result/pressure.py @@ -19,8 +19,8 @@ class pressure(Operator): r"""Read/compute Pressure by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -36,7 +36,7 @@ class pressure(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/pretension.py b/src/ansys/dpf/core/operators/result/pretension.py index cb8f7cfaa05..73b3ad2129d 100644 --- a/src/ansys/dpf/core/operators/result/pretension.py +++ b/src/ansys/dpf/core/operators/result/pretension.py @@ -20,8 +20,8 @@ class pretension(Operator): allowed for these results. - Parameters - ---------- + Inputs + ------ time_scoping: ScopingsContainer or Scoping, optional mesh_scoping: ScopingsContainer or Scoping, optional fields_container: FieldsContainer, optional @@ -38,7 +38,7 @@ class pretension(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- adjustment: FieldsContainer Adjustment diff --git a/src/ansys/dpf/core/operators/result/prns_to_field.py b/src/ansys/dpf/core/operators/result/prns_to_field.py index d935ed3e49a..dc3f0466b30 100644 --- a/src/ansys/dpf/core/operators/result/prns_to_field.py +++ b/src/ansys/dpf/core/operators/result/prns_to_field.py @@ -19,14 +19,14 @@ class prns_to_field(Operator): r"""Read the presol of nodal field generated file from mapdl. - Parameters - ---------- + Inputs + ------ filepath: str filepath columns_to_read: int, optional columns_to_read - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/result/raw_displacement.py b/src/ansys/dpf/core/operators/result/raw_displacement.py index e6662638b35..f083aa54af3 100644 --- a/src/ansys/dpf/core/operators/result/raw_displacement.py +++ b/src/ansys/dpf/core/operators/result/raw_displacement.py @@ -20,8 +20,8 @@ class raw_displacement(Operator): the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class raw_displacement(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/raw_reaction_force.py b/src/ansys/dpf/core/operators/result/raw_reaction_force.py index 9d15154e1ed..ea14aedce4b 100644 --- a/src/ansys/dpf/core/operators/result/raw_reaction_force.py +++ b/src/ansys/dpf/core/operators/result/raw_reaction_force.py @@ -20,8 +20,8 @@ class raw_reaction_force(Operator): the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class raw_reaction_force(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/reaction_force.py b/src/ansys/dpf/core/operators/result/reaction_force.py index a0f495dc49e..12e520d8db3 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force.py +++ b/src/ansys/dpf/core/operators/result/reaction_force.py @@ -20,8 +20,8 @@ class reaction_force(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class reaction_force(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/reaction_force_X.py b/src/ansys/dpf/core/operators/result/reaction_force_X.py index 9c99d0990d0..888d627f8d5 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force_X.py +++ b/src/ansys/dpf/core/operators/result/reaction_force_X.py @@ -20,8 +20,8 @@ class reaction_force_X(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class reaction_force_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/reaction_force_Y.py b/src/ansys/dpf/core/operators/result/reaction_force_Y.py index 52b6de41f28..e7d89ef61ea 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force_Y.py +++ b/src/ansys/dpf/core/operators/result/reaction_force_Y.py @@ -20,8 +20,8 @@ class reaction_force_Y(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class reaction_force_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/reaction_force_Z.py b/src/ansys/dpf/core/operators/result/reaction_force_Z.py index 6b4f1ebc526..cffb6e8eda9 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force_Z.py +++ b/src/ansys/dpf/core/operators/result/reaction_force_Z.py @@ -20,8 +20,8 @@ class reaction_force_Z(Operator): component) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class reaction_force_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/read_cms_rbd_file.py b/src/ansys/dpf/core/operators/result/read_cms_rbd_file.py index facb29ccadb..bf7d90c5c80 100644 --- a/src/ansys/dpf/core/operators/result/read_cms_rbd_file.py +++ b/src/ansys/dpf/core/operators/result/read_cms_rbd_file.py @@ -19,12 +19,12 @@ class read_cms_rbd_file(Operator): r"""Read the invariant terms and the model data from a cms_rbd file - Parameters - ---------- + Inputs + ------ in_cms_rbd_file_path: str file name with cms_rbd extension where to read the input cms_rbd file. - Returns + Outputs ------- model_data: PropertyField data describing the finite element model diff --git a/src/ansys/dpf/core/operators/result/recombine_harmonic_indeces_cyclic.py b/src/ansys/dpf/core/operators/result/recombine_harmonic_indeces_cyclic.py index 0bf0b28916e..ee6c01116e4 100644 --- a/src/ansys/dpf/core/operators/result/recombine_harmonic_indeces_cyclic.py +++ b/src/ansys/dpf/core/operators/result/recombine_harmonic_indeces_cyclic.py @@ -20,13 +20,13 @@ class recombine_harmonic_indeces_cyclic(Operator): frequencies to compute the response. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer is_constant: bool, optional If the result is constant, it will only copy the first result found. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/remove_rigid_body_motion.py b/src/ansys/dpf/core/operators/result/remove_rigid_body_motion.py index f3f8d2c5f14..9a185cedd8e 100644 --- a/src/ansys/dpf/core/operators/result/remove_rigid_body_motion.py +++ b/src/ansys/dpf/core/operators/result/remove_rigid_body_motion.py @@ -21,8 +21,8 @@ class remove_rigid_body_motion(Operator): result displacement field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected reference_node_id: int, optional @@ -30,7 +30,7 @@ class remove_rigid_body_motion(Operator): mesh: MeshedRegion, optional default is the mesh in the support - Returns + Outputs ------- field: Field translation_field: Field diff --git a/src/ansys/dpf/core/operators/result/remove_rigid_body_motion_fc.py b/src/ansys/dpf/core/operators/result/remove_rigid_body_motion_fc.py index bd51226b206..b18d5e540c0 100644 --- a/src/ansys/dpf/core/operators/result/remove_rigid_body_motion_fc.py +++ b/src/ansys/dpf/core/operators/result/remove_rigid_body_motion_fc.py @@ -21,8 +21,8 @@ class remove_rigid_body_motion_fc(Operator): result displacement field. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected reference_node_id: int, optional @@ -30,7 +30,7 @@ class remove_rigid_body_motion_fc(Operator): mesh: MeshedRegion, optional default is the mesh in the support - Returns + Outputs ------- fields_container: FieldsContainer translation_field: Field diff --git a/src/ansys/dpf/core/operators/result/result_provider.py b/src/ansys/dpf/core/operators/result/result_provider.py index d62142c1348..f2be2207a71 100644 --- a/src/ansys/dpf/core/operators/result/result_provider.py +++ b/src/ansys/dpf/core/operators/result/result_provider.py @@ -21,8 +21,8 @@ class result_provider(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -42,7 +42,7 @@ class result_provider(Operator): result_scripting_name: optional Specifies the scripting name of the result to extract;see ResultInfo for details. Use either "result name" or "result scripting name" with their appropriate pin, but not both. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/rigid_transformation.py b/src/ansys/dpf/core/operators/result/rigid_transformation.py index 76c3febee35..02f3f42fc5d 100644 --- a/src/ansys/dpf/core/operators/result/rigid_transformation.py +++ b/src/ansys/dpf/core/operators/result/rigid_transformation.py @@ -19,14 +19,14 @@ class rigid_transformation(Operator): r"""Extracts rigid body motions from a displacement in input. - Parameters - ---------- + Inputs + ------ streams_container: StreamsContainer, optional streams (result file container) (optional) data_sources: DataSources If the stream is null, retrieves the file path from the data sources. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/rigid_transformation_provider.py b/src/ansys/dpf/core/operators/result/rigid_transformation_provider.py index f0608e46a62..9ae28ced206 100644 --- a/src/ansys/dpf/core/operators/result/rigid_transformation_provider.py +++ b/src/ansys/dpf/core/operators/result/rigid_transformation_provider.py @@ -19,14 +19,14 @@ class rigid_transformation_provider(Operator): r"""Extracts rigid body transformation from dsub file. - Parameters - ---------- + Inputs + ------ streams: Stream, optional streams (result file container) (optional) data_sources: DataSources data source of dsub file. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/rms_static_pressure.py b/src/ansys/dpf/core/operators/result/rms_static_pressure.py index 1c81ae8f16c..e9ce1b9e876 100644 --- a/src/ansys/dpf/core/operators/result/rms_static_pressure.py +++ b/src/ansys/dpf/core/operators/result/rms_static_pressure.py @@ -20,8 +20,8 @@ class rms_static_pressure(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class rms_static_pressure(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/rms_temperature.py b/src/ansys/dpf/core/operators/result/rms_temperature.py index 2f89e65d611..0f70f3011a0 100644 --- a/src/ansys/dpf/core/operators/result/rms_temperature.py +++ b/src/ansys/dpf/core/operators/result/rms_temperature.py @@ -19,8 +19,8 @@ class rms_temperature(Operator): r"""Read RMS Temperature by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class rms_temperature(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/rms_velocity.py b/src/ansys/dpf/core/operators/result/rms_velocity.py index a2362f45c54..d667ceb1cd8 100644 --- a/src/ansys/dpf/core/operators/result/rms_velocity.py +++ b/src/ansys/dpf/core/operators/result/rms_velocity.py @@ -19,8 +19,8 @@ class rms_velocity(Operator): r"""Read RMS Velocity by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class rms_velocity(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/rom_data_provider.py b/src/ansys/dpf/core/operators/result/rom_data_provider.py index 94bdb147f3a..70df58ab5ed 100644 --- a/src/ansys/dpf/core/operators/result/rom_data_provider.py +++ b/src/ansys/dpf/core/operators/result/rom_data_provider.py @@ -20,8 +20,8 @@ class rom_data_provider(Operator): matrices, lumped mass matrix, modes …) - Parameters - ---------- + Inputs + ------ rom_type: bool If this pin is set to true, customized rom data must be given reduced_stiff_matrix: FieldsContainer @@ -38,7 +38,7 @@ class rom_data_provider(Operator): mode_shapes: FieldsContainer FieldsContainers containing the customized mode shapes - Returns + Outputs ------- rom_matrices: FieldsContainer FieldsContainers containing the reduced matrices diff --git a/src/ansys/dpf/core/operators/result/run.py b/src/ansys/dpf/core/operators/result/run.py index 41386ccef70..826a4956b3b 100644 --- a/src/ansys/dpf/core/operators/result/run.py +++ b/src/ansys/dpf/core/operators/result/run.py @@ -20,8 +20,8 @@ class run(Operator): file. - Parameters - ---------- + Inputs + ------ mapdl_exe_path: str, optional working_dir: str, optional number_of_processes: int, optional @@ -33,7 +33,7 @@ class run(Operator): server_mode: bool, optional used when a user includes commands in the input file allowing to launch DPF server inside MAPDL to interact with MAPDL using DPF client API - Returns + Outputs ------- data_sources: DataSources returns the data source if the server_mode pin is not set to yes diff --git a/src/ansys/dpf/core/operators/result/smisc.py b/src/ansys/dpf/core/operators/result/smisc.py index 9e16a69649f..248250e4eae 100644 --- a/src/ansys/dpf/core/operators/result/smisc.py +++ b/src/ansys/dpf/core/operators/result/smisc.py @@ -25,8 +25,8 @@ class smisc(Operator): each item. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -54,7 +54,7 @@ class smisc(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/specific_heat.py b/src/ansys/dpf/core/operators/result/specific_heat.py index 52da58f8706..c96ee334294 100644 --- a/src/ansys/dpf/core/operators/result/specific_heat.py +++ b/src/ansys/dpf/core/operators/result/specific_heat.py @@ -19,8 +19,8 @@ class specific_heat(Operator): r"""Read Specific Heat by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class specific_heat(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/spectrum_data.py b/src/ansys/dpf/core/operators/result/spectrum_data.py index 5a4b7f6a9df..798d75fcbb3 100644 --- a/src/ansys/dpf/core/operators/result/spectrum_data.py +++ b/src/ansys/dpf/core/operators/result/spectrum_data.py @@ -20,14 +20,14 @@ class spectrum_data(Operator): data sources. - Parameters - ---------- + Inputs + ------ streams: StreamsContainer, optional Result file container allowed to be kept open to cache data. data_sources: DataSources Result file path container, used if no streams are set. - Returns + Outputs ------- participation_factors: FieldsContainer Fields container holding participation factors. diff --git a/src/ansys/dpf/core/operators/result/state_variable.py b/src/ansys/dpf/core/operators/result/state_variable.py index 070035dc236..10d136da4f5 100644 --- a/src/ansys/dpf/core/operators/result/state_variable.py +++ b/src/ansys/dpf/core/operators/result/state_variable.py @@ -132,8 +132,8 @@ class state_variable(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -161,7 +161,7 @@ class state_variable(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/static_pressure.py b/src/ansys/dpf/core/operators/result/static_pressure.py index 237b9471155..46778a56af1 100644 --- a/src/ansys/dpf/core/operators/result/static_pressure.py +++ b/src/ansys/dpf/core/operators/result/static_pressure.py @@ -19,8 +19,8 @@ class static_pressure(Operator): r"""Read Static Pressure by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class static_pressure(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stiffness_matrix_energy.py b/src/ansys/dpf/core/operators/result/stiffness_matrix_energy.py index eeb58f78d8a..5f9b248b846 100644 --- a/src/ansys/dpf/core/operators/result/stiffness_matrix_energy.py +++ b/src/ansys/dpf/core/operators/result/stiffness_matrix_energy.py @@ -20,8 +20,8 @@ class stiffness_matrix_energy(Operator): calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stiffness_matrix_energy(Operator): phi: float, optional angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical.py b/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical.py index 22b4ba0661f..157e5db66a7 100644 --- a/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical.py +++ b/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical.py @@ -21,8 +21,8 @@ class strain_eqv_as_mechanical(Operator): bodies can either be activated or deactivated. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. mesh_scoping: Scoping or ScopingsContainer, optional @@ -42,7 +42,7 @@ class strain_eqv_as_mechanical(Operator): average_across_bodies: bool, optional for multibody simulations, the stresses are averaged across bodies if true or not if false (default). - Returns + Outputs ------- fields_container: FieldsContainer meshes_container: MeshesContainer diff --git a/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical_workflow.py b/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical_workflow.py index ef087f0738b..63ee4e9c864 100644 --- a/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical_workflow.py +++ b/src/ansys/dpf/core/operators/result/strain_eqv_as_mechanical_workflow.py @@ -22,8 +22,8 @@ class strain_eqv_as_mechanical_workflow(Operator): deactivated. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. mesh_scoping: Scoping or ScopingsContainer, optional @@ -41,7 +41,7 @@ class strain_eqv_as_mechanical_workflow(Operator): average_across_bodies: bool, optional for multibody simulations, the stresses are averaged across bodies if true or not if false (default). - Returns + Outputs ------- workflow: Workflow diff --git a/src/ansys/dpf/core/operators/result/stress.py b/src/ansys/dpf/core/operators/result/stress.py index eacb66831e3..baf37abd382 100644 --- a/src/ansys/dpf/core/operators/result/stress.py +++ b/src/ansys/dpf/core/operators/result/stress.py @@ -132,8 +132,8 @@ class stress(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -167,7 +167,7 @@ class stress(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_X.py b/src/ansys/dpf/core/operators/result/stress_X.py index 51e0e168f4c..053dbe8a33c 100644 --- a/src/ansys/dpf/core/operators/result/stress_X.py +++ b/src/ansys/dpf/core/operators/result/stress_X.py @@ -22,8 +22,8 @@ class stress_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_XY.py b/src/ansys/dpf/core/operators/result/stress_XY.py index 6d3d20d540e..d4edd74ae33 100644 --- a/src/ansys/dpf/core/operators/result/stress_XY.py +++ b/src/ansys/dpf/core/operators/result/stress_XY.py @@ -22,8 +22,8 @@ class stress_XY(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_XY(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_XZ.py b/src/ansys/dpf/core/operators/result/stress_XZ.py index a1f02d7cb99..7ae55d250b7 100644 --- a/src/ansys/dpf/core/operators/result/stress_XZ.py +++ b/src/ansys/dpf/core/operators/result/stress_XZ.py @@ -22,8 +22,8 @@ class stress_XZ(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_XZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_Y.py b/src/ansys/dpf/core/operators/result/stress_Y.py index 39949ae7734..cd80e0e8846 100644 --- a/src/ansys/dpf/core/operators/result/stress_Y.py +++ b/src/ansys/dpf/core/operators/result/stress_Y.py @@ -22,8 +22,8 @@ class stress_Y(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_YZ.py b/src/ansys/dpf/core/operators/result/stress_YZ.py index a2817610a7b..2fdce30d31a 100644 --- a/src/ansys/dpf/core/operators/result/stress_YZ.py +++ b/src/ansys/dpf/core/operators/result/stress_YZ.py @@ -22,8 +22,8 @@ class stress_YZ(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_YZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_Z.py b/src/ansys/dpf/core/operators/result/stress_Z.py index 34ac5828f56..24a5734639e 100644 --- a/src/ansys/dpf/core/operators/result/stress_Z.py +++ b/src/ansys/dpf/core/operators/result/stress_Z.py @@ -22,8 +22,8 @@ class stress_Z(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical.py b/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical.py index bb77f60125b..7ba99c6d40f 100644 --- a/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical.py +++ b/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical.py @@ -21,8 +21,8 @@ class stress_eqv_as_mechanical(Operator): can either be activated or deactivated. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. mesh_scoping: Scoping or ScopingsContainer, optional @@ -40,7 +40,7 @@ class stress_eqv_as_mechanical(Operator): average_across_bodies: bool, optional for multibody simulations, the stresses are averaged across bodies if true or not if false (default). - Returns + Outputs ------- fields_container: FieldsContainer meshes_container: MeshesContainer diff --git a/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical_workflow.py b/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical_workflow.py index 47cf673e8f6..41a5e25edde 100644 --- a/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical_workflow.py +++ b/src/ansys/dpf/core/operators/result/stress_eqv_as_mechanical_workflow.py @@ -21,8 +21,8 @@ class stress_eqv_as_mechanical_workflow(Operator): averaging across bodies can either be activated or deactivated. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional time/freq (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids use scoping with TimeFreq_steps location) required in output. mesh_scoping: Scoping or ScopingsContainer, optional @@ -40,7 +40,7 @@ class stress_eqv_as_mechanical_workflow(Operator): average_across_bodies: bool, optional for multibody simulations, the stresses are averaged across bodies if true or not if false (default). - Returns + Outputs ------- workflow: Workflow diff --git a/src/ansys/dpf/core/operators/result/stress_intensity.py b/src/ansys/dpf/core/operators/result/stress_intensity.py index 9003f99255b..34dabf423c2 100644 --- a/src/ansys/dpf/core/operators/result/stress_intensity.py +++ b/src/ansys/dpf/core/operators/result/stress_intensity.py @@ -22,8 +22,8 @@ class stress_intensity(Operator): which case a rotation to the global coordinate system is performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -44,7 +44,7 @@ class stress_intensity(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_max_shear.py b/src/ansys/dpf/core/operators/result/stress_max_shear.py index 428ca45fd90..810f6332e35 100644 --- a/src/ansys/dpf/core/operators/result/stress_max_shear.py +++ b/src/ansys/dpf/core/operators/result/stress_max_shear.py @@ -22,8 +22,8 @@ class stress_max_shear(Operator): which case a rotation to the global coordinate system is performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -44,7 +44,7 @@ class stress_max_shear(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_principal_1.py b/src/ansys/dpf/core/operators/result/stress_principal_1.py index ab2963cc163..4b669549017 100644 --- a/src/ansys/dpf/core/operators/result/stress_principal_1.py +++ b/src/ansys/dpf/core/operators/result/stress_principal_1.py @@ -23,8 +23,8 @@ class stress_principal_1(Operator): global coordinate system is performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_principal_1(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_principal_2.py b/src/ansys/dpf/core/operators/result/stress_principal_2.py index 07916d7e3c0..72976003dc4 100644 --- a/src/ansys/dpf/core/operators/result/stress_principal_2.py +++ b/src/ansys/dpf/core/operators/result/stress_principal_2.py @@ -23,8 +23,8 @@ class stress_principal_2(Operator): global coordinate system is performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_principal_2(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_principal_3.py b/src/ansys/dpf/core/operators/result/stress_principal_3.py index 0245e57c95b..d51230b4e75 100644 --- a/src/ansys/dpf/core/operators/result/stress_principal_3.py +++ b/src/ansys/dpf/core/operators/result/stress_principal_3.py @@ -23,8 +23,8 @@ class stress_principal_3(Operator): global coordinate system is performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class stress_principal_3(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_ratio.py b/src/ansys/dpf/core/operators/result/stress_ratio.py index 9b602e988ac..f8373ae79df 100644 --- a/src/ansys/dpf/core/operators/result/stress_ratio.py +++ b/src/ansys/dpf/core/operators/result/stress_ratio.py @@ -132,8 +132,8 @@ class stress_ratio(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class stress_ratio(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_rotation_by_euler_nodes.py b/src/ansys/dpf/core/operators/result/stress_rotation_by_euler_nodes.py index 979f77d5db8..3cf964d3265 100644 --- a/src/ansys/dpf/core/operators/result/stress_rotation_by_euler_nodes.py +++ b/src/ansys/dpf/core/operators/result/stress_rotation_by_euler_nodes.py @@ -20,14 +20,14 @@ class stress_rotation_by_euler_nodes(Operator): in the fieldsContainer. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer, optional streams_container: StreamsContainer or Stream or Class Dataprocessing::Crstfilewrapper, optional data_sources: DataSources - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/stress_von_mises.py b/src/ansys/dpf/core/operators/result/stress_von_mises.py index d35e8ff3674..db99763fdc4 100644 --- a/src/ansys/dpf/core/operators/result/stress_von_mises.py +++ b/src/ansys/dpf/core/operators/result/stress_von_mises.py @@ -22,8 +22,8 @@ class stress_von_mises(Operator): which case a rotation to the global coordinate system is performed. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -44,7 +44,7 @@ class stress_von_mises(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/structural_temperature.py b/src/ansys/dpf/core/operators/result/structural_temperature.py index a8d2a8fb823..cc42f4f0103 100644 --- a/src/ansys/dpf/core/operators/result/structural_temperature.py +++ b/src/ansys/dpf/core/operators/result/structural_temperature.py @@ -132,8 +132,8 @@ class structural_temperature(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class structural_temperature(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/superficial_velocity.py b/src/ansys/dpf/core/operators/result/superficial_velocity.py index c7e6ea1fdb7..59cda388ce0 100644 --- a/src/ansys/dpf/core/operators/result/superficial_velocity.py +++ b/src/ansys/dpf/core/operators/result/superficial_velocity.py @@ -20,8 +20,8 @@ class superficial_velocity(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class superficial_velocity(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/surface_heat_rate.py b/src/ansys/dpf/core/operators/result/surface_heat_rate.py index a24aa341796..1f16bf49534 100644 --- a/src/ansys/dpf/core/operators/result/surface_heat_rate.py +++ b/src/ansys/dpf/core/operators/result/surface_heat_rate.py @@ -20,8 +20,8 @@ class surface_heat_rate(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class surface_heat_rate(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/swelling_strains.py b/src/ansys/dpf/core/operators/result/swelling_strains.py index fe8abc97647..d9b710bd607 100644 --- a/src/ansys/dpf/core/operators/result/swelling_strains.py +++ b/src/ansys/dpf/core/operators/result/swelling_strains.py @@ -132,8 +132,8 @@ class swelling_strains(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class swelling_strains(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/tangential_contact_force.py b/src/ansys/dpf/core/operators/result/tangential_contact_force.py index 3d889131228..d285ed18af8 100644 --- a/src/ansys/dpf/core/operators/result/tangential_contact_force.py +++ b/src/ansys/dpf/core/operators/result/tangential_contact_force.py @@ -20,8 +20,8 @@ class tangential_contact_force(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class tangential_contact_force(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/tangential_contact_moment.py b/src/ansys/dpf/core/operators/result/tangential_contact_moment.py index 9c207b8f37b..2b4d7030885 100644 --- a/src/ansys/dpf/core/operators/result/tangential_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/tangential_contact_moment.py @@ -20,8 +20,8 @@ class tangential_contact_moment(Operator): the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class tangential_contact_moment(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/temperature.py b/src/ansys/dpf/core/operators/result/temperature.py index 57abd0d6801..dca724e855f 100644 --- a/src/ansys/dpf/core/operators/result/temperature.py +++ b/src/ansys/dpf/core/operators/result/temperature.py @@ -20,8 +20,8 @@ class temperature(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -51,7 +51,7 @@ class temperature(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/temperature_grad.py b/src/ansys/dpf/core/operators/result/temperature_grad.py index 3e652ee156b..e7dbd7c30c0 100644 --- a/src/ansys/dpf/core/operators/result/temperature_grad.py +++ b/src/ansys/dpf/core/operators/result/temperature_grad.py @@ -132,8 +132,8 @@ class temperature_grad(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class temperature_grad(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/temperature_grad_X.py b/src/ansys/dpf/core/operators/result/temperature_grad_X.py index 61bf1f33094..726d5de715e 100644 --- a/src/ansys/dpf/core/operators/result/temperature_grad_X.py +++ b/src/ansys/dpf/core/operators/result/temperature_grad_X.py @@ -22,8 +22,8 @@ class temperature_grad_X(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class temperature_grad_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/temperature_grad_Y.py b/src/ansys/dpf/core/operators/result/temperature_grad_Y.py index d1b16e06b15..b00d93ac807 100644 --- a/src/ansys/dpf/core/operators/result/temperature_grad_Y.py +++ b/src/ansys/dpf/core/operators/result/temperature_grad_Y.py @@ -22,8 +22,8 @@ class temperature_grad_Y(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class temperature_grad_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/temperature_grad_Z.py b/src/ansys/dpf/core/operators/result/temperature_grad_Z.py index bc227e8c89c..7b49299f685 100644 --- a/src/ansys/dpf/core/operators/result/temperature_grad_Z.py +++ b/src/ansys/dpf/core/operators/result/temperature_grad_Z.py @@ -22,8 +22,8 @@ class temperature_grad_Z(Operator): can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class temperature_grad_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_conductivity.py b/src/ansys/dpf/core/operators/result/thermal_conductivity.py index 33e89ede5c2..30306739074 100644 --- a/src/ansys/dpf/core/operators/result/thermal_conductivity.py +++ b/src/ansys/dpf/core/operators/result/thermal_conductivity.py @@ -20,8 +20,8 @@ class thermal_conductivity(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class thermal_conductivity(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_dissipation_energy.py b/src/ansys/dpf/core/operators/result/thermal_dissipation_energy.py index 08836c55d8f..d97d9f1da9c 100644 --- a/src/ansys/dpf/core/operators/result/thermal_dissipation_energy.py +++ b/src/ansys/dpf/core/operators/result/thermal_dissipation_energy.py @@ -20,8 +20,8 @@ class thermal_dissipation_energy(Operator): by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class thermal_dissipation_energy(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain.py b/src/ansys/dpf/core/operators/result/thermal_strain.py index c1ababef3c3..58f6666f373 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain.py @@ -132,8 +132,8 @@ class thermal_strain(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class thermal_strain(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_X.py b/src/ansys/dpf/core/operators/result/thermal_strain_X.py index 14097276139..1b0aa60562a 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_X.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_X.py @@ -22,8 +22,8 @@ class thermal_strain_X(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class thermal_strain_X(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_XY.py b/src/ansys/dpf/core/operators/result/thermal_strain_XY.py index 3dd92401485..74eb7f84c69 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_XY.py @@ -22,8 +22,8 @@ class thermal_strain_XY(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class thermal_strain_XY(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_XZ.py b/src/ansys/dpf/core/operators/result/thermal_strain_XZ.py index 7cd313d7043..ebd5c73072b 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_XZ.py @@ -22,8 +22,8 @@ class thermal_strain_XZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class thermal_strain_XZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_Y.py b/src/ansys/dpf/core/operators/result/thermal_strain_Y.py index 35dbf1b58c5..cebc3fccc19 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_Y.py @@ -22,8 +22,8 @@ class thermal_strain_Y(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class thermal_strain_Y(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_YZ.py b/src/ansys/dpf/core/operators/result/thermal_strain_YZ.py index 291f10d9913..d2f89857a37 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_YZ.py @@ -22,8 +22,8 @@ class thermal_strain_YZ(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class thermal_strain_YZ(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_Z.py b/src/ansys/dpf/core/operators/result/thermal_strain_Z.py index f7674eca857..add3ddf2257 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_Z.py @@ -22,8 +22,8 @@ class thermal_strain_Z(Operator): location can be Nodal/ElementalNodal/Elemental. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -45,7 +45,7 @@ class thermal_strain_Z(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_principal_1.py b/src/ansys/dpf/core/operators/result/thermal_strain_principal_1.py index 80159f2748d..935f1406305 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_principal_1.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_principal_1.py @@ -25,8 +25,8 @@ class thermal_strain_principal_1(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class thermal_strain_principal_1(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_principal_2.py b/src/ansys/dpf/core/operators/result/thermal_strain_principal_2.py index 06241ec9cd0..894197aa50e 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_principal_2.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_principal_2.py @@ -25,8 +25,8 @@ class thermal_strain_principal_2(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class thermal_strain_principal_2(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strain_principal_3.py b/src/ansys/dpf/core/operators/result/thermal_strain_principal_3.py index 54059fc00f6..eea17aeaed1 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_principal_3.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_principal_3.py @@ -25,8 +25,8 @@ class thermal_strain_principal_3(Operator): standard strain values. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -47,7 +47,7 @@ class thermal_strain_principal_3(Operator): read_beams: bool, optional elemental nodal beam results are read if this pin is set to true (default is false) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py b/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py index ea22ed24392..43209ba7dbe 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py +++ b/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py @@ -132,8 +132,8 @@ class thermal_strains_eqv(Operator): ======= ====================================================== - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -159,7 +159,7 @@ class thermal_strains_eqv(Operator): extend_to_mid_nodes: bool, optional Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/thickness.py b/src/ansys/dpf/core/operators/result/thickness.py index 62e31b7b4b7..f4145ee653c 100644 --- a/src/ansys/dpf/core/operators/result/thickness.py +++ b/src/ansys/dpf/core/operators/result/thickness.py @@ -20,8 +20,8 @@ class thickness(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class thickness(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/torque.py b/src/ansys/dpf/core/operators/result/torque.py index 5adbd367615..20c06df667b 100644 --- a/src/ansys/dpf/core/operators/result/torque.py +++ b/src/ansys/dpf/core/operators/result/torque.py @@ -19,14 +19,14 @@ class torque(Operator): r"""Compute torque of a force based on a 3D point. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer Fields container containing the nodal forces. spoint: Field or FieldsContainer Field or fields container containing the summation points for each associated field on pin 0. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/total_contact_force.py b/src/ansys/dpf/core/operators/result/total_contact_force.py index bb47f4249c4..8b619f37817 100644 --- a/src/ansys/dpf/core/operators/result/total_contact_force.py +++ b/src/ansys/dpf/core/operators/result/total_contact_force.py @@ -20,8 +20,8 @@ class total_contact_force(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class total_contact_force(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/total_contact_moment.py b/src/ansys/dpf/core/operators/result/total_contact_moment.py index 90061f31e42..3d16d347841 100644 --- a/src/ansys/dpf/core/operators/result/total_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/total_contact_moment.py @@ -20,8 +20,8 @@ class total_contact_moment(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class total_contact_moment(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/total_mass.py b/src/ansys/dpf/core/operators/result/total_mass.py index e8ce972fb34..caeeddd83f3 100644 --- a/src/ansys/dpf/core/operators/result/total_mass.py +++ b/src/ansys/dpf/core/operators/result/total_mass.py @@ -19,12 +19,12 @@ class total_mass(Operator): r"""Reads total mass from mode file. - Parameters - ---------- + Inputs + ------ data_sources: DataSources Data sources (must contain at least one mode file). - Returns + Outputs ------- mass: float the unit should be grabbed from the rst file diff --git a/src/ansys/dpf/core/operators/result/total_pressure.py b/src/ansys/dpf/core/operators/result/total_pressure.py index f4070c51b4b..427bb2160f9 100644 --- a/src/ansys/dpf/core/operators/result/total_pressure.py +++ b/src/ansys/dpf/core/operators/result/total_pressure.py @@ -19,8 +19,8 @@ class total_pressure(Operator): r"""Read Total Pressure by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class total_pressure(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/total_strain.py b/src/ansys/dpf/core/operators/result/total_strain.py index 7f95d1de30e..22813964e87 100644 --- a/src/ansys/dpf/core/operators/result/total_strain.py +++ b/src/ansys/dpf/core/operators/result/total_strain.py @@ -20,8 +20,8 @@ class total_strain(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -37,7 +37,7 @@ class total_strain(Operator): mesh: MeshedRegion or MeshesContainer, optional prevents from reading the mesh in the result files - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/total_temperature.py b/src/ansys/dpf/core/operators/result/total_temperature.py index fead31c0dc4..85586c60a45 100644 --- a/src/ansys/dpf/core/operators/result/total_temperature.py +++ b/src/ansys/dpf/core/operators/result/total_temperature.py @@ -20,8 +20,8 @@ class total_temperature(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class total_temperature(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/transform_invariant_terms_rbd.py b/src/ansys/dpf/core/operators/result/transform_invariant_terms_rbd.py index d30178b7aea..b22edaf4f76 100644 --- a/src/ansys/dpf/core/operators/result/transform_invariant_terms_rbd.py +++ b/src/ansys/dpf/core/operators/result/transform_invariant_terms_rbd.py @@ -20,8 +20,8 @@ class transform_invariant_terms_rbd(Operator): + rotation). - Parameters - ---------- + Inputs + ------ rotation_matrix: Field 3-3 rotation matrix. coordinate_system: Field @@ -55,7 +55,7 @@ class transform_invariant_terms_rbd(Operator): dnyn: dnzn: - Returns + Outputs ------- model_data: PropertyField data describing the finite element model diff --git a/src/ansys/dpf/core/operators/result/transient_rayleigh_integration.py b/src/ansys/dpf/core/operators/result/transient_rayleigh_integration.py index 894e944c629..5c44a91c6f2 100644 --- a/src/ansys/dpf/core/operators/result/transient_rayleigh_integration.py +++ b/src/ansys/dpf/core/operators/result/transient_rayleigh_integration.py @@ -19,8 +19,8 @@ class transient_rayleigh_integration(Operator): r"""Computes the transient Rayleigh integral - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer the input field container expects acceleration fields mesh: MeshedRegion or MeshesContainer @@ -36,7 +36,7 @@ class transient_rayleigh_integration(Operator): speed_of_sound: float Speed of sound (if it's not specified, default value of the speed of sound in the air is applied). - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/turbulent_kinetic_energy.py b/src/ansys/dpf/core/operators/result/turbulent_kinetic_energy.py index 6e6a5d69fec..e454180918a 100644 --- a/src/ansys/dpf/core/operators/result/turbulent_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/turbulent_kinetic_energy.py @@ -20,8 +20,8 @@ class turbulent_kinetic_energy(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class turbulent_kinetic_energy(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/turbulent_viscosity.py b/src/ansys/dpf/core/operators/result/turbulent_viscosity.py index ba9e2dfcbeb..225e9179e98 100644 --- a/src/ansys/dpf/core/operators/result/turbulent_viscosity.py +++ b/src/ansys/dpf/core/operators/result/turbulent_viscosity.py @@ -20,8 +20,8 @@ class turbulent_viscosity(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class turbulent_viscosity(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/velocity.py b/src/ansys/dpf/core/operators/result/velocity.py index 567ae1fbe3c..b8790ff9b81 100644 --- a/src/ansys/dpf/core/operators/result/velocity.py +++ b/src/ansys/dpf/core/operators/result/velocity.py @@ -20,8 +20,8 @@ class velocity(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -51,7 +51,7 @@ class velocity(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/velocity_X.py b/src/ansys/dpf/core/operators/result/velocity_X.py index 0f7be05da9f..0fd6d1b8493 100644 --- a/src/ansys/dpf/core/operators/result/velocity_X.py +++ b/src/ansys/dpf/core/operators/result/velocity_X.py @@ -20,8 +20,8 @@ class velocity_X(Operator): by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class velocity_X(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/velocity_Y.py b/src/ansys/dpf/core/operators/result/velocity_Y.py index 3efa6a4ecbf..e157e4134c4 100644 --- a/src/ansys/dpf/core/operators/result/velocity_Y.py +++ b/src/ansys/dpf/core/operators/result/velocity_Y.py @@ -20,8 +20,8 @@ class velocity_Y(Operator): by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class velocity_Y(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/velocity_Z.py b/src/ansys/dpf/core/operators/result/velocity_Z.py index 5f36db013b0..96c126ad8c7 100644 --- a/src/ansys/dpf/core/operators/result/velocity_Z.py +++ b/src/ansys/dpf/core/operators/result/velocity_Z.py @@ -20,8 +20,8 @@ class velocity_Z(Operator): by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class velocity_Z(Operator): read_cyclic: int, optional if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/volume_fraction.py b/src/ansys/dpf/core/operators/result/volume_fraction.py index 1b12a2ce8cb..650ea97766e 100644 --- a/src/ansys/dpf/core/operators/result/volume_fraction.py +++ b/src/ansys/dpf/core/operators/result/volume_fraction.py @@ -19,8 +19,8 @@ class volume_fraction(Operator): r"""Read Volume Fraction by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class volume_fraction(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/wall_shear_stress.py b/src/ansys/dpf/core/operators/result/wall_shear_stress.py index 7430e6a21d1..2799530c25b 100644 --- a/src/ansys/dpf/core/operators/result/wall_shear_stress.py +++ b/src/ansys/dpf/core/operators/result/wall_shear_stress.py @@ -20,8 +20,8 @@ class wall_shear_stress(Operator): datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -39,7 +39,7 @@ class wall_shear_stress(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/workflow_energy_per_component.py b/src/ansys/dpf/core/operators/result/workflow_energy_per_component.py index 82f9384f03f..92271cab2bb 100644 --- a/src/ansys/dpf/core/operators/result/workflow_energy_per_component.py +++ b/src/ansys/dpf/core/operators/result/workflow_energy_per_component.py @@ -20,8 +20,8 @@ class workflow_energy_per_component(Operator): cyclic and multistage models, the expansion will be automatically done. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional mesh_scoping: Scoping or ScopingsContainer, optional When the input is a scoping, it is treated as the master scoping. All named selections will intersect with it. When the input is a scopings container, named selections will not be needed. @@ -34,7 +34,7 @@ class workflow_energy_per_component(Operator): named_selection2: str, optional Named Selections. Intersection of all Named Selections with the master scoping will be done. - Returns + Outputs ------- component_energy: FieldsContainer component_energy_percentage: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/workflow_energy_per_harmonic.py b/src/ansys/dpf/core/operators/result/workflow_energy_per_harmonic.py index 18de463558d..54a8f47c40d 100644 --- a/src/ansys/dpf/core/operators/result/workflow_energy_per_harmonic.py +++ b/src/ansys/dpf/core/operators/result/workflow_energy_per_harmonic.py @@ -20,8 +20,8 @@ class workflow_energy_per_harmonic(Operator): multiharmonic model. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional mesh_scoping: Scoping, optional Master scoping. All harmonics will be intersected with this scoping. @@ -30,7 +30,7 @@ class workflow_energy_per_harmonic(Operator): stream: Stream data_sources: DataSources - Returns + Outputs ------- harmonic_energy: FieldsContainer harmonic_energy_percentage: FieldsContainer diff --git a/src/ansys/dpf/core/operators/result/write_cms_rbd_file.py b/src/ansys/dpf/core/operators/result/write_cms_rbd_file.py index ca8a6941a56..0caa2f8e82c 100644 --- a/src/ansys/dpf/core/operators/result/write_cms_rbd_file.py +++ b/src/ansys/dpf/core/operators/result/write_cms_rbd_file.py @@ -19,8 +19,8 @@ class write_cms_rbd_file(Operator): r"""Write the invariant terms and the model data in a cms_rbd file - Parameters - ---------- + Inputs + ------ model_data: PropertyField data describing the finite element model center_of_mass: Field @@ -52,7 +52,7 @@ class write_cms_rbd_file(Operator): file_path: str path with cms_rbd extension where the export occurs - Returns + Outputs ------- data_sources: DataSources Data Source containing the cms_rbd file generated. diff --git a/src/ansys/dpf/core/operators/result/write_motion_dfmf_file.py b/src/ansys/dpf/core/operators/result/write_motion_dfmf_file.py index 311787cc9ed..98cf565f845 100644 --- a/src/ansys/dpf/core/operators/result/write_motion_dfmf_file.py +++ b/src/ansys/dpf/core/operators/result/write_motion_dfmf_file.py @@ -19,8 +19,8 @@ class write_motion_dfmf_file(Operator): r"""Write the invariant terms and the model data in a motion dfmf file - Parameters - ---------- + Inputs + ------ model_data: PropertyField data describing the finite element model mode_shapes: FieldsContainer @@ -46,7 +46,7 @@ class write_motion_dfmf_file(Operator): path with motion dfmf extension where the export occurs rstfile_path: str - Returns + Outputs ------- dfmf_data_source: DataSources Data Source containing the dfmf file generated. diff --git a/src/ansys/dpf/core/operators/result/y_plus.py b/src/ansys/dpf/core/operators/result/y_plus.py index 523a23fcf0f..d4e3a72d1f6 100644 --- a/src/ansys/dpf/core/operators/result/y_plus.py +++ b/src/ansys/dpf/core/operators/result/y_plus.py @@ -19,8 +19,8 @@ class y_plus(Operator): r"""Read Y Plus (y+) by calling the readers defined by the datasources. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping or int or float or Field, optional time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. mesh_scoping: ScopingsContainer or Scoping, optional @@ -38,7 +38,7 @@ class y_plus(Operator): qualifiers2: dict, optional (for Fluid results only) LabelSpace with combination of zone, phases or species ids - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/scoping/adapt_with_scopings_container.py b/src/ansys/dpf/core/operators/scoping/adapt_with_scopings_container.py index baf77771a37..3a7571910a1 100644 --- a/src/ansys/dpf/core/operators/scoping/adapt_with_scopings_container.py +++ b/src/ansys/dpf/core/operators/scoping/adapt_with_scopings_container.py @@ -20,14 +20,14 @@ class adapt_with_scopings_container(Operator): container. - Parameters - ---------- + Inputs + ------ field_or_fields_container: FieldsContainer or Field scopings_container: ScopingsContainer keep_empty_fields: bool, optional Default false. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/scoping/change_fc.py b/src/ansys/dpf/core/operators/scoping/change_fc.py index af605b4bede..68f0c3807f9 100644 --- a/src/ansys/dpf/core/operators/scoping/change_fc.py +++ b/src/ansys/dpf/core/operators/scoping/change_fc.py @@ -20,12 +20,12 @@ class change_fc(Operator): fields container to correspond to a scopings container. - Parameters - ---------- + Inputs + ------ field_or_fields_container: FieldsContainer or Field scopings_container: ScopingsContainer - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/scoping/compute_element_centroids.py b/src/ansys/dpf/core/operators/scoping/compute_element_centroids.py index 3a4029cd30f..ab1b442b215 100644 --- a/src/ansys/dpf/core/operators/scoping/compute_element_centroids.py +++ b/src/ansys/dpf/core/operators/scoping/compute_element_centroids.py @@ -20,14 +20,14 @@ class compute_element_centroids(Operator): measure. - Parameters - ---------- + Inputs + ------ element_scoping: Scoping, optional If provided, only the centroids of the elements in the scoping are computed. mesh: MeshedRegion Mesh to compute centroids - Returns + Outputs ------- centroids: Field element centroids. diff --git a/src/ansys/dpf/core/operators/scoping/connectivity_ids.py b/src/ansys/dpf/core/operators/scoping/connectivity_ids.py index cd91cfe6a5c..28a3e7a26b6 100644 --- a/src/ansys/dpf/core/operators/scoping/connectivity_ids.py +++ b/src/ansys/dpf/core/operators/scoping/connectivity_ids.py @@ -20,8 +20,8 @@ class connectivity_ids(Operator): input. For each element the node ids are its connectivity. - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping Elemental scoping mesh: MeshedRegion, optional @@ -29,7 +29,7 @@ class connectivity_ids(Operator): take_mid_nodes: bool, optional default is true - Returns + Outputs ------- mesh_scoping: Scoping elemental_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/scoping/elemental_from_mesh.py b/src/ansys/dpf/core/operators/scoping/elemental_from_mesh.py index 70eba017a7d..888a3e46e47 100644 --- a/src/ansys/dpf/core/operators/scoping/elemental_from_mesh.py +++ b/src/ansys/dpf/core/operators/scoping/elemental_from_mesh.py @@ -20,11 +20,11 @@ class elemental_from_mesh(Operator): the element IDs. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion - Returns + Outputs ------- mesh_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/scoping/from_mesh.py b/src/ansys/dpf/core/operators/scoping/from_mesh.py index 2a93b8ebfff..46832884549 100644 --- a/src/ansys/dpf/core/operators/scoping/from_mesh.py +++ b/src/ansys/dpf/core/operators/scoping/from_mesh.py @@ -19,13 +19,13 @@ class from_mesh(Operator): r"""Provides the entire mesh scoping based on the requested location - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion requested_location: str, optional if nothing the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/scoping/intersect.py b/src/ansys/dpf/core/operators/scoping/intersect.py index 5e13b5dce93..c29ff2b2e5f 100644 --- a/src/ansys/dpf/core/operators/scoping/intersect.py +++ b/src/ansys/dpf/core/operators/scoping/intersect.py @@ -20,12 +20,12 @@ class intersect(Operator): between the intersection and the first scoping. - Parameters - ---------- + Inputs + ------ scopingA: Scoping scopingB: Scoping - Returns + Outputs ------- intersection: Scoping scopingA_min_intersection: Scoping diff --git a/src/ansys/dpf/core/operators/scoping/nodal_from_mesh.py b/src/ansys/dpf/core/operators/scoping/nodal_from_mesh.py index 30d6776a05c..419b719a2db 100644 --- a/src/ansys/dpf/core/operators/scoping/nodal_from_mesh.py +++ b/src/ansys/dpf/core/operators/scoping/nodal_from_mesh.py @@ -20,11 +20,11 @@ class nodal_from_mesh(Operator): node IDs. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion - Returns + Outputs ------- mesh_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/scoping/on_mesh_property.py b/src/ansys/dpf/core/operators/scoping/on_mesh_property.py index 22accc8b4d6..01a5311b820 100644 --- a/src/ansys/dpf/core/operators/scoping/on_mesh_property.py +++ b/src/ansys/dpf/core/operators/scoping/on_mesh_property.py @@ -19,8 +19,8 @@ class on_mesh_property(Operator): r"""Provides a scoping on a given property name and a property number. - Parameters - ---------- + Inputs + ------ requested_location: str, optional Nodal or Elemental location are expected property_name: str @@ -30,7 +30,7 @@ class on_mesh_property(Operator): Default is 1 (inclusive is true). Only used if 'shape_values' property is requested. If inclusive is set to 1 and 'elprops' property field is available, it will select all elements that are set on the corresponding property. If inclusive is set to 0 (exclusive) and 'elprops' property field is available, it will select the elements that are only set on this property. mesh: MeshedRegion - Returns + Outputs ------- mesh_scoping: Scoping Scoping diff --git a/src/ansys/dpf/core/operators/scoping/on_named_selection.py b/src/ansys/dpf/core/operators/scoping/on_named_selection.py index ba3a96756bc..e8f0283349b 100644 --- a/src/ansys/dpf/core/operators/scoping/on_named_selection.py +++ b/src/ansys/dpf/core/operators/scoping/on_named_selection.py @@ -19,8 +19,8 @@ class on_named_selection(Operator): r"""provides a scoping at a given location based on a given named selection - Parameters - ---------- + Inputs + ------ requested_location: str named_selection_name: str the string is expected to be in upper case @@ -29,7 +29,7 @@ class on_named_selection(Operator): streams_container: StreamsContainer, optional data_sources: DataSources - Returns + Outputs ------- mesh_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/scoping/on_property.py b/src/ansys/dpf/core/operators/scoping/on_property.py index 9f3cd6cde11..978b572083d 100644 --- a/src/ansys/dpf/core/operators/scoping/on_property.py +++ b/src/ansys/dpf/core/operators/scoping/on_property.py @@ -20,8 +20,8 @@ class on_property(Operator): and a property number. - Parameters - ---------- + Inputs + ------ requested_location: str Nodal or Elemental location are expected property_name: str @@ -33,7 +33,7 @@ class on_property(Operator): inclusive: int, optional If element scoping is requested on a nodal named selection, if inclusive == 1 then all the elements/faces adjacent to the nodes/faces ids in input are added, if inclusive == 0, only the elements/faces which have all their nodes/faces in the scoping are included - Returns + Outputs ------- mesh_scoping: Scoping Scoping diff --git a/src/ansys/dpf/core/operators/scoping/reduce_sampling.py b/src/ansys/dpf/core/operators/scoping/reduce_sampling.py index 2fb9464983a..ab342734adf 100644 --- a/src/ansys/dpf/core/operators/scoping/reduce_sampling.py +++ b/src/ansys/dpf/core/operators/scoping/reduce_sampling.py @@ -19,13 +19,13 @@ class reduce_sampling(Operator): r"""Take a scoping and remove half of it’s content. - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping denominator: int, optional Set the number of time the scoping is reduced (default is 2). Must be integer value above 1. - Returns + Outputs ------- mesh_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/scoping/rescope.py b/src/ansys/dpf/core/operators/scoping/rescope.py index 32c599257e6..aedb84b6145 100644 --- a/src/ansys/dpf/core/operators/scoping/rescope.py +++ b/src/ansys/dpf/core/operators/scoping/rescope.py @@ -21,14 +21,14 @@ class rescope(Operator): original field, the default value (in 2) is used when defined. - Parameters - ---------- + Inputs + ------ fields: FieldsContainer or Field mesh_scoping: Scoping, optional default_value: float, optional If pin 2 is used, the IDs not found in the field are added with this default value. - Returns + Outputs ------- fields: FieldsContainer or Field diff --git a/src/ansys/dpf/core/operators/scoping/rescope_custom_type_field.py b/src/ansys/dpf/core/operators/scoping/rescope_custom_type_field.py index 127a7982559..057b87fbd34 100644 --- a/src/ansys/dpf/core/operators/scoping/rescope_custom_type_field.py +++ b/src/ansys/dpf/core/operators/scoping/rescope_custom_type_field.py @@ -22,14 +22,14 @@ class rescope_custom_type_field(Operator): used when defined. - Parameters - ---------- + Inputs + ------ fields: CustomTypeFieldsContainer or CustomTypeField mesh_scoping: Scoping, optional default_value: CustomTypeField or CustomTypeField, optional If pin 2 is used, the IDs not found in the custom type field are added with this default value. - Returns + Outputs ------- fields: CustomTypeFieldsContainer or CustomTypeField diff --git a/src/ansys/dpf/core/operators/scoping/rescope_fc.py b/src/ansys/dpf/core/operators/scoping/rescope_fc.py index af8827af53e..72102bb8e31 100644 --- a/src/ansys/dpf/core/operators/scoping/rescope_fc.py +++ b/src/ansys/dpf/core/operators/scoping/rescope_fc.py @@ -20,14 +20,14 @@ class rescope_fc(Operator): original field, the default value (in 2) is used when defined. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer mesh_scoping: Scoping, optional default_value: float, optional If pin 2 is used, the IDs not found in the field are added with this default value. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/scoping/rescope_property_field.py b/src/ansys/dpf/core/operators/scoping/rescope_property_field.py index bd30e89ad75..deaf6d2c0fa 100644 --- a/src/ansys/dpf/core/operators/scoping/rescope_property_field.py +++ b/src/ansys/dpf/core/operators/scoping/rescope_property_field.py @@ -22,14 +22,14 @@ class rescope_property_field(Operator): defined. - Parameters - ---------- + Inputs + ------ fields: PropertyFieldsContainer or PropertyField mesh_scoping: Scoping, optional default_value: int, optional If pin 2 is used, the IDs not found in the property field are added with this default value. - Returns + Outputs ------- fields: PropertyFieldsContainer or PropertyField diff --git a/src/ansys/dpf/core/operators/scoping/scoping_get_attribute.py b/src/ansys/dpf/core/operators/scoping/scoping_get_attribute.py index ef8dad1d049..3c622b97b46 100644 --- a/src/ansys/dpf/core/operators/scoping/scoping_get_attribute.py +++ b/src/ansys/dpf/core/operators/scoping/scoping_get_attribute.py @@ -21,13 +21,13 @@ class scoping_get_attribute(Operator): input. - Parameters - ---------- + Inputs + ------ scoping: Scoping property_name: str Supported property names are: "ids", "location". - Returns + Outputs ------- property: str Returns a vector of int for property: "ids" and a string for property: "location". diff --git a/src/ansys/dpf/core/operators/scoping/split_on_property_type.py b/src/ansys/dpf/core/operators/scoping/split_on_property_type.py index f2a92c3e207..aae7d128b1c 100644 --- a/src/ansys/dpf/core/operators/scoping/split_on_property_type.py +++ b/src/ansys/dpf/core/operators/scoping/split_on_property_type.py @@ -22,8 +22,8 @@ class split_on_property_type(Operator): scopings container with those split scopings. - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping, optional Scoping mesh: MeshedRegion @@ -37,7 +37,7 @@ class split_on_property_type(Operator): label2: str, optional properties to apply the filtering 'mat' and/or 'elshape' (since 2025R1 it supports any property name contained in the mesh property fields) (default is 'elshape') - Returns + Outputs ------- mesh_scoping: ScopingsContainer Scoping diff --git a/src/ansys/dpf/core/operators/scoping/transpose.py b/src/ansys/dpf/core/operators/scoping/transpose.py index ce228eaf083..50c8ef666eb 100644 --- a/src/ansys/dpf/core/operators/scoping/transpose.py +++ b/src/ansys/dpf/core/operators/scoping/transpose.py @@ -21,8 +21,8 @@ class transpose(Operator): Nodal, or Nodal —> Elemental/Faces), based on the input mesh region. - Parameters - ---------- + Inputs + ------ mesh_scoping: Scoping or ScopingsContainer Scoping or scopings container (the input type is the output type) meshed_region: MeshedRegion or MeshesContainer @@ -31,7 +31,7 @@ class transpose(Operator): requested_location: str, optional Output scoping location for meshes with nodes, faces and elements. By default, elemental and faces scopings transpose to nodal, and nodal scopings transpose to elemental. - Returns + Outputs ------- mesh_scoping: Scoping or ScopingsContainer Scoping or scopings container (the input type is the output type) diff --git a/src/ansys/dpf/core/operators/serialization/csv_to_field.py b/src/ansys/dpf/core/operators/serialization/csv_to_field.py index f2b3fb97934..d56a947b7ed 100644 --- a/src/ansys/dpf/core/operators/serialization/csv_to_field.py +++ b/src/ansys/dpf/core/operators/serialization/csv_to_field.py @@ -19,13 +19,13 @@ class csv_to_field(Operator): r"""transform csv file to a field or fields container - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional data_sources: DataSources data sources containing a file with csv extension - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/serialization/data_tree_to_json.py b/src/ansys/dpf/core/operators/serialization/data_tree_to_json.py index 7a3bc780b66..40a5dc8330d 100644 --- a/src/ansys/dpf/core/operators/serialization/data_tree_to_json.py +++ b/src/ansys/dpf/core/operators/serialization/data_tree_to_json.py @@ -20,12 +20,12 @@ class data_tree_to_json(Operator): r"""Writes a json file or string from a DataTree - Parameters - ---------- + Inputs + ------ data_tree: DataTree path: str, optional - Returns + Outputs ------- data_sources: DataSources or str diff --git a/src/ansys/dpf/core/operators/serialization/data_tree_to_txt.py b/src/ansys/dpf/core/operators/serialization/data_tree_to_txt.py index 72f289d2cf0..067a16eba1c 100644 --- a/src/ansys/dpf/core/operators/serialization/data_tree_to_txt.py +++ b/src/ansys/dpf/core/operators/serialization/data_tree_to_txt.py @@ -20,12 +20,12 @@ class data_tree_to_txt(Operator): r"""Writes a txt file or string from a DataTree - Parameters - ---------- + Inputs + ------ data_tree: DataTree path: str, optional - Returns + Outputs ------- data_sources: DataSources or str diff --git a/src/ansys/dpf/core/operators/serialization/deserializer.py b/src/ansys/dpf/core/operators/serialization/deserializer.py index 2e87873a017..830a0f00e69 100644 --- a/src/ansys/dpf/core/operators/serialization/deserializer.py +++ b/src/ansys/dpf/core/operators/serialization/deserializer.py @@ -20,14 +20,14 @@ class deserializer(Operator): entities. - Parameters - ---------- + Inputs + ------ stream_type: int 0 for ASCII (default), and 1 for binary file_path: str file path - Returns + Outputs ------- any_output1: Any number and types of outputs corresponding of the inputs used in the serialization diff --git a/src/ansys/dpf/core/operators/serialization/export_symbolic_workflow.py b/src/ansys/dpf/core/operators/serialization/export_symbolic_workflow.py index 10d1f795a4c..b0469267282 100644 --- a/src/ansys/dpf/core/operators/serialization/export_symbolic_workflow.py +++ b/src/ansys/dpf/core/operators/serialization/export_symbolic_workflow.py @@ -21,8 +21,8 @@ class export_symbolic_workflow(Operator): (if a path is set in input) or string - Parameters - ---------- + Inputs + ------ workflow: Workflow path: str, optional format: int, optional @@ -30,7 +30,7 @@ class export_symbolic_workflow(Operator): options: int, optional 1 copies connections with its data, 2 forwards named inputs and outputs names, 7 copies connections of named inputs and ouputs with their data. default is 7. - Returns + Outputs ------- data_sources: DataSources or str diff --git a/src/ansys/dpf/core/operators/serialization/field_to_csv.py b/src/ansys/dpf/core/operators/serialization/field_to_csv.py index d0946d16efd..b562c22d6c5 100644 --- a/src/ansys/dpf/core/operators/serialization/field_to_csv.py +++ b/src/ansys/dpf/core/operators/serialization/field_to_csv.py @@ -19,15 +19,15 @@ class field_to_csv(Operator): r"""Exports a field or a fields container into a csv file - Parameters - ---------- + Inputs + ------ field_or_fields_container: FieldsContainer or Field field_or_fields_container file_path: str storage_type: int, optional storage type : if matrices (without any particularity) are included in the fields container, the storage format can be chosen. 0 : flat/line format, 1 : ranked format. If 1 is chosen, the csv can not be read by "csv to field" operator anymore. Default : 0. - Returns + Outputs ------- Examples diff --git a/src/ansys/dpf/core/operators/serialization/hdf5dpf_custom_read.py b/src/ansys/dpf/core/operators/serialization/hdf5dpf_custom_read.py index c98634da352..592cf835f18 100644 --- a/src/ansys/dpf/core/operators/serialization/hdf5dpf_custom_read.py +++ b/src/ansys/dpf/core/operators/serialization/hdf5dpf_custom_read.py @@ -21,8 +21,8 @@ class hdf5dpf_custom_read(Operator): deprecated, please use the ‘custom’ operator instead. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional mesh_scoping: Scoping, optional streams: StreamsContainer, optional @@ -34,7 +34,7 @@ class hdf5dpf_custom_read(Operator): result_name: Name of the result that must be extracted from the hdf5dpf file - Returns + Outputs ------- field_or_fields_container: FieldsContainer or Field diff --git a/src/ansys/dpf/core/operators/serialization/hdf5dpf_generate_result_file.py b/src/ansys/dpf/core/operators/serialization/hdf5dpf_generate_result_file.py index 6a3c6c8ca4b..0ab46fdb8fc 100644 --- a/src/ansys/dpf/core/operators/serialization/hdf5dpf_generate_result_file.py +++ b/src/ansys/dpf/core/operators/serialization/hdf5dpf_generate_result_file.py @@ -19,8 +19,8 @@ class hdf5dpf_generate_result_file(Operator): r"""Generate a dpf result file from provided information. - Parameters - ---------- + Inputs + ------ h5_chunk_size: int, optional Size of each HDF5 chunk in kilobytes (KB). Default: 1 MB when compression is enabled; for uncompressed datasets, the default is the full dataset size x dimension. append_mode: bool, optional @@ -44,7 +44,7 @@ class hdf5dpf_generate_result_file(Operator): input_name2: str or Any, optional Set of even and odd pins to serialize results. Odd pins (4, 6, 8...) are strings, and they represent the names of the results to be serialized. Even pins (5, 7, 9...) are DPF types, and they represent the results to be serialized. They should go in pairs (for each result name, there should be a result) and connected sequentially. - Returns + Outputs ------- data_sources: DataSources data_sources filled with the H5 generated file path. diff --git a/src/ansys/dpf/core/operators/serialization/import_symbolic_workflow.py b/src/ansys/dpf/core/operators/serialization/import_symbolic_workflow.py index 5ffda82e6cb..c5dd6657abc 100644 --- a/src/ansys/dpf/core/operators/serialization/import_symbolic_workflow.py +++ b/src/ansys/dpf/core/operators/serialization/import_symbolic_workflow.py @@ -20,13 +20,13 @@ class import_symbolic_workflow(Operator): WorkFlow with its data. - Parameters - ---------- + Inputs + ------ string_or_path: str or DataSources format: int, optional -1 is auto-detection, 0 is ASCII format, 1 is binary, 2 is json, default is -1 (auto-detection). - Returns + Outputs ------- workflow: Workflow diff --git a/src/ansys/dpf/core/operators/serialization/json_to_data_tree.py b/src/ansys/dpf/core/operators/serialization/json_to_data_tree.py index d52360ffa4d..f61f36f84d3 100644 --- a/src/ansys/dpf/core/operators/serialization/json_to_data_tree.py +++ b/src/ansys/dpf/core/operators/serialization/json_to_data_tree.py @@ -19,11 +19,11 @@ class json_to_data_tree(Operator): r"""Reads a json file or string to a DataTree - Parameters - ---------- + Inputs + ------ string_or_path: str or DataSources - Returns + Outputs ------- data_tree: DataTree diff --git a/src/ansys/dpf/core/operators/serialization/migrate_file_to_vtk.py b/src/ansys/dpf/core/operators/serialization/migrate_file_to_vtk.py index 0d21af3b3fd..a1065dabbfb 100644 --- a/src/ansys/dpf/core/operators/serialization/migrate_file_to_vtk.py +++ b/src/ansys/dpf/core/operators/serialization/migrate_file_to_vtk.py @@ -20,13 +20,13 @@ class migrate_file_to_vtk(Operator): possible to vtk. - Parameters - ---------- + Inputs + ------ output_filename: str, optional streams_container: StreamsContainer, optional data_sources: DataSources, optional - Returns + Outputs ------- data_sources: DataSources Generated output vtk file diff --git a/src/ansys/dpf/core/operators/serialization/migrate_to_vtu.py b/src/ansys/dpf/core/operators/serialization/migrate_to_vtu.py index f6704c4a031..c34817c3219 100644 --- a/src/ansys/dpf/core/operators/serialization/migrate_to_vtu.py +++ b/src/ansys/dpf/core/operators/serialization/migrate_to_vtu.py @@ -21,8 +21,8 @@ class migrate_to_vtu(Operator): operators. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional time sets to export, default is all streams_container: StreamsContainer, optional @@ -40,7 +40,7 @@ class migrate_to_vtu(Operator): write_mode: str, optional Available are rawbinarycompressed, rawbinary, base64appended, base64inline, ascii, default is (rawbinarycompressed) - Returns + Outputs ------- path: DataSources list of output vtu file path diff --git a/src/ansys/dpf/core/operators/serialization/serialize_to_hdf5.py b/src/ansys/dpf/core/operators/serialization/serialize_to_hdf5.py index 4a61bf7eac2..1e48fdf9f08 100644 --- a/src/ansys/dpf/core/operators/serialization/serialize_to_hdf5.py +++ b/src/ansys/dpf/core/operators/serialization/serialize_to_hdf5.py @@ -20,8 +20,8 @@ class serialize_to_hdf5(Operator): instead. Serialize the inputs in an hdf5 format. - Parameters - ---------- + Inputs + ------ file_path: str output file path with .h5 extension export_floats: bool, optional @@ -33,7 +33,7 @@ class serialize_to_hdf5(Operator): data2: only the data set explicitly to export is exported - Returns + Outputs ------- Examples diff --git a/src/ansys/dpf/core/operators/serialization/serializer.py b/src/ansys/dpf/core/operators/serialization/serializer.py index 1dff6722890..8dfde3c0c28 100644 --- a/src/ansys/dpf/core/operators/serialization/serializer.py +++ b/src/ansys/dpf/core/operators/serialization/serializer.py @@ -19,8 +19,8 @@ class serializer(Operator): r"""Take any input and serialize them in a file. - Parameters - ---------- + Inputs + ------ stream_type: int 0 for ASCII (default), and 1 for binary file_path: str @@ -29,7 +29,7 @@ class serializer(Operator): any_input2: Any any input - Returns + Outputs ------- file_path: str diff --git a/src/ansys/dpf/core/operators/serialization/serializer_to_string.py b/src/ansys/dpf/core/operators/serialization/serializer_to_string.py index b3283567e71..0312c740f17 100644 --- a/src/ansys/dpf/core/operators/serialization/serializer_to_string.py +++ b/src/ansys/dpf/core/operators/serialization/serializer_to_string.py @@ -19,8 +19,8 @@ class serializer_to_string(Operator): r"""Take any input and serialize them in a string. - Parameters - ---------- + Inputs + ------ stream_type: int 0 for string (default), 1 for binary, 2 for binary with chunked output (the output string will be returned in several chunks to prevent string memory overflows). any_input1: Any @@ -28,7 +28,7 @@ class serializer_to_string(Operator): any_input2: Any any input - Returns + Outputs ------- nof_chunks: int Number of chunks when mode passed to input pin(-1) = 2. diff --git a/src/ansys/dpf/core/operators/serialization/string_deserializer.py b/src/ansys/dpf/core/operators/serialization/string_deserializer.py index fbaef1419c9..3653b0ac0cd 100644 --- a/src/ansys/dpf/core/operators/serialization/string_deserializer.py +++ b/src/ansys/dpf/core/operators/serialization/string_deserializer.py @@ -20,14 +20,14 @@ class string_deserializer(Operator): DPF’s entities. - Parameters - ---------- + Inputs + ------ stream_type: int 0 for string (default), and 1 for binary serialized_string1: str serialized_string2: str - Returns + Outputs ------- any_output1: Any number and types of outputs corresponding of the inputs used in the serialization diff --git a/src/ansys/dpf/core/operators/serialization/txt_to_data_tree.py b/src/ansys/dpf/core/operators/serialization/txt_to_data_tree.py index fd98a59c8a9..46c21bdea87 100644 --- a/src/ansys/dpf/core/operators/serialization/txt_to_data_tree.py +++ b/src/ansys/dpf/core/operators/serialization/txt_to_data_tree.py @@ -19,11 +19,11 @@ class txt_to_data_tree(Operator): r"""Reads a txt file or string to a DataTree - Parameters - ---------- + Inputs + ------ string_or_path: str or DataSources - Returns + Outputs ------- data_tree: DataTree diff --git a/src/ansys/dpf/core/operators/serialization/vtk_export.py b/src/ansys/dpf/core/operators/serialization/vtk_export.py index 316328885b9..2f79980a14a 100644 --- a/src/ansys/dpf/core/operators/serialization/vtk_export.py +++ b/src/ansys/dpf/core/operators/serialization/vtk_export.py @@ -19,8 +19,8 @@ class vtk_export(Operator): r"""Write the input field and fields container into a given vtk path - Parameters - ---------- + Inputs + ------ export_type: int, optional Either export volume elements in the mesh with their fields with value 0 or faces elements in the mesh with their fields with value 1 (default is 0) file_path: str @@ -32,7 +32,7 @@ class vtk_export(Operator): fields2: FieldsContainer or Field fields exported - Returns + Outputs ------- Examples diff --git a/src/ansys/dpf/core/operators/serialization/vtk_to_fields.py b/src/ansys/dpf/core/operators/serialization/vtk_to_fields.py index 583389bba52..401bb3acdb7 100644 --- a/src/ansys/dpf/core/operators/serialization/vtk_to_fields.py +++ b/src/ansys/dpf/core/operators/serialization/vtk_to_fields.py @@ -19,14 +19,14 @@ class vtk_to_fields(Operator): r"""Write a field based on a vtk file. - Parameters - ---------- + Inputs + ------ field_name: str, optional name of the field in the vtk file streams: StreamsContainer, optional data_sources: DataSources - Returns + Outputs ------- fields_container: FieldsContainer fields_container diff --git a/src/ansys/dpf/core/operators/serialization/vtu_export.py b/src/ansys/dpf/core/operators/serialization/vtu_export.py index 34ae681435a..784d8ee4829 100644 --- a/src/ansys/dpf/core/operators/serialization/vtu_export.py +++ b/src/ansys/dpf/core/operators/serialization/vtu_export.py @@ -19,8 +19,8 @@ class vtu_export(Operator): r"""Export DPF data into vtu format. - Parameters - ---------- + Inputs + ------ directory: str directory path base_name: str, optional @@ -40,7 +40,7 @@ class vtu_export(Operator): mesh_properties: StringField, optional List of names of mesh properties to export. - Returns + Outputs ------- path: DataSources list of output vtu file path diff --git a/src/ansys/dpf/core/operators/serialization/workflow_to_pydpf.py b/src/ansys/dpf/core/operators/serialization/workflow_to_pydpf.py index d5d505fdc59..ed2b4526a17 100644 --- a/src/ansys/dpf/core/operators/serialization/workflow_to_pydpf.py +++ b/src/ansys/dpf/core/operators/serialization/workflow_to_pydpf.py @@ -21,12 +21,12 @@ class workflow_to_pydpf(Operator): specified path. - Parameters - ---------- + Inputs + ------ workflow: Workflow output_path: str, optional - Returns + Outputs ------- pydpf_code: str diff --git a/src/ansys/dpf/core/operators/serialization/workflow_to_workflow_topology.py b/src/ansys/dpf/core/operators/serialization/workflow_to_workflow_topology.py index d9685d2159f..1ad79e43b8c 100644 --- a/src/ansys/dpf/core/operators/serialization/workflow_to_workflow_topology.py +++ b/src/ansys/dpf/core/operators/serialization/workflow_to_workflow_topology.py @@ -21,11 +21,11 @@ class workflow_to_workflow_topology(Operator): connections, data connections, and exposed pins. - Parameters - ---------- + Inputs + ------ workflow: Workflow - Returns + Outputs ------- workflow_topology: GenericDataContainer diff --git a/src/ansys/dpf/core/operators/server/grpc_shutdown_server.py b/src/ansys/dpf/core/operators/server/grpc_shutdown_server.py index 4c3da3b86b4..e57427bd4a1 100644 --- a/src/ansys/dpf/core/operators/server/grpc_shutdown_server.py +++ b/src/ansys/dpf/core/operators/server/grpc_shutdown_server.py @@ -19,12 +19,12 @@ class grpc_shutdown_server(Operator): r"""Shutdowns dpf’s grpc server - Parameters - ---------- + Inputs + ------ grpc_stream: StreamsContainer dpf streams handling the server - Returns + Outputs ------- Examples diff --git a/src/ansys/dpf/core/operators/server/grpc_start_server.py b/src/ansys/dpf/core/operators/server/grpc_start_server.py index e855fe99062..6bb21ccc08f 100644 --- a/src/ansys/dpf/core/operators/server/grpc_start_server.py +++ b/src/ansys/dpf/core/operators/server/grpc_start_server.py @@ -20,8 +20,8 @@ class grpc_start_server(Operator): waiting for requests in a streams. - Parameters - ---------- + Inputs + ------ ip: str, optional If no ip address is put, the local ip address is taken port: str or int, optional @@ -35,7 +35,7 @@ class grpc_start_server(Operator): dpf_context: str or int, optional This pin is associated with pin(2) = 2 (server started in a new process). User can enter the integer associated with a DPF context (1: Standalone Context - DpfCoreStandalone.xml, 3: Custom - DpfCustomDefined.xml) or a string with the path of the XML specifying the context. - Returns + Outputs ------- grpc_streams: StreamsContainer, optional dpf streams handling the server, if the server is started in this thread, then nothing is added in output diff --git a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices.py b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices.py index eab99e62d27..25604e66ca1 100644 --- a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices.py +++ b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices.py @@ -21,8 +21,8 @@ class assemble_scalars_to_matrices(Operator): (xx, yy, zz, xy, xz and yz). - Parameters - ---------- + Inputs + ------ xx: Field, optional yy: Field, optional zz: Field, optional @@ -34,7 +34,7 @@ class assemble_scalars_to_matrices(Operator): zx: Field, optional symmetrical: bool, optional - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices_fc.py b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices_fc.py index 92f41f04b05..c4750d0e1e4 100644 --- a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices_fc.py +++ b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_matrices_fc.py @@ -21,8 +21,8 @@ class assemble_scalars_to_matrices_fc(Operator): containers are required (xx, yy, zz, xy, xz and yz). - Parameters - ---------- + Inputs + ------ xx: FieldsContainer, optional yy: FieldsContainer, optional zz: FieldsContainer, optional @@ -34,7 +34,7 @@ class assemble_scalars_to_matrices_fc(Operator): zx: FieldsContainer, optional symmetrical: bool, optional - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors.py b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors.py index fbc04c4b9db..02212bc9ac1 100644 --- a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors.py +++ b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors.py @@ -19,13 +19,13 @@ class assemble_scalars_to_vectors(Operator): r"""Takes three scalar fields and assembles them as a 3D vector field. - Parameters - ---------- + Inputs + ------ x: Field, optional y: Field, optional z: Field, optional - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors_fc.py b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors_fc.py index c74e0e5f9eb..45a49e0dbc8 100644 --- a/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors_fc.py +++ b/src/ansys/dpf/core/operators/utility/assemble_scalars_to_vectors_fc.py @@ -20,13 +20,13 @@ class assemble_scalars_to_vectors_fc(Operator): fields container. - Parameters - ---------- + Inputs + ------ x: FieldsContainer, optional y: FieldsContainer, optional z: FieldsContainer, optional - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/bind_support.py b/src/ansys/dpf/core/operators/utility/bind_support.py index bf4cd0fd4a2..00c67f87cbd 100644 --- a/src/ansys/dpf/core/operators/utility/bind_support.py +++ b/src/ansys/dpf/core/operators/utility/bind_support.py @@ -19,14 +19,14 @@ class bind_support(Operator): r"""Ties a support to a field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected support: MeshedRegion or AbstractFieldSupport meshed region or a support of the field - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/bind_support_fc.py b/src/ansys/dpf/core/operators/utility/bind_support_fc.py index 8f1b1b99659..17097cd9d5f 100644 --- a/src/ansys/dpf/core/operators/utility/bind_support_fc.py +++ b/src/ansys/dpf/core/operators/utility/bind_support_fc.py @@ -19,13 +19,13 @@ class bind_support_fc(Operator): r"""Ties a support to a fields container. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer support: MeshedRegion or AbstractFieldSupport or TimeFreqSupport Meshed region or a support of the field. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/change_location.py b/src/ansys/dpf/core/operators/utility/change_location.py index 62718a421f7..2b539ed869a 100644 --- a/src/ansys/dpf/core/operators/utility/change_location.py +++ b/src/ansys/dpf/core/operators/utility/change_location.py @@ -19,13 +19,13 @@ class change_location(Operator): r"""change the location of a field. - Parameters - ---------- + Inputs + ------ field: Field new_location: str new location of the output field ex 'Nodal', 'ElementalNodal', 'Elemental'... - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/change_shell_layers.py b/src/ansys/dpf/core/operators/utility/change_shell_layers.py index 85ad1f2050e..250ce67da2a 100644 --- a/src/ansys/dpf/core/operators/utility/change_shell_layers.py +++ b/src/ansys/dpf/core/operators/utility/change_shell_layers.py @@ -26,8 +26,8 @@ class change_shell_layers(Operator): the result. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer or Field e_shell_layer: int 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. @@ -36,7 +36,7 @@ class change_shell_layers(Operator): merge: bool, optional For fields with mixed shell layers (solid/shell elements with heterogeneous shell layers), group all of them in the same field (false by default). - Returns + Outputs ------- fields_container: FieldsContainer or Field diff --git a/src/ansys/dpf/core/operators/utility/compute_time_scoping.py b/src/ansys/dpf/core/operators/utility/compute_time_scoping.py index 76196f46f0a..defda2bddfb 100644 --- a/src/ansys/dpf/core/operators/utility/compute_time_scoping.py +++ b/src/ansys/dpf/core/operators/utility/compute_time_scoping.py @@ -20,8 +20,8 @@ class compute_time_scoping(Operator): interpolate on a list of time or frequencies. - Parameters - ---------- + Inputs + ------ time_freq_values: float or Field or TimeFreqSupport List of frequencies or times needed. To specify load steps, put a field (and not a list) in input with a scoping located on "TimeFreq_steps". step: int, optional @@ -29,7 +29,7 @@ class compute_time_scoping(Operator): 1:ramped' or 2:stepped', default is ramped time_freq_support: TimeFreqSupport - Returns + Outputs ------- scoping: Scoping time_scoping diff --git a/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py b/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py index 0208dd51ecf..af369618cfa 100644 --- a/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/customtypefield_get_attribute.py @@ -21,13 +21,13 @@ class customtypefield_get_attribute(Operator): pin 0, a property name (string) in pin 1 are expected as inputs - Parameters - ---------- + Inputs + ------ custom_type_field: CustomTypeField or CustomTypeFieldsContainer property_name: str Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'. - Returns + Outputs ------- property: str or TimeFreqSupport or Scoping or DataTree Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. diff --git a/src/ansys/dpf/core/operators/utility/cyclic_support_get_attribute.py b/src/ansys/dpf/core/operators/utility/cyclic_support_get_attribute.py index c57bd0d1cde..cb3829ee64a 100644 --- a/src/ansys/dpf/core/operators/utility/cyclic_support_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/cyclic_support_get_attribute.py @@ -21,13 +21,13 @@ class cyclic_support_get_attribute(Operator): expected in input. - Parameters - ---------- + Inputs + ------ cyclic_support: CyclicSupport property_name: str Accepted inputs are: 'element_duplicate_offset' and 'node_duplicate_offset' (returns int). - Returns + Outputs ------- property: str or int Property value. diff --git a/src/ansys/dpf/core/operators/utility/default_value.py b/src/ansys/dpf/core/operators/utility/default_value.py index a5044630b49..e1854cc4233 100644 --- a/src/ansys/dpf/core/operators/utility/default_value.py +++ b/src/ansys/dpf/core/operators/utility/default_value.py @@ -20,12 +20,12 @@ class default_value(Operator): nothing on input pin 0. - Parameters - ---------- + Inputs + ------ forced_value: optional default_value: - Returns + Outputs ------- output: diff --git a/src/ansys/dpf/core/operators/utility/delegate_to_operator.py b/src/ansys/dpf/core/operators/utility/delegate_to_operator.py index a13d91ab824..a09de0aaa92 100644 --- a/src/ansys/dpf/core/operators/utility/delegate_to_operator.py +++ b/src/ansys/dpf/core/operators/utility/delegate_to_operator.py @@ -20,11 +20,11 @@ class delegate_to_operator(Operator): (forwards all the input of this Operator to the sub Operator). - Parameters - ---------- + Inputs + ------ operator_name: str - Returns + Outputs ------- any1: Any inputs diff --git a/src/ansys/dpf/core/operators/utility/ds_get_attribute.py b/src/ansys/dpf/core/operators/utility/ds_get_attribute.py index 31c1feec267..0a7729de16e 100644 --- a/src/ansys/dpf/core/operators/utility/ds_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/ds_get_attribute.py @@ -22,8 +22,8 @@ class ds_get_attribute(Operator): provided. - Parameters - ---------- + Inputs + ------ data_sources: DataSources property_name: str Accepted inputs are: 'file_path' (returns string), 'result_file_name' (returns string), 'domain_file_path' (returns string), 'domain_result_file_name' (returns string), 'num_keys' (returns int), num_result_key (returns int), num_file_path (returns int), 'num_result_file_path' (returns int), 'key_by_index' (returns string), 'result_key_by_index' (returns string), 'path_by_index' (returns string), 'path_key_by_index' (returns string). @@ -34,7 +34,7 @@ class ds_get_attribute(Operator): property_result_key: str, optional Result key to look for. Can be used for 'file_path', 'result_file_name', 'domain_file_path' and 'domain_result_file_name'. - Returns + Outputs ------- property: str or int Property value. diff --git a/src/ansys/dpf/core/operators/utility/extract_field.py b/src/ansys/dpf/core/operators/utility/extract_field.py index 81ee5f74f46..28be8d18e15 100644 --- a/src/ansys/dpf/core/operators/utility/extract_field.py +++ b/src/ansys/dpf/core/operators/utility/extract_field.py @@ -20,14 +20,14 @@ class extract_field(Operator): fields container (in 0). - Parameters - ---------- + Inputs + ------ fields_container: Field or FieldsContainer if a field is in input, it is passed on as an output indices: optional Default is the first field - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/extract_scoping.py b/src/ansys/dpf/core/operators/utility/extract_scoping.py index 5c0a9a073f3..acd6bc32425 100644 --- a/src/ansys/dpf/core/operators/utility/extract_scoping.py +++ b/src/ansys/dpf/core/operators/utility/extract_scoping.py @@ -21,8 +21,8 @@ class extract_scoping(Operator): scoping or scopings container. - Parameters - ---------- + Inputs + ------ field_or_fields_container: Field or FieldsContainer or PropertyField or PropertyFieldsContainer or CustomTypeField or CustomTypeFieldsContainer or StringField or Scoping @@ -31,7 +31,7 @@ class extract_scoping(Operator): requested_location: int, optional If input 0 is a mesh or a meshes_container, the operator returns the nodes scoping, possible locations are: Nodal(default) or Elemental - Returns + Outputs ------- mesh_scoping: Scoping or ScopingsContainer diff --git a/src/ansys/dpf/core/operators/utility/extract_sub_fc.py b/src/ansys/dpf/core/operators/utility/extract_sub_fc.py index 8503f6298c2..fb5733c85b5 100644 --- a/src/ansys/dpf/core/operators/utility/extract_sub_fc.py +++ b/src/ansys/dpf/core/operators/utility/extract_sub_fc.py @@ -21,8 +21,8 @@ class extract_sub_fc(Operator): copied to the output. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields_container label_space: dict or Scoping, optional @@ -30,7 +30,7 @@ class extract_sub_fc(Operator): collapse_labels: bool, optional If set to true (default) the input label space (scoping location) is suppressed from the output fields container, otherwise, label space is kept. - Returns + Outputs ------- fields_container: FieldsContainer fields_container diff --git a/src/ansys/dpf/core/operators/utility/extract_sub_mc.py b/src/ansys/dpf/core/operators/utility/extract_sub_mc.py index 5cc2543eb3d..363b6e71a5a 100644 --- a/src/ansys/dpf/core/operators/utility/extract_sub_mc.py +++ b/src/ansys/dpf/core/operators/utility/extract_sub_mc.py @@ -21,8 +21,8 @@ class extract_sub_mc(Operator): be copied to the output. - Parameters - ---------- + Inputs + ------ meshes: MeshesContainer meshes label_space: dict or Scoping, optional @@ -30,7 +30,7 @@ class extract_sub_mc(Operator): collapse_labels: bool, optional If set to true (default) the input label space (scoping location) is suppressed from the output meshes container, otherwise, label space is kept. - Returns + Outputs ------- meshes_container: MeshesContainer meshes diff --git a/src/ansys/dpf/core/operators/utility/extract_sub_sc.py b/src/ansys/dpf/core/operators/utility/extract_sub_sc.py index 7409df8f358..2d8c9692e42 100644 --- a/src/ansys/dpf/core/operators/utility/extract_sub_sc.py +++ b/src/ansys/dpf/core/operators/utility/extract_sub_sc.py @@ -21,8 +21,8 @@ class extract_sub_sc(Operator): copied to the output. - Parameters - ---------- + Inputs + ------ scopings_container: ScopingsContainer scopings_container label_space: dict or Scoping, optional @@ -30,7 +30,7 @@ class extract_sub_sc(Operator): collapse_labels: bool, optional If set to true (default) the input label space (scoping location) is suppressed from the output scopings container, otherwise, label space is kept. - Returns + Outputs ------- scopings_container: ScopingsContainer scopings_container diff --git a/src/ansys/dpf/core/operators/utility/extract_time_freq.py b/src/ansys/dpf/core/operators/utility/extract_time_freq.py index a2ce6924824..a021928452b 100644 --- a/src/ansys/dpf/core/operators/utility/extract_time_freq.py +++ b/src/ansys/dpf/core/operators/utility/extract_time_freq.py @@ -20,14 +20,14 @@ class extract_time_freq(Operator): r"""Extract timefreqs with sets scoping from a time freq support - Parameters - ---------- + Inputs + ------ time_freq_support: TimeFreqSupport time_scoping: Scoping, optional real_or_complex: bool, optional False for real only (default). True for complex output. - Returns + Outputs ------- field: Field or FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/fc_get_attribute.py b/src/ansys/dpf/core/operators/utility/fc_get_attribute.py index b9dac39f9df..8f32db13196 100644 --- a/src/ansys/dpf/core/operators/utility/fc_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/fc_get_attribute.py @@ -21,15 +21,15 @@ class fc_get_attribute(Operator): container in input. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer property_name: str Supported property names are: "label_scoping", "label_values", "time_freq_support", "labels", "field_scoping" and "field". property_identifier: str or int, optional Additional pin for some property : the label name for "label_scoping" or "label_values", the field index (default 0) for "field_scoping" or "field". - Returns + Outputs ------- property: Scoping or TimeFreqSupport or dict or Field Returns a Scoping for property: "label_scoping", a vector of int for "label_values", a time freq support for "time_freq_support", a vector of string for "labels", a LabelSpace for "field_scoping" and a "field" for "field". diff --git a/src/ansys/dpf/core/operators/utility/field.py b/src/ansys/dpf/core/operators/utility/field.py index 6d4af310427..7401eaf963b 100644 --- a/src/ansys/dpf/core/operators/utility/field.py +++ b/src/ansys/dpf/core/operators/utility/field.py @@ -19,11 +19,11 @@ class field(Operator): r"""Incrementaly merge the input. - Parameters - ---------- + Inputs + ------ input: Field - Returns + Outputs ------- incremented_result: diff --git a/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py b/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py index 748239b6a0d..55fb31a8250 100644 --- a/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py +++ b/src/ansys/dpf/core/operators/utility/field_clone_to_shell_layer.py @@ -23,15 +23,15 @@ class field_clone_to_shell_layer(Operator): be shared or not based on the optional pin 2. - Parameters - ---------- + Inputs + ------ field: Field shell_layer: int 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. duplicate_scoping: bool, optional If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/field_get_attribute.py b/src/ansys/dpf/core/operators/utility/field_get_attribute.py index 8d1ad34a966..832946070aa 100644 --- a/src/ansys/dpf/core/operators/utility/field_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/field_get_attribute.py @@ -21,13 +21,13 @@ class field_get_attribute(Operator): property name (string) in pin 1 are expected as inputs - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer property_name: str Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'. - Returns + Outputs ------- property: str or TimeFreqSupport or Scoping or DataTree Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. diff --git a/src/ansys/dpf/core/operators/utility/field_to_fc.py b/src/ansys/dpf/core/operators/utility/field_to_fc.py index 9cb99f48f42..4f53cc81f97 100644 --- a/src/ansys/dpf/core/operators/utility/field_to_fc.py +++ b/src/ansys/dpf/core/operators/utility/field_to_fc.py @@ -19,14 +19,14 @@ class field_to_fc(Operator): r"""Creates a fields container containing the field provided on pin 0. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer If a fields container is set in input, it is passed on as an output with the additional label space (if any). label: dict Sets a label space. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/fields_container.py b/src/ansys/dpf/core/operators/utility/fields_container.py index fe2455e75a6..164708b3bab 100644 --- a/src/ansys/dpf/core/operators/utility/fields_container.py +++ b/src/ansys/dpf/core/operators/utility/fields_container.py @@ -19,11 +19,11 @@ class fields_container(Operator): r"""Incrementaly merge the input. - Parameters - ---------- + Inputs + ------ input: FieldsContainer - Returns + Outputs ------- incremented_result: diff --git a/src/ansys/dpf/core/operators/utility/fields_container_matrices_label.py b/src/ansys/dpf/core/operators/utility/fields_container_matrices_label.py index 3f61b34d55e..4ab8754d2e0 100644 --- a/src/ansys/dpf/core/operators/utility/fields_container_matrices_label.py +++ b/src/ansys/dpf/core/operators/utility/fields_container_matrices_label.py @@ -20,8 +20,8 @@ class fields_container_matrices_label(Operator): fields container of field matrices. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer fields container to be merged label: str @@ -29,7 +29,7 @@ class fields_container_matrices_label(Operator): time_scoping: int or Scoping, optional if it's specified, fields container of field matrices is constructed only on the specified time scoping - Returns + Outputs ------- fields_container: FieldsContainer fields container of field matrices obtained after merging. diff --git a/src/ansys/dpf/core/operators/utility/for_each.py b/src/ansys/dpf/core/operators/utility/for_each.py index 15ebba0e5ac..f2500241c05 100644 --- a/src/ansys/dpf/core/operators/utility/for_each.py +++ b/src/ansys/dpf/core/operators/utility/for_each.py @@ -19,8 +19,8 @@ class for_each(Operator): r"""Allows to write a loop over a chunk of operators. - Parameters - ---------- + Inputs + ------ iterable: Either the result of the make_iterable_info operator, or the operator that must be incremented. iterable_values: optional @@ -28,7 +28,7 @@ class for_each(Operator): forward1: forward2: - Returns + Outputs ------- empty: output1: diff --git a/src/ansys/dpf/core/operators/utility/forward.py b/src/ansys/dpf/core/operators/utility/forward.py index e95380fe3f4..0396ce1157b 100644 --- a/src/ansys/dpf/core/operators/utility/forward.py +++ b/src/ansys/dpf/core/operators/utility/forward.py @@ -19,12 +19,12 @@ class forward(Operator): r"""Return all the inputs as outputs. - Parameters - ---------- + Inputs + ------ any: Any any type of input - Returns + Outputs ------- any: Any same types as inputs diff --git a/src/ansys/dpf/core/operators/utility/forward_field.py b/src/ansys/dpf/core/operators/utility/forward_field.py index 736e505c9eb..7080a2d3768 100644 --- a/src/ansys/dpf/core/operators/utility/forward_field.py +++ b/src/ansys/dpf/core/operators/utility/forward_field.py @@ -19,12 +19,12 @@ class forward_field(Operator): r"""Returns the input field or fields container. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/forward_fields_container.py b/src/ansys/dpf/core/operators/utility/forward_fields_container.py index b01b9ad51bd..94c7bdfa305 100644 --- a/src/ansys/dpf/core/operators/utility/forward_fields_container.py +++ b/src/ansys/dpf/core/operators/utility/forward_fields_container.py @@ -19,11 +19,11 @@ class forward_fields_container(Operator): r"""Returns the input field or fields container. - Parameters - ---------- + Inputs + ------ fields: FieldsContainer or Field - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/forward_meshes_container.py b/src/ansys/dpf/core/operators/utility/forward_meshes_container.py index 85e13074774..bbfee1cfd02 100644 --- a/src/ansys/dpf/core/operators/utility/forward_meshes_container.py +++ b/src/ansys/dpf/core/operators/utility/forward_meshes_container.py @@ -19,13 +19,13 @@ class forward_meshes_container(Operator): r"""Returns the input mesh or meshes container into a meshes container. - Parameters - ---------- + Inputs + ------ meshes: MeshesContainer or MeshedRegion default_label: str, optional this default label is used if a new meshes container needs to be created (default is unknown) - Returns + Outputs ------- meshes_container: MeshesContainer diff --git a/src/ansys/dpf/core/operators/utility/hdf5dpf_workglow_provider.py b/src/ansys/dpf/core/operators/utility/hdf5dpf_workglow_provider.py index 129b58383a9..61b14bc61fa 100644 --- a/src/ansys/dpf/core/operators/utility/hdf5dpf_workglow_provider.py +++ b/src/ansys/dpf/core/operators/utility/hdf5dpf_workglow_provider.py @@ -19,8 +19,8 @@ class hdf5dpf_workglow_provider(Operator): r"""Extract a custom result from an hdf5dpf file as an executable workflow. - Parameters - ---------- + Inputs + ------ time_scoping: Scoping, optional mesh_scoping: Scoping, optional streams: StreamsContainer, optional @@ -32,7 +32,7 @@ class hdf5dpf_workglow_provider(Operator): result_name: Name of the result that must be extracted from the hdf5dpf file - Returns + Outputs ------- field_or_fields_container: Workflow diff --git a/src/ansys/dpf/core/operators/utility/html_doc.py b/src/ansys/dpf/core/operators/utility/html_doc.py index f07ab297eb9..5f191637c5d 100644 --- a/src/ansys/dpf/core/operators/utility/html_doc.py +++ b/src/ansys/dpf/core/operators/utility/html_doc.py @@ -19,14 +19,14 @@ class html_doc(Operator): r"""Create dpf’s html documentation. Only on Windows. - Parameters - ---------- + Inputs + ------ output_path: str, optional default is {working directory}/dataProcessingDoc.html exposure_level: int, optional Generate the documentation depending on exposure level : 0 (default) for public operators, 1 includes hidden operator, 2 includes private operator, 3 includes operator without specifications. - Returns + Outputs ------- Examples diff --git a/src/ansys/dpf/core/operators/utility/incremental_concatenate_as_fc.py b/src/ansys/dpf/core/operators/utility/incremental_concatenate_as_fc.py index 1be68be1c5e..19de953288e 100644 --- a/src/ansys/dpf/core/operators/utility/incremental_concatenate_as_fc.py +++ b/src/ansys/dpf/core/operators/utility/incremental_concatenate_as_fc.py @@ -19,13 +19,13 @@ class incremental_concatenate_as_fc(Operator): r"""Assemble fields in a fields container. - Parameters - ---------- + Inputs + ------ field: Field label: dict, optional Label space value that must be applied to the added field. - Returns + Outputs ------- output: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/ints_to_scoping.py b/src/ansys/dpf/core/operators/utility/ints_to_scoping.py index 09b48df3341..9ecd5f36254 100644 --- a/src/ansys/dpf/core/operators/utility/ints_to_scoping.py +++ b/src/ansys/dpf/core/operators/utility/ints_to_scoping.py @@ -20,15 +20,15 @@ class ints_to_scoping(Operator): location “numeric”. - Parameters - ---------- + Inputs + ------ int_or_vector_int: int or Scoping int or single value scoping or vector of int location: str, optional upper_bound: int or Scoping, optional Define the upper bound to create a scoping that will contain a range from the single value input in pin 0 to the upper bound defined in this pin. - Returns + Outputs ------- scoping: Scoping diff --git a/src/ansys/dpf/core/operators/utility/make_for_each_range.py b/src/ansys/dpf/core/operators/utility/make_for_each_range.py index f712d8a075d..32554852846 100644 --- a/src/ansys/dpf/core/operators/utility/make_for_each_range.py +++ b/src/ansys/dpf/core/operators/utility/make_for_each_range.py @@ -19,8 +19,8 @@ class make_for_each_range(Operator): r"""Generate a range that can be consumed by the for_each operator - Parameters - ---------- + Inputs + ------ try_generate_iterable: bool, optional if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) iterable: optional @@ -33,7 +33,7 @@ class make_for_each_range(Operator): valueC1: valueC2: - Returns + Outputs ------- output: diff --git a/src/ansys/dpf/core/operators/utility/make_label_space.py b/src/ansys/dpf/core/operators/utility/make_label_space.py index 88b2056960d..3368237641d 100644 --- a/src/ansys/dpf/core/operators/utility/make_label_space.py +++ b/src/ansys/dpf/core/operators/utility/make_label_space.py @@ -19,15 +19,15 @@ class make_label_space(Operator): r"""Assemble strings and integers to make a label space. - Parameters - ---------- + Inputs + ------ base_label: dict or FieldsContainer or ScopingsContainer, optional Used as a base label (extracted from Fields/Scoping Container, or directly from Label Space) that is concatenated with provided values. label_name: str label_value1: int label_value2: int - Returns + Outputs ------- label: dict diff --git a/src/ansys/dpf/core/operators/utility/make_overall.py b/src/ansys/dpf/core/operators/utility/make_overall.py index 2f7f67dc09c..abaab362aa8 100644 --- a/src/ansys/dpf/core/operators/utility/make_overall.py +++ b/src/ansys/dpf/core/operators/utility/make_overall.py @@ -20,12 +20,12 @@ class make_overall(Operator): value, with the associated scoping’s location set as ‘overall’. - Parameters - ---------- + Inputs + ------ field: Field id: int - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/make_producer_consumer_for_each_iterator.py b/src/ansys/dpf/core/operators/utility/make_producer_consumer_for_each_iterator.py index a68916f4bf5..813b55db086 100644 --- a/src/ansys/dpf/core/operators/utility/make_producer_consumer_for_each_iterator.py +++ b/src/ansys/dpf/core/operators/utility/make_producer_consumer_for_each_iterator.py @@ -22,8 +22,8 @@ class make_producer_consumer_for_each_iterator(Operator): the producers and the consumers. - Parameters - ---------- + Inputs + ------ try_generate_iterable: bool, optional if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true) iterable: optional @@ -44,7 +44,7 @@ class make_producer_consumer_for_each_iterator(Operator): consumer_op11: Operator consumer_op12: Operator - Returns + Outputs ------- iterator: to connect to producer_consumer_for_each diff --git a/src/ansys/dpf/core/operators/utility/merge_any.py b/src/ansys/dpf/core/operators/utility/merge_any.py index 6bd5f5aef91..c1caea268fa 100644 --- a/src/ansys/dpf/core/operators/utility/merge_any.py +++ b/src/ansys/dpf/core/operators/utility/merge_any.py @@ -21,14 +21,14 @@ class merge_any(Operator): Operator. - Parameters - ---------- + Inputs + ------ any1: Any Either a vector of objects (sharing the same data types) or objects from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. any2: Any Either a vector of objects (sharing the same data types) or objects from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. - Returns + Outputs ------- any: Any diff --git a/src/ansys/dpf/core/operators/utility/merge_collections.py b/src/ansys/dpf/core/operators/utility/merge_collections.py index 86390f29eec..a1fa2789dc8 100644 --- a/src/ansys/dpf/core/operators/utility/merge_collections.py +++ b/src/ansys/dpf/core/operators/utility/merge_collections.py @@ -19,14 +19,14 @@ class merge_collections(Operator): r"""Merges a set of collections into a unique one. - Parameters - ---------- + Inputs + ------ collections1: AnyCollection a vector of collections to merge or collections from pin 0 to ... collections2: AnyCollection a vector of collections to merge or collections from pin 0 to ... - Returns + Outputs ------- merged_collections: AnyCollection diff --git a/src/ansys/dpf/core/operators/utility/merge_data_tree.py b/src/ansys/dpf/core/operators/utility/merge_data_tree.py index 57de473776b..c0876412e27 100644 --- a/src/ansys/dpf/core/operators/utility/merge_data_tree.py +++ b/src/ansys/dpf/core/operators/utility/merge_data_tree.py @@ -20,14 +20,14 @@ class merge_data_tree(Operator): accross data tree instances. - Parameters - ---------- + Inputs + ------ data_tree1: DataTree Either a vector of data trees or data trees from pin 0 to ... to merge. data_tree2: DataTree Either a vector of data trees or data trees from pin 0 to ... to merge. - Returns + Outputs ------- any: Any diff --git a/src/ansys/dpf/core/operators/utility/merge_fields.py b/src/ansys/dpf/core/operators/utility/merge_fields.py index 8eb07b62e95..c710a4c5656 100644 --- a/src/ansys/dpf/core/operators/utility/merge_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_fields.py @@ -19,8 +19,8 @@ class merge_fields(Operator): r"""Assembles a set of fields into a unique one. - Parameters - ---------- + Inputs + ------ sum_merge: bool, optional Default is false. If true, redundant quantities are summed instead of being ignored. merged_support: AbstractFieldSupport, optional @@ -30,7 +30,7 @@ class merge_fields(Operator): fields2: Field or FieldsContainer Either a fields container, a vector of fields to merge, or fields from pin 0 to ... - Returns + Outputs ------- merged_field: Field diff --git a/src/ansys/dpf/core/operators/utility/merge_fields_by_label.py b/src/ansys/dpf/core/operators/utility/merge_fields_by_label.py index 131607836bb..f6ce973dedc 100644 --- a/src/ansys/dpf/core/operators/utility/merge_fields_by_label.py +++ b/src/ansys/dpf/core/operators/utility/merge_fields_by_label.py @@ -19,8 +19,8 @@ class merge_fields_by_label(Operator): r"""Merges the fields of a fields container that share the same label value. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer label: str Label identifier that should be merged. @@ -29,7 +29,7 @@ class merge_fields_by_label(Operator): sum_merge: bool, optional Default is false. If true, redundant quantities are summed instead of being ignored. - Returns + Outputs ------- fields_container: FieldsContainer merged_field_support: AbstractFieldSupport diff --git a/src/ansys/dpf/core/operators/utility/merge_fields_containers.py b/src/ansys/dpf/core/operators/utility/merge_fields_containers.py index 0c7902fb7b2..5e832a11a26 100644 --- a/src/ansys/dpf/core/operators/utility/merge_fields_containers.py +++ b/src/ansys/dpf/core/operators/utility/merge_fields_containers.py @@ -19,8 +19,8 @@ class merge_fields_containers(Operator): r"""Assembles a set of fields containers into a unique one. - Parameters - ---------- + Inputs + ------ should_merge_named_selections: bool, optional For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. sum_merge: bool, optional @@ -34,7 +34,7 @@ class merge_fields_containers(Operator): fields_containers2: FieldsContainer A vector of fields containers to merge or fields containers from pin 0 to ... - Returns + Outputs ------- merged_fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/merge_generic_data_container.py b/src/ansys/dpf/core/operators/utility/merge_generic_data_container.py index 0b5df369cdc..10c07d56604 100644 --- a/src/ansys/dpf/core/operators/utility/merge_generic_data_container.py +++ b/src/ansys/dpf/core/operators/utility/merge_generic_data_container.py @@ -21,14 +21,14 @@ class merge_generic_data_container(Operator): cannot be merged, first instance found will be maintained in the result. - Parameters - ---------- + Inputs + ------ generic_data_container1: GenericDataContainer Either a vector of generic data containers (sharing the same data types) or generic data containers from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. generic_data_container2: GenericDataContainer Either a vector of generic data containers (sharing the same data types) or generic data containers from pin 0 to ... to merge. Supported types rely on existing type specific merge operators. - Returns + Outputs ------- generic_data_container: GenericDataContainer diff --git a/src/ansys/dpf/core/operators/utility/merge_materials.py b/src/ansys/dpf/core/operators/utility/merge_materials.py index 1e6d7e32303..4f45add1b4b 100644 --- a/src/ansys/dpf/core/operators/utility/merge_materials.py +++ b/src/ansys/dpf/core/operators/utility/merge_materials.py @@ -19,14 +19,14 @@ class merge_materials(Operator): r"""Assembles a set of materials into a unique one. - Parameters - ---------- + Inputs + ------ materials1: Materials A vector of materials to merge or materials from pin 0 to ... materials2: Materials A vector of materials to merge or materials from pin 0 to ... - Returns + Outputs ------- merged_materials: Materials diff --git a/src/ansys/dpf/core/operators/utility/merge_meshes.py b/src/ansys/dpf/core/operators/utility/merge_meshes.py index 8d1e6c90f40..7512ad00df2 100644 --- a/src/ansys/dpf/core/operators/utility/merge_meshes.py +++ b/src/ansys/dpf/core/operators/utility/merge_meshes.py @@ -19,8 +19,8 @@ class merge_meshes(Operator): r"""Take a set of meshes and assemble them in a unique one - Parameters - ---------- + Inputs + ------ naive_merge_elements: bool, optional If true, merge the elemental Property Fields of the input meshes assuming that there is no repetition in their scoping ids. Default is false. should_merge_named_selections: bool, optional @@ -36,7 +36,7 @@ class merge_meshes(Operator): remove_duplicate_elements: int, optional 0: keep duplicate elements (default), 1: remove duplicate elements - Returns + Outputs ------- merges_mesh: MeshedRegion diff --git a/src/ansys/dpf/core/operators/utility/merge_meshes_containers.py b/src/ansys/dpf/core/operators/utility/merge_meshes_containers.py index 2e6ab7228f5..a1ce4358899 100644 --- a/src/ansys/dpf/core/operators/utility/merge_meshes_containers.py +++ b/src/ansys/dpf/core/operators/utility/merge_meshes_containers.py @@ -19,14 +19,14 @@ class merge_meshes_containers(Operator): r"""Assembles a set of meshes containers into a unique one. - Parameters - ---------- + Inputs + ------ meshes_containers1: MeshesContainer a vector of meshes containers to merge or meshes containers from pin 0 to ... meshes_containers2: MeshesContainer a vector of meshes containers to merge or meshes containers from pin 0 to ... - Returns + Outputs ------- merged_meshes_container: MeshesContainer diff --git a/src/ansys/dpf/core/operators/utility/merge_property_fields.py b/src/ansys/dpf/core/operators/utility/merge_property_fields.py index 26a77ed352e..f65f922afbc 100644 --- a/src/ansys/dpf/core/operators/utility/merge_property_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_property_fields.py @@ -19,8 +19,8 @@ class merge_property_fields(Operator): r"""Assembles a set of property fields into a unique one. - Parameters - ---------- + Inputs + ------ naive_merge: bool If true, merge the input property fields assuming that there is no repetition in their scoping ids. Default is false. property_fields1: PropertyField or PropertyFieldsContainer @@ -28,7 +28,7 @@ class merge_property_fields(Operator): property_fields2: PropertyField or PropertyFieldsContainer Either a property fields container, a vector of property fields to merge or property fields from pin 0 to ... - Returns + Outputs ------- property_field: PropertyField diff --git a/src/ansys/dpf/core/operators/utility/merge_result_infos.py b/src/ansys/dpf/core/operators/utility/merge_result_infos.py index 7ddcaff11ca..ddd18385267 100644 --- a/src/ansys/dpf/core/operators/utility/merge_result_infos.py +++ b/src/ansys/dpf/core/operators/utility/merge_result_infos.py @@ -19,14 +19,14 @@ class merge_result_infos(Operator): r"""Assembles a set of result information into a unique one. - Parameters - ---------- + Inputs + ------ result_infos1: ResultInfo A vector of result info containers to merge or result infos from pin 0 to ... result_infos2: ResultInfo A vector of result info containers to merge or result infos from pin 0 to ... - Returns + Outputs ------- merged_result_infos: ResultInfo diff --git a/src/ansys/dpf/core/operators/utility/merge_scopings.py b/src/ansys/dpf/core/operators/utility/merge_scopings.py index 6be359b4ed5..d1b631bbc90 100644 --- a/src/ansys/dpf/core/operators/utility/merge_scopings.py +++ b/src/ansys/dpf/core/operators/utility/merge_scopings.py @@ -19,14 +19,14 @@ class merge_scopings(Operator): r"""Assembles a set of scopings into a unique one. - Parameters - ---------- + Inputs + ------ scopings1: Scoping or ScopingsContainer Either a scopings container, a vector of scopings to merge, or scopings from pin 0 to ... scopings2: Scoping or ScopingsContainer Either a scopings container, a vector of scopings to merge, or scopings from pin 0 to ... - Returns + Outputs ------- merged_scoping: Scoping diff --git a/src/ansys/dpf/core/operators/utility/merge_scopings_containers.py b/src/ansys/dpf/core/operators/utility/merge_scopings_containers.py index 637dca90868..edbb2fad31c 100644 --- a/src/ansys/dpf/core/operators/utility/merge_scopings_containers.py +++ b/src/ansys/dpf/core/operators/utility/merge_scopings_containers.py @@ -19,14 +19,14 @@ class merge_scopings_containers(Operator): r"""Assembles a set of scopings containers into a unique one. - Parameters - ---------- + Inputs + ------ scopings_containers1: ScopingsContainer A vector of scopings containers to merge or scopings containers from pin 0 to ... scopings_containers2: ScopingsContainer A vector of scopings containers to merge or scopings containers from pin 0 to ... - Returns + Outputs ------- merged_scopings_container: ScopingsContainer diff --git a/src/ansys/dpf/core/operators/utility/merge_string_fields.py b/src/ansys/dpf/core/operators/utility/merge_string_fields.py index 14a651bba7c..c490570436a 100644 --- a/src/ansys/dpf/core/operators/utility/merge_string_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_string_fields.py @@ -19,14 +19,14 @@ class merge_string_fields(Operator): r"""Assembles a set of string fields into a unique one. - Parameters - ---------- + Inputs + ------ string_fields1: StringField Either a a vector of string fields to merge or string fields from pin 0 to ... string_fields2: StringField Either a a vector of string fields to merge or string fields from pin 0 to ... - Returns + Outputs ------- string_field: StringField diff --git a/src/ansys/dpf/core/operators/utility/merge_supports.py b/src/ansys/dpf/core/operators/utility/merge_supports.py index bf7db80ea8a..4a1680f4e6d 100644 --- a/src/ansys/dpf/core/operators/utility/merge_supports.py +++ b/src/ansys/dpf/core/operators/utility/merge_supports.py @@ -19,8 +19,8 @@ class merge_supports(Operator): r"""Assembles a set of supports into a unique one. - Parameters - ---------- + Inputs + ------ should_merge_named_selections: bool, optional For some result files (such as RST), the scoping on names selection is duplicated through all the distributed files.If this pin is false, the merging process is skipped. If it is true, this scoping is merged. Default is true. supports1: AbstractFieldSupport @@ -28,7 +28,7 @@ class merge_supports(Operator): supports2: AbstractFieldSupport A vector of supports to merge or supports from pin 0 to ... - Returns + Outputs ------- merged_support: AbstractFieldSupport diff --git a/src/ansys/dpf/core/operators/utility/merge_time_freq_supports.py b/src/ansys/dpf/core/operators/utility/merge_time_freq_supports.py index 547c0043991..5b734526be9 100644 --- a/src/ansys/dpf/core/operators/utility/merge_time_freq_supports.py +++ b/src/ansys/dpf/core/operators/utility/merge_time_freq_supports.py @@ -19,14 +19,14 @@ class merge_time_freq_supports(Operator): r"""Assembles a set of time/frequency supports into a unique one. - Parameters - ---------- + Inputs + ------ time_freq_supports1: TimeFreqSupport A vector of time/frequency supports to merge or time/frequency supports from pin 0 to ... time_freq_supports2: TimeFreqSupport A vector of time/frequency supports to merge or time/frequency supports from pin 0 to ... - Returns + Outputs ------- merged_support: TimeFreqSupport diff --git a/src/ansys/dpf/core/operators/utility/merge_to_field_matrix.py b/src/ansys/dpf/core/operators/utility/merge_to_field_matrix.py index 1ac28e5c55f..cf5fce72779 100644 --- a/src/ansys/dpf/core/operators/utility/merge_to_field_matrix.py +++ b/src/ansys/dpf/core/operators/utility/merge_to_field_matrix.py @@ -19,14 +19,14 @@ class merge_to_field_matrix(Operator): r"""Assembles a set of fields into a field matrix. - Parameters - ---------- + Inputs + ------ fields1: Field or FieldsContainer Either a fields container, a vector of fields to merge, or fields from pin 0 to ... fields2: Field or FieldsContainer Either a fields container, a vector of fields to merge, or fields from pin 0 to ... - Returns + Outputs ------- merged_field_matrix: Field diff --git a/src/ansys/dpf/core/operators/utility/merge_weighted_fields.py b/src/ansys/dpf/core/operators/utility/merge_weighted_fields.py index d40ed53b7b2..65b9becd8c5 100644 --- a/src/ansys/dpf/core/operators/utility/merge_weighted_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_weighted_fields.py @@ -20,8 +20,8 @@ class merge_weighted_fields(Operator): sum of the fields. - Parameters - ---------- + Inputs + ------ sum_merge: bool, optional Default is false. If true, redundant quantities are summed instead of being ignored. merged_support: AbstractFieldSupport, optional @@ -35,7 +35,7 @@ class merge_weighted_fields(Operator): weights2: PropertyField Weights to apply to each field from pin 1000 to ... - Returns + Outputs ------- merged_field: Field diff --git a/src/ansys/dpf/core/operators/utility/merge_weighted_fields_containers.py b/src/ansys/dpf/core/operators/utility/merge_weighted_fields_containers.py index f0531dac22a..bdee65964dd 100644 --- a/src/ansys/dpf/core/operators/utility/merge_weighted_fields_containers.py +++ b/src/ansys/dpf/core/operators/utility/merge_weighted_fields_containers.py @@ -20,8 +20,8 @@ class merge_weighted_fields_containers(Operator): weight on the sum of the fields. - Parameters - ---------- + Inputs + ------ sum_merge: bool, optional Default is false. If true, redundant quantities are summed instead of being ignored. merged_fields_support: AbstractFieldSupport, optional @@ -39,7 +39,7 @@ class merge_weighted_fields_containers(Operator): Dataprocessing::Cpropertyfield> Weights to apply to each field from pin 1000 to ... - Returns + Outputs ------- merged_fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/mesh.py b/src/ansys/dpf/core/operators/utility/mesh.py index c41a6b50f0e..be67f93caa9 100644 --- a/src/ansys/dpf/core/operators/utility/mesh.py +++ b/src/ansys/dpf/core/operators/utility/mesh.py @@ -19,11 +19,11 @@ class mesh(Operator): r"""Incrementaly merge the input. - Parameters - ---------- + Inputs + ------ input: MeshedRegion - Returns + Outputs ------- incremented_result: diff --git a/src/ansys/dpf/core/operators/utility/mesh_to_mc.py b/src/ansys/dpf/core/operators/utility/mesh_to_mc.py index d310c67813b..f88dc00f399 100644 --- a/src/ansys/dpf/core/operators/utility/mesh_to_mc.py +++ b/src/ansys/dpf/core/operators/utility/mesh_to_mc.py @@ -19,14 +19,14 @@ class mesh_to_mc(Operator): r"""Creates a meshes container containing the mesh provided on pin 0. - Parameters - ---------- + Inputs + ------ mesh: MeshedRegion or MeshesContainer If a meshes container is set in input, it is passed on as an output with the additional label space (if any). label: dict Sets a label space. - Returns + Outputs ------- meshes_container: MeshesContainer diff --git a/src/ansys/dpf/core/operators/utility/meshes_container.py b/src/ansys/dpf/core/operators/utility/meshes_container.py index f5c7c524c8e..869f14c9957 100644 --- a/src/ansys/dpf/core/operators/utility/meshes_container.py +++ b/src/ansys/dpf/core/operators/utility/meshes_container.py @@ -19,11 +19,11 @@ class meshes_container(Operator): r"""Incrementaly merge the input. - Parameters - ---------- + Inputs + ------ input: MeshesContainer - Returns + Outputs ------- incremented_result: diff --git a/src/ansys/dpf/core/operators/utility/operator_changelog.py b/src/ansys/dpf/core/operators/utility/operator_changelog.py index ec94195eeab..e2949ce0763 100644 --- a/src/ansys/dpf/core/operators/utility/operator_changelog.py +++ b/src/ansys/dpf/core/operators/utility/operator_changelog.py @@ -20,12 +20,12 @@ class operator_changelog(Operator): operator based on its name. - Parameters - ---------- + Inputs + ------ operator_name: str Operator internal name. - Returns + Outputs ------- changelog_gdc: GenericDataContainer GenericDataContainer used to instantiate a Changelog. diff --git a/src/ansys/dpf/core/operators/utility/operator_id.py b/src/ansys/dpf/core/operators/utility/operator_id.py index fea1af7e63e..884b44cb2c2 100644 --- a/src/ansys/dpf/core/operators/utility/operator_id.py +++ b/src/ansys/dpf/core/operators/utility/operator_id.py @@ -19,11 +19,11 @@ class operator_id(Operator): r"""Return the id of an Operator. - Parameters - ---------- + Inputs + ------ op: Operator - Returns + Outputs ------- id: int diff --git a/src/ansys/dpf/core/operators/utility/overlap_fields.py b/src/ansys/dpf/core/operators/utility/overlap_fields.py index 99e2e42cc37..88ca2308d41 100644 --- a/src/ansys/dpf/core/operators/utility/overlap_fields.py +++ b/src/ansys/dpf/core/operators/utility/overlap_fields.py @@ -20,12 +20,12 @@ class overlap_fields(Operator): values of base_field. - Parameters - ---------- + Inputs + ------ base_field: Field, optional overlapping_field: Field, optional - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/producer_consumer_for_each.py b/src/ansys/dpf/core/operators/utility/producer_consumer_for_each.py index 03747ef518b..16ca0e625da 100644 --- a/src/ansys/dpf/core/operators/utility/producer_consumer_for_each.py +++ b/src/ansys/dpf/core/operators/utility/producer_consumer_for_each.py @@ -22,8 +22,8 @@ class producer_consumer_for_each(Operator): These 2 parts will run asynchronously on 2 threads. - Parameters - ---------- + Inputs + ------ producer_consumer_iterableq: The result of the make_producer_consumer_for_each_iterator operator. forward1: @@ -31,7 +31,7 @@ class producer_consumer_for_each(Operator): forward2: output of the last operators of the workflow - Returns + Outputs ------- empty: output1: diff --git a/src/ansys/dpf/core/operators/utility/property_field.py b/src/ansys/dpf/core/operators/utility/property_field.py index 9c235014425..b0ba03984c4 100644 --- a/src/ansys/dpf/core/operators/utility/property_field.py +++ b/src/ansys/dpf/core/operators/utility/property_field.py @@ -19,11 +19,11 @@ class property_field(Operator): r"""Incrementaly merge the input. - Parameters - ---------- + Inputs + ------ input: PropertyField - Returns + Outputs ------- incremented_result: diff --git a/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py b/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py index 7057708fa00..9a03f259c60 100644 --- a/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/propertyfield_get_attribute.py @@ -21,13 +21,13 @@ class propertyfield_get_attribute(Operator): pin 0, a property name (string) in pin 1 are expected as inputs - Parameters - ---------- + Inputs + ------ property_field: PropertyField or PropertyFieldsContainer property_name: str Property to get. Accepted inputs are specific strings namely: 'unit, 'name','time_freq_support', 'scoping' and 'header'. - Returns + Outputs ------- property: str or TimeFreqSupport or Scoping or DataTree Property value that is returned. Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. diff --git a/src/ansys/dpf/core/operators/utility/python_generator.py b/src/ansys/dpf/core/operators/utility/python_generator.py index 8cf02906478..940e7350189 100644 --- a/src/ansys/dpf/core/operators/utility/python_generator.py +++ b/src/ansys/dpf/core/operators/utility/python_generator.py @@ -19,14 +19,14 @@ class python_generator(Operator): r"""Generates .py file with specifications for loaded plugin(s). - Parameters - ---------- + Inputs + ------ dll_source_path: str output_path: str load_symbol: str, optional library_key: str, optional - Returns + Outputs ------- Examples diff --git a/src/ansys/dpf/core/operators/utility/remote_operator_instantiate.py b/src/ansys/dpf/core/operators/utility/remote_operator_instantiate.py index e309f181d8e..110dd68def1 100644 --- a/src/ansys/dpf/core/operators/utility/remote_operator_instantiate.py +++ b/src/ansys/dpf/core/operators/utility/remote_operator_instantiate.py @@ -21,8 +21,8 @@ class remote_operator_instantiate(Operator): workflow is created with this operator and returned in output - Parameters - ---------- + Inputs + ------ operator_to_send: int local workflow to push to a remote or id of a remote workflow output_pin: int @@ -32,7 +32,7 @@ class remote_operator_instantiate(Operator): output_name: str output's name of the workflow to return - Returns + Outputs ------- remote_workflow: Workflow remote workflow containing an image of the remote workflow and the protocols streams diff --git a/src/ansys/dpf/core/operators/utility/remote_workflow_instantiate.py b/src/ansys/dpf/core/operators/utility/remote_workflow_instantiate.py index ed5f7c88881..7c13b1c5a97 100644 --- a/src/ansys/dpf/core/operators/utility/remote_workflow_instantiate.py +++ b/src/ansys/dpf/core/operators/utility/remote_workflow_instantiate.py @@ -21,14 +21,14 @@ class remote_workflow_instantiate(Operator): by an id and an address) for a given protocol registered in the streams. - Parameters - ---------- + Inputs + ------ workflow_to_send: Workflow or int local workflow to push to a remote or id of a remote workflow streams_to_remote: StreamsContainer data_sources_to_remote: DataSources, optional - Returns + Outputs ------- remote_workflow: Workflow remote workflow containing an image of the remote workflow and the protocols streams diff --git a/src/ansys/dpf/core/operators/utility/remove_unnecessary_labels.py b/src/ansys/dpf/core/operators/utility/remove_unnecessary_labels.py index 4a631ff579a..f2272adfdba 100644 --- a/src/ansys/dpf/core/operators/utility/remove_unnecessary_labels.py +++ b/src/ansys/dpf/core/operators/utility/remove_unnecessary_labels.py @@ -19,8 +19,8 @@ class remove_unnecessary_labels(Operator): r"""Removes the selected label from a fields container. - Parameters - ---------- + Inputs + ------ permissive: bool, optional If true, the operator does not throw an error if the label to be removed has more than one entry. fields_container: FieldsContainer @@ -28,7 +28,7 @@ class remove_unnecessary_labels(Operator): label_to_remove: str Label to be removed from the fields container. - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/scalars_to_field.py b/src/ansys/dpf/core/operators/utility/scalars_to_field.py index a1115ee1bff..86db9ba9ef0 100644 --- a/src/ansys/dpf/core/operators/utility/scalars_to_field.py +++ b/src/ansys/dpf/core/operators/utility/scalars_to_field.py @@ -19,8 +19,8 @@ class scalars_to_field(Operator): r"""Create scalar or vector Field. - Parameters - ---------- + Inputs + ------ double_or_vector_double: float, optional Data of the field, default is 0-field. Specify a double to have a field of same value or specify directly the data vector. unit: str, optional @@ -34,7 +34,7 @@ class scalars_to_field(Operator): scoping: Scoping, optional Scoping. - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/server_path.py b/src/ansys/dpf/core/operators/utility/server_path.py index 40b0578c7c2..29e9fc1fcdb 100644 --- a/src/ansys/dpf/core/operators/utility/server_path.py +++ b/src/ansys/dpf/core/operators/utility/server_path.py @@ -19,12 +19,12 @@ class server_path(Operator): r"""Returns the platform-specific path to a folder in the Dpf server - Parameters - ---------- + Inputs + ------ subpath: int, optional Subpath of the Dpf server. Supported values: 0 (default): root of the server, 1: "dpf/bin/platform", 2: "aisol/bin(dll)/platform", 3: "dpf/plugins", 4: "dpf/workflows". - Returns + Outputs ------- path: str Path to the requested folder in the Dpf server diff --git a/src/ansys/dpf/core/operators/utility/set_attribute.py b/src/ansys/dpf/core/operators/utility/set_attribute.py index 24b7ddcdf00..919f1dde992 100644 --- a/src/ansys/dpf/core/operators/utility/set_attribute.py +++ b/src/ansys/dpf/core/operators/utility/set_attribute.py @@ -19,15 +19,15 @@ class set_attribute(Operator): r"""Uses the FieldsContainer APIs to modify it. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer property_name: str Supported property names are: "labels". property_identifier: dict, optional Value of the property to be set : vector of string or LabelSpace for "labels". - Returns + Outputs ------- fields_container: FieldsContainer Returns the modified FieldsContainer. diff --git a/src/ansys/dpf/core/operators/utility/set_property.py b/src/ansys/dpf/core/operators/utility/set_property.py index 0473c92261b..1ded8946f40 100644 --- a/src/ansys/dpf/core/operators/utility/set_property.py +++ b/src/ansys/dpf/core/operators/utility/set_property.py @@ -22,8 +22,8 @@ class set_property(Operator): expected as inputs - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer property_name: str Property to set. Accepted inputs are specific strings namely: 'unit', 'name', 'time_freq_support', 'scoping', 'header'. @@ -31,7 +31,7 @@ class set_property(Operator): float Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string. - Returns + Outputs ------- field: Field or FieldsContainer Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. diff --git a/src/ansys/dpf/core/operators/utility/split_in_for_each_range.py b/src/ansys/dpf/core/operators/utility/split_in_for_each_range.py index 76d1dedbe7f..63040b3ffde 100644 --- a/src/ansys/dpf/core/operators/utility/split_in_for_each_range.py +++ b/src/ansys/dpf/core/operators/utility/split_in_for_each_range.py @@ -20,8 +20,8 @@ class split_in_for_each_range(Operator): for_each loop. - Parameters - ---------- + Inputs + ------ iterable: optional Iterable that can be combined with the one currently generated. operator_to_iterate: Operator @@ -30,7 +30,7 @@ class split_in_for_each_range(Operator): scoping: Scoping chunk_size: int - Returns + Outputs ------- output: diff --git a/src/ansys/dpf/core/operators/utility/strain_from_voigt.py b/src/ansys/dpf/core/operators/utility/strain_from_voigt.py index da648221093..ba6ffa366bf 100644 --- a/src/ansys/dpf/core/operators/utility/strain_from_voigt.py +++ b/src/ansys/dpf/core/operators/utility/strain_from_voigt.py @@ -19,12 +19,12 @@ class strain_from_voigt(Operator): r"""Converts the strain field from Voigt notation into standard format. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/strain_from_voigt_fc.py b/src/ansys/dpf/core/operators/utility/strain_from_voigt_fc.py index 9a444d6c622..a6782bfdda7 100644 --- a/src/ansys/dpf/core/operators/utility/strain_from_voigt_fc.py +++ b/src/ansys/dpf/core/operators/utility/strain_from_voigt_fc.py @@ -19,12 +19,12 @@ class strain_from_voigt_fc(Operator): r"""Converts the strain field from Voigt notation into standard format. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- fields_container: FieldsContainer diff --git a/src/ansys/dpf/core/operators/utility/txt_file_to_dpf.py b/src/ansys/dpf/core/operators/utility/txt_file_to_dpf.py index b608d5dd102..94d83cffd00 100644 --- a/src/ansys/dpf/core/operators/utility/txt_file_to_dpf.py +++ b/src/ansys/dpf/core/operators/utility/txt_file_to_dpf.py @@ -19,12 +19,12 @@ class txt_file_to_dpf(Operator): r"""Take an input string and parse it into dataProcessing type - Parameters - ---------- + Inputs + ------ input_string: str ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' - Returns + Outputs ------- any_output1: any output diff --git a/src/ansys/dpf/core/operators/utility/unitary_field.py b/src/ansys/dpf/core/operators/utility/unitary_field.py index 788d6dfe6a0..7767776bf04 100644 --- a/src/ansys/dpf/core/operators/utility/unitary_field.py +++ b/src/ansys/dpf/core/operators/utility/unitary_field.py @@ -20,12 +20,12 @@ class unitary_field(Operator): and scoping as the input field. - Parameters - ---------- + Inputs + ------ field: Field or FieldsContainer field or fields container with only one field is expected - Returns + Outputs ------- field: Field diff --git a/src/ansys/dpf/core/operators/utility/weighted_merge_fields_by_label.py b/src/ansys/dpf/core/operators/utility/weighted_merge_fields_by_label.py index 56f1db0e859..e6121787066 100644 --- a/src/ansys/dpf/core/operators/utility/weighted_merge_fields_by_label.py +++ b/src/ansys/dpf/core/operators/utility/weighted_merge_fields_by_label.py @@ -20,8 +20,8 @@ class weighted_merge_fields_by_label(Operator): same label value. - Parameters - ---------- + Inputs + ------ fields_container: FieldsContainer label: str Label identifier that should be merged. @@ -34,7 +34,7 @@ class weighted_merge_fields_by_label(Operator): weights2: PropertyField Weights to apply to each field from pin 1000 to ... - Returns + Outputs ------- fields_container: FieldsContainer