diff --git a/src/ansys/dpf/core/operators/averaging/elemental_difference.py b/src/ansys/dpf/core/operators/averaging/elemental_difference.py index db53f278b2..8aa967cab2 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_difference.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_difference.py @@ -30,6 +30,9 @@ class elemental_difference(Operator): through the different shell layers if true (default is false). + Returns + ------- + field : Field Examples -------- 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 55391bc5fd..00db3727d5 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py @@ -38,6 +38,9 @@ class elemental_difference_fc(Operator): through the different shell layers if true (default is false). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 fc9ff69560..2fc864fe5b 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py @@ -40,6 +40,9 @@ class elemental_fraction_fc(Operator): different shell layers if true (default is false). + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/averaging/elemental_mean.py b/src/ansys/dpf/core/operators/averaging/elemental_mean.py index c105822c3e..e93db29b41 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_mean.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_mean.py @@ -29,6 +29,9 @@ class elemental_mean(Operator): correspond to the one of the fields containers. + Returns + ------- + field : Field Examples -------- 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 b6f50facee..fb50df1bd2 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py @@ -36,6 +36,9 @@ class elemental_mean_fc(Operator): perform the averaging. it is used if there is no fields support. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 20656efa28..b09991fd6b 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 @@ -36,6 +36,13 @@ class elemental_nodal_to_nodal(Operator): available). default is false. mesh : MeshedRegion, optional + Returns + ------- + field : Field + weight : PropertyField + Provides the number of times it was found in + the elemental nodal field, for each + node. can be used to average later. Examples -------- 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 898e3cabc3..82387e29e7 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 @@ -22,6 +22,9 @@ class elemental_nodal_to_nodal_elemental(Operator): is expected mesh_scoping : Scoping, optional + Returns + ------- + field : Field Examples -------- 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 9ff7750a57..18229a4a4a 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,6 +20,9 @@ class elemental_nodal_to_nodal_elemental_fc(Operator): fields_container : FieldsContainer mesh_scoping : Scoping, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 2597c0365b..790e9a83bf 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 @@ -52,6 +52,14 @@ class elemental_nodal_to_nodal_fc(Operator): one field all solids and shells (only on one layer). + Returns + ------- + fields_container : FieldsContainer + weights : Class Dataprocessing::Dpftypecollection<Class + Dataprocessing::Cpropertyfield> + Gives for each node, the number of times it + was found in the elemental nodal + field. can be used to average later. Examples -------- 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 2ce21eac34..62059f3cb6 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 @@ -23,6 +23,9 @@ class elemental_to_elemental_nodal(Operator): Average only on these entities mesh : MeshedRegion, optional + Returns + ------- + field : Field Examples -------- 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 00bc3dc330..7ad4aacce7 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 @@ -20,6 +20,9 @@ class elemental_to_elemental_nodal_fc(Operator): mesh : MeshedRegion, optional mesh_scoping : Scoping, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bd09ada559..43d2cf0a96 100644 --- a/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py +++ b/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py @@ -40,6 +40,9 @@ class elemental_to_nodal(Operator): (default is chosen based on the type of mesh). + Returns + ------- + field : Field Examples -------- 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 a3088f3479..56654db706 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 @@ -39,6 +39,9 @@ class elemental_to_nodal_fc(Operator): (default is chosen based on the type of mesh). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 6bd8475dc4..2d23588db2 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 @@ -22,6 +22,9 @@ class extend_to_mid_nodes(Operator): is expected mesh : MeshedRegion, optional + Returns + ------- + field : Field Examples -------- 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 277d4f32f5..35983de1bb 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 @@ -23,6 +23,9 @@ class extend_to_mid_nodes_fc(Operator): perform the averaging. it is used if there is no fields support. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/averaging/force_summation.py b/src/ansys/dpf/core/operators/averaging/force_summation.py index b0880dbf29..9283491ab3 100644 --- a/src/ansys/dpf/core/operators/averaging/force_summation.py +++ b/src/ansys/dpf/core/operators/averaging/force_summation.py @@ -39,6 +39,14 @@ class force_summation(Operator): Coordinate field of a point for moment summations. defaults to (0,0,0). + Returns + ------- + force_accumulation : FieldsContainer + moment_accumulation : FieldsContainer + heat_accumulation : FieldsContainer + forces_on_nodes : FieldsContainer + moments_on_nodes : FieldsContainer + heats_on_nodes : FieldsContainer Examples -------- 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 163a48145c..4679a0a3bb 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 @@ -31,6 +31,9 @@ class gauss_to_node_fc(Operator): container, the label must correspond to the one of the fields containers. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/averaging/nodal_difference.py b/src/ansys/dpf/core/operators/averaging/nodal_difference.py index ec9b1f8347..53f9bf6bbb 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_difference.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_difference.py @@ -26,6 +26,9 @@ class nodal_difference(Operator): Average only on these entities mesh : MeshedRegion, optional + Returns + ------- + field : Field Examples -------- 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 fa6042c419..cf2e1615ae 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py @@ -32,6 +32,9 @@ class nodal_difference_fc(Operator): correspond to the one of the fields containers. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/averaging/nodal_extend_to_mid_nodes.py b/src/ansys/dpf/core/operators/averaging/nodal_extend_to_mid_nodes.py index 4b3859c4b2..6be3556a74 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_extend_to_mid_nodes.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_extend_to_mid_nodes.py @@ -27,6 +27,9 @@ class nodal_extend_to_mid_nodes(Operator): (improves performances). mesh : MeshedRegion, optional + Returns + ------- + field : Field Examples -------- 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 92a75ec241..d9cf8a0f52 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py @@ -34,6 +34,9 @@ class nodal_fraction_fc(Operator): fraction instead of elemental_nodal_to_nodal_fc. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1e323f6363..9d1fa1b614 100644 --- a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py +++ b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py @@ -25,6 +25,9 @@ class nodal_to_elemental(Operator): If true, shell layers are averaged as well (default is false). + Returns + ------- + field : Field Examples -------- 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 83eb3f7ec9..7cf8d1f55f 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 @@ -44,6 +44,9 @@ class nodal_to_elemental_fc(Operator): one field all solids and shells (only on one layer). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bc5aa58a07..1e505ba4d9 100644 --- a/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py +++ b/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py @@ -39,6 +39,9 @@ class to_elemental_fc(Operator): one field all solids and shells (only on one layer). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 9748c62daf..e16083df90 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 @@ -21,6 +21,9 @@ class to_elemental_nodal_fc(Operator): mesh_scoping : Scoping, optional mesh : MeshedRegion, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal.py b/src/ansys/dpf/core/operators/averaging/to_nodal.py index b061123fdf..a58dfd81f7 100644 --- a/src/ansys/dpf/core/operators/averaging/to_nodal.py +++ b/src/ansys/dpf/core/operators/averaging/to_nodal.py @@ -32,6 +32,9 @@ class to_nodal(Operator): one field all solids and shells (only on one layer). + Returns + ------- + field : Field Examples -------- 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 e7c9e53f52..d30233a59b 100644 --- a/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py +++ b/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py @@ -31,6 +31,9 @@ class to_nodal_fc(Operator): one field all solids and shells (only on one layer). + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/compression/apply_svd.py b/src/ansys/dpf/core/operators/compression/apply_svd.py index 7a193b3aff..f50ff70663 100644 --- a/src/ansys/dpf/core/operators/compression/apply_svd.py +++ b/src/ansys/dpf/core/operators/compression/apply_svd.py @@ -32,6 +32,24 @@ class apply_svd(Operator): transposed (square matrix), default value is false + Returns + ------- + us_svd : FieldsContainer + The output entity is a field container (time + dependant); it contains the + multiplication of two matrices, u and + s, where a=u.s.vt + vt_svd : FieldsContainer + The output entity is a field container (space + dependant), containing the vt, where + a=u.s.vt + sigma : Field or FieldsContainer + The output entity is a field (or a field + container if input fc contains + several labels, where field contains + results per label), containing + singular (s) values of the input + data, where a=u.s.vt Examples -------- diff --git a/src/ansys/dpf/core/operators/compression/apply_zfp.py b/src/ansys/dpf/core/operators/compression/apply_zfp.py index b9cc9d35ca..b9f87f9aac 100644 --- a/src/ansys/dpf/core/operators/compression/apply_zfp.py +++ b/src/ansys/dpf/core/operators/compression/apply_zfp.py @@ -47,6 +47,28 @@ class apply_zfp(Operator): * relativetol) are considered identical (default value: 1.0e-10). + Returns + ------- + 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] + compress_ratio : float + The output entity is a double, containing + compression rate = initial/compressed + dataOut : CustomTypeFieldsContainer + The output entity is a 'custom type field + container'; each + output field containing compressed + results corresponding to one + component data (ie. input vector + field/fc contains 3 components will + give 3 output fields), this is not + the case when input pin3 is set to 3, + all components will be compressed + into one field. Examples -------- diff --git a/src/ansys/dpf/core/operators/compression/kmeans_clustering.py b/src/ansys/dpf/core/operators/compression/kmeans_clustering.py index 931e399551..99432bdd34 100644 --- a/src/ansys/dpf/core/operators/compression/kmeans_clustering.py +++ b/src/ansys/dpf/core/operators/compression/kmeans_clustering.py @@ -30,6 +30,12 @@ class kmeans_clustering(Operator): '0' for x-displacement, '1' for y-displacement,... + Returns + ------- + scoping_clusters : ScopingsContainer + Scopings container with the space scoping + (entities' ids) corresponding to each + of k-clusters Examples -------- diff --git a/src/ansys/dpf/core/operators/compression/zfp_decompress.py b/src/ansys/dpf/core/operators/compression/zfp_decompress.py index fd94989130..4712460fdd 100644 --- a/src/ansys/dpf/core/operators/compression/zfp_decompress.py +++ b/src/ansys/dpf/core/operators/compression/zfp_decompress.py @@ -23,6 +23,15 @@ class zfp_decompress(Operator): zfp_compression operator to decompress + Returns + ------- + dataOut : Field or FieldsContainer + The output entity is a field or a fields + container; it contains decompressed + data + decompress_speed : float + The output entity is a double, containing + decompression speed (mb/sec) Examples -------- diff --git a/src/ansys/dpf/core/operators/filter/abc_weightings.py b/src/ansys/dpf/core/operators/filter/abc_weightings.py index 51f4177fe1..783d7cdaae 100644 --- a/src/ansys/dpf/core/operators/filter/abc_weightings.py +++ b/src/ansys/dpf/core/operators/filter/abc_weightings.py @@ -29,6 +29,10 @@ class abc_weightings(Operator): time freq scoping and not by ids. default is false + Returns + ------- + weightings : FieldsContainer + Weighted data in db units. Examples -------- 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 a1cc6cafc6..8a08ef3fee 100644 --- a/src/ansys/dpf/core/operators/filter/field_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/field_band_pass.py @@ -28,6 +28,9 @@ class field_band_pass(Operator): A maximum threshold scalar or a field containing one value is expected. + Returns + ------- + field : Field Examples -------- 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 e391756b2a..4671a6b892 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 @@ -28,6 +28,9 @@ class field_band_pass_fc(Operator): A maximum threshold scalar or a field containing one value is expected. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 300ce67cca..ec037ad072 100644 --- a/src/ansys/dpf/core/operators/filter/field_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/field_high_pass.py @@ -29,6 +29,9 @@ class field_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + field : Field Examples -------- 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 b624b66c00..0423d46a83 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 @@ -29,6 +29,9 @@ class field_high_pass_fc(Operator): container is returned on output pin 1. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b07be31b19..12dabf3d14 100644 --- a/src/ansys/dpf/core/operators/filter/field_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/field_low_pass.py @@ -29,6 +29,9 @@ class field_low_pass(Operator): container is returned on output pin 1. + Returns + ------- + field : Field Examples -------- 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 450a8f6712..efae9a71e8 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 @@ -29,6 +29,9 @@ class field_low_pass_fc(Operator): container is returned on output pin 1. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 8b985f433f..19817fb58a 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 @@ -29,6 +29,9 @@ class field_signed_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + field : Field Examples -------- 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 de319096ee..56b83cc00e 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 @@ -29,6 +29,9 @@ class field_signed_high_pass_fc(Operator): container is returned on output pin 1. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e5c23c925d..ebc29c779e 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 @@ -31,6 +31,9 @@ class filtering_max_over_time(Operator): Threshold from which the operator will filter. + Returns + ------- + workflow : Workflow Examples -------- 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 d4e3484b83..0505e20f26 100644 --- a/src/ansys/dpf/core/operators/filter/scoping_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/scoping_band_pass.py @@ -28,6 +28,9 @@ class scoping_band_pass(Operator): A maximum threshold scalar or a field containing one value is expected. + Returns + ------- + scoping : Scoping Examples -------- 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 eb84446fbc..0a75d89298 100644 --- a/src/ansys/dpf/core/operators/filter/scoping_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/scoping_high_pass.py @@ -29,6 +29,9 @@ class scoping_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + scoping : Scoping Examples -------- 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 7d73a9901e..67650b5743 100644 --- a/src/ansys/dpf/core/operators/filter/scoping_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/scoping_low_pass.py @@ -29,6 +29,9 @@ class scoping_low_pass(Operator): container is returned on output pin 1. + Returns + ------- + scoping : Scoping Examples -------- 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 086d56510e..e516097a74 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 @@ -29,6 +29,9 @@ class scoping_signed_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + scoping : Scoping Examples -------- 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 3c3be2453e..9395dcb8bd 100644 --- a/src/ansys/dpf/core/operators/filter/timefreq_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/timefreq_band_pass.py @@ -26,6 +26,10 @@ class timefreq_band_pass(Operator): A maximum threshold scalar or a field containing one value is expected. + Returns + ------- + time_freq_support : TimeFreqSupport + scoping : Scoping Examples -------- 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 20edddbbdc..4209b20476 100644 --- a/src/ansys/dpf/core/operators/filter/timefreq_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/timefreq_high_pass.py @@ -27,6 +27,10 @@ class timefreq_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + time_freq_support : TimeFreqSupport + scoping : Scoping Examples -------- 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 273a022695..957e8cc7ae 100644 --- a/src/ansys/dpf/core/operators/filter/timefreq_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/timefreq_low_pass.py @@ -27,6 +27,10 @@ class timefreq_low_pass(Operator): container is returned on output pin 1. + Returns + ------- + time_freq_support : TimeFreqSupport + scoping : Scoping Examples -------- 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 7a57f45502..ef4347da68 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 @@ -27,6 +27,10 @@ class timefreq_signed_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + time_freq_support : TimeFreqSupport + scoping : Scoping Examples -------- 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 18d66832e3..037b10b176 100644 --- a/src/ansys/dpf/core/operators/filter/timescoping_band_pass.py +++ b/src/ansys/dpf/core/operators/filter/timescoping_band_pass.py @@ -26,6 +26,9 @@ class timescoping_band_pass(Operator): A maximum threshold scalar or a field containing one value is expected. + Returns + ------- + scoping : Scoping Examples -------- 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 1c5d459c3b..7c0fd27cb9 100644 --- a/src/ansys/dpf/core/operators/filter/timescoping_high_pass.py +++ b/src/ansys/dpf/core/operators/filter/timescoping_high_pass.py @@ -27,6 +27,9 @@ class timescoping_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + scoping : Scoping Examples -------- 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 d13aa864ca..69ddc42474 100644 --- a/src/ansys/dpf/core/operators/filter/timescoping_low_pass.py +++ b/src/ansys/dpf/core/operators/filter/timescoping_low_pass.py @@ -27,6 +27,9 @@ class timescoping_low_pass(Operator): container is returned on output pin 1. + Returns + ------- + scoping : Scoping Examples -------- 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 21c0d43067..d2973a330c 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 @@ -27,6 +27,9 @@ class timescoping_signed_high_pass(Operator): container is returned on output pin 1. + Returns + ------- + scoping : Scoping Examples -------- 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 4e9d9078c9..8f90794c8e 100644 --- a/src/ansys/dpf/core/operators/geo/cartesian_to_spherical.py +++ b/src/ansys/dpf/core/operators/geo/cartesian_to_spherical.py @@ -18,6 +18,9 @@ class cartesian_to_spherical(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field Examples -------- 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 0928d26394..d619ab80d1 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 @@ -18,6 +18,9 @@ class cartesian_to_spherical_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 9bb5277c53..6b0ddfa946 100644 --- a/src/ansys/dpf/core/operators/geo/element_nodal_contribution.py +++ b/src/ansys/dpf/core/operators/geo/element_nodal_contribution.py @@ -30,6 +30,9 @@ class element_nodal_contribution(Operator): normalized with the element volume, area or length. default: true. + Returns + ------- + field : Field Examples -------- 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 e7a629805a..f8c0259b33 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 @@ -26,6 +26,12 @@ class elements_facets_surfaces_over_time(Operator): field's container does not contain it, or if there is no displacement. + Returns + ------- + fields_container : FieldsContainer + Surfaces field. + mesh : MeshedRegion + Mesh made of surface elements only. Examples -------- diff --git a/src/ansys/dpf/core/operators/geo/elements_volume.py b/src/ansys/dpf/core/operators/geo/elements_volume.py index 0d7d37de73..39cec5b4a5 100644 --- a/src/ansys/dpf/core/operators/geo/elements_volume.py +++ b/src/ansys/dpf/core/operators/geo/elements_volume.py @@ -25,6 +25,9 @@ class elements_volume(Operator): provided, the scoping needs to have "elemental" location. + Returns + ------- + field : Field Examples -------- 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 e8657676eb..80c485d197 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 @@ -27,6 +27,9 @@ class elements_volumes_over_time(Operator): field's container does not contain it, or if there is no displacement. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/geo/faces_area.py b/src/ansys/dpf/core/operators/geo/faces_area.py index 62384ea927..398ba27bd3 100644 --- a/src/ansys/dpf/core/operators/geo/faces_area.py +++ b/src/ansys/dpf/core/operators/geo/faces_area.py @@ -25,6 +25,9 @@ class faces_area(Operator): the scoping needs to have "faces" location. + Returns + ------- + field : Field Examples -------- 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 20c2b24e1f..b2ff2f8b3b 100644 --- a/src/ansys/dpf/core/operators/geo/gauss_to_node.py +++ b/src/ansys/dpf/core/operators/geo/gauss_to_node.py @@ -26,6 +26,9 @@ class gauss_to_node(Operator): mesh : MeshedRegion, optional Mesh to integrate on. + Returns + ------- + field : Field Examples -------- 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 7cc4075f8c..cadcff0e40 100644 --- a/src/ansys/dpf/core/operators/geo/integrate_over_elements.py +++ b/src/ansys/dpf/core/operators/geo/integrate_over_elements.py @@ -24,6 +24,9 @@ class integrate_over_elements(Operator): Mesh to integrate on. if not provided, the one from input field is employed. + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/geo/normals.py b/src/ansys/dpf/core/operators/geo/normals.py index e8cf764eb2..8077c41764 100644 --- a/src/ansys/dpf/core/operators/geo/normals.py +++ b/src/ansys/dpf/core/operators/geo/normals.py @@ -22,6 +22,9 @@ class normals(Operator): mesh_scoping : Scoping, optional field : Field, optional + Returns + ------- + field : Field Examples -------- 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 9d077342a1..68bc5d8309 100644 --- a/src/ansys/dpf/core/operators/geo/normals_provider_nl.py +++ b/src/ansys/dpf/core/operators/geo/normals_provider_nl.py @@ -28,6 +28,9 @@ class normals_provider_nl(Operator): overrides scoping. default is elemental. + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/geo/rotate.py b/src/ansys/dpf/core/operators/geo/rotate.py index 867d8dc3e2..558f36958f 100644 --- a/src/ansys/dpf/core/operators/geo/rotate.py +++ b/src/ansys/dpf/core/operators/geo/rotate.py @@ -22,6 +22,9 @@ class rotate(Operator): field_rotation_matrix : Field 3-3 rotation matrix + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/geo/rotate_fc.py b/src/ansys/dpf/core/operators/geo/rotate_fc.py index c6ab50bd8b..0ae5b47c17 100644 --- a/src/ansys/dpf/core/operators/geo/rotate_fc.py +++ b/src/ansys/dpf/core/operators/geo/rotate_fc.py @@ -21,6 +21,9 @@ class rotate_fc(Operator): coordinate_system : Field 3-3 rotation matrix + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5eb72ba6fd..2f58ff0671 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 @@ -30,6 +30,9 @@ class rotate_in_cylindrical_cs(Operator): mesh : MeshedRegion, optional Mesh support of the input field. + Returns + ------- + field : Field Examples -------- 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 c72fcc3eaf..49b8599d67 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 @@ -30,6 +30,9 @@ class rotate_in_cylindrical_cs_fc(Operator): Mesh support of the input fields_container, in case it does not have one defined. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5c0571e4ad..742eb329ce 100644 --- a/src/ansys/dpf/core/operators/geo/spherical_to_cartesian.py +++ b/src/ansys/dpf/core/operators/geo/spherical_to_cartesian.py @@ -18,6 +18,9 @@ class spherical_to_cartesian(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field Examples -------- 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 2fa0a88941..3e30c25103 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 @@ -18,6 +18,9 @@ class spherical_to_cartesian_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 255c57d71a..96bb75afe5 100644 --- a/src/ansys/dpf/core/operators/geo/to_polar_coordinates.py +++ b/src/ansys/dpf/core/operators/geo/to_polar_coordinates.py @@ -28,6 +28,9 @@ class to_polar_coordinates(Operator): rotation axis is the z axis and the origin is [0,0,0]. + Returns + ------- + field : Field Examples -------- 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 39e7d79770..b1a4587e64 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 @@ -21,6 +21,9 @@ class convertnum_bcs_to_nod(Operator): data_sources : DataSources Data_sources (must contain the full file). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d1c51f1ed8..ea7af2ee67 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 @@ -21,6 +21,9 @@ class convertnum_nod_to_bcs(Operator): data_sources : DataSources Data_sources (must contain the full file). + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/invariant/convertnum_op.py b/src/ansys/dpf/core/operators/invariant/convertnum_op.py index e0fdd17eff..714541d559 100644 --- a/src/ansys/dpf/core/operators/invariant/convertnum_op.py +++ b/src/ansys/dpf/core/operators/invariant/convertnum_op.py @@ -26,6 +26,9 @@ class convertnum_op(Operator): data_sources : DataSources Data_sources (must contain the full file). + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/invariant/eigen_values.py b/src/ansys/dpf/core/operators/invariant/eigen_values.py index 6b072a7f63..ce64b497b3 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_values.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_values.py @@ -20,6 +20,9 @@ class eigen_values(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 894fbd5d66..b203a78652 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_values_fc.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_values_fc.py @@ -19,6 +19,9 @@ class eigen_values_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/invariant/eigen_vectors.py b/src/ansys/dpf/core/operators/invariant/eigen_vectors.py index d741b2c6be..e8b4ba0489 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_vectors.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_vectors.py @@ -20,6 +20,9 @@ class eigen_vectors(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 d563d19181..82b50030ac 100644 --- a/src/ansys/dpf/core/operators/invariant/eigen_vectors_fc.py +++ b/src/ansys/dpf/core/operators/invariant/eigen_vectors_fc.py @@ -19,6 +19,9 @@ class eigen_vectors_fc(Operator): ---------- fields_container : FieldsContainer or Field + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/invariant/invariants.py b/src/ansys/dpf/core/operators/invariant/invariants.py index 1bdbb9d97f..d1b73d9b01 100644 --- a/src/ansys/dpf/core/operators/invariant/invariants.py +++ b/src/ansys/dpf/core/operators/invariant/invariants.py @@ -18,6 +18,14 @@ class invariants(Operator): ---------- field : Field + Returns + ------- + field_int : Field + Stress intensity field + field_eqv : Field + Stress equivalent intensity + field_max_shear : Field + Max shear stress field Examples -------- diff --git a/src/ansys/dpf/core/operators/invariant/invariants_fc.py b/src/ansys/dpf/core/operators/invariant/invariants_fc.py index f75bec0ecb..c0cb32043a 100644 --- a/src/ansys/dpf/core/operators/invariant/invariants_fc.py +++ b/src/ansys/dpf/core/operators/invariant/invariants_fc.py @@ -19,6 +19,14 @@ class invariants_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_int : FieldsContainer + Stress intensity field + fields_eqv : FieldsContainer + Stress equivalent intensity + fields_max_shear : FieldsContainer + Max shear stress field Examples -------- diff --git a/src/ansys/dpf/core/operators/invariant/principal_invariants.py b/src/ansys/dpf/core/operators/invariant/principal_invariants.py index 1acbefe6b8..e716f0cc32 100644 --- a/src/ansys/dpf/core/operators/invariant/principal_invariants.py +++ b/src/ansys/dpf/core/operators/invariant/principal_invariants.py @@ -18,6 +18,14 @@ class principal_invariants(Operator): ---------- field : Field + Returns + ------- + field_eig_1 : Field + First eigen value field + field_eig_2 : Field + Second eigen value field + field_eig_3 : Field + Third eigen value field Examples -------- 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 f6d76794e5..4c3b94ac89 100644 --- a/src/ansys/dpf/core/operators/invariant/principal_invariants_fc.py +++ b/src/ansys/dpf/core/operators/invariant/principal_invariants_fc.py @@ -19,6 +19,14 @@ class principal_invariants_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_eig_1 : FieldsContainer + First eigen value fields + fields_eig_2 : FieldsContainer + Second eigen value fields + fields_eig_3 : FieldsContainer + Third eigen value fields Examples -------- 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 71fcc8d025..5c44e93687 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 @@ -21,6 +21,9 @@ class segalman_von_mises_eqv(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 bb29ef0880..d4aa603c8e 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 @@ -19,6 +19,9 @@ class segalman_von_mises_eqv_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 6161534a8c..1aed931415 100644 --- a/src/ansys/dpf/core/operators/invariant/von_mises_eqv.py +++ b/src/ansys/dpf/core/operators/invariant/von_mises_eqv.py @@ -23,6 +23,9 @@ class von_mises_eqv(Operator): Poisson ratio to be used in equivalent strain calculation. + Returns + ------- + field : Field Examples -------- 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 32a668bd2d..3955694ffe 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 @@ -22,6 +22,9 @@ class von_mises_eqv_fc(Operator): Poisson ratio to be used in equivalent strain calculation. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/ascending_sort.py b/src/ansys/dpf/core/operators/logic/ascending_sort.py index dc68a720d1..a87e6a4a8d 100644 --- a/src/ansys/dpf/core/operators/logic/ascending_sort.py +++ b/src/ansys/dpf/core/operators/logic/ascending_sort.py @@ -28,6 +28,9 @@ class ascending_sort(Operator): If true, uses scoping to sort the field (default is false) + Returns + ------- + field : Field Examples -------- 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 a5c015e798..da07b9f624 100644 --- a/src/ansys/dpf/core/operators/logic/ascending_sort_fc.py +++ b/src/ansys/dpf/core/operators/logic/ascending_sort_fc.py @@ -28,6 +28,9 @@ class ascending_sort_fc(Operator): If true, uses scoping to sort the field (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/component_selector.py b/src/ansys/dpf/core/operators/logic/component_selector.py index 04dd4a1b53..930659b188 100644 --- a/src/ansys/dpf/core/operators/logic/component_selector.py +++ b/src/ansys/dpf/core/operators/logic/component_selector.py @@ -24,6 +24,9 @@ class component_selector(Operator): Set a default value for components that do not exist. + Returns + ------- + field : Field Examples -------- 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 418321c71c..8f4be543f4 100644 --- a/src/ansys/dpf/core/operators/logic/component_selector_fc.py +++ b/src/ansys/dpf/core/operators/logic/component_selector_fc.py @@ -22,6 +22,9 @@ class component_selector_fc(Operator): One or several component index that will be extracted from the initial field. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/component_transformer.py b/src/ansys/dpf/core/operators/logic/component_transformer.py index a49a0c0f38..adf04f4903 100644 --- a/src/ansys/dpf/core/operators/logic/component_transformer.py +++ b/src/ansys/dpf/core/operators/logic/component_transformer.py @@ -24,6 +24,9 @@ class component_transformer(Operator): default_value : float, optional Set a default value for components selected. + Returns + ------- + field : Field Examples -------- 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 889b89ab95..cb4a8590d9 100644 --- a/src/ansys/dpf/core/operators/logic/component_transformer_fc.py +++ b/src/ansys/dpf/core/operators/logic/component_transformer_fc.py @@ -24,6 +24,9 @@ class component_transformer_fc(Operator): default_value : float, optional Set a default value for components selected. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/descending_sort.py b/src/ansys/dpf/core/operators/logic/descending_sort.py index bc0e3c9394..beedd8f85b 100644 --- a/src/ansys/dpf/core/operators/logic/descending_sort.py +++ b/src/ansys/dpf/core/operators/logic/descending_sort.py @@ -27,6 +27,9 @@ class descending_sort(Operator): If true, uses scoping to sort the field (default is false) + Returns + ------- + field : Field Examples -------- 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 fd32b743e8..d2531d2f30 100644 --- a/src/ansys/dpf/core/operators/logic/descending_sort_fc.py +++ b/src/ansys/dpf/core/operators/logic/descending_sort_fc.py @@ -27,6 +27,9 @@ class descending_sort_fc(Operator): If true, uses scoping to sort the field (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 a48303a656..eeda0ad01d 100644 --- a/src/ansys/dpf/core/operators/logic/elementary_data_selector.py +++ b/src/ansys/dpf/core/operators/logic/elementary_data_selector.py @@ -29,6 +29,9 @@ class elementary_data_selector(Operator): For field with nature matrix, this is the column indices to extract. + Returns + ------- + field : Field Examples -------- 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 3e4b3584b9..2b1322a38d 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 @@ -28,6 +28,9 @@ class elementary_data_selector_fc(Operator): For a field with nature matrix, this extracts the column indices. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/enrich_materials.py b/src/ansys/dpf/core/operators/logic/enrich_materials.py index 03292e8d7f..c4b3785ef6 100644 --- a/src/ansys/dpf/core/operators/logic/enrich_materials.py +++ b/src/ansys/dpf/core/operators/logic/enrich_materials.py @@ -21,6 +21,9 @@ class enrich_materials(Operator): streams : StreamsContainer or FieldsContainer streams_mapping : PropertyFieldsContainer + Returns + ------- + MaterialContainer : bool Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/identical_fc.py b/src/ansys/dpf/core/operators/logic/identical_fc.py index c9209de6f4..e255087d5b 100644 --- a/src/ansys/dpf/core/operators/logic/identical_fc.py +++ b/src/ansys/dpf/core/operators/logic/identical_fc.py @@ -32,6 +32,11 @@ class identical_fc(Operator): considered identical (v1-v2)/v2 < relativetol (default is 0.001). + Returns + ------- + boolean : bool + Bool (true if identical...) + message : str Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/identical_fields.py b/src/ansys/dpf/core/operators/logic/identical_fields.py index 9593785af6..81d3586d0d 100644 --- a/src/ansys/dpf/core/operators/logic/identical_fields.py +++ b/src/ansys/dpf/core/operators/logic/identical_fields.py @@ -32,6 +32,11 @@ class identical_fields(Operator): considered identical(v1 - v2) / v2 < relativetol(default is 0.001). + Returns + ------- + boolean : bool + Bool (true if identical...) + message : str Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/identical_meshes.py b/src/ansys/dpf/core/operators/logic/identical_meshes.py index 6e2eec127c..2990dc4683 100644 --- a/src/ansys/dpf/core/operators/logic/identical_meshes.py +++ b/src/ansys/dpf/core/operators/logic/identical_meshes.py @@ -31,6 +31,9 @@ class identical_meshes(Operator): scopings...). default value is 'false'. + Returns + ------- + are_identical : bool Examples -------- 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 9d010d23d5..8efad06158 100644 --- a/src/ansys/dpf/core/operators/logic/identical_property_fields.py +++ b/src/ansys/dpf/core/operators/logic/identical_property_fields.py @@ -19,6 +19,10 @@ class identical_property_fields(Operator): property_fieldA : MeshedRegion property_fieldB : MeshedRegion + Returns + ------- + are_identical : bool + information : str Examples -------- 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 f161ca3ff5..375cf6c594 100644 --- a/src/ansys/dpf/core/operators/logic/identical_string_fields.py +++ b/src/ansys/dpf/core/operators/logic/identical_string_fields.py @@ -19,6 +19,10 @@ class identical_string_fields(Operator): string_fieldA : StringField string_fieldB : StringField + Returns + ------- + are_identical : bool + information : str Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/included_fields.py b/src/ansys/dpf/core/operators/logic/included_fields.py index 967b065977..21e171d13c 100644 --- a/src/ansys/dpf/core/operators/logic/included_fields.py +++ b/src/ansys/dpf/core/operators/logic/included_fields.py @@ -32,6 +32,11 @@ class included_fields(Operator): considered identical (v1-v2)/v2 < relativetol (default is 0.001). + Returns + ------- + included : bool + Bool (true if belongs...) + message : str Examples -------- 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 7816ea2fe1..82f20528c1 100644 --- a/src/ansys/dpf/core/operators/logic/solid_shell_fields.py +++ b/src/ansys/dpf/core/operators/logic/solid_shell_fields.py @@ -19,6 +19,9 @@ class solid_shell_fields(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e09da58a4d..56eeda2ae6 100644 --- a/src/ansys/dpf/core/operators/logic/split_data_sources.py +++ b/src/ansys/dpf/core/operators/logic/split_data_sources.py @@ -23,6 +23,14 @@ class split_data_sources(Operator): output_count : int Number of desired outputs. + Returns + ------- + output_count : int + Actual number of outputs. + outputs1 : DataSources + Data sources outputs. + outputs2 : DataSources + Data sources outputs. Examples -------- diff --git a/src/ansys/dpf/core/operators/logic/split_streams.py b/src/ansys/dpf/core/operators/logic/split_streams.py index 945ee9ef94..40d5c9aa71 100644 --- a/src/ansys/dpf/core/operators/logic/split_streams.py +++ b/src/ansys/dpf/core/operators/logic/split_streams.py @@ -23,6 +23,14 @@ class split_streams(Operator): output_count : int Number of desired outputs. + Returns + ------- + output_count : int + Actual number of outputs. + outputs1 : StreamsContainer + Streams outputs. + outputs2 : StreamsContainer + Streams outputs. Examples -------- diff --git a/src/ansys/dpf/core/operators/mapping/fft.py b/src/ansys/dpf/core/operators/mapping/fft.py index f1bd7115b3..d7b86cc485 100644 --- a/src/ansys/dpf/core/operators/mapping/fft.py +++ b/src/ansys/dpf/core/operators/mapping/fft.py @@ -44,6 +44,13 @@ class fft(Operator): applied, to have right amplitude values. + Returns + ------- + fields_container : FieldsContainer + Output complex fields container with labels + matching input fields container. no + supports binded, but + prepare_sampling_fft provides it. Examples -------- 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 18626238fb..25a072092c 100644 --- a/src/ansys/dpf/core/operators/mapping/find_reduced_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/find_reduced_coordinates.py @@ -33,6 +33,13 @@ class find_reduced_coordinates(Operator): quadratic (more precise but less performant). default is false. + Returns + ------- + reduced_coordinates : FieldsContainer + Coordinates in the reference elements + element_ids : ScopingsContainer + Ids of the elements where each set of reduced + coordinates is found Examples -------- diff --git a/src/ansys/dpf/core/operators/mapping/on_coordinates.py b/src/ansys/dpf/core/operators/mapping/on_coordinates.py index ee8bb397ca..f9aca9031b 100644 --- a/src/ansys/dpf/core/operators/mapping/on_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/on_coordinates.py @@ -44,6 +44,9 @@ class on_coordinates(Operator): precise but less performant). default is false. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 00a1fc4114..dd2a5040fe 100644 --- a/src/ansys/dpf/core/operators/mapping/on_reduced_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/on_reduced_coordinates.py @@ -42,6 +42,9 @@ class on_reduced_coordinates(Operator): is false. to use only when results have mid side nodes values. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d0f67e4a21..a0a54c83ce 100644 --- a/src/ansys/dpf/core/operators/mapping/prep_sampling_fft.py +++ b/src/ansys/dpf/core/operators/mapping/prep_sampling_fft.py @@ -29,6 +29,13 @@ class prep_sampling_fft(Operator): For number of sampling point (calculation with cutoff_frequency is ignored). + Returns + ------- + time_tfs_sampled : TimeFreqSupport + Optimum sampled time domain timefreqsupport. + freq_tfs_fft : TimeFreqSupport + Frequency domain timefreqsupport expected in + output of fft. Examples -------- 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 2fd8aa09d3..bc406ed850 100644 --- a/src/ansys/dpf/core/operators/mapping/prepare_mapping_workflow.py +++ b/src/ansys/dpf/core/operators/mapping/prepare_mapping_workflow.py @@ -23,6 +23,9 @@ class prepare_mapping_workflow(Operator): Radius size for the rbf filter influence_box : float, optional + Returns + ------- + mapping_workflow : Workflow Examples -------- 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 310fbe4677..6f6326f8fa 100644 --- a/src/ansys/dpf/core/operators/mapping/scoping_on_coordinates.py +++ b/src/ansys/dpf/core/operators/mapping/scoping_on_coordinates.py @@ -19,6 +19,9 @@ class scoping_on_coordinates(Operator): coordinates : Field mesh : MeshedRegion + Returns + ------- + scoping : Scoping Examples -------- 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 c0a7373c80..529298365d 100644 --- a/src/ansys/dpf/core/operators/mapping/solid_to_skin.py +++ b/src/ansys/dpf/core/operators/mapping/solid_to_skin.py @@ -31,6 +31,9 @@ class solid_to_skin(Operator): solid_mesh : MeshedRegion, optional Solid mesh support (optional). + Returns + ------- + field : Field Examples -------- 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 3ebc7e90a4..b4f80f651c 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 @@ -31,6 +31,9 @@ class solid_to_skin_fc(Operator): solid_mesh : MeshedRegion, optional Solid mesh support (optional). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 849ed79170..3f2185f5b3 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 @@ -21,6 +21,9 @@ class absolute_value_by_component(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 7d1c1bac2d..ed5dd50d4a 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 @@ -21,6 +21,9 @@ class absolute_value_by_component_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/accumulate.py b/src/ansys/dpf/core/operators/math/accumulate.py index ecf4cb26d7..996090c472 100644 --- a/src/ansys/dpf/core/operators/math/accumulate.py +++ b/src/ansys/dpf/core/operators/math/accumulate.py @@ -26,6 +26,11 @@ class accumulate(Operator): time_scoping : Scoping, optional Time_scoping + Returns + ------- + field : Field + Field containing the (weighted) sum for each + component in an elementary data Examples -------- diff --git a/src/ansys/dpf/core/operators/math/accumulate_fc.py b/src/ansys/dpf/core/operators/math/accumulate_fc.py index 51bb67a839..fd9f233534 100644 --- a/src/ansys/dpf/core/operators/math/accumulate_fc.py +++ b/src/ansys/dpf/core/operators/math/accumulate_fc.py @@ -26,6 +26,11 @@ class accumulate_fc(Operator): time_scoping : Scoping, optional Time_scoping + Returns + ------- + fields_container : FieldsContainer + Field containing the (weighted) sum for each + component in an elementary data Examples -------- 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 dae278ef56..11ad828edb 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 @@ -26,6 +26,9 @@ class accumulate_level_over_label_fc(Operator): Label of the fields container where it should operate. + Returns + ------- + field : Field Examples -------- 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 d98f67369f..1a174adc0f 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 @@ -25,6 +25,9 @@ class accumulate_min_over_label_fc(Operator): Label of the fields container where it should operate. + Returns + ------- + field : Field Examples -------- 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 f2c0b9f923..292c4958a9 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 @@ -25,6 +25,9 @@ class accumulate_over_label_fc(Operator): Label of the fields container where it should operate. + Returns + ------- + field : Field Examples -------- 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 c6073a71bc..c1eccd8f3d 100644 --- a/src/ansys/dpf/core/operators/math/accumulation_per_scoping.py +++ b/src/ansys/dpf/core/operators/math/accumulation_per_scoping.py @@ -28,6 +28,10 @@ class accumulation_per_scoping(Operator): The intersection between the of the first will be used. + Returns + ------- + accumulation_per_scoping : FieldsContainer + accumulation_per_scoping_percentage : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/add.py b/src/ansys/dpf/core/operators/math/add.py index a2290393d6..abcf5c5004 100644 --- a/src/ansys/dpf/core/operators/math/add.py +++ b/src/ansys/dpf/core/operators/math/add.py @@ -27,6 +27,9 @@ class add(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/add_constant.py b/src/ansys/dpf/core/operators/math/add_constant.py index c9f261f5b6..002ab3159a 100644 --- a/src/ansys/dpf/core/operators/math/add_constant.py +++ b/src/ansys/dpf/core/operators/math/add_constant.py @@ -22,6 +22,9 @@ class add_constant(Operator): ponderation : float Double or vector of double + Returns + ------- + field : Field Examples -------- 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 1fabd94d5d..d141f6f8f3 100644 --- a/src/ansys/dpf/core/operators/math/add_constant_fc.py +++ b/src/ansys/dpf/core/operators/math/add_constant_fc.py @@ -22,6 +22,9 @@ class add_constant_fc(Operator): ponderation : float Double or vector of double + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/add_fc.py b/src/ansys/dpf/core/operators/math/add_fc.py index f3a6b1ea47..6d0ec6b548 100644 --- a/src/ansys/dpf/core/operators/math/add_fc.py +++ b/src/ansys/dpf/core/operators/math/add_fc.py @@ -21,6 +21,9 @@ class add_fc(Operator): fields_container1 : FieldsContainer or Field or float fields_container2 : FieldsContainer or Field or float + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/amplitude.py b/src/ansys/dpf/core/operators/math/amplitude.py index 19af576dae..76064d9907 100644 --- a/src/ansys/dpf/core/operators/math/amplitude.py +++ b/src/ansys/dpf/core/operators/math/amplitude.py @@ -23,6 +23,9 @@ class amplitude(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/amplitude_fc.py b/src/ansys/dpf/core/operators/math/amplitude_fc.py index 551b3c8f14..72deb5c2a8 100644 --- a/src/ansys/dpf/core/operators/math/amplitude_fc.py +++ b/src/ansys/dpf/core/operators/math/amplitude_fc.py @@ -18,6 +18,9 @@ class amplitude_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 a33cc6240e..6105a94eec 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 @@ -25,6 +25,9 @@ class average_over_label_fc(Operator): Label of the fields container where it should operate. + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/centroid.py b/src/ansys/dpf/core/operators/math/centroid.py index b347bea0ac..8358541b6d 100644 --- a/src/ansys/dpf/core/operators/math/centroid.py +++ b/src/ansys/dpf/core/operators/math/centroid.py @@ -26,6 +26,9 @@ class centroid(Operator): factor : float Scalar + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/centroid_fc.py b/src/ansys/dpf/core/operators/math/centroid_fc.py index 9f48153985..d2e7f800a8 100644 --- a/src/ansys/dpf/core/operators/math/centroid_fc.py +++ b/src/ansys/dpf/core/operators/math/centroid_fc.py @@ -23,6 +23,9 @@ class centroid_fc(Operator): step : int, optional time_freq_support : TimeFreqSupport, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b088ff8885..26f9efc98a 100644 --- a/src/ansys/dpf/core/operators/math/component_wise_divide.py +++ b/src/ansys/dpf/core/operators/math/component_wise_divide.py @@ -27,6 +27,9 @@ class component_wise_divide(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 df66cbd446..430c041ffb 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,6 +23,9 @@ class component_wise_divide_fc(Operator): fields_containerA : FieldsContainer fields_containerB : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 153f91deb7..ca306c5cf1 100644 --- a/src/ansys/dpf/core/operators/math/component_wise_product.py +++ b/src/ansys/dpf/core/operators/math/component_wise_product.py @@ -27,6 +27,9 @@ class component_wise_product(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 35f88ae8b0..5c6f2c48e5 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 @@ -27,6 +27,9 @@ class component_wise_product_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e53d8eebc4..5af38c0139 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 @@ -57,6 +57,20 @@ class compute_residual_and_error(Operator): Field or fields container of same dimensionality as entry 1 - optional + Returns + ------- + residuals : Field or FieldsContainer + 0: normalized residuals (aka field 1 - field + 2) as a field or field container, + normalized depending on the + normalization type + error : Field or FieldsContainer + 1: error as a field or a field container + depending on the entry's type. + residuals_normalization_factor : Field or FieldsContainer + 2: factor used for residual normalization + error_normalization_factor : Field or FieldsContainer + 3: factor used for error norm normalization Examples -------- diff --git a/src/ansys/dpf/core/operators/math/conjugate.py b/src/ansys/dpf/core/operators/math/conjugate.py index a53610131c..b0c98df082 100644 --- a/src/ansys/dpf/core/operators/math/conjugate.py +++ b/src/ansys/dpf/core/operators/math/conjugate.py @@ -19,6 +19,9 @@ class conjugate(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/correlation.py b/src/ansys/dpf/core/operators/math/correlation.py index 2aa82fc412..6c64c0aaa2 100644 --- a/src/ansys/dpf/core/operators/math/correlation.py +++ b/src/ansys/dpf/core/operators/math/correlation.py @@ -31,6 +31,14 @@ class correlation(Operator): If true, correlation factor is ||amb||/(||ama||.||bmb||) + Returns + ------- + field : Field + Correlation factor for each input field b. + index : int + If several b are provided, this output + contains the index of the highest + correlation factor. Examples -------- diff --git a/src/ansys/dpf/core/operators/math/cos.py b/src/ansys/dpf/core/operators/math/cos.py index 60cd41a0b9..de9dab5cdc 100644 --- a/src/ansys/dpf/core/operators/math/cos.py +++ b/src/ansys/dpf/core/operators/math/cos.py @@ -20,6 +20,9 @@ class cos(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/cos_fc.py b/src/ansys/dpf/core/operators/math/cos_fc.py index 59fc7d2d5b..63f41e9908 100644 --- a/src/ansys/dpf/core/operators/math/cos_fc.py +++ b/src/ansys/dpf/core/operators/math/cos_fc.py @@ -20,6 +20,9 @@ class cos_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/cplx_derive.py b/src/ansys/dpf/core/operators/math/cplx_derive.py index 90fb9890eb..90f1bae2ca 100644 --- a/src/ansys/dpf/core/operators/math/cplx_derive.py +++ b/src/ansys/dpf/core/operators/math/cplx_derive.py @@ -18,6 +18,9 @@ class cplx_derive(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/cplx_divide.py b/src/ansys/dpf/core/operators/math/cplx_divide.py index 32cc2ebaa8..c23aa9084b 100644 --- a/src/ansys/dpf/core/operators/math/cplx_divide.py +++ b/src/ansys/dpf/core/operators/math/cplx_divide.py @@ -20,6 +20,9 @@ class cplx_divide(Operator): fields_containerA : FieldsContainer fields_containerB : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/cplx_dot.py b/src/ansys/dpf/core/operators/math/cplx_dot.py index d60a137895..fddafdf240 100644 --- a/src/ansys/dpf/core/operators/math/cplx_dot.py +++ b/src/ansys/dpf/core/operators/math/cplx_dot.py @@ -20,6 +20,9 @@ class cplx_dot(Operator): fields_containerA : FieldsContainer fields_containerB : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/cplx_multiply.py b/src/ansys/dpf/core/operators/math/cplx_multiply.py index 6c584c5cbb..b0a72e663f 100644 --- a/src/ansys/dpf/core/operators/math/cplx_multiply.py +++ b/src/ansys/dpf/core/operators/math/cplx_multiply.py @@ -20,6 +20,9 @@ class cplx_multiply(Operator): fields_containerA : FieldsContainer fields_containerB : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/cross_product.py b/src/ansys/dpf/core/operators/math/cross_product.py index f6e8ff19b9..7235e4136b 100644 --- a/src/ansys/dpf/core/operators/math/cross_product.py +++ b/src/ansys/dpf/core/operators/math/cross_product.py @@ -24,6 +24,9 @@ class cross_product(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 8a2a9ad67f..843c93fcde 100644 --- a/src/ansys/dpf/core/operators/math/cross_product_fc.py +++ b/src/ansys/dpf/core/operators/math/cross_product_fc.py @@ -24,6 +24,9 @@ class cross_product_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/dot.py b/src/ansys/dpf/core/operators/math/dot.py index cadb27f539..522932826f 100644 --- a/src/ansys/dpf/core/operators/math/dot.py +++ b/src/ansys/dpf/core/operators/math/dot.py @@ -27,6 +27,9 @@ class dot(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/dot_tensor.py b/src/ansys/dpf/core/operators/math/dot_tensor.py index 1548562a9f..3b5a6c329e 100644 --- a/src/ansys/dpf/core/operators/math/dot_tensor.py +++ b/src/ansys/dpf/core/operators/math/dot_tensor.py @@ -23,6 +23,9 @@ class dot_tensor(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/elemental_density.py b/src/ansys/dpf/core/operators/math/elemental_density.py index b40eb14474..f4615603f2 100644 --- a/src/ansys/dpf/core/operators/math/elemental_density.py +++ b/src/ansys/dpf/core/operators/math/elemental_density.py @@ -27,6 +27,9 @@ class elemental_density(Operator): Take custom ponderation_field from the topo file by name + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/entity_extractor.py b/src/ansys/dpf/core/operators/math/entity_extractor.py index ee8478dad9..6b1e1ae489 100644 --- a/src/ansys/dpf/core/operators/math/entity_extractor.py +++ b/src/ansys/dpf/core/operators/math/entity_extractor.py @@ -19,6 +19,9 @@ class entity_extractor(Operator): fieldA : Field scalar_int : int + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/exponential.py b/src/ansys/dpf/core/operators/math/exponential.py index 692b31d61b..db35933ea9 100644 --- a/src/ansys/dpf/core/operators/math/exponential.py +++ b/src/ansys/dpf/core/operators/math/exponential.py @@ -20,6 +20,9 @@ class exponential(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/exponential_fc.py b/src/ansys/dpf/core/operators/math/exponential_fc.py index 8470abaff2..6e8052542a 100644 --- a/src/ansys/dpf/core/operators/math/exponential_fc.py +++ b/src/ansys/dpf/core/operators/math/exponential_fc.py @@ -20,6 +20,9 @@ class exponential_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/fft_approx.py b/src/ansys/dpf/core/operators/math/fft_approx.py index 4a88aa615a..e3a76c1d5e 100644 --- a/src/ansys/dpf/core/operators/math/fft_approx.py +++ b/src/ansys/dpf/core/operators/math/fft_approx.py @@ -43,6 +43,18 @@ class fft_approx(Operator): cutoff_fr : float or int, optional Cutoff frequency. + Returns + ------- + 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. + first_der_dy : FieldsContainer + The first derivative (dy) from the fitted y. + second_der_d2y : FieldsContainer + The second derivative (d2y) from the fitted + y. Examples -------- diff --git a/src/ansys/dpf/core/operators/math/fft_eval.py b/src/ansys/dpf/core/operators/math/fft_eval.py index ee948cd4d2..8d0f2b42e3 100644 --- a/src/ansys/dpf/core/operators/math/fft_eval.py +++ b/src/ansys/dpf/core/operators/math/fft_eval.py @@ -22,6 +22,10 @@ class fft_eval(Operator): If specified only the results at these set ids are used + Returns + ------- + field : Field + offset : Field Examples -------- 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 246ef10165..c627cab659 100644 --- a/src/ansys/dpf/core/operators/math/fft_gradient_eval.py +++ b/src/ansys/dpf/core/operators/math/fft_gradient_eval.py @@ -24,6 +24,9 @@ class fft_gradient_eval(Operator): fs_ratio : int, optional Default value = 20 + Returns + ------- + coefficients : FieldsContainer Examples -------- 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 50e50f0db1..3031c3f62f 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 @@ -47,6 +47,11 @@ class fft_multi_harmonic_minmax(Operator): default the operator is evaluated using all the available steps + Returns + ------- + field_min : FieldsContainer + field_max : FieldsContainer + all_fields : FieldsContainer Examples -------- 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 cd689278a1..baf4d959f9 100644 --- a/src/ansys/dpf/core/operators/math/generalized_inner_product.py +++ b/src/ansys/dpf/core/operators/math/generalized_inner_product.py @@ -24,6 +24,9 @@ class generalized_inner_product(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 555fb4b6da..bdc1b80eac 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 @@ -24,6 +24,9 @@ class generalized_inner_product_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/img_part.py b/src/ansys/dpf/core/operators/math/img_part.py index 3a047375cf..a0f5172bcf 100644 --- a/src/ansys/dpf/core/operators/math/img_part.py +++ b/src/ansys/dpf/core/operators/math/img_part.py @@ -19,6 +19,9 @@ class img_part(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/invert.py b/src/ansys/dpf/core/operators/math/invert.py index f975c6dffb..5490dbfae6 100644 --- a/src/ansys/dpf/core/operators/math/invert.py +++ b/src/ansys/dpf/core/operators/math/invert.py @@ -21,6 +21,9 @@ class invert(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/invert_fc.py b/src/ansys/dpf/core/operators/math/invert_fc.py index 0a59da1453..e72ab372d4 100644 --- a/src/ansys/dpf/core/operators/math/invert_fc.py +++ b/src/ansys/dpf/core/operators/math/invert_fc.py @@ -21,6 +21,9 @@ class invert_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/kronecker_prod.py b/src/ansys/dpf/core/operators/math/kronecker_prod.py index a6c18af0e0..1e1b47cae5 100644 --- a/src/ansys/dpf/core/operators/math/kronecker_prod.py +++ b/src/ansys/dpf/core/operators/math/kronecker_prod.py @@ -23,6 +23,9 @@ class kronecker_prod(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/linear_combination.py b/src/ansys/dpf/core/operators/math/linear_combination.py index 0a0d3d3665..a52d33ec8a 100644 --- a/src/ansys/dpf/core/operators/math/linear_combination.py +++ b/src/ansys/dpf/core/operators/math/linear_combination.py @@ -25,6 +25,9 @@ class linear_combination(Operator): Double fields_containerC : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/ln.py b/src/ansys/dpf/core/operators/math/ln.py index ca92096807..bed647070d 100644 --- a/src/ansys/dpf/core/operators/math/ln.py +++ b/src/ansys/dpf/core/operators/math/ln.py @@ -20,6 +20,9 @@ class ln(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/ln_fc.py b/src/ansys/dpf/core/operators/math/ln_fc.py index f89f746e75..f84b43022f 100644 --- a/src/ansys/dpf/core/operators/math/ln_fc.py +++ b/src/ansys/dpf/core/operators/math/ln_fc.py @@ -20,6 +20,9 @@ class ln_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/mac.py b/src/ansys/dpf/core/operators/math/mac.py index e08a850616..dd7bd3b0b6 100644 --- a/src/ansys/dpf/core/operators/math/mac.py +++ b/src/ansys/dpf/core/operators/math/mac.py @@ -27,6 +27,13 @@ class mac(Operator): Field m, optional weighting for mac matrix computation. + Returns + ------- + field : Field + Mac matrix for all the combinations between + mode fields of field container a and + field container b. results listed row + by row. Examples -------- 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 a5fc9452eb..39435e90bc 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,6 +20,9 @@ class make_one_on_comp(Operator): fieldA : Field scalar_int : int + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/matrix_inverse.py b/src/ansys/dpf/core/operators/math/matrix_inverse.py index 41892c05e8..298e76558e 100644 --- a/src/ansys/dpf/core/operators/math/matrix_inverse.py +++ b/src/ansys/dpf/core/operators/math/matrix_inverse.py @@ -20,6 +20,9 @@ class matrix_inverse(Operator): fields_container : FieldsContainer Fields_container + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 571ae7a049..f1cd3f2f61 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 @@ -20,6 +20,9 @@ class min_max_over_time(Operator): int32 : int Define min or max. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/minus.py b/src/ansys/dpf/core/operators/math/minus.py index 8677342ca0..d86cc4e41c 100644 --- a/src/ansys/dpf/core/operators/math/minus.py +++ b/src/ansys/dpf/core/operators/math/minus.py @@ -26,6 +26,9 @@ class minus(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/minus_fc.py b/src/ansys/dpf/core/operators/math/minus_fc.py index 65c5a05b4d..1de473ba31 100644 --- a/src/ansys/dpf/core/operators/math/minus_fc.py +++ b/src/ansys/dpf/core/operators/math/minus_fc.py @@ -26,6 +26,9 @@ class minus_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bf47906a53..c5d640653b 100644 --- a/src/ansys/dpf/core/operators/math/modal_damping_ratio.py +++ b/src/ansys/dpf/core/operators/math/modal_damping_ratio.py @@ -28,6 +28,10 @@ class modal_damping_ratio(Operator): k_coefficient : float Global stiffness matrix multiplier + Returns + ------- + field : Field + Field of modal damping ratio. Examples -------- diff --git a/src/ansys/dpf/core/operators/math/modal_participation.py b/src/ansys/dpf/core/operators/math/modal_participation.py index 11c60da646..5ab608582d 100644 --- a/src/ansys/dpf/core/operators/math/modal_participation.py +++ b/src/ansys/dpf/core/operators/math/modal_participation.py @@ -27,6 +27,9 @@ class modal_participation(Operator): If set, will force a label space for output result. + Returns + ------- + output : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/modal_superposition.py b/src/ansys/dpf/core/operators/math/modal_superposition.py index e1a4d2cafa..15f2be29c7 100644 --- a/src/ansys/dpf/core/operators/math/modal_superposition.py +++ b/src/ansys/dpf/core/operators/math/modal_superposition.py @@ -37,6 +37,9 @@ class modal_superposition(Operator): domain defined in the modal_basis fields container. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/modulus.py b/src/ansys/dpf/core/operators/math/modulus.py index 0e078b2b22..6bc0e9b8bb 100644 --- a/src/ansys/dpf/core/operators/math/modulus.py +++ b/src/ansys/dpf/core/operators/math/modulus.py @@ -19,6 +19,9 @@ class modulus(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/nodal_density.py b/src/ansys/dpf/core/operators/math/nodal_density.py index 9f6db4f72e..9f1e5dfe1f 100644 --- a/src/ansys/dpf/core/operators/math/nodal_density.py +++ b/src/ansys/dpf/core/operators/math/nodal_density.py @@ -27,6 +27,9 @@ class nodal_density(Operator): Take custom ponderation_field from the topo file by name + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/norm.py b/src/ansys/dpf/core/operators/math/norm.py index 9e2f3f650a..07ef85e12e 100644 --- a/src/ansys/dpf/core/operators/math/norm.py +++ b/src/ansys/dpf/core/operators/math/norm.py @@ -24,6 +24,9 @@ class norm(Operator): Lp normalisation type, p = 1, 2, ...n - default lp=l2 + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/norm_fc.py b/src/ansys/dpf/core/operators/math/norm_fc.py index f86eeb6fed..47fe7be7e7 100644 --- a/src/ansys/dpf/core/operators/math/norm_fc.py +++ b/src/ansys/dpf/core/operators/math/norm_fc.py @@ -22,6 +22,9 @@ class norm_fc(Operator): Lp normalisation type, p = 1, 2, ...n - default lp=2 + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/outer_product.py b/src/ansys/dpf/core/operators/math/outer_product.py index 236eaa819c..51ee24aa8b 100644 --- a/src/ansys/dpf/core/operators/math/outer_product.py +++ b/src/ansys/dpf/core/operators/math/outer_product.py @@ -23,6 +23,9 @@ class outer_product(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/overall_dot.py b/src/ansys/dpf/core/operators/math/overall_dot.py index fd31d0de22..9b2d2217b4 100644 --- a/src/ansys/dpf/core/operators/math/overall_dot.py +++ b/src/ansys/dpf/core/operators/math/overall_dot.py @@ -20,6 +20,11 @@ class overall_dot(Operator): fieldA : Field fieldB : Field + Returns + ------- + field : Field + Field defined on over-all location, contains + a unique scalar value Examples -------- diff --git a/src/ansys/dpf/core/operators/math/phase.py b/src/ansys/dpf/core/operators/math/phase.py index 8db02c402d..7720af1ee5 100644 --- a/src/ansys/dpf/core/operators/math/phase.py +++ b/src/ansys/dpf/core/operators/math/phase.py @@ -23,6 +23,9 @@ class phase(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/phase_fc.py b/src/ansys/dpf/core/operators/math/phase_fc.py index 2b47ede569..846a5217d3 100644 --- a/src/ansys/dpf/core/operators/math/phase_fc.py +++ b/src/ansys/dpf/core/operators/math/phase_fc.py @@ -18,6 +18,9 @@ class phase_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 6ec2d697d9..790bb11729 100644 --- a/src/ansys/dpf/core/operators/math/polar_to_cplx.py +++ b/src/ansys/dpf/core/operators/math/polar_to_cplx.py @@ -18,6 +18,9 @@ class polar_to_cplx(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/pow.py b/src/ansys/dpf/core/operators/math/pow.py index ab3b9f1030..cb2175b93b 100644 --- a/src/ansys/dpf/core/operators/math/pow.py +++ b/src/ansys/dpf/core/operators/math/pow.py @@ -19,6 +19,9 @@ class pow(Operator): field : Field factor : float + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/pow_fc.py b/src/ansys/dpf/core/operators/math/pow_fc.py index 8b83bd74aa..333bc20f66 100644 --- a/src/ansys/dpf/core/operators/math/pow_fc.py +++ b/src/ansys/dpf/core/operators/math/pow_fc.py @@ -19,6 +19,9 @@ class pow_fc(Operator): fields_container : FieldsContainer factor : float + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/qr_solve.py b/src/ansys/dpf/core/operators/math/qr_solve.py index 1aaf396276..9dba52a771 100644 --- a/src/ansys/dpf/core/operators/math/qr_solve.py +++ b/src/ansys/dpf/core/operators/math/qr_solve.py @@ -21,6 +21,9 @@ class qr_solve(Operator): rhs : FieldsContainer Fields_container + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/real_part.py b/src/ansys/dpf/core/operators/math/real_part.py index 878a0e538d..0d0df52d0b 100644 --- a/src/ansys/dpf/core/operators/math/real_part.py +++ b/src/ansys/dpf/core/operators/math/real_part.py @@ -19,6 +19,9 @@ class real_part(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/relative_error.py b/src/ansys/dpf/core/operators/math/relative_error.py index 793e151c41..1d79cd2318 100644 --- a/src/ansys/dpf/core/operators/math/relative_error.py +++ b/src/ansys/dpf/core/operators/math/relative_error.py @@ -24,6 +24,15 @@ class relative_error(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field + zero_ref_scoping : Scoping + Ids of entities where reference value is + zero. + no_ref_scoping : Scoping + Ids of entities where there are no reference + value. Examples -------- diff --git a/src/ansys/dpf/core/operators/math/scale.py b/src/ansys/dpf/core/operators/math/scale.py index 248b2c6dc0..2537dbbb07 100644 --- a/src/ansys/dpf/core/operators/math/scale.py +++ b/src/ansys/dpf/core/operators/math/scale.py @@ -34,6 +34,9 @@ class scale(Operator): algorithm : int, optional Default is 0 use mkl. if set to 1, don't + Returns + ------- + field : Field Examples -------- 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 37cadee86c..1f80c40eb3 100644 --- a/src/ansys/dpf/core/operators/math/scale_by_field.py +++ b/src/ansys/dpf/core/operators/math/scale_by_field.py @@ -25,6 +25,9 @@ class scale_by_field(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 7cc6a1a9a1..a3618b4032 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 @@ -25,6 +25,9 @@ class scale_by_field_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/scale_fc.py b/src/ansys/dpf/core/operators/math/scale_fc.py index 5ef9542ada..9094d8d673 100644 --- a/src/ansys/dpf/core/operators/math/scale_fc.py +++ b/src/ansys/dpf/core/operators/math/scale_fc.py @@ -34,6 +34,9 @@ class scale_fc(Operator): algorithm : int, optional Default is 0 use mkl. if set to 1, don't + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/sin.py b/src/ansys/dpf/core/operators/math/sin.py index f99811b8b5..5519381202 100644 --- a/src/ansys/dpf/core/operators/math/sin.py +++ b/src/ansys/dpf/core/operators/math/sin.py @@ -18,6 +18,9 @@ class sin(Operator): ---------- field : Field + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/sin_fc.py b/src/ansys/dpf/core/operators/math/sin_fc.py index c4cf0d7196..16bfabee6e 100644 --- a/src/ansys/dpf/core/operators/math/sin_fc.py +++ b/src/ansys/dpf/core/operators/math/sin_fc.py @@ -18,6 +18,9 @@ class sin_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/sqr.py b/src/ansys/dpf/core/operators/math/sqr.py index 10f55ca48b..867c29310d 100644 --- a/src/ansys/dpf/core/operators/math/sqr.py +++ b/src/ansys/dpf/core/operators/math/sqr.py @@ -20,6 +20,9 @@ class sqr(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/sqr_fc.py b/src/ansys/dpf/core/operators/math/sqr_fc.py index c54bc807f7..e202bf43a9 100644 --- a/src/ansys/dpf/core/operators/math/sqr_fc.py +++ b/src/ansys/dpf/core/operators/math/sqr_fc.py @@ -20,6 +20,9 @@ class sqr_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/sqrt.py b/src/ansys/dpf/core/operators/math/sqrt.py index 6059609a50..8b9c1fd984 100644 --- a/src/ansys/dpf/core/operators/math/sqrt.py +++ b/src/ansys/dpf/core/operators/math/sqrt.py @@ -20,6 +20,9 @@ class sqrt(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/sqrt_fc.py b/src/ansys/dpf/core/operators/math/sqrt_fc.py index 027a0b943b..c316eea14d 100644 --- a/src/ansys/dpf/core/operators/math/sqrt_fc.py +++ b/src/ansys/dpf/core/operators/math/sqrt_fc.py @@ -20,6 +20,9 @@ class sqrt_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/svd.py b/src/ansys/dpf/core/operators/math/svd.py index b671218678..86b3d90eec 100644 --- a/src/ansys/dpf/core/operators/math/svd.py +++ b/src/ansys/dpf/core/operators/math/svd.py @@ -20,6 +20,15 @@ class svd(Operator): fields_container : FieldsContainer Fields_container + Returns + ------- + s_svd : FieldsContainer + Singular values of the input data, where + a=u.s.vt + u_svd : FieldsContainer + U of the input data, where a=u.s.vt + vt_svd : FieldsContainer + Vt of the input data, where a=u.s.vt Examples -------- diff --git a/src/ansys/dpf/core/operators/math/sweeping_phase.py b/src/ansys/dpf/core/operators/math/sweeping_phase.py index 22a5e036a9..67842b79ab 100644 --- a/src/ansys/dpf/core/operators/math/sweeping_phase.py +++ b/src/ansys/dpf/core/operators/math/sweeping_phase.py @@ -34,6 +34,9 @@ class sweeping_phase(Operator): is supposed to be 0 (default is false). + Returns + ------- + field : Field Examples -------- 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 0062ab10a4..6d321366d7 100644 --- a/src/ansys/dpf/core/operators/math/sweeping_phase_fc.py +++ b/src/ansys/dpf/core/operators/math/sweeping_phase_fc.py @@ -24,6 +24,9 @@ class sweeping_phase_fc(Operator): "rad". default: "rad". abs_value : bool + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/time_derivation.py b/src/ansys/dpf/core/operators/math/time_derivation.py index 76ee51754c..cfc7d5171d 100644 --- a/src/ansys/dpf/core/operators/math/time_derivation.py +++ b/src/ansys/dpf/core/operators/math/time_derivation.py @@ -22,6 +22,9 @@ class time_derivation(Operator): Uses spline fitting on the input field to compute smooth derivatives + Returns + ------- + field : Field Examples -------- 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 8ee44c88d6..9a9f08102b 100644 --- a/src/ansys/dpf/core/operators/math/time_freq_interpolation.py +++ b/src/ansys/dpf/core/operators/math/time_freq_interpolation.py @@ -43,6 +43,9 @@ class time_freq_interpolation(Operator): existing ones. time_freq_support : TimeFreqSupport, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/time_integration.py b/src/ansys/dpf/core/operators/math/time_integration.py index e90fff31cb..bf447ab45e 100644 --- a/src/ansys/dpf/core/operators/math/time_integration.py +++ b/src/ansys/dpf/core/operators/math/time_integration.py @@ -27,6 +27,9 @@ class time_integration(Operator): integration_constant : float, optional Constant to be added to the integrated field + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/math/unit_convert.py b/src/ansys/dpf/core/operators/math/unit_convert.py index 82fcf8caa6..a2ecac9965 100644 --- a/src/ansys/dpf/core/operators/math/unit_convert.py +++ b/src/ansys/dpf/core/operators/math/unit_convert.py @@ -25,6 +25,11 @@ class unit_convert(Operator): or a field from which expected unit will be extracted. + Returns + ------- + converted_entity : Field or FieldsContainer or MeshedRegion or MeshesContainer + The output entity is the same as the input + (inplace operator) Examples -------- 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 099fd68f5e..4678ae5ded 100644 --- a/src/ansys/dpf/core/operators/math/unit_convert_fc.py +++ b/src/ansys/dpf/core/operators/math/unit_convert_fc.py @@ -21,6 +21,9 @@ class unit_convert_fc(Operator): Unit as a string, ex 'm' for meter, 'pa' for pascal,... + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/window_bartlett.py b/src/ansys/dpf/core/operators/math/window_bartlett.py index 3086bbbd5b..e13c7671d4 100644 --- a/src/ansys/dpf/core/operators/math/window_bartlett.py +++ b/src/ansys/dpf/core/operators/math/window_bartlett.py @@ -21,6 +21,9 @@ class window_bartlett(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 d60ea9209a..a188a6222e 100644 --- a/src/ansys/dpf/core/operators/math/window_bartlett_fc.py +++ b/src/ansys/dpf/core/operators/math/window_bartlett_fc.py @@ -20,6 +20,9 @@ class window_bartlett_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/window_blackman.py b/src/ansys/dpf/core/operators/math/window_blackman.py index 39234a3650..547a2b7dca 100644 --- a/src/ansys/dpf/core/operators/math/window_blackman.py +++ b/src/ansys/dpf/core/operators/math/window_blackman.py @@ -21,6 +21,9 @@ class window_blackman(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 ed35d61200..a198a0f7cf 100644 --- a/src/ansys/dpf/core/operators/math/window_blackman_fc.py +++ b/src/ansys/dpf/core/operators/math/window_blackman_fc.py @@ -20,6 +20,9 @@ class window_blackman_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/window_hamming.py b/src/ansys/dpf/core/operators/math/window_hamming.py index 75c9cb0100..7c20ca44ee 100644 --- a/src/ansys/dpf/core/operators/math/window_hamming.py +++ b/src/ansys/dpf/core/operators/math/window_hamming.py @@ -21,6 +21,9 @@ class window_hamming(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 880c22a90d..07e6a65ff0 100644 --- a/src/ansys/dpf/core/operators/math/window_hamming_fc.py +++ b/src/ansys/dpf/core/operators/math/window_hamming_fc.py @@ -20,6 +20,9 @@ class window_hamming_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/window_hanning.py b/src/ansys/dpf/core/operators/math/window_hanning.py index 43e31c55f3..01cddce444 100644 --- a/src/ansys/dpf/core/operators/math/window_hanning.py +++ b/src/ansys/dpf/core/operators/math/window_hanning.py @@ -21,6 +21,9 @@ class window_hanning(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 422e7e1381..2c41148ee6 100644 --- a/src/ansys/dpf/core/operators/math/window_hanning_fc.py +++ b/src/ansys/dpf/core/operators/math/window_hanning_fc.py @@ -20,6 +20,9 @@ class window_hanning_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/window_triangular.py b/src/ansys/dpf/core/operators/math/window_triangular.py index 05e86f2861..e8a6d86ca0 100644 --- a/src/ansys/dpf/core/operators/math/window_triangular.py +++ b/src/ansys/dpf/core/operators/math/window_triangular.py @@ -21,6 +21,9 @@ class window_triangular(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 58c21b8831..e6dfeb7474 100644 --- a/src/ansys/dpf/core/operators/math/window_triangular_fc.py +++ b/src/ansys/dpf/core/operators/math/window_triangular_fc.py @@ -20,6 +20,9 @@ class window_triangular_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/math/window_welch.py b/src/ansys/dpf/core/operators/math/window_welch.py index ae18d784f5..4a526aa7e5 100644 --- a/src/ansys/dpf/core/operators/math/window_welch.py +++ b/src/ansys/dpf/core/operators/math/window_welch.py @@ -21,6 +21,9 @@ class window_welch(Operator): ---------- field : Field or FieldsContainer + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 db0773ce08..6db242cde2 100644 --- a/src/ansys/dpf/core/operators/math/window_welch_fc.py +++ b/src/ansys/dpf/core/operators/math/window_welch_fc.py @@ -20,6 +20,9 @@ class window_welch_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 52e867c91d..9e613c01ca 100644 --- a/src/ansys/dpf/core/operators/mesh/acmo_mesh_provider.py +++ b/src/ansys/dpf/core/operators/mesh/acmo_mesh_provider.py @@ -19,6 +19,9 @@ class acmo_mesh_provider(Operator): assembly_mesh : AnsDispatchHolder or Struct Iansdispatch unit : str, optional + Returns + ------- + meshes_container : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/beam_properties.py b/src/ansys/dpf/core/operators/mesh/beam_properties.py index cf3967a699..d63b2178dd 100644 --- a/src/ansys/dpf/core/operators/mesh/beam_properties.py +++ b/src/ansys/dpf/core/operators/mesh/beam_properties.py @@ -24,6 +24,52 @@ class beam_properties(Operator): Result file path container, used if no streams are set. + Returns + ------- + 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. + field_type_section_id : Field + This field contains the section id of beams. + 1:rec; 3:csolid, 4:ctube, 5:chan, + 6:z, 7:l, 8:i, 9:t, 11:hats, 12:hrec. + field_area : Field + This field contains the area of beams. + field_moment_inertia : Field + This field contains the inertia moment of + beams. iyy, iyz, izz. + field_geometry : Field + This field contains the geometry of beams. + rec:b,h. csolid:ri. ctube:ri, re. + chan:w1,w2,w3,t1,t2,t3. + z:w1,w2,w3,t1,t2,t3. l:w1,w2,t1,t2. + i:w1,w2,w3,t1,t2,t3. t:w1,w2,t1,t2. + hats: w1,w2,w3,w4,t1,t2,t3,t4. + hrec:w1,w2,t1,t2,t3,t4. + field_young_modulus : Field + This field contains the young's modulus of + beams. + field_poisson_ratio : Field + This field contains the poisson's ratio of + beams. + field_shear_modulus : Field + This field contains the shear modulus of + beams. + field_beam_length : Field + This field contains the length of beams. + field_torsion_constant : Field + This field contains the torsion constant of + beams. + field_warping_constant : Field + This field contains the warping constant of + beams. + field_offset_type : Field + This field contains offset type of beams. + field_offset_y : Field + This field contains offset y of beams. + field_offset_z : Field + This field contains offset z of beams. Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/change_cs.py b/src/ansys/dpf/core/operators/mesh/change_cs.py index 32349b7e5d..d1e618cc76 100644 --- a/src/ansys/dpf/core/operators/mesh/change_cs.py +++ b/src/ansys/dpf/core/operators/mesh/change_cs.py @@ -23,6 +23,9 @@ class change_cs(Operator): 3-3 rotation matrix + 3 translations (x, y, z) + Returns + ------- + meshed_region : MeshedRegion or MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/combine_levelset.py b/src/ansys/dpf/core/operators/mesh/combine_levelset.py index 2f518e8f6b..b82e418bf4 100644 --- a/src/ansys/dpf/core/operators/mesh/combine_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/combine_levelset.py @@ -19,6 +19,9 @@ class combine_levelset(Operator): fieldA : Field fieldB : Field + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/decimate_mesh.py b/src/ansys/dpf/core/operators/mesh/decimate_mesh.py index 6b1bb6689f..a7b60bb52c 100644 --- a/src/ansys/dpf/core/operators/mesh/decimate_mesh.py +++ b/src/ansys/dpf/core/operators/mesh/decimate_mesh.py @@ -30,6 +30,10 @@ class decimate_mesh(Operator): time. value range is 0 to 150, default is 0. + Returns + ------- + mesh : MeshedRegion + Decimated mesh with triangle elements Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/exclude_levelset.py b/src/ansys/dpf/core/operators/mesh/exclude_levelset.py index 0d3f771c2f..aa79496fd9 100644 --- a/src/ansys/dpf/core/operators/mesh/exclude_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/exclude_levelset.py @@ -19,6 +19,9 @@ class exclude_levelset(Operator): fieldA : Field fieldB : Field + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/external_layer.py b/src/ansys/dpf/core/operators/mesh/external_layer.py index a9e0103d98..f200fcbf09 100644 --- a/src/ansys/dpf/core/operators/mesh/external_layer.py +++ b/src/ansys/dpf/core/operators/mesh/external_layer.py @@ -19,6 +19,11 @@ class external_layer(Operator): ---------- mesh : MeshedRegion + Returns + ------- + mesh : MeshedRegion + nodes_mesh_scoping : Scoping + elements_mesh_scoping : Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/from_field.py b/src/ansys/dpf/core/operators/mesh/from_field.py index a07a09d820..6bc3d01066 100644 --- a/src/ansys/dpf/core/operators/mesh/from_field.py +++ b/src/ansys/dpf/core/operators/mesh/from_field.py @@ -18,6 +18,9 @@ class from_field(Operator): ---------- field : Field + Returns + ------- + mesh : MeshedRegion Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/from_scoping.py b/src/ansys/dpf/core/operators/mesh/from_scoping.py index d1b546f810..4e95ccef30 100644 --- a/src/ansys/dpf/core/operators/mesh/from_scoping.py +++ b/src/ansys/dpf/core/operators/mesh/from_scoping.py @@ -39,6 +39,9 @@ class from_scoping(Operator): is false. mesh : MeshedRegion + Returns + ------- + mesh : MeshedRegion Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/from_scopings.py b/src/ansys/dpf/core/operators/mesh/from_scopings.py index 2dc08401b9..c5341590ee 100644 --- a/src/ansys/dpf/core/operators/mesh/from_scopings.py +++ b/src/ansys/dpf/core/operators/mesh/from_scopings.py @@ -33,6 +33,9 @@ class from_scopings(Operator): elements). default is false. mesh : MeshedRegion + Returns + ------- + meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/iso_surfaces.py b/src/ansys/dpf/core/operators/mesh/iso_surfaces.py index d667eb0087..53d9c477dc 100644 --- a/src/ansys/dpf/core/operators/mesh/iso_surfaces.py +++ b/src/ansys/dpf/core/operators/mesh/iso_surfaces.py @@ -46,6 +46,10 @@ class iso_surfaces(Operator): are linearly compute between the min and the max of the field of results. + Returns + ------- + meshes : MeshesContainer + fields_container : FieldsContainer Examples -------- 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 0c9410f88d..b111759b68 100644 --- a/src/ansys/dpf/core/operators/mesh/make_plane_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/make_plane_levelset.py @@ -24,6 +24,9 @@ class make_plane_levelset(Operator): An overall 3d vector that gives a point of the plane. + Returns + ------- + field : Field Examples -------- 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 366eef38a8..fd9317877c 100644 --- a/src/ansys/dpf/core/operators/mesh/make_sphere_levelset.py +++ b/src/ansys/dpf/core/operators/mesh/make_sphere_levelset.py @@ -23,6 +23,9 @@ class make_sphere_levelset(Operator): radius : float Sphere radius. + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/mesh_clip.py b/src/ansys/dpf/core/operators/mesh/mesh_clip.py index e8c09d4108..6a6b148491 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_clip.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_clip.py @@ -29,6 +29,10 @@ class mesh_clip(Operator): slicing will ignore shell and skin elements. the default is true. + Returns + ------- + field : Field + mesh : MeshedRegion Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/mesh_cut.py b/src/ansys/dpf/core/operators/mesh/mesh_cut.py index b354445396..8c5d982ffa 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_cut.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_cut.py @@ -35,6 +35,9 @@ class mesh_cut(Operator): slicing will ignore shell and skin elements. the default is true. + Returns + ------- + mesh : MeshedRegion Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/mesh_extraction.py b/src/ansys/dpf/core/operators/mesh/mesh_extraction.py index 209938822d..092f4a5147 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_extraction.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_extraction.py @@ -22,6 +22,9 @@ class mesh_extraction(Operator): extension : int, optional Number of extension layer + Returns + ------- + abstract_meshed_region : MeshedRegion Examples -------- 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 51130ed313..e370f3c369 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_get_attribute.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_get_attribute.py @@ -37,6 +37,23 @@ class mesh_get_attribute(Operator): number or by name, example: a named selection's name. + Returns + ------- + 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", + ace_scoping", a string field for + properties: "named_selection_names", + "named_selection_locations" and an + int for property: + "num_named_selections". Examples -------- 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 39d73d4a5a..12865959d5 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_plan_clip.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_plan_clip.py @@ -24,6 +24,10 @@ class mesh_plan_clip(Operator): An overall 3d vector that gives a point of the plane. + Returns + ------- + field : Field + mesh : MeshedRegion Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/mesh_provider.py b/src/ansys/dpf/core/operators/mesh/mesh_provider.py index 42a6bd319f..5f368f0021 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_provider.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_provider.py @@ -56,6 +56,9 @@ class mesh_provider(Operator): option set to 0 will return all possible properties + Returns + ------- + mesh : MeshedRegion Examples -------- 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 4c398a72f1..a586804403 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_to_graphics.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_to_graphics.py @@ -23,6 +23,13 @@ class mesh_to_graphics(Operator): node normals) mesh : MeshedRegion + Returns + ------- + nodes : Field + Node coordinates + normals : Field + Node normals + connectivity : PropertyField Examples -------- 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 245f2d1a08..1deb1fbd80 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 @@ -20,6 +20,11 @@ class mesh_to_graphics_edges(Operator): include_mid_nodes : bool, optional mesh : MeshedRegion + Returns + ------- + nodes : Field + Node coordinates + connectivity : PropertyField Examples -------- 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 8021845de8..1d984bcdea 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_to_pyvista.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_to_pyvista.py @@ -33,6 +33,16 @@ class mesh_to_pyvista(Operator): Export elements as polyhedrons (cell-face- node representation). default false. + Returns + ------- + nodes : Field + Node coordinates double vector + cells : + Cell connectivity int vector + cell_types : + Cell types property int vector + offsets : optional + If vtk_updated=false, offsets int vector Examples -------- 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 2c711f3bf5..811319e485 100644 --- a/src/ansys/dpf/core/operators/mesh/mesh_to_tetra.py +++ b/src/ansys/dpf/core/operators/mesh/mesh_to_tetra.py @@ -23,6 +23,14 @@ class mesh_to_tetra(Operator): mesh : MeshedRegion Mesh with arbitrary element types. + Returns + ------- + mesh : MeshedRegion + Tetrahedralized mesh. + node_mapping : Scoping + Node mapping. + element_mapping : Scoping + Element mapping. Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/meshes_provider.py b/src/ansys/dpf/core/operators/mesh/meshes_provider.py index 7763366b9c..2f8500e92d 100644 --- a/src/ansys/dpf/core/operators/mesh/meshes_provider.py +++ b/src/ansys/dpf/core/operators/mesh/meshes_provider.py @@ -36,6 +36,9 @@ class meshes_provider(Operator): zone for fluid results or part for lsdyna results). + Returns + ------- + meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/node_coordinates.py b/src/ansys/dpf/core/operators/mesh/node_coordinates.py index 4781951b21..0865f69bbf 100644 --- a/src/ansys/dpf/core/operators/mesh/node_coordinates.py +++ b/src/ansys/dpf/core/operators/mesh/node_coordinates.py @@ -19,6 +19,14 @@ class node_coordinates(Operator): ---------- mesh : MeshedRegion or MeshesContainer + Returns + ------- + 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 Examples -------- 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 bde8e1c38e..250e4e1567 100644 --- a/src/ansys/dpf/core/operators/mesh/points_from_coordinates.py +++ b/src/ansys/dpf/core/operators/mesh/points_from_coordinates.py @@ -20,6 +20,9 @@ class points_from_coordinates(Operator): nodes_to_keep : Scoping or ScopingsContainer mesh : MeshedRegion or MeshesContainer + Returns + ------- + abstract_meshed_region : MeshedRegion Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/skin.py b/src/ansys/dpf/core/operators/mesh/skin.py index 28e7cc1b3c..d09c7c0c59 100644 --- a/src/ansys/dpf/core/operators/mesh/skin.py +++ b/src/ansys/dpf/core/operators/mesh/skin.py @@ -30,6 +30,28 @@ class skin(Operator): duplicated, one per each orientation, or (boolean = 0) remain unchanged. + Returns + ------- + mesh : MeshedRegion + Skin meshed region with facets and + facets_to_ele property fields. + nodes_mesh_scoping : Scoping + map_new_elements_to_old : + property_field_new_elements_to_old : PropertyField + This property field provides, for each new + face element id (in the scoping), the + corresponding 3d volume element index + (in the data) it has been extracted + from. the 3d volume element id can be + found with the element scoping of the + input mesh. + facet_indices : PropertyField + This property field gives, for each new face + element id (in the scoping), the + corresponding face index on the + source 3d volume element. the 3d + volume element can be extracted from + the previous output. Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/split_fields.py b/src/ansys/dpf/core/operators/mesh/split_fields.py index 2e2e2accdf..1caf55cee6 100644 --- a/src/ansys/dpf/core/operators/mesh/split_fields.py +++ b/src/ansys/dpf/core/operators/mesh/split_fields.py @@ -22,6 +22,9 @@ class split_fields(Operator): Body meshes in the mesh controller cannot be mixed shell/solid + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/split_mesh.py b/src/ansys/dpf/core/operators/mesh/split_mesh.py index 7c5e435575..8f0edfc400 100644 --- a/src/ansys/dpf/core/operators/mesh/split_mesh.py +++ b/src/ansys/dpf/core/operators/mesh/split_mesh.py @@ -22,6 +22,9 @@ class split_mesh(Operator): mesh : MeshedRegion property : str + Returns + ------- + meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/stl_export.py b/src/ansys/dpf/core/operators/mesh/stl_export.py index 82b2dbd3fc..03d2e82526 100644 --- a/src/ansys/dpf/core/operators/mesh/stl_export.py +++ b/src/ansys/dpf/core/operators/mesh/stl_export.py @@ -19,6 +19,9 @@ class stl_export(Operator): mesh : MeshedRegion file_path : str + Returns + ------- + data_sources : DataSources Examples -------- 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 129acb7679..7fedc31abf 100644 --- a/src/ansys/dpf/core/operators/mesh/tri_mesh_skin.py +++ b/src/ansys/dpf/core/operators/mesh/tri_mesh_skin.py @@ -29,6 +29,10 @@ class tri_mesh_skin(Operator): mesh if all its nodes are in the scoping. + Returns + ------- + mesh : MeshedRegion + nodes_mesh_scoping : Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/mesh/wireframe.py b/src/ansys/dpf/core/operators/mesh/wireframe.py index e52c708f98..442fee4d26 100644 --- a/src/ansys/dpf/core/operators/mesh/wireframe.py +++ b/src/ansys/dpf/core/operators/mesh/wireframe.py @@ -22,6 +22,9 @@ class wireframe(Operator): Angle threshold in radian that will trigger an edge detection. + Returns + ------- + wireframe : MeshedRegion Examples -------- 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 717b132b4e..3a4c67193f 100644 --- a/src/ansys/dpf/core/operators/metadata/boundary_condition_provider.py +++ b/src/ansys/dpf/core/operators/metadata/boundary_condition_provider.py @@ -21,6 +21,10 @@ class boundary_condition_provider(Operator): streams_container : StreamsContainer, optional data_sources : DataSources + Returns + ------- + results_info : Field or FieldsContainer + Results info Examples -------- 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 67a1b26a1b..64bb5620be 100644 --- a/src/ansys/dpf/core/operators/metadata/cyclic_mesh_expansion.py +++ b/src/ansys/dpf/core/operators/metadata/cyclic_mesh_expansion.py @@ -23,6 +23,14 @@ class cyclic_mesh_expansion(Operator): multistage: use scopings container with 'stage' label. + Returns + ------- + meshed_region : MeshedRegion + Expanded meshed region. + cyclic_support : CyclicSupport + Input cyclic support modified in place + containing the new expanded meshed + regions. Examples -------- 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 bf4ddd1987..8ad5f113a5 100644 --- a/src/ansys/dpf/core/operators/metadata/cyclic_support_provider.py +++ b/src/ansys/dpf/core/operators/metadata/cyclic_support_provider.py @@ -31,6 +31,10 @@ class cyclic_support_provider(Operator): multistage: use scopings container with 'stage' label. + Returns + ------- + cyclic_support : CyclicSupport + sector_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/metadata/datasources_provider.py b/src/ansys/dpf/core/operators/metadata/datasources_provider.py index d8d6761a7f..cd31022768 100644 --- a/src/ansys/dpf/core/operators/metadata/datasources_provider.py +++ b/src/ansys/dpf/core/operators/metadata/datasources_provider.py @@ -18,6 +18,9 @@ class datasources_provider(Operator): ---------- data_sources : DataSources + Returns + ------- + data_sources : DataSources Examples -------- 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 10f267958d..69c289aab6 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 @@ -25,6 +25,9 @@ class integrate_over_time_freq(Operator): freq support from the input field is taken. + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/metadata/is_cyclic.py b/src/ansys/dpf/core/operators/metadata/is_cyclic.py index 2a052cbb6e..5dd99ad4ff 100644 --- a/src/ansys/dpf/core/operators/metadata/is_cyclic.py +++ b/src/ansys/dpf/core/operators/metadata/is_cyclic.py @@ -22,6 +22,11 @@ class is_cyclic(Operator): If the stream is null, retrieves the file path from the data sources. + Returns + ------- + file_path : str + Returns 'single_stage' or 'multi_stage' or an + empty string for non cyclic model Examples -------- 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 3ea06ca803..b8090bcf7f 100644 --- a/src/ansys/dpf/core/operators/metadata/material_support_provider.py +++ b/src/ansys/dpf/core/operators/metadata/material_support_provider.py @@ -22,6 +22,9 @@ class material_support_provider(Operator): If the stream is null, get the file path from the data sources. + Returns + ------- + abstract_field_support : AbstractFieldSupport Examples -------- 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 9c5edb53a1..7c7bbbacdc 100644 --- a/src/ansys/dpf/core/operators/metadata/mesh_info_provider.py +++ b/src/ansys/dpf/core/operators/metadata/mesh_info_provider.py @@ -27,6 +27,9 @@ class mesh_info_provider(Operator): If the stream is null, retrieves the file path from the data sources. + Returns + ------- + mesh_info : GenericDataContainer Examples -------- 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 d2b324d4a0..1bbaffa5c5 100644 --- a/src/ansys/dpf/core/operators/metadata/mesh_property_provider.py +++ b/src/ansys/dpf/core/operators/metadata/mesh_property_provider.py @@ -39,6 +39,17 @@ class mesh_property_provider(Operator): selection's number or a named selection's name. + Returns + ------- + 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". Examples -------- 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 1177b3df60..4079b670ac 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 @@ -24,6 +24,9 @@ class mesh_selection_manager_provider(Operator): If the stream is null, retrieves the file path from the data sources. + Returns + ------- + mesh_selection_manager : MeshSelectionManager Examples -------- 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 2526db0bb8..6484954d67 100644 --- a/src/ansys/dpf/core/operators/metadata/mesh_support_provider.py +++ b/src/ansys/dpf/core/operators/metadata/mesh_support_provider.py @@ -22,6 +22,9 @@ class mesh_support_provider(Operator): If the stream is null, retrieves the file path from the data sources. + Returns + ------- + abstract_field_support : AbstractFieldSupport Examples -------- 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 341c2f1486..fea97846ae 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 @@ -35,6 +35,10 @@ class property_field_provider_by_name(Operator): step, substep, keyopt_i (i = 1 -> 18). + Returns + ------- + property_field : PropertyField + Property field Examples -------- 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 1d9599a369..0c0f373129 100644 --- a/src/ansys/dpf/core/operators/metadata/result_info_provider.py +++ b/src/ansys/dpf/core/operators/metadata/result_info_provider.py @@ -24,6 +24,9 @@ class result_info_provider(Operator): If the stream is null, retrieves the file path from the data sources. + Returns + ------- + result_info : ResultInfo Examples -------- diff --git a/src/ansys/dpf/core/operators/metadata/streams_provider.py b/src/ansys/dpf/core/operators/metadata/streams_provider.py index ed80a49589..e6e57301ae 100644 --- a/src/ansys/dpf/core/operators/metadata/streams_provider.py +++ b/src/ansys/dpf/core/operators/metadata/streams_provider.py @@ -18,6 +18,9 @@ class streams_provider(Operator): ---------- data_sources : DataSources + Returns + ------- + streams_container : StreamsContainer Examples -------- 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 3212c55731..9bb6e1498f 100644 --- a/src/ansys/dpf/core/operators/metadata/time_freq_provider.py +++ b/src/ansys/dpf/core/operators/metadata/time_freq_provider.py @@ -23,6 +23,9 @@ class time_freq_provider(Operator): If the stream is null, retrieves the file path from the data sources. + Returns + ------- + time_freq_support : TimeFreqSupport Examples -------- 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 afd1c4d19b..c6917fb5f1 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 @@ -34,6 +34,14 @@ class time_freq_support_get_attribute(Operator): (if none, last substep is considered). + Returns + ------- + 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", and a field + otherwise. Examples -------- 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 0e948b2472..a77f0b66a8 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 @@ -25,6 +25,9 @@ class max_by_component(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 ca6d5849bb..f0f00f3b83 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 @@ -25,6 +25,9 @@ class max_over_phase(Operator): phase_increment : float, optional Phase increment (default is 10.0 degrees). + Returns + ------- + field : Field Examples -------- 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 22e9f71d7b..253623701e 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 @@ -22,6 +22,9 @@ class max_over_time_by_entity(Operator): compute_amplitude : bool, optional Do calculate amplitude. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 a7fcf277d5..2715c8f041 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 @@ -25,6 +25,9 @@ class min_by_component(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 08eeae7cc8..4e5d258b6e 100644 --- a/src/ansys/dpf/core/operators/min_max/min_max.py +++ b/src/ansys/dpf/core/operators/min_max/min_max.py @@ -21,6 +21,10 @@ class min_max(Operator): Field or fields container with only one field is expected + Returns + ------- + field_min : Field + field_max : Field Examples -------- 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 d508bbafd4..b909195f6c 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 @@ -19,6 +19,10 @@ class min_max_by_entity(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + field_min : Field + field_max : Field Examples -------- 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 029cc1c61e..ecbea0fad7 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 @@ -23,6 +23,10 @@ class min_max_by_time(Operator): entities before computing the min/max. + Returns + ------- + min : FieldsContainer + max : FieldsContainer Examples -------- 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 2225c454e9..9cee8ca71a 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 @@ -19,6 +19,10 @@ class min_max_fc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + field_min : Field + field_max : Field Examples -------- 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 a4d31ee571..e78eff9251 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 @@ -19,6 +19,10 @@ class min_max_fc_inc(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + field_min : Field + field_max : Field Examples -------- 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 c54522f35b..7aaede41f9 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,6 +20,12 @@ class min_max_inc(Operator): field : Field domain_id : int, optional + Returns + ------- + field_min : Field + field_max : Field + domain_ids_min : Scoping + domain_ids_max : Scoping Examples -------- 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 02e4c90a23..9da59b3f52 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 @@ -29,6 +29,14 @@ class min_max_over_label_fc(Operator): label : str Label name from the fields container + Returns + ------- + field_min : Field + field_max : Field + domain_ids_min : Scoping, optional + domain_ids_max : Scoping, optional + scoping_ids_min : Scoping + scoping_ids_max : Scoping Examples -------- 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 697cc5dfa8..68170cd635 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,6 +25,12 @@ class min_max_over_time_by_entity(Operator): compute_amplitude : bool, optional Do calculate amplitude. + Returns + ------- + min : FieldsContainer + max : FieldsContainer + time_freq_of_min : FieldsContainer + time_freq_of_max : FieldsContainer Examples -------- 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 6eb53aaac2..52490ce378 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 @@ -22,6 +22,9 @@ class min_over_time_by_entity(Operator): compute_amplitude : bool, optional Do calculate amplitude. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d8c92ab465..6d4a87bff2 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 @@ -23,6 +23,9 @@ class phase_of_max(Operator): phase_increment : float Phase increment. + Returns + ------- + field : Field Examples -------- 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 ca407d81f1..6432433665 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 @@ -22,6 +22,9 @@ class time_of_max_by_entity(Operator): compute_amplitude : bool, optional Do calculate amplitude. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 dcb8ffdbb5..c44780e094 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 @@ -22,6 +22,9 @@ class time_of_min_by_entity(Operator): compute_amplitude : bool, optional Do calculate amplitude. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/operator.mustache b/src/ansys/dpf/core/operators/operator.mustache index d0f34c4425..85802bbcc9 100644 --- a/src/ansys/dpf/core/operators/operator.mustache +++ b/src/ansys/dpf/core/operators/operator.mustache @@ -35,6 +35,19 @@ class {{class_name}}(Operator): {{/document}} {{/input_pins}} + Returns + ------- + {{#output_pins}} + {{#optional}} + {{name}} :{{#types_for_docstring}} {{types_for_docstring}},{{/types_for_docstring}} optional + {{/optional}} + {{^optional}} + {{name}} :{{#types_for_docstring}} {{types_for_docstring}}{{/types_for_docstring}} + {{/optional}} + {{#document}} + {{{document}}} + {{/document}} + {{/output_pins}} Examples -------- diff --git a/src/ansys/dpf/core/operators/result/acceleration.py b/src/ansys/dpf/core/operators/result/acceleration.py index 27931c25cd..6bbbbb9b1e 100644 --- a/src/ansys/dpf/core/operators/result/acceleration.py +++ b/src/ansys/dpf/core/operators/result/acceleration.py @@ -67,6 +67,9 @@ class acceleration(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/acceleration_X.py b/src/ansys/dpf/core/operators/result/acceleration_X.py index 7aa12492aa..f54963bd19 100644 --- a/src/ansys/dpf/core/operators/result/acceleration_X.py +++ b/src/ansys/dpf/core/operators/result/acceleration_X.py @@ -67,6 +67,9 @@ class acceleration_X(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/acceleration_Y.py b/src/ansys/dpf/core/operators/result/acceleration_Y.py index ffc415d54b..d15ea0c835 100644 --- a/src/ansys/dpf/core/operators/result/acceleration_Y.py +++ b/src/ansys/dpf/core/operators/result/acceleration_Y.py @@ -67,6 +67,9 @@ class acceleration_Y(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/acceleration_Z.py b/src/ansys/dpf/core/operators/result/acceleration_Z.py index db9bb41198..21d1870588 100644 --- a/src/ansys/dpf/core/operators/result/acceleration_Z.py +++ b/src/ansys/dpf/core/operators/result/acceleration_Z.py @@ -67,6 +67,9 @@ class acceleration_Z(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 351c9aa2ca..48e3fea003 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 @@ -92,6 +92,9 @@ class accu_eqv_creep_strain(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 879643b98a..e3dff18cd6 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 @@ -92,6 +92,9 @@ class accu_eqv_plastic_strain(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b32518aa3a..a818c8dcb1 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 @@ -26,6 +26,9 @@ class add_rigid_body_motion(Operator): mesh : MeshedRegion, optional Default is the mesh in the support + Returns + ------- + field : Field Examples -------- 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 fab42ac397..dffb1c85a1 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 @@ -26,6 +26,9 @@ class add_rigid_body_motion_fc(Operator): mesh : MeshedRegion, optional Default is the mesh in the support + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 3922e4c0e7..8b22262636 100644 --- a/src/ansys/dpf/core/operators/result/artificial_hourglass_energy.py +++ b/src/ansys/dpf/core/operators/result/artificial_hourglass_energy.py @@ -67,6 +67,9 @@ class artificial_hourglass_energy(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 448b602887..bbcacc8ca7 100644 --- a/src/ansys/dpf/core/operators/result/beam_axial_force.py +++ b/src/ansys/dpf/core/operators/result/beam_axial_force.py @@ -46,6 +46,9 @@ class beam_axial_force(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bd19b3580b..eb1e17d7f1 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 @@ -50,6 +50,9 @@ class beam_axial_plastic_strain(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d5c36a36a3..916adffb1e 100644 --- a/src/ansys/dpf/core/operators/result/beam_axial_stress.py +++ b/src/ansys/dpf/core/operators/result/beam_axial_stress.py @@ -50,6 +50,9 @@ class beam_axial_stress(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 88f7752a55..02b3d6674b 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 @@ -50,6 +50,9 @@ class beam_axial_total_strain(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 58baad6838..563f04c905 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 @@ -50,6 +50,9 @@ class beam_rs_shear_stress(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b3190e83ce..b34704406f 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 @@ -46,6 +46,9 @@ class beam_s_bending_moment(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 65a469140c..7a21003797 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 @@ -46,6 +46,9 @@ class beam_s_shear_force(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d92052d2e3..a81450ae90 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 @@ -46,6 +46,9 @@ class beam_t_bending_moment(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 39dd9850f4..f67a8f3b8f 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 @@ -46,6 +46,9 @@ class beam_t_shear_force(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 dfb33865e4..9e00caa124 100644 --- a/src/ansys/dpf/core/operators/result/beam_torsional_moment.py +++ b/src/ansys/dpf/core/operators/result/beam_torsional_moment.py @@ -46,6 +46,9 @@ class beam_torsional_moment(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 914c25102c..68ec7f929f 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 @@ -50,6 +50,9 @@ class beam_tr_shear_stress(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 03f2acac1b..33712e2b04 100644 --- a/src/ansys/dpf/core/operators/result/cgns_result_provider.py +++ b/src/ansys/dpf/core/operators/result/cgns_result_provider.py @@ -41,6 +41,10 @@ class cgns_result_provider(Operator): region_scoping : Scoping or int, optional Optional zone name/id of the mesh. + Returns + ------- + fields : FieldsContainer + Results Examples -------- 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 1d6502f30a..288c200131 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 @@ -20,6 +20,10 @@ class cms_dst_table_provider(Operator): Data_sources (must contain at least one subfile). + Returns + ------- + dst_table : PropertyField + Returns integer values of the dst table Examples -------- 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 13dcae943b..fd4b8c62e0 100644 --- a/src/ansys/dpf/core/operators/result/cms_matrices_provider.py +++ b/src/ansys/dpf/core/operators/result/cms_matrices_provider.py @@ -24,6 +24,13 @@ class cms_matrices_provider(Operator): If this pin i set to true, data are return as matrix form. + Returns + ------- + 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. Examples -------- 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 f738217e66..c1e5e66ca4 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 @@ -23,6 +23,19 @@ class cms_subfile_info_provider(Operator): If this pin i set to true, data are return in a field. + Returns + ------- + 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 + field : PropertyField + Returns integer values in the order : number + of load vectors (nvects), number of + nodes (nnod), number of virtual nodes + (nvnodes), number of modes (nvmodes) Examples -------- diff --git a/src/ansys/dpf/core/operators/result/co_energy.py b/src/ansys/dpf/core/operators/result/co_energy.py index 0a880e1689..a957218bf5 100644 --- a/src/ansys/dpf/core/operators/result/co_energy.py +++ b/src/ansys/dpf/core/operators/result/co_energy.py @@ -67,6 +67,9 @@ class co_energy(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 18f880361a..0d66370e83 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 @@ -32,6 +32,31 @@ class compute_invariant_terms_motion(Operator): Coordinates of all nodes nod : + Returns + ------- + model_data : PropertyField + Data describing the finite element model + mode_shapes : FieldsContainer + Fieldscontainers containing the mode shapes, + which are cst and nor for the cms + method + lumped_mass : FieldsContainer + Fieldscontainers containing the lumped mass + field_coordinates_and_euler_angles : FieldsContainer + Coordinates and euler angles of all nodes + nod : + used_node_index : + eigenvalue : + translational_mode_shape : + rotational_mode_shape : + invrt_1 : float + invrt_2 : + invrt_3 : + invrt_4 : + invrt_5 : + invrt_6 : + invrt_7 : + invrt_8 : Examples -------- 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 9ef7f477ab..adf9465bf0 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 @@ -40,6 +40,35 @@ class compute_invariant_terms_rbd(Operator): If true, the orthogonality of the constraint modes are checked. default is false. + Returns + ------- + model_data : PropertyField + Data describing the finite element model + center_of_mass : Field + Center of mass of the body + inertia_relief : Field + Inertia matrix + model_size : PropertyField + master_node_coordinates : + v_trsf : + Translational and rotational shape functions + k_mat : Field + mass_mat : Field + c_mat : Field + rhs : Field + dn : + dr_cross_n : + drn : + dn_cross_n : + dnx_y : + dny_y : + dnz_y : + dyx_n : + dyy_n : + dyz_n : + dnxn : + dnyn : + dnzn : Examples -------- diff --git a/src/ansys/dpf/core/operators/result/compute_stress.py b/src/ansys/dpf/core/operators/result/compute_stress.py index 5be8442a8e..d3346974e7 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress.py +++ b/src/ansys/dpf/core/operators/result/compute_stress.py @@ -35,6 +35,11 @@ class compute_stress(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 4b1aaf88c0..59d38a5b2c 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_1.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_1.py @@ -36,6 +36,11 @@ class compute_stress_1(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 ca69976952..c261f1c761 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_2.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_2.py @@ -36,6 +36,11 @@ class compute_stress_2(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 cca6f87264..4ac804392a 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_3.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_3.py @@ -36,6 +36,11 @@ class compute_stress_3(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 356df934ca..9fae04b516 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_X.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_X.py @@ -36,6 +36,11 @@ class compute_stress_X(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 1bb052e9aa..8e5cb2514f 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_XY.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_XY.py @@ -36,6 +36,11 @@ class compute_stress_XY(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 af0c23c264..4a2ebc0128 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_XZ.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_XZ.py @@ -36,6 +36,11 @@ class compute_stress_XZ(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 05b44982f9..f45e7a28b3 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_Y.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_Y.py @@ -36,6 +36,11 @@ class compute_stress_Y(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 56e0234652..6c9de41f93 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_YZ.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_YZ.py @@ -36,6 +36,11 @@ class compute_stress_YZ(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 9a8c66fda7..9b03bffc40 100644 --- a/src/ansys/dpf/core/operators/result/compute_stress_Z.py +++ b/src/ansys/dpf/core/operators/result/compute_stress_Z.py @@ -36,6 +36,11 @@ class compute_stress_Z(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 35d2a0149c..0851adb9b3 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 @@ -36,6 +36,11 @@ class compute_stress_von_mises(Operator): Field/or fields container containing only the elastic strain field (element nodal). + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 223a11107b..4959cb61a5 100644 --- a/src/ansys/dpf/core/operators/result/compute_total_strain.py +++ b/src/ansys/dpf/core/operators/result/compute_total_strain.py @@ -78,6 +78,11 @@ class compute_total_strain(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 56400fd2a5..677870afae 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 @@ -79,6 +79,11 @@ class compute_total_strain_1(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 7f3d05d14d..e48f3b720c 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 @@ -79,6 +79,11 @@ class compute_total_strain_2(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 99b6c66809..37b4fc5a14 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 @@ -79,6 +79,11 @@ class compute_total_strain_3(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 ddeb662288..0b7b8caee8 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 @@ -79,6 +79,11 @@ class compute_total_strain_X(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 00276dffa0..704318a6c5 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 @@ -79,6 +79,11 @@ class compute_total_strain_XY(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 f5ad9d8c04..249b0b10d3 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 @@ -79,6 +79,11 @@ class compute_total_strain_XZ(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 8a7098896b..f4c249fd84 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 @@ -79,6 +79,11 @@ class compute_total_strain_Y(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 7e11a3dd75..103b93893f 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 @@ -79,6 +79,11 @@ class compute_total_strain_YZ(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 a9633a9126..75a577e436 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 @@ -79,6 +79,11 @@ class compute_total_strain_Z(Operator): specified, read displacements from result file using the data_sources. + Returns + ------- + fields_container : FieldsContainer + The computed result fields container + (elemental nodal). Examples -------- 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 c8dd69bc68..fe67799159 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 @@ -92,6 +92,9 @@ class contact_fluid_penetration_pressure(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ad8a79ad95..dc5043503b 100644 --- a/src/ansys/dpf/core/operators/result/contact_friction_stress.py +++ b/src/ansys/dpf/core/operators/result/contact_friction_stress.py @@ -92,6 +92,9 @@ class contact_friction_stress(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d7476bc5a1..ae0b5ee32b 100644 --- a/src/ansys/dpf/core/operators/result/contact_gap_distance.py +++ b/src/ansys/dpf/core/operators/result/contact_gap_distance.py @@ -92,6 +92,9 @@ class contact_gap_distance(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/contact_penetration.py b/src/ansys/dpf/core/operators/result/contact_penetration.py index 6888351afe..c3abfa0f0f 100644 --- a/src/ansys/dpf/core/operators/result/contact_penetration.py +++ b/src/ansys/dpf/core/operators/result/contact_penetration.py @@ -92,6 +92,9 @@ class contact_penetration(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/contact_pressure.py b/src/ansys/dpf/core/operators/result/contact_pressure.py index e90ef2c2c5..425ecff8b1 100644 --- a/src/ansys/dpf/core/operators/result/contact_pressure.py +++ b/src/ansys/dpf/core/operators/result/contact_pressure.py @@ -92,6 +92,9 @@ class contact_pressure(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 903e0c32ed..dc8865df28 100644 --- a/src/ansys/dpf/core/operators/result/contact_sliding_distance.py +++ b/src/ansys/dpf/core/operators/result/contact_sliding_distance.py @@ -92,6 +92,9 @@ class contact_sliding_distance(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/contact_status.py b/src/ansys/dpf/core/operators/result/contact_status.py index c6c5fb37ff..327b081141 100644 --- a/src/ansys/dpf/core/operators/result/contact_status.py +++ b/src/ansys/dpf/core/operators/result/contact_status.py @@ -92,6 +92,9 @@ class contact_status(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 2c413d6819..09385b0d09 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 @@ -92,6 +92,9 @@ class contact_surface_heat_flux(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ac74323699..adf42f1ac2 100644 --- a/src/ansys/dpf/core/operators/result/contact_total_stress.py +++ b/src/ansys/dpf/core/operators/result/contact_total_stress.py @@ -92,6 +92,9 @@ class contact_total_stress(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/coordinate_system.py b/src/ansys/dpf/core/operators/result/coordinate_system.py index f19a6296bf..c9b3a3d6ce 100644 --- a/src/ansys/dpf/core/operators/result/coordinate_system.py +++ b/src/ansys/dpf/core/operators/result/coordinate_system.py @@ -21,6 +21,12 @@ class coordinate_system(Operator): streams_container : StreamsContainer, optional data_sources : DataSources + Returns + ------- + field : Field + The first 9 double are the rotation (3x3 + matrix) and the last 3 is the + translation vector Examples -------- diff --git a/src/ansys/dpf/core/operators/result/coordinates.py b/src/ansys/dpf/core/operators/result/coordinates.py index 713f976b42..8afbe23b80 100644 --- a/src/ansys/dpf/core/operators/result/coordinates.py +++ b/src/ansys/dpf/core/operators/result/coordinates.py @@ -67,6 +67,9 @@ class coordinates(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 dcb362a4f7..9c0c957d5c 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 @@ -92,6 +92,9 @@ class creep_strain_energy_density(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/current_density.py b/src/ansys/dpf/core/operators/result/current_density.py index 54c0559db8..5105234a49 100644 --- a/src/ansys/dpf/core/operators/result/current_density.py +++ b/src/ansys/dpf/core/operators/result/current_density.py @@ -67,6 +67,9 @@ class current_density(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/custom.py b/src/ansys/dpf/core/operators/result/custom.py index 08a3003ac7..7e38f12898 100644 --- a/src/ansys/dpf/core/operators/result/custom.py +++ b/src/ansys/dpf/core/operators/result/custom.py @@ -67,6 +67,9 @@ class custom(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b1a55ac153..0de2cb2f96 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 @@ -26,6 +26,10 @@ class cyclic_analytic_seqv_max(Operator): Default is true cyclic_support : CyclicSupport + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in Examples -------- 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 b28b676012..5fa24df994 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 @@ -26,6 +26,10 @@ class cyclic_analytic_usum_max(Operator): Default is true cyclic_support : CyclicSupport + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_equivalent_mass.py b/src/ansys/dpf/core/operators/result/cyclic_equivalent_mass.py index 16b415d4f9..72fdbfeb31 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_equivalent_mass.py +++ b/src/ansys/dpf/core/operators/result/cyclic_equivalent_mass.py @@ -51,6 +51,11 @@ class cyclic_equivalent_mass(Operator): phi : float, optional Angle phi in degrees (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_acceleration.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_acceleration.py index 07ead200bc..7f4ab412d6 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_acceleration.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_acceleration.py @@ -52,6 +52,11 @@ class cyclic_expanded_acceleration(Operator): phi : float, optional Angle phi in degrees (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_displacement.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_displacement.py index 78c827dbe0..77e739d6d8 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_displacement.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_displacement.py @@ -53,6 +53,11 @@ class cyclic_expanded_displacement(Operator): phi : float, optional Angle phi in degrees (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_el_strain.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_el_strain.py index e5d44e52ea..2efb724bc3 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_el_strain.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_el_strain.py @@ -53,6 +53,11 @@ class cyclic_expanded_el_strain(Operator): phi : float, optional Phi angle (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_enf.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_enf.py index 04664955e4..f01c9cd9ee 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_enf.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_enf.py @@ -52,6 +52,11 @@ class cyclic_expanded_enf(Operator): phi : float, optional Phi angle (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py index d754444fb4..f56cd7ad28 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_heat_flux.py @@ -53,6 +53,11 @@ class cyclic_expanded_heat_flux(Operator): phi : float, optional Phi angle (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_stress.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_stress.py index 809f527d8d..187bd057b7 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_stress.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_stress.py @@ -53,6 +53,11 @@ class cyclic_expanded_stress(Operator): phi : float, optional Phi angle (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py index ae14ace410..dc7391963d 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_temperature.py @@ -52,6 +52,11 @@ class cyclic_expanded_temperature(Operator): phi : float, optional Angle phi in degrees (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expanded_velocity.py b/src/ansys/dpf/core/operators/result/cyclic_expanded_velocity.py index ccf63f52b8..b92bf839ac 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expanded_velocity.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expanded_velocity.py @@ -52,6 +52,11 @@ class cyclic_expanded_velocity(Operator): phi : float, optional Angle phi in degrees (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_expansion.py b/src/ansys/dpf/core/operators/result/cyclic_expansion.py index 042ce22259..1307b634fe 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_expansion.py +++ b/src/ansys/dpf/core/operators/result/cyclic_expansion.py @@ -37,6 +37,10 @@ class cyclic_expansion(Operator): phi : float, optional Angle phi in degrees (default value 0.0) + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_kinetic_energy.py b/src/ansys/dpf/core/operators/result/cyclic_kinetic_energy.py index 7b860163cc..4bca8a5e4f 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/cyclic_kinetic_energy.py @@ -45,6 +45,11 @@ class cyclic_kinetic_energy(Operator): Mesh expanded. cyclic_support : CyclicSupport, optional + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_nmisc.py b/src/ansys/dpf/core/operators/result/cyclic_nmisc.py index 847b73bd56..dc40dcc01e 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_nmisc.py +++ b/src/ansys/dpf/core/operators/result/cyclic_nmisc.py @@ -45,6 +45,11 @@ class cyclic_nmisc(Operator): Mesh expanded. cyclic_support : CyclicSupport, optional + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_strain_energy.py b/src/ansys/dpf/core/operators/result/cyclic_strain_energy.py index d5ce43d54b..a6a2927d1c 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_strain_energy.py +++ b/src/ansys/dpf/core/operators/result/cyclic_strain_energy.py @@ -45,6 +45,11 @@ class cyclic_strain_energy(Operator): Mesh expanded. cyclic_support : CyclicSupport, optional + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/cyclic_volume.py b/src/ansys/dpf/core/operators/result/cyclic_volume.py index 1022c04a74..1801d2e510 100644 --- a/src/ansys/dpf/core/operators/result/cyclic_volume.py +++ b/src/ansys/dpf/core/operators/result/cyclic_volume.py @@ -45,6 +45,11 @@ class cyclic_volume(Operator): Mesh expanded. cyclic_support : CyclicSupport, optional + Returns + ------- + fields_container : FieldsContainer + Fieldscontainer filled in + expanded_meshes : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/density.py b/src/ansys/dpf/core/operators/result/density.py index eee0ffcabf..f82aae2a2b 100644 --- a/src/ansys/dpf/core/operators/result/density.py +++ b/src/ansys/dpf/core/operators/result/density.py @@ -68,6 +68,9 @@ class density(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/displacement.py b/src/ansys/dpf/core/operators/result/displacement.py index 414d2e6dfc..0d71f3c76c 100644 --- a/src/ansys/dpf/core/operators/result/displacement.py +++ b/src/ansys/dpf/core/operators/result/displacement.py @@ -67,6 +67,9 @@ class displacement(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/displacement_X.py b/src/ansys/dpf/core/operators/result/displacement_X.py index c6c64d4c04..9bdcc58e39 100644 --- a/src/ansys/dpf/core/operators/result/displacement_X.py +++ b/src/ansys/dpf/core/operators/result/displacement_X.py @@ -67,6 +67,9 @@ class displacement_X(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/displacement_Y.py b/src/ansys/dpf/core/operators/result/displacement_Y.py index c0871cf7d3..1beb4ebe47 100644 --- a/src/ansys/dpf/core/operators/result/displacement_Y.py +++ b/src/ansys/dpf/core/operators/result/displacement_Y.py @@ -67,6 +67,9 @@ class displacement_Y(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/displacement_Z.py b/src/ansys/dpf/core/operators/result/displacement_Z.py index 455910583d..4283e6f325 100644 --- a/src/ansys/dpf/core/operators/result/displacement_Z.py +++ b/src/ansys/dpf/core/operators/result/displacement_Z.py @@ -67,6 +67,9 @@ class displacement_Z(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 fa034cbc24..cc3876be90 100644 --- a/src/ansys/dpf/core/operators/result/div_lighthill_tensor.py +++ b/src/ansys/dpf/core/operators/result/div_lighthill_tensor.py @@ -69,6 +69,9 @@ class div_lighthill_tensor(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/dynamic_viscosity.py b/src/ansys/dpf/core/operators/result/dynamic_viscosity.py index 3d42af3dbb..8072531284 100644 --- a/src/ansys/dpf/core/operators/result/dynamic_viscosity.py +++ b/src/ansys/dpf/core/operators/result/dynamic_viscosity.py @@ -69,6 +69,9 @@ class dynamic_viscosity(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/elastic_strain.py b/src/ansys/dpf/core/operators/result/elastic_strain.py index da65e6dea8..d80fd4aa3e 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain.py @@ -92,6 +92,9 @@ class elastic_strain(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 179fa5f4cd..80acb05031 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_X.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_X.py @@ -75,6 +75,9 @@ class elastic_strain_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 9f422cf257..5c1a4b4dbc 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_XY.py @@ -75,6 +75,9 @@ class elastic_strain_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 c4903577bb..98db3a9dc7 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_XZ.py @@ -75,6 +75,9 @@ class elastic_strain_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 14fba7ee27..2893f75b90 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_Y.py @@ -75,6 +75,9 @@ class elastic_strain_Y(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 a487b13f21..429ec824c2 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_YZ.py @@ -75,6 +75,9 @@ class elastic_strain_YZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1aff372fba..06bf46ca23 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_Z.py @@ -75,6 +75,9 @@ class elastic_strain_Z(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e047966f8a..99bb338d20 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 @@ -92,6 +92,9 @@ class elastic_strain_energy_density(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d74a167ac4..10949ad4c9 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_eqv.py @@ -92,6 +92,9 @@ class elastic_strain_eqv(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 703553a922..1e6373e18f 100644 --- a/src/ansys/dpf/core/operators/result/elastic_strain_intensity.py +++ b/src/ansys/dpf/core/operators/result/elastic_strain_intensity.py @@ -71,6 +71,9 @@ class elastic_strain_intensity(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 65c04baff7..65eb13122e 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 @@ -71,6 +71,9 @@ class elastic_strain_max_shear(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 47866358ea..f2e10a01b0 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 @@ -73,6 +73,9 @@ class elastic_strain_principal_1(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 13af4b34fc..2f540f4c21 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 @@ -73,6 +73,9 @@ class elastic_strain_principal_2(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5d764f096f..3c947d2608 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 @@ -73,6 +73,9 @@ class elastic_strain_principal_3(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 aa5506508a..78cdb799ce 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 @@ -22,6 +22,9 @@ class elastic_strain_rotation_by_euler_nodes(Operator): Dataprocessing::Crstfilewrapper, optional data_sources : DataSources + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/electric_field.py b/src/ansys/dpf/core/operators/result/electric_field.py index 7b5f174ce2..2ad55312db 100644 --- a/src/ansys/dpf/core/operators/result/electric_field.py +++ b/src/ansys/dpf/core/operators/result/electric_field.py @@ -92,6 +92,9 @@ class electric_field(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5cc6881f4b..11ae53e8fd 100644 --- a/src/ansys/dpf/core/operators/result/electric_flux_density.py +++ b/src/ansys/dpf/core/operators/result/electric_flux_density.py @@ -92,6 +92,9 @@ class electric_flux_density(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/electric_potential.py b/src/ansys/dpf/core/operators/result/electric_potential.py index 65415d506b..92d0dc2b99 100644 --- a/src/ansys/dpf/core/operators/result/electric_potential.py +++ b/src/ansys/dpf/core/operators/result/electric_potential.py @@ -67,6 +67,9 @@ class electric_potential(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/element_centroids.py b/src/ansys/dpf/core/operators/result/element_centroids.py index d405e46c6a..cbf445db00 100644 --- a/src/ansys/dpf/core/operators/result/element_centroids.py +++ b/src/ansys/dpf/core/operators/result/element_centroids.py @@ -67,6 +67,9 @@ class element_centroids(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 24dd99bacd..78bcca771b 100644 --- a/src/ansys/dpf/core/operators/result/element_nodal_forces.py +++ b/src/ansys/dpf/core/operators/result/element_nodal_forces.py @@ -102,6 +102,9 @@ class element_nodal_forces(Operator): and 2 for inertial terms). default is false. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/element_orientations.py b/src/ansys/dpf/core/operators/result/element_orientations.py index d9d6519f06..5f90b9c7a8 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations.py +++ b/src/ansys/dpf/core/operators/result/element_orientations.py @@ -92,6 +92,9 @@ class element_orientations(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e394656862..8cd1025cf7 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations_X.py +++ b/src/ansys/dpf/core/operators/result/element_orientations_X.py @@ -74,6 +74,9 @@ class element_orientations_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b7e91ec74c..f3cf293050 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations_Y.py +++ b/src/ansys/dpf/core/operators/result/element_orientations_Y.py @@ -74,6 +74,9 @@ class element_orientations_Y(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 3d3665954d..5a33fd293e 100644 --- a/src/ansys/dpf/core/operators/result/element_orientations_Z.py +++ b/src/ansys/dpf/core/operators/result/element_orientations_Z.py @@ -74,6 +74,9 @@ class element_orientations_Z(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 7e8685d11a..b736686543 100644 --- a/src/ansys/dpf/core/operators/result/elemental_heat_generation.py +++ b/src/ansys/dpf/core/operators/result/elemental_heat_generation.py @@ -67,6 +67,9 @@ class elemental_heat_generation(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/elemental_mass.py b/src/ansys/dpf/core/operators/result/elemental_mass.py index 5c774550fc..2646b44799 100644 --- a/src/ansys/dpf/core/operators/result/elemental_mass.py +++ b/src/ansys/dpf/core/operators/result/elemental_mass.py @@ -67,6 +67,9 @@ class elemental_mass(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/elemental_volume.py b/src/ansys/dpf/core/operators/result/elemental_volume.py index 7692af4dd3..5d19cd990d 100644 --- a/src/ansys/dpf/core/operators/result/elemental_volume.py +++ b/src/ansys/dpf/core/operators/result/elemental_volume.py @@ -67,6 +67,9 @@ class elemental_volume(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 788c40b2ed..a0ada6c268 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 @@ -22,6 +22,9 @@ class enf_rotation_by_euler_nodes(Operator): Dataprocessing::Crstfilewrapper, optional data_sources : DataSources + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/enthalpy.py b/src/ansys/dpf/core/operators/result/enthalpy.py index 5634c665f9..5afdc7ecc9 100644 --- a/src/ansys/dpf/core/operators/result/enthalpy.py +++ b/src/ansys/dpf/core/operators/result/enthalpy.py @@ -68,6 +68,9 @@ class enthalpy(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/entropy.py b/src/ansys/dpf/core/operators/result/entropy.py index 7c488ba75e..1dd863ed30 100644 --- a/src/ansys/dpf/core/operators/result/entropy.py +++ b/src/ansys/dpf/core/operators/result/entropy.py @@ -68,6 +68,9 @@ class entropy(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/epsilon.py b/src/ansys/dpf/core/operators/result/epsilon.py index 5b9f5f4afe..c86040e811 100644 --- a/src/ansys/dpf/core/operators/result/epsilon.py +++ b/src/ansys/dpf/core/operators/result/epsilon.py @@ -69,6 +69,9 @@ class epsilon(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/equivalent_mass.py b/src/ansys/dpf/core/operators/result/equivalent_mass.py index bab06e873a..2205aff8c7 100644 --- a/src/ansys/dpf/core/operators/result/equivalent_mass.py +++ b/src/ansys/dpf/core/operators/result/equivalent_mass.py @@ -66,6 +66,9 @@ class equivalent_mass(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 92b12576de..a90f13819a 100644 --- a/src/ansys/dpf/core/operators/result/equivalent_radiated_power.py +++ b/src/ansys/dpf/core/operators/result/equivalent_radiated_power.py @@ -46,6 +46,9 @@ class equivalent_radiated_power(Operator): factor : float Erp reference value. default is 1e-12 + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 f8d4490547..ccf438dfce 100644 --- a/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py +++ b/src/ansys/dpf/core/operators/result/eqv_stress_parameter.py @@ -92,6 +92,9 @@ class eqv_stress_parameter(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 c2a714c387..6c216b0fad 100644 --- a/src/ansys/dpf/core/operators/result/erp_radiation_efficiency.py +++ b/src/ansys/dpf/core/operators/result/erp_radiation_efficiency.py @@ -35,6 +35,9 @@ class erp_radiation_efficiency(Operator): default value of the speed of sound in the air is applied). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 8472764033..be1ff4b140 100644 --- a/src/ansys/dpf/core/operators/result/euler_load_buckling.py +++ b/src/ansys/dpf/core/operators/result/euler_load_buckling.py @@ -29,6 +29,19 @@ class euler_load_buckling(Operator): field_beam_length : Field Field of beam's length + Returns + ------- + 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. + field_euler_critical_load_yy : Field + This field contains euler's critical load on + axis y. + field_euler_critical_load_zz : Field + This field contains euler's critical load on + axis z. Examples -------- diff --git a/src/ansys/dpf/core/operators/result/euler_nodes.py b/src/ansys/dpf/core/operators/result/euler_nodes.py index 8effa363ea..6f68911fde 100644 --- a/src/ansys/dpf/core/operators/result/euler_nodes.py +++ b/src/ansys/dpf/core/operators/result/euler_nodes.py @@ -30,6 +30,9 @@ class euler_nodes(Operator): (default is true). mesh : MeshedRegion, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation.py b/src/ansys/dpf/core/operators/result/gasket_deformation.py index f027bfbef8..c933869a15 100644 --- a/src/ansys/dpf/core/operators/result/gasket_deformation.py +++ b/src/ansys/dpf/core/operators/result/gasket_deformation.py @@ -92,6 +92,9 @@ class gasket_deformation(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation_X.py b/src/ansys/dpf/core/operators/result/gasket_deformation_X.py index abee6dd6eb..35d2faab56 100644 --- a/src/ansys/dpf/core/operators/result/gasket_deformation_X.py +++ b/src/ansys/dpf/core/operators/result/gasket_deformation_X.py @@ -74,6 +74,9 @@ class gasket_deformation_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation_XY.py b/src/ansys/dpf/core/operators/result/gasket_deformation_XY.py index 718dc4c49b..4f38742091 100644 --- a/src/ansys/dpf/core/operators/result/gasket_deformation_XY.py +++ b/src/ansys/dpf/core/operators/result/gasket_deformation_XY.py @@ -74,6 +74,9 @@ class gasket_deformation_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/gasket_deformation_XZ.py b/src/ansys/dpf/core/operators/result/gasket_deformation_XZ.py index a7eb482945..de7689e506 100644 --- a/src/ansys/dpf/core/operators/result/gasket_deformation_XZ.py +++ b/src/ansys/dpf/core/operators/result/gasket_deformation_XZ.py @@ -74,6 +74,9 @@ class gasket_deformation_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5dbc0e9668..abeaae7050 100644 --- a/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py +++ b/src/ansys/dpf/core/operators/result/gasket_inelastic_closure.py @@ -92,6 +92,9 @@ class gasket_inelastic_closure(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5b1bb832af..9c0d53228f 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 @@ -74,6 +74,9 @@ class gasket_inelastic_closure_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 fd07027386..ad68ce15d4 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 @@ -74,6 +74,9 @@ class gasket_inelastic_closure_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 dd02511547..99dd0ac98b 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 @@ -74,6 +74,9 @@ class gasket_inelastic_closure_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/gasket_stress.py b/src/ansys/dpf/core/operators/result/gasket_stress.py index a7c7e2c2a6..7a70259309 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress.py @@ -92,6 +92,9 @@ class gasket_stress(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 7abed7281c..4c070d8e96 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress_X.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress_X.py @@ -74,6 +74,9 @@ class gasket_stress_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 c8e3281091..41d1b6b152 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress_XY.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress_XY.py @@ -74,6 +74,9 @@ class gasket_stress_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 45b1b0f96b..edb2daceec 100644 --- a/src/ansys/dpf/core/operators/result/gasket_stress_XZ.py +++ b/src/ansys/dpf/core/operators/result/gasket_stress_XZ.py @@ -74,6 +74,9 @@ class gasket_stress_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1265232d45..002143eadd 100644 --- a/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py +++ b/src/ansys/dpf/core/operators/result/gasket_thermal_closure.py @@ -92,6 +92,9 @@ class gasket_thermal_closure(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 cae0beb162..feb687d305 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 @@ -74,6 +74,9 @@ class gasket_thermal_closure_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bd98cc0784..3f0a852d24 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 @@ -74,6 +74,9 @@ class gasket_thermal_closure_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 cbff70f2ce..07835d9a1f 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 @@ -74,6 +74,9 @@ class gasket_thermal_closure_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 04365ef4f9..32106c5fb7 100644 --- a/src/ansys/dpf/core/operators/result/global_added_mass.py +++ b/src/ansys/dpf/core/operators/result/global_added_mass.py @@ -28,6 +28,9 @@ class global_added_mass(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e106092352..882d729e85 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 @@ -28,6 +28,9 @@ class global_added_mass_pct(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 6adfaf6452..d522f88d65 100644 --- a/src/ansys/dpf/core/operators/result/global_center_mass.py +++ b/src/ansys/dpf/core/operators/result/global_center_mass.py @@ -28,6 +28,9 @@ class global_center_mass(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e00d86d6dd..4b18a8d4dd 100644 --- a/src/ansys/dpf/core/operators/result/global_energy_ratio.py +++ b/src/ansys/dpf/core/operators/result/global_energy_ratio.py @@ -28,6 +28,9 @@ class global_energy_ratio(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 35552f10ab..eb5d75ba2b 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 @@ -28,6 +28,9 @@ class global_energy_ratio_wo_eroded(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 28bb0eff41..f93ace594e 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 @@ -28,6 +28,9 @@ class global_eroded_hourglass_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 a05d00cafa..d78edafde3 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 @@ -28,6 +28,9 @@ class global_eroded_internal_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 babbd04e3d..935465f8ee 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 @@ -28,6 +28,9 @@ class global_eroded_kinetic_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 6c82dfb6e3..881c8cecc9 100644 --- a/src/ansys/dpf/core/operators/result/global_external_work.py +++ b/src/ansys/dpf/core/operators/result/global_external_work.py @@ -28,6 +28,9 @@ class global_external_work(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b79f906652..99f86980b3 100644 --- a/src/ansys/dpf/core/operators/result/global_hourglass_energy.py +++ b/src/ansys/dpf/core/operators/result/global_hourglass_energy.py @@ -28,6 +28,9 @@ class global_hourglass_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 2873717c1e..d89f473010 100644 --- a/src/ansys/dpf/core/operators/result/global_internal_energy.py +++ b/src/ansys/dpf/core/operators/result/global_internal_energy.py @@ -28,6 +28,9 @@ class global_internal_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1f96b63c30..a48267b382 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 @@ -28,6 +28,9 @@ class global_joint_internal_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 59e15d8225..1ab5857fc1 100644 --- a/src/ansys/dpf/core/operators/result/global_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/global_kinetic_energy.py @@ -28,6 +28,9 @@ class global_kinetic_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 8c086eeb21..36fb4338fc 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 @@ -28,6 +28,9 @@ class global_rigid_body_stopper_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e199104de8..4ad58e7025 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 @@ -28,6 +28,9 @@ class global_sliding_interface_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 85507bf883..63ab9002d4 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 @@ -28,6 +28,9 @@ class global_spring_damper_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 000ca34a9c..7398cffa0a 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 @@ -28,6 +28,9 @@ class global_system_damping_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 3d7d2c63d2..ce5cbf1ea2 100644 --- a/src/ansys/dpf/core/operators/result/global_time_step.py +++ b/src/ansys/dpf/core/operators/result/global_time_step.py @@ -28,6 +28,9 @@ class global_time_step(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5bd409dda1..4e97677988 100644 --- a/src/ansys/dpf/core/operators/result/global_to_nodal.py +++ b/src/ansys/dpf/core/operators/result/global_to_nodal.py @@ -26,6 +26,10 @@ class global_to_nodal(Operator): file. those must be the rotations from nodal to global. + Returns + ------- + field : Field + Rotated field Examples -------- 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 c15e8d80f0..803f8295d8 100644 --- a/src/ansys/dpf/core/operators/result/global_total_energy.py +++ b/src/ansys/dpf/core/operators/result/global_total_energy.py @@ -28,6 +28,9 @@ class global_total_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 7aad86f7bf..f8ee7df009 100644 --- a/src/ansys/dpf/core/operators/result/global_total_mass.py +++ b/src/ansys/dpf/core/operators/result/global_total_mass.py @@ -28,6 +28,9 @@ class global_total_mass(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/global_velocity.py b/src/ansys/dpf/core/operators/result/global_velocity.py index 043a54e2e7..170901488f 100644 --- a/src/ansys/dpf/core/operators/result/global_velocity.py +++ b/src/ansys/dpf/core/operators/result/global_velocity.py @@ -28,6 +28,9 @@ class global_velocity(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/heat_flux.py b/src/ansys/dpf/core/operators/result/heat_flux.py index d9decc460a..45288f46f5 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux.py +++ b/src/ansys/dpf/core/operators/result/heat_flux.py @@ -92,6 +92,9 @@ class heat_flux(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 69285f82ad..085d4e76e7 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux_X.py +++ b/src/ansys/dpf/core/operators/result/heat_flux_X.py @@ -74,6 +74,9 @@ class heat_flux_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ff65950d08..aa491cf1f7 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux_Y.py +++ b/src/ansys/dpf/core/operators/result/heat_flux_Y.py @@ -74,6 +74,9 @@ class heat_flux_Y(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bfd842462f..a7590f11a6 100644 --- a/src/ansys/dpf/core/operators/result/heat_flux_Z.py +++ b/src/ansys/dpf/core/operators/result/heat_flux_Z.py @@ -74,6 +74,9 @@ class heat_flux_Z(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py b/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py index 6150db2165..c187280bab 100644 --- a/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py +++ b/src/ansys/dpf/core/operators/result/hydrostatic_pressure.py @@ -92,6 +92,9 @@ class hydrostatic_pressure(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/incremental_energy.py b/src/ansys/dpf/core/operators/result/incremental_energy.py index 577504ccd2..24010e03fe 100644 --- a/src/ansys/dpf/core/operators/result/incremental_energy.py +++ b/src/ansys/dpf/core/operators/result/incremental_energy.py @@ -67,6 +67,9 @@ class incremental_energy(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/initial_coordinates.py b/src/ansys/dpf/core/operators/result/initial_coordinates.py index 507ee221d8..422ce48269 100644 --- a/src/ansys/dpf/core/operators/result/initial_coordinates.py +++ b/src/ansys/dpf/core/operators/result/initial_coordinates.py @@ -67,6 +67,9 @@ class initial_coordinates(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 9a7c763e48..76476e2880 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_area.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_area.py @@ -32,6 +32,9 @@ class interface_contact_area(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 a08ab2be04..b7c31168d6 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_force.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_force.py @@ -32,6 +32,9 @@ class interface_contact_force(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 151c03d8b8..fadbb49286 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_mass.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_mass.py @@ -32,6 +32,9 @@ class interface_contact_mass(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5b104aa654..095b3fd36f 100644 --- a/src/ansys/dpf/core/operators/result/interface_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/interface_contact_moment.py @@ -32,6 +32,9 @@ class interface_contact_moment(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ad7b67092c..3a84a77446 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 @@ -32,6 +32,9 @@ class interface_resultant_contact_force(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 6c4da75e49..02e8b95548 100644 --- a/src/ansys/dpf/core/operators/result/joint_force_reaction.py +++ b/src/ansys/dpf/core/operators/result/joint_force_reaction.py @@ -67,6 +67,9 @@ class joint_force_reaction(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 8ad9c6e5b5..3f65a5c2af 100644 --- a/src/ansys/dpf/core/operators/result/joint_moment_reaction.py +++ b/src/ansys/dpf/core/operators/result/joint_moment_reaction.py @@ -67,6 +67,9 @@ class joint_moment_reaction(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 c23d13d02a..baa5f38e1b 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_acceleration.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_acceleration.py @@ -67,6 +67,9 @@ class joint_relative_acceleration(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 93c53881d8..59b73e2c3b 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 @@ -67,6 +67,9 @@ class joint_relative_angular_acceleration(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 3115c9e3c0..05320a1fac 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 @@ -67,6 +67,9 @@ class joint_relative_angular_velocity(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b4d69b63d3..118d292721 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_displacement.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_displacement.py @@ -67,6 +67,9 @@ class joint_relative_displacement(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ef50ee5aca..f4d6a27077 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_rotation.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_rotation.py @@ -67,6 +67,9 @@ class joint_relative_rotation(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 68bc83d883..c26511305e 100644 --- a/src/ansys/dpf/core/operators/result/joint_relative_velocity.py +++ b/src/ansys/dpf/core/operators/result/joint_relative_velocity.py @@ -67,6 +67,9 @@ class joint_relative_velocity(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/kinetic_energy.py b/src/ansys/dpf/core/operators/result/kinetic_energy.py index 412931ded9..611682f0ff 100644 --- a/src/ansys/dpf/core/operators/result/kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/kinetic_energy.py @@ -67,6 +67,9 @@ class kinetic_energy(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/mach_number.py b/src/ansys/dpf/core/operators/result/mach_number.py index 9135b60b11..4c219f4aaa 100644 --- a/src/ansys/dpf/core/operators/result/mach_number.py +++ b/src/ansys/dpf/core/operators/result/mach_number.py @@ -68,6 +68,9 @@ class mach_number(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 33676b8ff1..e05f310d00 100644 --- a/src/ansys/dpf/core/operators/result/mapdl_material_properties.py +++ b/src/ansys/dpf/core/operators/result/mapdl_material_properties.py @@ -35,6 +35,9 @@ class mapdl_material_properties(Operator): streams_container : StreamsContainer data_sources : DataSources + Returns + ------- + properties_value : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/mapdl_section.py b/src/ansys/dpf/core/operators/result/mapdl_section.py index 2d320cec42..15d90f6f76 100644 --- a/src/ansys/dpf/core/operators/result/mapdl_section.py +++ b/src/ansys/dpf/core/operators/result/mapdl_section.py @@ -33,6 +33,12 @@ class mapdl_section(Operator): Array with layers requested for the section. default = alllayers. + Returns + ------- + properties_value : FieldsContainer + layers_per_section : PropertyField + Only available if layer_property option is + set to true. Examples -------- 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 d200509511..26a84f3faa 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 @@ -47,6 +47,10 @@ class mapdl_split_on_facet_indices(Operator): volume_mesh : MeshedRegion The solid support. + Returns + ------- + fields_container : FieldsContainer + Output splitted fields containter Examples -------- 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 2c169e0ea8..d69850c0f9 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 @@ -35,6 +35,10 @@ class mapdl_split_to_acmo_facet_indices(Operator): should be the same as the scoping of the corresponding field in input 0. + Returns + ------- + fields_container : FieldsContainer + Output splitted fields containter Examples -------- 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 ca1f1ad00b..03ebb4b60c 100644 --- a/src/ansys/dpf/core/operators/result/mass_flow_rate.py +++ b/src/ansys/dpf/core/operators/result/mass_flow_rate.py @@ -68,6 +68,9 @@ class mass_flow_rate(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/mass_fraction.py b/src/ansys/dpf/core/operators/result/mass_fraction.py index a08983704c..ebfcb29eaa 100644 --- a/src/ansys/dpf/core/operators/result/mass_fraction.py +++ b/src/ansys/dpf/core/operators/result/mass_fraction.py @@ -68,6 +68,9 @@ class mass_fraction(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 4af983e517..73567b8035 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,6 +20,10 @@ class material_property_of_element(Operator): streams_container : StreamsContainer, optional data_sources : DataSources + Returns + ------- + material_properties : Field + Material properties Examples -------- 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 36c1b72526..17bd1b7d48 100644 --- a/src/ansys/dpf/core/operators/result/mean_static_pressure.py +++ b/src/ansys/dpf/core/operators/result/mean_static_pressure.py @@ -69,6 +69,9 @@ class mean_static_pressure(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/mean_temperature.py b/src/ansys/dpf/core/operators/result/mean_temperature.py index 75607a7798..37640f7285 100644 --- a/src/ansys/dpf/core/operators/result/mean_temperature.py +++ b/src/ansys/dpf/core/operators/result/mean_temperature.py @@ -69,6 +69,9 @@ class mean_temperature(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/mean_velocity.py b/src/ansys/dpf/core/operators/result/mean_velocity.py index 76dcdb7762..4359e0adc5 100644 --- a/src/ansys/dpf/core/operators/result/mean_velocity.py +++ b/src/ansys/dpf/core/operators/result/mean_velocity.py @@ -68,6 +68,9 @@ class mean_velocity(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 6b6b885e5c..1975080c1d 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 @@ -56,6 +56,18 @@ class members_in_bending_not_certified(Operator): Fields container of bending moment on axis z defined by user + Returns + ------- + 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. + buckling_resistance_bending_zz : FieldsContainer + Fields container of buckling resistance + factor on axis z-z in case of + bending(m). these factors should be + less than 1 and positive. Examples -------- 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 8e18760115..0c2d803b7d 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 @@ -57,6 +57,18 @@ class members_in_compression_not_certified(Operator): define its fabrication type. true: rolled section, false: welded section + Returns + ------- + 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. + buckling_resistance_compression_zz : FieldsContainer + Fields container of buckling resistance + factor on axis z-z in case of + compression. these factors should be + less than 1 and positive. Examples -------- 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 e62f00fa04..e1cc55f338 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 @@ -74,6 +74,14 @@ class members_in_linear_compression_bending_not_certified(Operator): rolled section, false: welded section. default: rolled section. + Returns + ------- + 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. Examples -------- 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 c91bfbd808..2bc91d1899 100644 --- a/src/ansys/dpf/core/operators/result/migrate_to_h5dpf.py +++ b/src/ansys/dpf/core/operators/result/migrate_to_h5dpf.py @@ -66,6 +66,9 @@ class migrate_to_h5dpf(Operator): map a filtering workflow to a result name. + Returns + ------- + migrated_file : DataSources Examples -------- diff --git a/src/ansys/dpf/core/operators/result/modal_basis.py b/src/ansys/dpf/core/operators/result/modal_basis.py index fa89dae923..4aef2f2b19 100644 --- a/src/ansys/dpf/core/operators/result/modal_basis.py +++ b/src/ansys/dpf/core/operators/result/modal_basis.py @@ -67,6 +67,9 @@ class modal_basis(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/nmisc.py b/src/ansys/dpf/core/operators/result/nmisc.py index b72236f9c1..133e14252a 100644 --- a/src/ansys/dpf/core/operators/result/nmisc.py +++ b/src/ansys/dpf/core/operators/result/nmisc.py @@ -73,6 +73,9 @@ class nmisc(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/nodal_force.py b/src/ansys/dpf/core/operators/result/nodal_force.py index 93ceaa6101..cb1842e225 100644 --- a/src/ansys/dpf/core/operators/result/nodal_force.py +++ b/src/ansys/dpf/core/operators/result/nodal_force.py @@ -67,6 +67,9 @@ class nodal_force(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/nodal_moment.py b/src/ansys/dpf/core/operators/result/nodal_moment.py index a347cafcbf..d7563b335c 100644 --- a/src/ansys/dpf/core/operators/result/nodal_moment.py +++ b/src/ansys/dpf/core/operators/result/nodal_moment.py @@ -67,6 +67,9 @@ class nodal_moment(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 f04dd6aa44..2414fb2d83 100644 --- a/src/ansys/dpf/core/operators/result/nodal_to_global.py +++ b/src/ansys/dpf/core/operators/result/nodal_to_global.py @@ -24,6 +24,10 @@ class nodal_to_global(Operator): file. those must be the rotations from nodal to global. + Returns + ------- + field : Field + Rotated field Examples -------- 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 5629ccf0ff..eaa1a30649 100644 --- a/src/ansys/dpf/core/operators/result/normal_contact_force.py +++ b/src/ansys/dpf/core/operators/result/normal_contact_force.py @@ -67,6 +67,9 @@ class normal_contact_force(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1d506cbc79..a7f8ff9db8 100644 --- a/src/ansys/dpf/core/operators/result/normal_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/normal_contact_moment.py @@ -67,6 +67,9 @@ class normal_contact_moment(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 496c82d1ca..772369a135 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 @@ -92,6 +92,9 @@ class num_surface_status_changes(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/omega.py b/src/ansys/dpf/core/operators/result/omega.py index 3e34da2bd4..6262423968 100644 --- a/src/ansys/dpf/core/operators/result/omega.py +++ b/src/ansys/dpf/core/operators/result/omega.py @@ -69,6 +69,9 @@ class omega(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 7eae5a192d..ed0c524390 100644 --- a/src/ansys/dpf/core/operators/result/part_added_mass.py +++ b/src/ansys/dpf/core/operators/result/part_added_mass.py @@ -32,6 +32,9 @@ class part_added_mass(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bfba1d712d..c1ad151a27 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 @@ -32,6 +32,9 @@ class part_eroded_internal_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 31720a8495..430dce1a08 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 @@ -32,6 +32,9 @@ class part_eroded_kinetic_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d0c8a31a03..2c65fb537e 100644 --- a/src/ansys/dpf/core/operators/result/part_hourglass_energy.py +++ b/src/ansys/dpf/core/operators/result/part_hourglass_energy.py @@ -32,6 +32,9 @@ class part_hourglass_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5352a6ee88..09497c26c2 100644 --- a/src/ansys/dpf/core/operators/result/part_internal_energy.py +++ b/src/ansys/dpf/core/operators/result/part_internal_energy.py @@ -32,6 +32,9 @@ class part_internal_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 3a29e6df27..2c014ac0df 100644 --- a/src/ansys/dpf/core/operators/result/part_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/part_kinetic_energy.py @@ -32,6 +32,9 @@ class part_kinetic_energy(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/part_momentum.py b/src/ansys/dpf/core/operators/result/part_momentum.py index b4758a983f..5457a6e82b 100644 --- a/src/ansys/dpf/core/operators/result/part_momentum.py +++ b/src/ansys/dpf/core/operators/result/part_momentum.py @@ -32,6 +32,9 @@ class part_momentum(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 37d2d92541..2f3fbd3720 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 @@ -32,6 +32,9 @@ class part_rigid_body_velocity(Operator): list of base unit strings (str) or unitsystem instance + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 c4aaf512f6..8a37669f8b 100644 --- a/src/ansys/dpf/core/operators/result/plastic_state_variable.py +++ b/src/ansys/dpf/core/operators/result/plastic_state_variable.py @@ -92,6 +92,9 @@ class plastic_state_variable(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/plastic_strain.py b/src/ansys/dpf/core/operators/result/plastic_strain.py index f61ac1d59c..d4a84720d0 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain.py @@ -92,6 +92,9 @@ class plastic_strain(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5f28963de7..c3e4fd8789 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_X.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_X.py @@ -75,6 +75,9 @@ class plastic_strain_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 fdb9dd804f..240a8e528d 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_XY.py @@ -75,6 +75,9 @@ class plastic_strain_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b558316060..f940a985dd 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_XZ.py @@ -75,6 +75,9 @@ class plastic_strain_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 787bd74ffb..7e33c5c4eb 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_Y.py @@ -75,6 +75,9 @@ class plastic_strain_Y(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 47fe076725..c5882181e7 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_YZ.py @@ -75,6 +75,9 @@ class plastic_strain_YZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 3324643705..9605786d2e 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_Z.py @@ -75,6 +75,9 @@ class plastic_strain_Z(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 0f37c75c20..618a18a4b3 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 @@ -92,6 +92,9 @@ class plastic_strain_energy_density(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 314b337e7e..07cb9469c3 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_eqv.py @@ -92,6 +92,9 @@ class plastic_strain_eqv(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 869914fc10..1ea53ac65a 100644 --- a/src/ansys/dpf/core/operators/result/plastic_strain_intensity.py +++ b/src/ansys/dpf/core/operators/result/plastic_strain_intensity.py @@ -71,6 +71,9 @@ class plastic_strain_intensity(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 384d8f550a..27d4ecb52c 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 @@ -71,6 +71,9 @@ class plastic_strain_max_shear(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 078d1221b9..4f1e37997e 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 @@ -73,6 +73,9 @@ class plastic_strain_principal_1(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e3cebbf096..92a5ee33e4 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 @@ -73,6 +73,9 @@ class plastic_strain_principal_2(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 bcc15d490f..96d4b0fe31 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 @@ -73,6 +73,9 @@ class plastic_strain_principal_3(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 f0945a3348..21414d0e62 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 @@ -22,6 +22,9 @@ class plastic_strain_rotation_by_euler_nodes(Operator): Dataprocessing::Crstfilewrapper, optional data_sources : DataSources + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/poynting_vector.py b/src/ansys/dpf/core/operators/result/poynting_vector.py index 7e9e3e3022..049ad4fcdd 100644 --- a/src/ansys/dpf/core/operators/result/poynting_vector.py +++ b/src/ansys/dpf/core/operators/result/poynting_vector.py @@ -28,6 +28,9 @@ class poynting_vector(Operator): poynting vector is computed only on the substeps of this step + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 258481d0fe..c7f531e83b 100644 --- a/src/ansys/dpf/core/operators/result/poynting_vector_surface.py +++ b/src/ansys/dpf/core/operators/result/poynting_vector_surface.py @@ -28,6 +28,9 @@ class poynting_vector_surface(Operator): poynting vector is computed only on the substeps of this step + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1a313aa8aa..a15a7c233b 100644 --- a/src/ansys/dpf/core/operators/result/pres_to_field.py +++ b/src/ansys/dpf/core/operators/result/pres_to_field.py @@ -21,6 +21,9 @@ class pres_to_field(Operator): columns_to_read : int, optional Columns_to_read + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/result/pressure.py b/src/ansys/dpf/core/operators/result/pressure.py index 1b2a79fb3b..03893316e6 100644 --- a/src/ansys/dpf/core/operators/result/pressure.py +++ b/src/ansys/dpf/core/operators/result/pressure.py @@ -67,6 +67,9 @@ class pressure(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 cf8e06caf3..067af31507 100644 --- a/src/ansys/dpf/core/operators/result/prns_to_field.py +++ b/src/ansys/dpf/core/operators/result/prns_to_field.py @@ -21,6 +21,9 @@ class prns_to_field(Operator): columns_to_read : int, optional Columns_to_read + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/result/raw_displacement.py b/src/ansys/dpf/core/operators/result/raw_displacement.py index 62fe9cdc22..c9a558fa65 100644 --- a/src/ansys/dpf/core/operators/result/raw_displacement.py +++ b/src/ansys/dpf/core/operators/result/raw_displacement.py @@ -67,6 +67,9 @@ class raw_displacement(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b694b15b40..5a54a2991e 100644 --- a/src/ansys/dpf/core/operators/result/raw_reaction_force.py +++ b/src/ansys/dpf/core/operators/result/raw_reaction_force.py @@ -67,6 +67,9 @@ class raw_reaction_force(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/reaction_force.py b/src/ansys/dpf/core/operators/result/reaction_force.py index 68f87d50b2..c0c255310e 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force.py +++ b/src/ansys/dpf/core/operators/result/reaction_force.py @@ -67,6 +67,9 @@ class reaction_force(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 2ecef1e5ca..bbe1e252a6 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force_X.py +++ b/src/ansys/dpf/core/operators/result/reaction_force_X.py @@ -67,6 +67,9 @@ class reaction_force_X(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 f56684ecc3..142527f83e 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force_Y.py +++ b/src/ansys/dpf/core/operators/result/reaction_force_Y.py @@ -67,6 +67,9 @@ class reaction_force_Y(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 fd36ab3948..cf1eef0a64 100644 --- a/src/ansys/dpf/core/operators/result/reaction_force_Z.py +++ b/src/ansys/dpf/core/operators/result/reaction_force_Z.py @@ -67,6 +67,9 @@ class reaction_force_Z(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 cbc2b072c6..61d02acc50 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 @@ -20,6 +20,35 @@ class read_cms_rbd_file(Operator): File name with cms_rbd extension where to read the input cms_rbd file. + Returns + ------- + model_data : PropertyField + Data describing the finite element model + center_of_mass : Field + Center of mass of the body + inertia_relief : Field + Inertia matrix + model_size : PropertyField + master_node_coordinates : + v_trsf : + Translational and rotational shape functions + k_mat : Field + mass_mat : Field + c_mat : Field + rhs : Field + dn : + dr_cross_n : + drn : + dn_cross_n : + dnx_y : + dny_y : + dnz_y : + dyx_n : + dyy_n : + dyz_n : + dnxn : + dnyn : + dnzn : Examples -------- 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 806d8c5285..bab8c4ab9e 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 @@ -19,6 +19,9 @@ class recombine_harmonic_indeces_cyclic(Operator): ---------- fields_container : FieldsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 73bc35b26c..8b8b2f6288 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 @@ -26,6 +26,15 @@ class remove_rigid_body_motion(Operator): mesh : MeshedRegion, optional Default is the mesh in the support + Returns + ------- + field : Field + translation_field : Field + Global rigid translation vector + rotation_field : Field + Global rigid rotation angles + center_field : Field + Center of the rigid rotation Examples -------- 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 fa6665d45d..0b37a8334f 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 @@ -26,6 +26,15 @@ class remove_rigid_body_motion_fc(Operator): mesh : MeshedRegion, optional Default is the mesh in the support + Returns + ------- + fields_container : FieldsContainer + translation_field : Field + Global rigid translation vector + rotation_field : Field + Global rigid rotation angles + center_field : Field + Center of the rigid rotation Examples -------- diff --git a/src/ansys/dpf/core/operators/result/rigid_transformation.py b/src/ansys/dpf/core/operators/result/rigid_transformation.py index 8bd4c0bb32..5baccf768a 100644 --- a/src/ansys/dpf/core/operators/result/rigid_transformation.py +++ b/src/ansys/dpf/core/operators/result/rigid_transformation.py @@ -22,6 +22,9 @@ class rigid_transformation(Operator): If the stream is null, retrieves the file path from the data sources. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d5aea30949..912ca55d92 100644 --- a/src/ansys/dpf/core/operators/result/rigid_transformation_provider.py +++ b/src/ansys/dpf/core/operators/result/rigid_transformation_provider.py @@ -21,6 +21,9 @@ class rigid_transformation_provider(Operator): data_sources : DataSources Data source of dsub file. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 0862d245fb..2e1c6b16c1 100644 --- a/src/ansys/dpf/core/operators/result/rms_static_pressure.py +++ b/src/ansys/dpf/core/operators/result/rms_static_pressure.py @@ -69,6 +69,9 @@ class rms_static_pressure(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/rms_temperature.py b/src/ansys/dpf/core/operators/result/rms_temperature.py index f73c023b80..2c6b8af5aa 100644 --- a/src/ansys/dpf/core/operators/result/rms_temperature.py +++ b/src/ansys/dpf/core/operators/result/rms_temperature.py @@ -69,6 +69,9 @@ class rms_temperature(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/rms_velocity.py b/src/ansys/dpf/core/operators/result/rms_velocity.py index ff766eceb5..90c35e08a4 100644 --- a/src/ansys/dpf/core/operators/result/rms_velocity.py +++ b/src/ansys/dpf/core/operators/result/rms_velocity.py @@ -68,6 +68,9 @@ class rms_velocity(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 fd2da8f945..785d5b3001 100644 --- a/src/ansys/dpf/core/operators/result/rom_data_provider.py +++ b/src/ansys/dpf/core/operators/result/rom_data_provider.py @@ -40,6 +40,30 @@ class rom_data_provider(Operator): Fieldscontainers containing the customized mode shapes + Returns + ------- + rom_matrices : FieldsContainer + Fieldscontainers containing the reduced + matrices + mode_shapes : FieldsContainer + Fieldscontainers containing the mode shapes, + which are cst and nor for the cms + method + lumped_mass : FieldsContainer + Fieldscontainers containing the lumped mass + model_data : PropertyField + Data describing the finite element model + center_of_mass : PropertyField + inertia_relief : Field + Inertia matrix + model_size : float + Size of the model + field_coordinates_and_euler_angles : float + Coordinates and euler angles of all nodes + nod : + Ids of master nodes + meshed_region : MeshedRegion + Expanded meshed region. Examples -------- diff --git a/src/ansys/dpf/core/operators/result/run.py b/src/ansys/dpf/core/operators/result/run.py index c10abb56e5..326dc759d9 100644 --- a/src/ansys/dpf/core/operators/result/run.py +++ b/src/ansys/dpf/core/operators/result/run.py @@ -30,6 +30,17 @@ class run(Operator): server inside mapdl to interact with mapdl using dpf client api + Returns + ------- + data_sources : DataSources + Returns the data source if the server_mode + pin is not set to yes + ip : str + Returns the ip if the server_mode pin is set + to yes + port : str + Returns a port when the server mode pin is + set to yes Examples -------- diff --git a/src/ansys/dpf/core/operators/result/smisc.py b/src/ansys/dpf/core/operators/result/smisc.py index da098dfe93..29259928ed 100644 --- a/src/ansys/dpf/core/operators/result/smisc.py +++ b/src/ansys/dpf/core/operators/result/smisc.py @@ -75,6 +75,9 @@ class smisc(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/specific_heat.py b/src/ansys/dpf/core/operators/result/specific_heat.py index 696f312ca4..b1d0921891 100644 --- a/src/ansys/dpf/core/operators/result/specific_heat.py +++ b/src/ansys/dpf/core/operators/result/specific_heat.py @@ -68,6 +68,9 @@ class specific_heat(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/spectrum_data.py b/src/ansys/dpf/core/operators/result/spectrum_data.py index 42871e9550..93575436b9 100644 --- a/src/ansys/dpf/core/operators/result/spectrum_data.py +++ b/src/ansys/dpf/core/operators/result/spectrum_data.py @@ -20,6 +20,11 @@ class spectrum_data(Operator): Data_sources (must contain at least one mode file). + Returns + ------- + participation_factors : FieldsContainer + Fields container containing participation + factors. Examples -------- diff --git a/src/ansys/dpf/core/operators/result/static_pressure.py b/src/ansys/dpf/core/operators/result/static_pressure.py index ceab590d0c..ffe675d631 100644 --- a/src/ansys/dpf/core/operators/result/static_pressure.py +++ b/src/ansys/dpf/core/operators/result/static_pressure.py @@ -69,6 +69,9 @@ class static_pressure(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 a57c3583c9..75fc1677ea 100644 --- a/src/ansys/dpf/core/operators/result/stiffness_matrix_energy.py +++ b/src/ansys/dpf/core/operators/result/stiffness_matrix_energy.py @@ -67,6 +67,9 @@ class stiffness_matrix_energy(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 109258e6aa..852486ee89 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 @@ -49,6 +49,10 @@ class strain_eqv_as_mechanical(Operator): averaged across bodies if true or not if false (default). + Returns + ------- + fields_container : FieldsContainer + meshes_container : MeshesContainer Examples -------- 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 2f1e6d81a4..50022a0220 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 @@ -47,6 +47,9 @@ class strain_eqv_as_mechanical_workflow(Operator): averaged across bodies if true or not if false (default). + Returns + ------- + workflow : Workflow Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress.py b/src/ansys/dpf/core/operators/result/stress.py index 66f6e4fd34..d4f386a34a 100644 --- a/src/ansys/dpf/core/operators/result/stress.py +++ b/src/ansys/dpf/core/operators/result/stress.py @@ -92,6 +92,9 @@ class stress(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_X.py b/src/ansys/dpf/core/operators/result/stress_X.py index 41df2f687a..40951299e5 100644 --- a/src/ansys/dpf/core/operators/result/stress_X.py +++ b/src/ansys/dpf/core/operators/result/stress_X.py @@ -74,6 +74,9 @@ class stress_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_XY.py b/src/ansys/dpf/core/operators/result/stress_XY.py index 27cf887232..cf936dbd27 100644 --- a/src/ansys/dpf/core/operators/result/stress_XY.py +++ b/src/ansys/dpf/core/operators/result/stress_XY.py @@ -74,6 +74,9 @@ class stress_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_XZ.py b/src/ansys/dpf/core/operators/result/stress_XZ.py index dd8c67793c..9f23335a50 100644 --- a/src/ansys/dpf/core/operators/result/stress_XZ.py +++ b/src/ansys/dpf/core/operators/result/stress_XZ.py @@ -74,6 +74,9 @@ class stress_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_Y.py b/src/ansys/dpf/core/operators/result/stress_Y.py index ab9e5aec28..38f0cf73fd 100644 --- a/src/ansys/dpf/core/operators/result/stress_Y.py +++ b/src/ansys/dpf/core/operators/result/stress_Y.py @@ -74,6 +74,9 @@ class stress_Y(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_YZ.py b/src/ansys/dpf/core/operators/result/stress_YZ.py index 74c3f29221..27bfdd35c7 100644 --- a/src/ansys/dpf/core/operators/result/stress_YZ.py +++ b/src/ansys/dpf/core/operators/result/stress_YZ.py @@ -74,6 +74,9 @@ class stress_YZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_Z.py b/src/ansys/dpf/core/operators/result/stress_Z.py index 4307651428..8a29b3dccd 100644 --- a/src/ansys/dpf/core/operators/result/stress_Z.py +++ b/src/ansys/dpf/core/operators/result/stress_Z.py @@ -74,6 +74,9 @@ class stress_Z(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b26ff16ded..feecdea557 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 @@ -46,6 +46,10 @@ class stress_eqv_as_mechanical(Operator): averaged across bodies if true or not if false (default). + Returns + ------- + fields_container : FieldsContainer + meshes_container : MeshesContainer Examples -------- 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 043e05aa8d..3cdaee738f 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 @@ -47,6 +47,9 @@ class stress_eqv_as_mechanical_workflow(Operator): averaged across bodies if true or not if false (default). + Returns + ------- + workflow : Workflow Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_intensity.py b/src/ansys/dpf/core/operators/result/stress_intensity.py index e620eebcb6..490126e42d 100644 --- a/src/ansys/dpf/core/operators/result/stress_intensity.py +++ b/src/ansys/dpf/core/operators/result/stress_intensity.py @@ -71,6 +71,9 @@ class stress_intensity(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 de8bca1493..6b1104cb87 100644 --- a/src/ansys/dpf/core/operators/result/stress_max_shear.py +++ b/src/ansys/dpf/core/operators/result/stress_max_shear.py @@ -71,6 +71,9 @@ class stress_max_shear(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 4bd40a2be8..ca88fa0faa 100644 --- a/src/ansys/dpf/core/operators/result/stress_principal_1.py +++ b/src/ansys/dpf/core/operators/result/stress_principal_1.py @@ -72,6 +72,9 @@ class stress_principal_1(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 39809eafd0..831233c8bc 100644 --- a/src/ansys/dpf/core/operators/result/stress_principal_2.py +++ b/src/ansys/dpf/core/operators/result/stress_principal_2.py @@ -72,6 +72,9 @@ class stress_principal_2(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 8cb2dbd602..d92f77b077 100644 --- a/src/ansys/dpf/core/operators/result/stress_principal_3.py +++ b/src/ansys/dpf/core/operators/result/stress_principal_3.py @@ -72,6 +72,9 @@ class stress_principal_3(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/stress_ratio.py b/src/ansys/dpf/core/operators/result/stress_ratio.py index a6586cd06a..adffcc8935 100644 --- a/src/ansys/dpf/core/operators/result/stress_ratio.py +++ b/src/ansys/dpf/core/operators/result/stress_ratio.py @@ -92,6 +92,9 @@ class stress_ratio(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 4588fc64af..17698920e9 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 @@ -22,6 +22,9 @@ class stress_rotation_by_euler_nodes(Operator): Dataprocessing::Crstfilewrapper, optional data_sources : DataSources + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 58f059dfb3..60a1480534 100644 --- a/src/ansys/dpf/core/operators/result/stress_von_mises.py +++ b/src/ansys/dpf/core/operators/result/stress_von_mises.py @@ -71,6 +71,9 @@ class stress_von_mises(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/structural_temperature.py b/src/ansys/dpf/core/operators/result/structural_temperature.py index 7ef7619d5d..70360759c1 100644 --- a/src/ansys/dpf/core/operators/result/structural_temperature.py +++ b/src/ansys/dpf/core/operators/result/structural_temperature.py @@ -92,6 +92,9 @@ class structural_temperature(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/superficial_velocity.py b/src/ansys/dpf/core/operators/result/superficial_velocity.py index 4bf20f7cdb..bb6fabcb65 100644 --- a/src/ansys/dpf/core/operators/result/superficial_velocity.py +++ b/src/ansys/dpf/core/operators/result/superficial_velocity.py @@ -69,6 +69,9 @@ class superficial_velocity(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 0f1c26c388..0c04e546c7 100644 --- a/src/ansys/dpf/core/operators/result/surface_heat_rate.py +++ b/src/ansys/dpf/core/operators/result/surface_heat_rate.py @@ -69,6 +69,9 @@ class surface_heat_rate(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/swelling_strains.py b/src/ansys/dpf/core/operators/result/swelling_strains.py index a00ff6e2dd..5c6ae73c45 100644 --- a/src/ansys/dpf/core/operators/result/swelling_strains.py +++ b/src/ansys/dpf/core/operators/result/swelling_strains.py @@ -92,6 +92,9 @@ class swelling_strains(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 5fe91c68c7..f5e94f9f8f 100644 --- a/src/ansys/dpf/core/operators/result/tangential_contact_force.py +++ b/src/ansys/dpf/core/operators/result/tangential_contact_force.py @@ -67,6 +67,9 @@ class tangential_contact_force(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 32b3493386..66dac44196 100644 --- a/src/ansys/dpf/core/operators/result/tangential_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/tangential_contact_moment.py @@ -67,6 +67,9 @@ class tangential_contact_moment(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/temperature.py b/src/ansys/dpf/core/operators/result/temperature.py index 13ec635464..ea793b8a7f 100644 --- a/src/ansys/dpf/core/operators/result/temperature.py +++ b/src/ansys/dpf/core/operators/result/temperature.py @@ -81,6 +81,9 @@ class temperature(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/temperature_grad.py b/src/ansys/dpf/core/operators/result/temperature_grad.py index e86a5df6a2..5d2539b2f6 100644 --- a/src/ansys/dpf/core/operators/result/temperature_grad.py +++ b/src/ansys/dpf/core/operators/result/temperature_grad.py @@ -92,6 +92,9 @@ class temperature_grad(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/thermal_conductivity.py b/src/ansys/dpf/core/operators/result/thermal_conductivity.py index a0cd4e9060..c337654d8b 100644 --- a/src/ansys/dpf/core/operators/result/thermal_conductivity.py +++ b/src/ansys/dpf/core/operators/result/thermal_conductivity.py @@ -69,6 +69,9 @@ class thermal_conductivity(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d9a29af5d0..567ceb75e0 100644 --- a/src/ansys/dpf/core/operators/result/thermal_dissipation_energy.py +++ b/src/ansys/dpf/core/operators/result/thermal_dissipation_energy.py @@ -67,6 +67,9 @@ class thermal_dissipation_energy(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/thermal_strain.py b/src/ansys/dpf/core/operators/result/thermal_strain.py index 8f987aa39b..f8f9306145 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain.py @@ -92,6 +92,9 @@ class thermal_strain(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 e6f7779a41..5425596a99 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_X.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_X.py @@ -75,6 +75,9 @@ class thermal_strain_X(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 0c14f519b4..15aa1144f9 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_XY.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_XY.py @@ -75,6 +75,9 @@ class thermal_strain_XY(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 0e71c253e3..c27e92a2f3 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_XZ.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_XZ.py @@ -75,6 +75,9 @@ class thermal_strain_XZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 58f55a9a4e..b61fca1925 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_Y.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_Y.py @@ -75,6 +75,9 @@ class thermal_strain_Y(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1e72de566d..71dedef8a4 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_YZ.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_YZ.py @@ -75,6 +75,9 @@ class thermal_strain_YZ(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 466909a329..bde7f12ee8 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strain_Z.py +++ b/src/ansys/dpf/core/operators/result/thermal_strain_Z.py @@ -75,6 +75,9 @@ class thermal_strain_Z(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 616c2d0a0d..7567e7fe01 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 @@ -73,6 +73,9 @@ class thermal_strain_principal_1(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ae5119479a..cc822dbacb 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 @@ -73,6 +73,9 @@ class thermal_strain_principal_2(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 fe1301a18a..f00aeaca12 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 @@ -73,6 +73,9 @@ class thermal_strain_principal_3(Operator): Elemental nodal beam results are read if this pin is set to true (default is false) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 9d9f3fe50c..4d61b819fd 100644 --- a/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py +++ b/src/ansys/dpf/core/operators/result/thermal_strains_eqv.py @@ -92,6 +92,9 @@ class thermal_strains_eqv(Operator): layer is provided, results will be merged on this specific shell layer. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/thickness.py b/src/ansys/dpf/core/operators/result/thickness.py index c9d3229725..9122b1bc76 100644 --- a/src/ansys/dpf/core/operators/result/thickness.py +++ b/src/ansys/dpf/core/operators/result/thickness.py @@ -67,6 +67,9 @@ class thickness(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/torque.py b/src/ansys/dpf/core/operators/result/torque.py index 33912081ee..3c34b2a140 100644 --- a/src/ansys/dpf/core/operators/result/torque.py +++ b/src/ansys/dpf/core/operators/result/torque.py @@ -21,6 +21,9 @@ class torque(Operator): field : Field Field + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 b8dfef4823..0b4ae2aeca 100644 --- a/src/ansys/dpf/core/operators/result/total_contact_force.py +++ b/src/ansys/dpf/core/operators/result/total_contact_force.py @@ -67,6 +67,9 @@ class total_contact_force(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 50aa184b8a..d44caf99dc 100644 --- a/src/ansys/dpf/core/operators/result/total_contact_moment.py +++ b/src/ansys/dpf/core/operators/result/total_contact_moment.py @@ -67,6 +67,9 @@ class total_contact_moment(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/total_mass.py b/src/ansys/dpf/core/operators/result/total_mass.py index d36e4215c3..f8faf013c4 100644 --- a/src/ansys/dpf/core/operators/result/total_mass.py +++ b/src/ansys/dpf/core/operators/result/total_mass.py @@ -20,6 +20,10 @@ class total_mass(Operator): Data sources (must contain at least one mode file). + Returns + ------- + mass : float + The unit should be grabbed from the rst file Examples -------- diff --git a/src/ansys/dpf/core/operators/result/total_pressure.py b/src/ansys/dpf/core/operators/result/total_pressure.py index 80619a7101..0b3399d909 100644 --- a/src/ansys/dpf/core/operators/result/total_pressure.py +++ b/src/ansys/dpf/core/operators/result/total_pressure.py @@ -68,6 +68,9 @@ class total_pressure(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/total_strain.py b/src/ansys/dpf/core/operators/result/total_strain.py index 87a4384ab6..d81585bbe5 100644 --- a/src/ansys/dpf/core/operators/result/total_strain.py +++ b/src/ansys/dpf/core/operators/result/total_strain.py @@ -67,6 +67,9 @@ class total_strain(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/total_temperature.py b/src/ansys/dpf/core/operators/result/total_temperature.py index 88d9db6ead..b1a68897e6 100644 --- a/src/ansys/dpf/core/operators/result/total_temperature.py +++ b/src/ansys/dpf/core/operators/result/total_temperature.py @@ -69,6 +69,9 @@ class total_temperature(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 1807980490..5ebaa24206 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 @@ -50,6 +50,35 @@ class transform_invariant_terms_rbd(Operator): dnyn : dnzn : + Returns + ------- + model_data : PropertyField + Data describing the finite element model + center_of_mass : Field + Center of mass of the body + inertia_relief : Field + Inertia matrix + model_size : PropertyField + master_node_coordinates : + v_trsf : + Translational and rotational shape functions + k_mat : Field + mass_mat : Field + c_mat : Field + rhs : Field + dn : + dr_cross_n : + drn : + dn_cross_n : + dnx_y : + dny_y : + dnz_y : + dyx_n : + dyy_n : + dyz_n : + dnxn : + dnyn : + dnzn : Examples -------- 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 e4b786836f..aa7ed49a71 100644 --- a/src/ansys/dpf/core/operators/result/transient_rayleigh_integration.py +++ b/src/ansys/dpf/core/operators/result/transient_rayleigh_integration.py @@ -43,6 +43,9 @@ class transient_rayleigh_integration(Operator): default value of the speed of sound in the air is applied). + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ec775e8071..ab18c1bae7 100644 --- a/src/ansys/dpf/core/operators/result/turbulent_kinetic_energy.py +++ b/src/ansys/dpf/core/operators/result/turbulent_kinetic_energy.py @@ -69,6 +69,9 @@ class turbulent_kinetic_energy(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/turbulent_viscosity.py b/src/ansys/dpf/core/operators/result/turbulent_viscosity.py index 65f2b3df22..0ef2236065 100644 --- a/src/ansys/dpf/core/operators/result/turbulent_viscosity.py +++ b/src/ansys/dpf/core/operators/result/turbulent_viscosity.py @@ -69,6 +69,9 @@ class turbulent_viscosity(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/velocity.py b/src/ansys/dpf/core/operators/result/velocity.py index f8c4a31d12..be26da388c 100644 --- a/src/ansys/dpf/core/operators/result/velocity.py +++ b/src/ansys/dpf/core/operators/result/velocity.py @@ -81,6 +81,9 @@ class velocity(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/velocity_X.py b/src/ansys/dpf/core/operators/result/velocity_X.py index 4f10921062..4855700646 100644 --- a/src/ansys/dpf/core/operators/result/velocity_X.py +++ b/src/ansys/dpf/core/operators/result/velocity_X.py @@ -67,6 +67,9 @@ class velocity_X(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/velocity_Y.py b/src/ansys/dpf/core/operators/result/velocity_Y.py index 6408672c27..c3bf0277e3 100644 --- a/src/ansys/dpf/core/operators/result/velocity_Y.py +++ b/src/ansys/dpf/core/operators/result/velocity_Y.py @@ -67,6 +67,9 @@ class velocity_Y(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/velocity_Z.py b/src/ansys/dpf/core/operators/result/velocity_Z.py index 4507012744..2bec890e6c 100644 --- a/src/ansys/dpf/core/operators/result/velocity_Z.py +++ b/src/ansys/dpf/core/operators/result/velocity_Z.py @@ -67,6 +67,9 @@ class velocity_Z(Operator): done and stages are merged (default is 1) + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/result/volume_fraction.py b/src/ansys/dpf/core/operators/result/volume_fraction.py index f68929715c..726fd2cf45 100644 --- a/src/ansys/dpf/core/operators/result/volume_fraction.py +++ b/src/ansys/dpf/core/operators/result/volume_fraction.py @@ -69,6 +69,9 @@ class volume_fraction(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 deab678b5c..b030147ebd 100644 --- a/src/ansys/dpf/core/operators/result/wall_shear_stress.py +++ b/src/ansys/dpf/core/operators/result/wall_shear_stress.py @@ -69,6 +69,9 @@ class wall_shear_stress(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ca1d39cebf..35a22485c2 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 @@ -41,6 +41,16 @@ class workflow_energy_per_component(Operator): selections with the master scoping will be done. + Returns + ------- + component_energy : FieldsContainer + component_energy_percentage : FieldsContainer + component_total_energy : FieldsContainer, optional + component_total_energy_percentage : FieldsContainer, optional + component_strain_energy : FieldsContainer, optional + component_strain_energy_percentage : FieldsContainer, optional + component_kinetic_energy : FieldsContainer, optional + component_kinetic_energy_percentage : FieldsContainer, optional Examples -------- 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 0bc3b5f3f0..3a169afce0 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 @@ -27,6 +27,10 @@ class workflow_energy_per_harmonic(Operator): energy, 2: kinetic energy) data_sources : DataSources + Returns + ------- + harmonic_energy : FieldsContainer + harmonic_energy_percentage : FieldsContainer Examples -------- 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 6efe3d15f7..c31b13c92e 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 @@ -48,6 +48,11 @@ class write_cms_rbd_file(Operator): Path with cms_rbd extension where the export occurs + Returns + ------- + data_sources : DataSources + Data source containing the cms_rbd file + generated. Examples -------- 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 614f09aed6..b21fcdfd84 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 @@ -44,6 +44,11 @@ class write_motion_dfmf_file(Operator): export occurs rstfile_path : str + Returns + ------- + dfmf_data_source : DataSources + Data source containing the dfmf file + generated. Examples -------- diff --git a/src/ansys/dpf/core/operators/result/y_plus.py b/src/ansys/dpf/core/operators/result/y_plus.py index 582b296864..935d54b3f8 100644 --- a/src/ansys/dpf/core/operators/result/y_plus.py +++ b/src/ansys/dpf/core/operators/result/y_plus.py @@ -68,6 +68,9 @@ class y_plus(Operator): combination of zone, phases or species ids + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/change_fc.py b/src/ansys/dpf/core/operators/scoping/change_fc.py index c19e987537..2e54a5d653 100644 --- a/src/ansys/dpf/core/operators/scoping/change_fc.py +++ b/src/ansys/dpf/core/operators/scoping/change_fc.py @@ -20,6 +20,9 @@ class change_fc(Operator): field_or_fields_container : FieldsContainer or Field scopings_container : ScopingsContainer + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 9423ef3ba7..dbad8cead2 100644 --- a/src/ansys/dpf/core/operators/scoping/compute_element_centroids.py +++ b/src/ansys/dpf/core/operators/scoping/compute_element_centroids.py @@ -23,6 +23,14 @@ class compute_element_centroids(Operator): mesh : MeshedRegion Mesh to compute centroids + Returns + ------- + centroids : Field + Element centroids. + measure : Field + Element measure (length, surface or volume + depending on the dimension of the + element). Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/connectivity_ids.py b/src/ansys/dpf/core/operators/scoping/connectivity_ids.py index 3ca1487c77..8346758ffc 100644 --- a/src/ansys/dpf/core/operators/scoping/connectivity_ids.py +++ b/src/ansys/dpf/core/operators/scoping/connectivity_ids.py @@ -25,6 +25,13 @@ class connectivity_ids(Operator): take_mid_nodes : bool, optional Default is true + Returns + ------- + mesh_scoping : Scoping + elemental_scoping : Scoping + Same as the input scoping but with ids + duplicated to have the same size as + nodal output scoping Examples -------- 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 ecd6715f95..c6a6d5ffe4 100644 --- a/src/ansys/dpf/core/operators/scoping/elemental_from_mesh.py +++ b/src/ansys/dpf/core/operators/scoping/elemental_from_mesh.py @@ -19,6 +19,9 @@ class elemental_from_mesh(Operator): ---------- mesh : MeshedRegion + Returns + ------- + mesh_scoping : Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/from_mesh.py b/src/ansys/dpf/core/operators/scoping/from_mesh.py index 1a7707fbb1..f767d4238f 100644 --- a/src/ansys/dpf/core/operators/scoping/from_mesh.py +++ b/src/ansys/dpf/core/operators/scoping/from_mesh.py @@ -22,6 +22,9 @@ class from_mesh(Operator): scoping, possible locations are: nodal(default) or elemental + Returns + ------- + scoping : Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/intersect.py b/src/ansys/dpf/core/operators/scoping/intersect.py index 3e52ab265f..3908710c25 100644 --- a/src/ansys/dpf/core/operators/scoping/intersect.py +++ b/src/ansys/dpf/core/operators/scoping/intersect.py @@ -20,6 +20,10 @@ class intersect(Operator): scopingA : Scoping scopingB : Scoping + Returns + ------- + intersection : Scoping + scopingA_min_intersection : Scoping Examples -------- 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 90dba574c8..e6c6ad5315 100644 --- a/src/ansys/dpf/core/operators/scoping/nodal_from_mesh.py +++ b/src/ansys/dpf/core/operators/scoping/nodal_from_mesh.py @@ -19,6 +19,9 @@ class nodal_from_mesh(Operator): ---------- mesh : MeshedRegion + Returns + ------- + mesh_scoping : Scoping Examples -------- 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 ff3ec5dbfb..d35dc2756b 100644 --- a/src/ansys/dpf/core/operators/scoping/on_mesh_property.py +++ b/src/ansys/dpf/core/operators/scoping/on_mesh_property.py @@ -39,6 +39,10 @@ class on_mesh_property(Operator): on this property. mesh : MeshedRegion + Returns + ------- + mesh_scoping : Scoping + Scoping Examples -------- 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 6d138278d2..a9bd1d6e7d 100644 --- a/src/ansys/dpf/core/operators/scoping/on_named_selection.py +++ b/src/ansys/dpf/core/operators/scoping/on_named_selection.py @@ -30,6 +30,9 @@ class on_named_selection(Operator): streams_container : StreamsContainer, optional data_sources : DataSources + Returns + ------- + mesh_scoping : Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/on_property.py b/src/ansys/dpf/core/operators/scoping/on_property.py index b4ed8eddeb..b7b5bcb9f8 100644 --- a/src/ansys/dpf/core/operators/scoping/on_property.py +++ b/src/ansys/dpf/core/operators/scoping/on_property.py @@ -39,6 +39,10 @@ class on_property(Operator): nodes/faces in the scoping are included + Returns + ------- + mesh_scoping : Scoping + Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/reduce_sampling.py b/src/ansys/dpf/core/operators/scoping/reduce_sampling.py index b13150f931..02fd3e46d2 100644 --- a/src/ansys/dpf/core/operators/scoping/reduce_sampling.py +++ b/src/ansys/dpf/core/operators/scoping/reduce_sampling.py @@ -22,6 +22,9 @@ class reduce_sampling(Operator): (default is 2). must be integer value above 1. + Returns + ------- + mesh_scoping : Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/rescope.py b/src/ansys/dpf/core/operators/scoping/rescope.py index ed454e94ab..e081170b5d 100644 --- a/src/ansys/dpf/core/operators/scoping/rescope.py +++ b/src/ansys/dpf/core/operators/scoping/rescope.py @@ -25,6 +25,9 @@ class rescope(Operator): field are added with this default value. + Returns + ------- + fields : FieldsContainer or Field Examples -------- 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 6fc262b50f..1725e3737d 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 @@ -26,6 +26,9 @@ class rescope_custom_type_field(Operator): custom type field are added with this default value. + Returns + ------- + fields : CustomTypeFieldsContainer or CustomTypeField Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/rescope_fc.py b/src/ansys/dpf/core/operators/scoping/rescope_fc.py index a364352f4f..54a159d435 100644 --- a/src/ansys/dpf/core/operators/scoping/rescope_fc.py +++ b/src/ansys/dpf/core/operators/scoping/rescope_fc.py @@ -24,6 +24,9 @@ class rescope_fc(Operator): field are added with this default value. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 8efc0e5966..aafe12a637 100644 --- a/src/ansys/dpf/core/operators/scoping/rescope_property_field.py +++ b/src/ansys/dpf/core/operators/scoping/rescope_property_field.py @@ -26,6 +26,9 @@ class rescope_property_field(Operator): property field are added with this default value. + Returns + ------- + fields : PropertyFieldsContainer or PropertyField Examples -------- 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 e2d537ba79..960bf440e2 100644 --- a/src/ansys/dpf/core/operators/scoping/scoping_get_attribute.py +++ b/src/ansys/dpf/core/operators/scoping/scoping_get_attribute.py @@ -23,6 +23,12 @@ class scoping_get_attribute(Operator): Supported property names are: "ids", "location". + Returns + ------- + property : str + Returns a vector of int for property: "ids" + and a string for property: + "location". Examples -------- 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 a1591cc926..606bccc431 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 @@ -44,6 +44,10 @@ class split_on_property_type(Operator): in the mesh property fields) (default is 'elshape') + Returns + ------- + mesh_scoping : ScopingsContainer + Scoping Examples -------- diff --git a/src/ansys/dpf/core/operators/scoping/transpose.py b/src/ansys/dpf/core/operators/scoping/transpose.py index 4ae50b612d..17d60b8b15 100644 --- a/src/ansys/dpf/core/operators/scoping/transpose.py +++ b/src/ansys/dpf/core/operators/scoping/transpose.py @@ -37,6 +37,11 @@ class transpose(Operator): transpose to nodal, and nodal scopings transpose to elemental. + Returns + ------- + mesh_scoping : Scoping or ScopingsContainer + Scoping or scopings container (the input type + is the output type) Examples -------- 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 ae581ab476..40647111c4 100644 --- a/src/ansys/dpf/core/operators/serialization/csv_to_field.py +++ b/src/ansys/dpf/core/operators/serialization/csv_to_field.py @@ -21,6 +21,9 @@ class csv_to_field(Operator): Data sources containing a file with csv extension + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 89d43cb750..0fe6a63984 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,6 +20,9 @@ class data_tree_to_json(Operator): data_tree : DataTree path : str, optional + Returns + ------- + data_sources : DataSources or str Examples -------- 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 1b22d2b0ad..6c81ffe119 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,6 +20,9 @@ class data_tree_to_txt(Operator): data_tree : DataTree path : str, optional + Returns + ------- + data_sources : DataSources or str Examples -------- diff --git a/src/ansys/dpf/core/operators/serialization/deserializer.py b/src/ansys/dpf/core/operators/serialization/deserializer.py index 2aff08bde6..070a6ea53b 100644 --- a/src/ansys/dpf/core/operators/serialization/deserializer.py +++ b/src/ansys/dpf/core/operators/serialization/deserializer.py @@ -20,6 +20,14 @@ class deserializer(Operator): file_path : str File path + Returns + ------- + any_output1 : Any + Number and types of outputs corresponding of + the inputs used in the serialization + any_output2 : Any + Number and types of outputs corresponding of + the inputs used in the serialization Examples -------- 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 b2cf63c715..8f1293b98c 100644 --- a/src/ansys/dpf/core/operators/serialization/export_symbolic_workflow.py +++ b/src/ansys/dpf/core/operators/serialization/export_symbolic_workflow.py @@ -30,6 +30,9 @@ class export_symbolic_workflow(Operator): inputs and ouputs with their data. default is 7. + Returns + ------- + data_sources : DataSources or str Examples -------- 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 e70e404b81..f98c7f55ac 100644 --- a/src/ansys/dpf/core/operators/serialization/field_to_csv.py +++ b/src/ansys/dpf/core/operators/serialization/field_to_csv.py @@ -28,6 +28,8 @@ class field_to_csv(Operator): the csv can not be read by "csv to field" operator anymore. default : 0. + Returns + ------- 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 dbad37fec9..ab7b5ad481 100644 --- a/src/ansys/dpf/core/operators/serialization/hdf5dpf_custom_read.py +++ b/src/ansys/dpf/core/operators/serialization/hdf5dpf_custom_read.py @@ -30,6 +30,9 @@ class hdf5dpf_custom_read(Operator): Name of the result that must be extracted from the hdf5dpf file + Returns + ------- + field_or_fields_container : FieldsContainer or Field Examples -------- 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 7002814d19..c3958996c5 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 @@ -73,6 +73,11 @@ class hdf5dpf_generate_result_file(Operator): be a result) and connected sequentially. + Returns + ------- + data_sources : DataSources + Data_sources filed with the h5 generated file + path. Examples -------- 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 0ae07a534d..939eba4bd1 100644 --- a/src/ansys/dpf/core/operators/serialization/import_symbolic_workflow.py +++ b/src/ansys/dpf/core/operators/serialization/import_symbolic_workflow.py @@ -23,6 +23,9 @@ class import_symbolic_workflow(Operator): binary, 2 is json, default is -1 (auto-detection). + Returns + ------- + workflow : Workflow Examples -------- 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 cbe1953436..c23c865740 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 @@ -18,6 +18,9 @@ class json_to_data_tree(Operator): ---------- string_or_path : str or DataSources + Returns + ------- + data_tree : DataTree Examples -------- diff --git a/src/ansys/dpf/core/operators/serialization/mechanical_csv_to_field.py b/src/ansys/dpf/core/operators/serialization/mechanical_csv_to_field.py index 2b893cb279..11c3ef8c19 100644 --- a/src/ansys/dpf/core/operators/serialization/mechanical_csv_to_field.py +++ b/src/ansys/dpf/core/operators/serialization/mechanical_csv_to_field.py @@ -21,6 +21,9 @@ class mechanical_csv_to_field(Operator): data_sources : DataSources requested_location : str or FieldDefinition + Returns + ------- + field : Field Examples -------- 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 85847016b5..acc333f9f0 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 @@ -21,6 +21,10 @@ class migrate_file_to_vtk(Operator): streams_container : StreamsContainer, optional data_sources : DataSources, optional + Returns + ------- + data_sources : DataSources + Generated output vtk file Examples -------- 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 72f4d9b111..ef2eb60b8a 100644 --- a/src/ansys/dpf/core/operators/serialization/migrate_to_vtu.py +++ b/src/ansys/dpf/core/operators/serialization/migrate_to_vtu.py @@ -45,6 +45,10 @@ class migrate_to_vtu(Operator): base64appended, base64inline, ascii, default is (rawbinarycompressed) + Returns + ------- + path : DataSources + List of output vtu file path Examples -------- 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 80dbb1f7b9..de4c6744a1 100644 --- a/src/ansys/dpf/core/operators/serialization/serialize_to_hdf5.py +++ b/src/ansys/dpf/core/operators/serialization/serialize_to_hdf5.py @@ -33,6 +33,8 @@ class serialize_to_hdf5(Operator): Only the data set explicitly to export is exported + Returns + ------- Examples -------- diff --git a/src/ansys/dpf/core/operators/serialization/serializer.py b/src/ansys/dpf/core/operators/serialization/serializer.py index ab23777b45..e005a14b76 100644 --- a/src/ansys/dpf/core/operators/serialization/serializer.py +++ b/src/ansys/dpf/core/operators/serialization/serializer.py @@ -22,6 +22,9 @@ class serializer(Operator): any_input2 : Any Any input + Returns + ------- + file_path : str Examples -------- 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 bb254c5acb..bfb047d2ed 100644 --- a/src/ansys/dpf/core/operators/serialization/serializer_to_string.py +++ b/src/ansys/dpf/core/operators/serialization/serializer_to_string.py @@ -23,6 +23,9 @@ class serializer_to_string(Operator): any_input2 : Any Any input + Returns + ------- + serialized_string : str Examples -------- diff --git a/src/ansys/dpf/core/operators/serialization/string_deserializer.py b/src/ansys/dpf/core/operators/serialization/string_deserializer.py index f93810f3eb..312962533a 100644 --- a/src/ansys/dpf/core/operators/serialization/string_deserializer.py +++ b/src/ansys/dpf/core/operators/serialization/string_deserializer.py @@ -21,6 +21,14 @@ class string_deserializer(Operator): 0 for string (default), and 1 for binary serialized_string : str + Returns + ------- + any_output1 : Any + Number and types of outputs corresponding of + the inputs used in the serialization + any_output2 : Any + Number and types of outputs corresponding of + the inputs used in the serialization Examples -------- 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 8d9ec7c42e..2b9a2bc115 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 @@ -18,6 +18,9 @@ class txt_to_data_tree(Operator): ---------- string_or_path : str or DataSources + Returns + ------- + data_tree : DataTree Examples -------- diff --git a/src/ansys/dpf/core/operators/serialization/vtk_export.py b/src/ansys/dpf/core/operators/serialization/vtk_export.py index cf6fcfde25..281e5310a8 100644 --- a/src/ansys/dpf/core/operators/serialization/vtk_export.py +++ b/src/ansys/dpf/core/operators/serialization/vtk_export.py @@ -33,6 +33,8 @@ class vtk_export(Operator): fields2 : FieldsContainer or Field Fields exported + Returns + ------- 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 dadf734fb6..160a4a2eea 100644 --- a/src/ansys/dpf/core/operators/serialization/vtk_to_fields.py +++ b/src/ansys/dpf/core/operators/serialization/vtk_to_fields.py @@ -21,6 +21,10 @@ class vtk_to_fields(Operator): streams : StreamsContainer, optional data_sources : DataSources + Returns + ------- + fields_container : FieldsContainer + Fields_container Examples -------- diff --git a/src/ansys/dpf/core/operators/serialization/vtu_export.py b/src/ansys/dpf/core/operators/serialization/vtu_export.py index d727e38c97..ff45a59f0e 100644 --- a/src/ansys/dpf/core/operators/serialization/vtu_export.py +++ b/src/ansys/dpf/core/operators/serialization/vtu_export.py @@ -48,6 +48,10 @@ class vtu_export(Operator): mesh_properties : StringField, optional List of names of mesh properties to export. + Returns + ------- + path : DataSources + List of output vtu file path Examples -------- 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 e2dce70fa4..d05bc46396 100644 --- a/src/ansys/dpf/core/operators/server/grpc_shutdown_server.py +++ b/src/ansys/dpf/core/operators/server/grpc_shutdown_server.py @@ -19,6 +19,8 @@ class grpc_shutdown_server(Operator): grpc_stream : StreamsContainer Dpf streams handling the server + Returns + ------- 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 466857d495..fa9613c9ff 100644 --- a/src/ansys/dpf/core/operators/server/grpc_start_server.py +++ b/src/ansys/dpf/core/operators/server/grpc_start_server.py @@ -48,6 +48,12 @@ class grpc_start_server(Operator): string with the path of the xml specifying the context. + Returns + ------- + grpc_streams : StreamsContainer, optional + Dpf streams handling the server, if the + server is started in this thread, + then nothing is added in output Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/Workflow_to_PyDPF_Generator.py b/src/ansys/dpf/core/operators/utility/Workflow_to_PyDPF_Generator.py index 1ca7c15102..7e9140d83e 100644 --- a/src/ansys/dpf/core/operators/utility/Workflow_to_PyDPF_Generator.py +++ b/src/ansys/dpf/core/operators/utility/Workflow_to_PyDPF_Generator.py @@ -21,6 +21,9 @@ class Workflow_to_PyDPF_Generator(Operator): output_path : str, optional output_file_name : str, optional + Returns + ------- + pydpf_code : str Examples -------- 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 ebb35f28ca..362f9e1147 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 @@ -29,6 +29,9 @@ class assemble_scalars_to_matrices(Operator): zx : Field, optional symmetrical : bool, optional + Returns + ------- + field : Field Examples -------- 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 87f969c3a9..1cfe9c8489 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 @@ -29,6 +29,9 @@ class assemble_scalars_to_matrices_fc(Operator): zx : FieldsContainer, optional symmetrical : bool, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 21de9b317c..694eb8edd6 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 @@ -20,6 +20,9 @@ class assemble_scalars_to_vectors(Operator): y : Field, optional z : Field, optional + Returns + ------- + field : Field Examples -------- 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 1a53ff1d7f..550af5e23a 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 @@ -21,6 +21,9 @@ class assemble_scalars_to_vectors_fc(Operator): y : FieldsContainer, optional z : FieldsContainer, optional + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/bind_support.py b/src/ansys/dpf/core/operators/utility/bind_support.py index ab4969e584..875df1b5bb 100644 --- a/src/ansys/dpf/core/operators/utility/bind_support.py +++ b/src/ansys/dpf/core/operators/utility/bind_support.py @@ -22,6 +22,9 @@ class bind_support(Operator): support : MeshedRegion or AbstractFieldSupport Meshed region or a support of the field + Returns + ------- + field : Field Examples -------- 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 d2fc267cb1..0e6947a1c1 100644 --- a/src/ansys/dpf/core/operators/utility/bind_support_fc.py +++ b/src/ansys/dpf/core/operators/utility/bind_support_fc.py @@ -20,6 +20,9 @@ class bind_support_fc(Operator): support : MeshedRegion or AbstractFieldSupport or TimeFreqSupport Meshed region or a support of the field. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/change_location.py b/src/ansys/dpf/core/operators/utility/change_location.py index 33d2bdac87..60cf899357 100644 --- a/src/ansys/dpf/core/operators/utility/change_location.py +++ b/src/ansys/dpf/core/operators/utility/change_location.py @@ -21,6 +21,9 @@ class change_location(Operator): New location of the output field ex 'nodal', 'elementalnodal', 'elemental'... + Returns + ------- + field : Field Examples -------- 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 a4f693cb7f..29fc178ec0 100644 --- a/src/ansys/dpf/core/operators/utility/change_shell_layers.py +++ b/src/ansys/dpf/core/operators/utility/change_shell_layers.py @@ -39,6 +39,9 @@ class change_shell_layers(Operator): regarding the shell layer set in s_shell_layer pin (false by default). + Returns + ------- + fields_container : FieldsContainer or Field Examples -------- 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 2f1fb11fdb..295618f366 100644 --- a/src/ansys/dpf/core/operators/utility/compute_time_scoping.py +++ b/src/ansys/dpf/core/operators/utility/compute_time_scoping.py @@ -27,6 +27,12 @@ class compute_time_scoping(Operator): 1:ramped' or 2:stepped', default is ramped time_freq_support : TimeFreqSupport + Returns + ------- + scoping : Scoping + Time_scoping + field : Field + Time_freq_values Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/default_value.py b/src/ansys/dpf/core/operators/utility/default_value.py index 954d7c48e3..215d79d3b9 100644 --- a/src/ansys/dpf/core/operators/utility/default_value.py +++ b/src/ansys/dpf/core/operators/utility/default_value.py @@ -20,6 +20,9 @@ class default_value(Operator): forced_value : optional default_value : + Returns + ------- + output : Examples -------- 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 401a67cd5f..bc40ea3cd3 100644 --- a/src/ansys/dpf/core/operators/utility/delegate_to_operator.py +++ b/src/ansys/dpf/core/operators/utility/delegate_to_operator.py @@ -19,6 +19,12 @@ class delegate_to_operator(Operator): ---------- operator_name : str + Returns + ------- + any1 : Any + Inputs + any2 : Any + Inputs Examples -------- 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 b5f95cea6f..0cdf314c89 100644 --- a/src/ansys/dpf/core/operators/utility/ds_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/ds_get_attribute.py @@ -51,6 +51,10 @@ class ds_get_attribute(Operator): 'domain_file_path' and 'domain_result_file_name'. + Returns + ------- + property : str or int + Property value. Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/extract_field.py b/src/ansys/dpf/core/operators/utility/extract_field.py index b7b1ca41bc..c3790fd29f 100644 --- a/src/ansys/dpf/core/operators/utility/extract_field.py +++ b/src/ansys/dpf/core/operators/utility/extract_field.py @@ -23,6 +23,9 @@ class extract_field(Operator): indices : optional Default is the first field + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/extract_scoping.py b/src/ansys/dpf/core/operators/utility/extract_scoping.py index 12d2b430d7..de81f3c7a7 100644 --- a/src/ansys/dpf/core/operators/utility/extract_scoping.py +++ b/src/ansys/dpf/core/operators/utility/extract_scoping.py @@ -20,6 +20,9 @@ class extract_scoping(Operator): ---------- field_or_fields_container : Field or FieldsContainer, optional + Returns + ------- + mesh_scoping : Scoping or ScopingsContainer Examples -------- 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 0efd99b539..7b8fdb7d0d 100644 --- a/src/ansys/dpf/core/operators/utility/extract_sub_fc.py +++ b/src/ansys/dpf/core/operators/utility/extract_sub_fc.py @@ -31,6 +31,10 @@ class extract_sub_fc(Operator): container, otherwise, label space is kept. + Returns + ------- + fields_container : FieldsContainer + Fields_container Examples -------- 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 782042ad4b..cb2422c066 100644 --- a/src/ansys/dpf/core/operators/utility/extract_sub_mc.py +++ b/src/ansys/dpf/core/operators/utility/extract_sub_mc.py @@ -31,6 +31,10 @@ class extract_sub_mc(Operator): container, otherwise, label space is kept. + Returns + ------- + meshes_container : MeshesContainer + Meshes Examples -------- 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 1a139e62b9..913ca77e69 100644 --- a/src/ansys/dpf/core/operators/utility/extract_sub_sc.py +++ b/src/ansys/dpf/core/operators/utility/extract_sub_sc.py @@ -31,6 +31,10 @@ class extract_sub_sc(Operator): container, otherwise, label space is kept. + Returns + ------- + scopings_container : ScopingsContainer + Scopings_container Examples -------- 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 624468549f..6fdc0c93d7 100644 --- a/src/ansys/dpf/core/operators/utility/extract_time_freq.py +++ b/src/ansys/dpf/core/operators/utility/extract_time_freq.py @@ -23,6 +23,9 @@ class extract_time_freq(Operator): False for real only (default). true for complex output. + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 6d771d1ef5..03633c76a6 100644 --- a/src/ansys/dpf/core/operators/utility/fc_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/fc_get_attribute.py @@ -30,6 +30,15 @@ class fc_get_attribute(Operator): "label_values", the field index (default 0) for "field_scoping". + Returns + ------- + property : Scoping or TimeFreqSupport or dict + 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". Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/field.py b/src/ansys/dpf/core/operators/utility/field.py index b992b53872..57b930d33c 100644 --- a/src/ansys/dpf/core/operators/utility/field.py +++ b/src/ansys/dpf/core/operators/utility/field.py @@ -18,6 +18,9 @@ class field(Operator): ---------- input : Field + Returns + ------- + incremented_result : Examples -------- 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 a4d5e32afd..01daec9f39 100644 --- a/src/ansys/dpf/core/operators/utility/field_get_attribute.py +++ b/src/ansys/dpf/core/operators/utility/field_get_attribute.py @@ -23,6 +23,10 @@ class field_get_attribute(Operator): Accepted inputs are: 'time_freq_support' and 'scoping'. + Returns + ------- + property : TimeFreqSupport or Scoping + Property value. Examples -------- 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 88b658b907..cc535c2689 100644 --- a/src/ansys/dpf/core/operators/utility/field_to_fc.py +++ b/src/ansys/dpf/core/operators/utility/field_to_fc.py @@ -23,6 +23,9 @@ class field_to_fc(Operator): label : dict Sets a label space. + Returns + ------- + fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/fields_container.py b/src/ansys/dpf/core/operators/utility/fields_container.py index 4f56e629de..12c308fcef 100644 --- a/src/ansys/dpf/core/operators/utility/fields_container.py +++ b/src/ansys/dpf/core/operators/utility/fields_container.py @@ -18,6 +18,9 @@ class fields_container(Operator): ---------- input : FieldsContainer + Returns + ------- + incremented_result : Examples -------- 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 7e267dcb67..f03615321c 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 @@ -26,6 +26,11 @@ class fields_container_matrices_label(Operator): matrices is constructed only on the specified time scoping + Returns + ------- + fields_container : FieldsContainer + Fields container of field matrices obtained + after merging. Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/for_each.py b/src/ansys/dpf/core/operators/utility/for_each.py index 0365c763f9..e5e5c17b00 100644 --- a/src/ansys/dpf/core/operators/utility/for_each.py +++ b/src/ansys/dpf/core/operators/utility/for_each.py @@ -25,6 +25,11 @@ class for_each(Operator): forward1 : forward2 : + Returns + ------- + empty : + output1 : + output2 : Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/forward.py b/src/ansys/dpf/core/operators/utility/forward.py index b8ed35496c..a6c93a745f 100644 --- a/src/ansys/dpf/core/operators/utility/forward.py +++ b/src/ansys/dpf/core/operators/utility/forward.py @@ -19,6 +19,10 @@ class forward(Operator): any : Any Any type of input + Returns + ------- + any : Any + Same types as inputs Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/forward_field.py b/src/ansys/dpf/core/operators/utility/forward_field.py index 0755bcac75..e8341c21f2 100644 --- a/src/ansys/dpf/core/operators/utility/forward_field.py +++ b/src/ansys/dpf/core/operators/utility/forward_field.py @@ -20,6 +20,9 @@ class forward_field(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 158874d09a..156d6d21ad 100644 --- a/src/ansys/dpf/core/operators/utility/forward_fields_container.py +++ b/src/ansys/dpf/core/operators/utility/forward_fields_container.py @@ -18,6 +18,9 @@ class forward_fields_container(Operator): ---------- fields : FieldsContainer or Field + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 d6de2cca08..7b05157a8f 100644 --- a/src/ansys/dpf/core/operators/utility/forward_meshes_container.py +++ b/src/ansys/dpf/core/operators/utility/forward_meshes_container.py @@ -22,6 +22,9 @@ class forward_meshes_container(Operator): container needs to be created (default is unknown) + Returns + ------- + meshes_container : MeshesContainer Examples -------- 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 d9c4c24ae1..3ff2e49731 100644 --- a/src/ansys/dpf/core/operators/utility/hdf5dpf_workglow_provider.py +++ b/src/ansys/dpf/core/operators/utility/hdf5dpf_workglow_provider.py @@ -30,6 +30,9 @@ class hdf5dpf_workglow_provider(Operator): Name of the result that must be extracted from the hdf5dpf file + Returns + ------- + field_or_fields_container : Workflow Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/html_doc.py b/src/ansys/dpf/core/operators/utility/html_doc.py index 4b0b75a389..2f6ca0a7e4 100644 --- a/src/ansys/dpf/core/operators/utility/html_doc.py +++ b/src/ansys/dpf/core/operators/utility/html_doc.py @@ -27,6 +27,8 @@ class html_doc(Operator): operator, 3 includes operator without specifications. + Returns + ------- 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 2dee7bb65b..ef55c410d2 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 @@ -21,6 +21,9 @@ class incremental_concatenate_as_fc(Operator): Label space value that must be applied to the added field. + Returns + ------- + output : FieldsContainer Examples -------- 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 b81dcdd964..218c2e6686 100644 --- a/src/ansys/dpf/core/operators/utility/ints_to_scoping.py +++ b/src/ansys/dpf/core/operators/utility/ints_to_scoping.py @@ -21,6 +21,9 @@ class ints_to_scoping(Operator): Int or vector of int location : str, optional + Returns + ------- + scoping : Scoping Examples -------- 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 f2e53bbe02..d2faed6129 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 @@ -36,6 +36,9 @@ class make_for_each_range(Operator): valueC1 : valueC2 : + Returns + ------- + output : Examples -------- 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 f90da54678..ee1519b086 100644 --- a/src/ansys/dpf/core/operators/utility/make_label_space.py +++ b/src/ansys/dpf/core/operators/utility/make_label_space.py @@ -25,6 +25,9 @@ class make_label_space(Operator): label_value1 : int label_value2 : int + Returns + ------- + label : dict Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/make_overall.py b/src/ansys/dpf/core/operators/utility/make_overall.py index 1ab40532a2..7cb8c3b26d 100644 --- a/src/ansys/dpf/core/operators/utility/make_overall.py +++ b/src/ansys/dpf/core/operators/utility/make_overall.py @@ -21,6 +21,9 @@ class make_overall(Operator): field : Field id : int + Returns + ------- + field : Field Examples -------- 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 882d407d7f..e9c53bdda7 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 @@ -47,6 +47,10 @@ class make_producer_consumer_for_each_iterator(Operator): consumer_op11 : Operator consumer_op12 : Operator + Returns + ------- + iterator : + To connect to producer_consumer_for_each Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/make_time_chunk_for_each.py b/src/ansys/dpf/core/operators/utility/make_time_chunk_for_each.py index 95e45cc18c..7094db1124 100644 --- a/src/ansys/dpf/core/operators/utility/make_time_chunk_for_each.py +++ b/src/ansys/dpf/core/operators/utility/make_time_chunk_for_each.py @@ -47,6 +47,11 @@ class make_time_chunk_for_each(Operator): consumer_op11 : Operator consumer_op12 : Operator + Returns + ------- + chunks : + To connect to "producer_consumer_for_each" + operator on pin 0 Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/make_time_freq_support_chunk_for_each.py b/src/ansys/dpf/core/operators/utility/make_time_freq_support_chunk_for_each.py index 44824ddb8c..3876fbddcb 100644 --- a/src/ansys/dpf/core/operators/utility/make_time_freq_support_chunk_for_each.py +++ b/src/ansys/dpf/core/operators/utility/make_time_freq_support_chunk_for_each.py @@ -49,6 +49,11 @@ class make_time_freq_support_chunk_for_each(Operator): consumer_op11 : Operator consumer_op12 : Operator + Returns + ------- + chunks : + To connect to "producer_consumer_for_each" + operator on pin 0 Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/merge_any.py b/src/ansys/dpf/core/operators/utility/merge_any.py index 70a4947d53..14bc3559e1 100644 --- a/src/ansys/dpf/core/operators/utility/merge_any.py +++ b/src/ansys/dpf/core/operators/utility/merge_any.py @@ -31,6 +31,9 @@ class merge_any(Operator): existing type specific merge operators. + Returns + ------- + any : Any Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/merge_collections.py b/src/ansys/dpf/core/operators/utility/merge_collections.py index f6fb0e67fc..de0ff7de48 100644 --- a/src/ansys/dpf/core/operators/utility/merge_collections.py +++ b/src/ansys/dpf/core/operators/utility/merge_collections.py @@ -23,6 +23,9 @@ class merge_collections(Operator): A vector of collections to merge or collections from pin 0 to ... + Returns + ------- + merged_collections : AnyCollection Examples -------- 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 6e083e8cd0..b204893ead 100644 --- a/src/ansys/dpf/core/operators/utility/merge_data_tree.py +++ b/src/ansys/dpf/core/operators/utility/merge_data_tree.py @@ -24,6 +24,9 @@ class merge_data_tree(Operator): Either a vector of data trees or data trees from pin 0 to ... to merge. + Returns + ------- + any : Any Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/merge_fields.py b/src/ansys/dpf/core/operators/utility/merge_fields.py index 515bf71bfd..b4fc9655f1 100644 --- a/src/ansys/dpf/core/operators/utility/merge_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_fields.py @@ -29,6 +29,9 @@ class merge_fields(Operator): Either a fields container, a vector of fields to merge, or fields from pin 0 to ... + Returns + ------- + merged_field : Field Examples -------- 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 cdf173335b..140fa3f348 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 @@ -28,6 +28,10 @@ class merge_fields_by_label(Operator): quantities are summed instead of being ignored. + Returns + ------- + fields_container : FieldsContainer + merged_field_support : AbstractFieldSupport Examples -------- 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 faab85e32a..80c2012887 100644 --- a/src/ansys/dpf/core/operators/utility/merge_fields_containers.py +++ b/src/ansys/dpf/core/operators/utility/merge_fields_containers.py @@ -39,6 +39,9 @@ class merge_fields_containers(Operator): A vector of fields containers to merge or fields containers from pin 0 to ... + Returns + ------- + merged_fields_container : FieldsContainer Examples -------- 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 e84bd7ab80..21cb0c2d38 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 @@ -34,6 +34,9 @@ class merge_generic_data_container(Operator): existing type specific merge operators. + Returns + ------- + generic_data_container : GenericDataContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/merge_materials.py b/src/ansys/dpf/core/operators/utility/merge_materials.py index 803b1f690a..25909e30f0 100644 --- a/src/ansys/dpf/core/operators/utility/merge_materials.py +++ b/src/ansys/dpf/core/operators/utility/merge_materials.py @@ -23,6 +23,9 @@ class merge_materials(Operator): A vector of materials to merge or materials from pin 0 to ... + Returns + ------- + merged_materials : Materials Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/merge_meshes.py b/src/ansys/dpf/core/operators/utility/merge_meshes.py index effbd5d665..41c65b578e 100644 --- a/src/ansys/dpf/core/operators/utility/merge_meshes.py +++ b/src/ansys/dpf/core/operators/utility/merge_meshes.py @@ -44,6 +44,9 @@ class merge_meshes(Operator): 0: keep duplicate elements (default), 1: remove duplicate elements + Returns + ------- + merges_mesh : MeshedRegion Examples -------- 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 2f97a220c6..7953b6a18f 100644 --- a/src/ansys/dpf/core/operators/utility/merge_meshes_containers.py +++ b/src/ansys/dpf/core/operators/utility/merge_meshes_containers.py @@ -23,6 +23,9 @@ class merge_meshes_containers(Operator): A vector of meshes containers to merge or meshes containers from pin 0 to ... + Returns + ------- + merged_meshes_container : MeshesContainer Examples -------- 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 a8a1210215..e042ab8fab 100644 --- a/src/ansys/dpf/core/operators/utility/merge_property_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_property_fields.py @@ -30,6 +30,9 @@ class merge_property_fields(Operator): of property fields to merge or property fields from pin 0 to ... + Returns + ------- + property_field : PropertyField Examples -------- 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 6e4cec8140..d6ab3dbc62 100644 --- a/src/ansys/dpf/core/operators/utility/merge_result_infos.py +++ b/src/ansys/dpf/core/operators/utility/merge_result_infos.py @@ -23,6 +23,9 @@ class merge_result_infos(Operator): A vector of result info containers to merge or result infos from pin 0 to ... + Returns + ------- + merged_result_infos : ResultInfo Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/merge_scopings.py b/src/ansys/dpf/core/operators/utility/merge_scopings.py index 8c45e1fb8e..fa1d4958c3 100644 --- a/src/ansys/dpf/core/operators/utility/merge_scopings.py +++ b/src/ansys/dpf/core/operators/utility/merge_scopings.py @@ -25,6 +25,9 @@ class merge_scopings(Operator): scopings to merge, or scopings from pin 0 to ... + Returns + ------- + merged_scoping : Scoping Examples -------- 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 95f311678f..0c7f31314f 100644 --- a/src/ansys/dpf/core/operators/utility/merge_scopings_containers.py +++ b/src/ansys/dpf/core/operators/utility/merge_scopings_containers.py @@ -23,6 +23,9 @@ class merge_scopings_containers(Operator): A vector of scopings containers to merge or scopings containers from pin 0 to ... + Returns + ------- + merged_scopings_container : ScopingsContainer Examples -------- 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 4587c75111..7b0d2d3018 100644 --- a/src/ansys/dpf/core/operators/utility/merge_string_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_string_fields.py @@ -23,6 +23,9 @@ class merge_string_fields(Operator): Either a a vector of string fields to merge or string fields from pin 0 to ... + Returns + ------- + string_field : StringField Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/merge_supports.py b/src/ansys/dpf/core/operators/utility/merge_supports.py index ebee17d892..536cb17519 100644 --- a/src/ansys/dpf/core/operators/utility/merge_supports.py +++ b/src/ansys/dpf/core/operators/utility/merge_supports.py @@ -31,6 +31,9 @@ class merge_supports(Operator): A vector of supports to merge or supports from pin 0 to ... + Returns + ------- + merged_support : AbstractFieldSupport Examples -------- 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 1eaa40d54e..ec1853f437 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 @@ -25,6 +25,9 @@ class merge_time_freq_supports(Operator): or time/frequency supports from pin 0 to ... + Returns + ------- + merged_support : TimeFreqSupport Examples -------- 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 a7af24ef3c..53dafb154b 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 @@ -23,6 +23,9 @@ class merge_to_field_matrix(Operator): Either a fields container, a vector of fields to merge, or fields from pin 0 to ... + Returns + ------- + merged_field_matrix : Field Examples -------- 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 642010c207..c8f3ac91af 100644 --- a/src/ansys/dpf/core/operators/utility/merge_weighted_fields.py +++ b/src/ansys/dpf/core/operators/utility/merge_weighted_fields.py @@ -36,6 +36,9 @@ class merge_weighted_fields(Operator): Weights to apply to each field from pin 1000 to ... + Returns + ------- + merged_field : Field Examples -------- 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 0d265c4fcd..dd40994403 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 @@ -40,6 +40,9 @@ class merge_weighted_fields_containers(Operator): Weights to apply to each field from pin 1000 to ... + Returns + ------- + merged_fields_container : FieldsContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/mesh.py b/src/ansys/dpf/core/operators/utility/mesh.py index f84b70ec6a..a03ffbb6d9 100644 --- a/src/ansys/dpf/core/operators/utility/mesh.py +++ b/src/ansys/dpf/core/operators/utility/mesh.py @@ -18,6 +18,9 @@ class mesh(Operator): ---------- input : MeshedRegion + Returns + ------- + incremented_result : Examples -------- 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 dad2ec10ea..cf4d21b5b4 100644 --- a/src/ansys/dpf/core/operators/utility/mesh_to_mc.py +++ b/src/ansys/dpf/core/operators/utility/mesh_to_mc.py @@ -23,6 +23,9 @@ class mesh_to_mc(Operator): label : dict Sets a label space. + Returns + ------- + meshes_container : MeshesContainer Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/meshes_container.py b/src/ansys/dpf/core/operators/utility/meshes_container.py index 5adbf0ec38..9566106e69 100644 --- a/src/ansys/dpf/core/operators/utility/meshes_container.py +++ b/src/ansys/dpf/core/operators/utility/meshes_container.py @@ -18,6 +18,9 @@ class meshes_container(Operator): ---------- input : MeshesContainer + Returns + ------- + incremented_result : Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/overlap_fields.py b/src/ansys/dpf/core/operators/utility/overlap_fields.py index a6633e06ca..73517ba6f9 100644 --- a/src/ansys/dpf/core/operators/utility/overlap_fields.py +++ b/src/ansys/dpf/core/operators/utility/overlap_fields.py @@ -20,6 +20,9 @@ class overlap_fields(Operator): base_field : Field, optional overlapping_field : Field, optional + Returns + ------- + field : Field Examples -------- 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 55d4a4245e..54360384ec 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 @@ -29,6 +29,11 @@ class producer_consumer_for_each(Operator): forward2 : Output of the last operators of the workflow + Returns + ------- + empty : + output1 : + output2 : Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/property_field.py b/src/ansys/dpf/core/operators/utility/property_field.py index bb16994122..e5d9f2a4ed 100644 --- a/src/ansys/dpf/core/operators/utility/property_field.py +++ b/src/ansys/dpf/core/operators/utility/property_field.py @@ -18,6 +18,9 @@ class property_field(Operator): ---------- input : PropertyField + Returns + ------- + incremented_result : Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/python_generator.py b/src/ansys/dpf/core/operators/utility/python_generator.py index 8244c3e846..b56f324955 100644 --- a/src/ansys/dpf/core/operators/utility/python_generator.py +++ b/src/ansys/dpf/core/operators/utility/python_generator.py @@ -21,6 +21,8 @@ class python_generator(Operator): load_symbol : str, optional library_key : str, optional + Returns + ------- 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 c485a91fca..1210a258a5 100644 --- a/src/ansys/dpf/core/operators/utility/remote_operator_instantiate.py +++ b/src/ansys/dpf/core/operators/utility/remote_operator_instantiate.py @@ -28,6 +28,12 @@ class remote_operator_instantiate(Operator): output_name : str Output's name of the workflow to return + Returns + ------- + remote_workflow : Workflow + Remote workflow containing an image of the + remote workflow and the protocols + streams Examples -------- 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 bd7032a3ff..373108902d 100644 --- a/src/ansys/dpf/core/operators/utility/remote_workflow_instantiate.py +++ b/src/ansys/dpf/core/operators/utility/remote_workflow_instantiate.py @@ -25,6 +25,12 @@ class remote_workflow_instantiate(Operator): streams_to_remote : StreamsContainer data_sources_to_remote : DataSources, optional + Returns + ------- + remote_workflow : Workflow + Remote workflow containing an image of the + remote workflow and the protocols + streams Examples -------- 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 d300a2fbcc..2feafccc9b 100644 --- a/src/ansys/dpf/core/operators/utility/remove_unnecessary_labels.py +++ b/src/ansys/dpf/core/operators/utility/remove_unnecessary_labels.py @@ -27,6 +27,9 @@ class remove_unnecessary_labels(Operator): Label to be removed from the fields container. + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 13e500be23..ac554db408 100644 --- a/src/ansys/dpf/core/operators/utility/scalars_to_field.py +++ b/src/ansys/dpf/core/operators/utility/scalars_to_field.py @@ -36,6 +36,9 @@ class scalars_to_field(Operator): scoping : Scoping, optional Scoping. + Returns + ------- + field : Field Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/server_path.py b/src/ansys/dpf/core/operators/utility/server_path.py index 0cb5461fa1..4f423aea98 100644 --- a/src/ansys/dpf/core/operators/utility/server_path.py +++ b/src/ansys/dpf/core/operators/utility/server_path.py @@ -23,6 +23,11 @@ class server_path(Operator): "aisol/bin(dll)/platform", 3: "dpf/plugins", 4: "dpf/workflows". + Returns + ------- + path : str + Path to the requested folder in the dpf + server Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/set_attribute.py b/src/ansys/dpf/core/operators/utility/set_attribute.py index 77a730cee6..00046b98ff 100644 --- a/src/ansys/dpf/core/operators/utility/set_attribute.py +++ b/src/ansys/dpf/core/operators/utility/set_attribute.py @@ -23,6 +23,10 @@ class set_attribute(Operator): Value of the property to be set : vector of string or labelspace for "labels". + Returns + ------- + fields_container : FieldsContainer + Returns the modified fieldscontainer. Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/set_property.py b/src/ansys/dpf/core/operators/utility/set_property.py index b41a704e16..37c41dfe9b 100644 --- a/src/ansys/dpf/core/operators/utility/set_property.py +++ b/src/ansys/dpf/core/operators/utility/set_property.py @@ -23,6 +23,9 @@ class set_property(Operator): property_value : str or int or float Property to set + Returns + ------- + field : Field or FieldsContainer Examples -------- 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 5f8f02fac3..ae1cd86d42 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 @@ -27,6 +27,9 @@ class split_in_for_each_range(Operator): scoping : Scoping chunk_size : int + Returns + ------- + output : Examples -------- 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 7f5d588fcc..6608fcbecd 100644 --- a/src/ansys/dpf/core/operators/utility/strain_from_voigt.py +++ b/src/ansys/dpf/core/operators/utility/strain_from_voigt.py @@ -20,6 +20,9 @@ class strain_from_voigt(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 db6c996c6d..02af282f5d 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 @@ -20,6 +20,9 @@ class strain_from_voigt_fc(Operator): Field or fields container with only one field is expected + Returns + ------- + fields_container : FieldsContainer Examples -------- 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 ef1f803464..486e9504ff 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 @@ -20,6 +20,12 @@ class txt_file_to_dpf(Operator): Ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' + Returns + ------- + any_output1 : + Any output + any_output2 : + Any output Examples -------- diff --git a/src/ansys/dpf/core/operators/utility/unitary_field.py b/src/ansys/dpf/core/operators/utility/unitary_field.py index 0c5bc3674d..9e40e480d0 100644 --- a/src/ansys/dpf/core/operators/utility/unitary_field.py +++ b/src/ansys/dpf/core/operators/utility/unitary_field.py @@ -21,6 +21,9 @@ class unitary_field(Operator): Field or fields container with only one field is expected + Returns + ------- + field : Field Examples -------- 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 4eceea2855..d8d5a3a10f 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 @@ -34,6 +34,9 @@ class weighted_merge_fields_by_label(Operator): Weights to apply to each field from pin 1000 to ... + Returns + ------- + fields_container : FieldsContainer Examples --------