From b59065d1d7ac6b0b2ccf61a77260b4e2d94ff70a Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@win.ansys.com> Date: Tue, 12 May 2026 20:16:27 -0400 Subject: [PATCH 1/6] DPF doc update for 271 (2026.05.12) --- .../changelog/changelog.md | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/2027R1/dpf-framework-27-r1/changelog/changelog.md b/2027R1/dpf-framework-27-r1/changelog/changelog.md index ebe13f955..ae7d97410 100644 --- a/2027R1/dpf-framework-27-r1/changelog/changelog.md +++ b/2027R1/dpf-framework-27-r1/changelog/changelog.md @@ -26,7 +26,7 @@ The following table shows which components have updates in each category. | eng_mat | |[1 item](#Fixes_eng_mat) | | expansion | [1 item](#Features_expansion) | | | fbs | [2 items](#Features_fbs) | | -| femutils | [3 items](#Features_femutils) |[15 items](#Fixes_femutils) | +| femutils | [3 items](#Features_femutils) |[16 items](#Fixes_femutils) | | flatbuffers | |[1 item](#Fixes_flatbuffers) | | framework | [2 items](#Features_framework) |[8 items](#Fixes_framework) | | gate | |[1 item](#Fixes_gate) | @@ -46,14 +46,14 @@ The following table shows which components have updates in each category. | math | [12 items](#Features_math) |[1 item](#Fixes_math) | | mechanical | [3 items](#Features_mechanical) |[5 items](#Fixes_mechanical) | | mesh | [2 items](#Features_mesh) |[4 items](#Fixes_mesh) | -| misc | [15 items](#Features_misc) |[21 items](#Fixes_misc) | +| misc | [15 items](#Features_misc) |[22 items](#Fixes_misc) | | multiphysics | [2 items](#Features_multiphysics) | | | multiphysicsmapper | |[6 items](#Fixes_multiphysicsmapper) | | name | |[1 item](#Fixes_name) | | native | [8 items](#Features_native) |[23 items](#Fixes_native) | | nuget | |[1 item](#Fixes_nuget) | | perf | [2 items](#Features_perf) |[1 item](#Fixes_perf) | -| prime | [4 items](#Features_prime) |[1 item](#Fixes_prime) | +| prime | [4 items](#Features_prime) |[2 items](#Fixes_prime) | | pydpf | |[1 item](#Fixes_pydpf) | | refactor | [1 item](#Features_refactor) | | | rotation | |[1 item](#Fixes_rotation) | @@ -462,6 +462,15 @@ The following table shows which components have updates in each category. ### Fixes +- Improve performance of Cyclic expansion of meshes and results: + > + > + > Fix performance bottlenecks for large model in cyclic operators `cyclic_expansion_meshes` and `cyclic_expansion_field`. + > + > + > + > + - Fix issue in force_summation with total forces and no damping: > > @@ -2001,6 +2010,11 @@ The following table shows which components have updates in each category. ### Fixes +- Ansys.dpf conanfile DPFEmpty.xml wrong source dir: + > + > + > + - Restored a number of error messages: > > @@ -2546,6 +2560,11 @@ The following table shows which components have updates in each category. ### Fixes +- Fixing parallelization issue with prime operators: + > Support parallelization for `prepare_morphing` (and so `morphed_field`) and `export_mesh_with_prime`. + > + > + - Restoring parallelization config options: > Restoring parallelization config options, when applies. > From 9935c14aed9684e3059a6a2d1d9768db0c9d8678 Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@ansys.com> Date: Wed, 13 May 2026 08:47:13 -0700 Subject: [PATCH 2/6] DPF doc update for 271 (2026.05.13) --- .../structansys-dpf-reflect-unsigned-short.md | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-reflect-unsigned-short.md diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-reflect-unsigned-short.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-reflect-unsigned-short.md new file mode 100644 index 000000000..7eea32cc1 --- /dev/null +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-reflect-unsigned-short.md @@ -0,0 +1,49 @@ +# Structure ansys::dpf::reflect\< unsigned short \> + + + +![][C++] +![][public] + + + + + + + +## Members + +* [type_name](structansys-dpf-reflect-unsigned-short.md#structansys-dpf-reflect-unsigned-short-4-1a7523fa0faa3fdbbc1dd7917d21398679) + +## Public static functions + + +### Function type_name + +![][public] +![][static] + + +```cpp +static std::string ansys::dpf::reflect< unsigned short >::type_name() +``` + + + + + + + + +**Return type**: std::string + + + +[C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) +[const]: https://img.shields.io/badge/-const-lightblue (const) +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[static]: https://img.shields.io/badge/-static-lightgrey (static) \ No newline at end of file From f1addbb75a8d6eae3ff0ee75b618979df7587145 Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@win.ansys.com> Date: Wed, 13 May 2026 20:18:03 -0400 Subject: [PATCH 3/6] DPF doc update for 271 (2026.05.13) --- .../changelog/changelog.md | 245 +++++++++++++++++- .../math/absolute_value_by_component.md | 8 +- .../math/absolute_value_by_component_fc.md | 8 +- .../math/accumulate.md | 12 +- .../math/accumulate_fc.md | 12 +- .../operator-specifications/math/add.md | 12 +- .../operator-specifications/math/add_fc.md | 9 +- .../operator-specifications/math/amplitude.md | 9 +- .../math/amplitude_fc.md | 11 +- .../operator-specifications/math/centroid.md | 12 +- .../math/centroid_fc.md | 18 +- .../math/component_wise_divide.md | 12 +- .../math/component_wise_divide_fc.md | 9 +- .../operator-specifications/math/conjugate.md | 11 +- .../operator-specifications/math/cos.md | 12 +- .../operator-specifications/math/cos_fc.md | 12 +- .../math/cplx_derive.md | 14 +- .../math/cplx_divide.md | 14 +- .../operator-specifications/math/cplx_dot.md | 9 +- .../math/cplx_multiply.md | 10 +- .../math/dot_tensor.md | 2 +- .../math/exponential.md | 11 +- .../math/exponential_fc.md | 11 +- .../math/generalized_inner_product.md | 33 ++- .../math/generalized_inner_product_fc.md | 33 ++- .../operator-specifications/math/img_part.md | 9 +- .../operator-specifications/math/invert.md | 4 +- .../operator-specifications/math/invert_fc.md | 4 +- .../math/kronecker_prod.md | 11 +- .../math/linear_combination.md | 16 +- .../operator-specifications/math/ln.md | 11 +- .../operator-specifications/math/ln_fc.md | 11 +- .../operator-specifications/math/minus.md | 12 +- .../operator-specifications/math/minus_fc.md | 12 +- .../operator-specifications/math/modulus.md | 11 +- .../operator-specifications/math/norm.md | 12 +- .../operator-specifications/math/norm_fc.md | 13 +- .../operator-specifications/math/phase.md | 9 +- .../operator-specifications/math/phase_fc.md | 11 +- .../math/polar_to_cplx.md | 13 +- .../operator-specifications/math/pow.md | 2 +- .../operator-specifications/math/pow_fc.md | 2 +- .../operator-specifications/math/real_part.md | 9 +- .../operator-specifications/math/scale.md | 11 +- .../operator-specifications/math/scale_fc.md | 10 +- .../operator-specifications/math/sin.md | 12 +- .../operator-specifications/math/sin_fc.md | 12 +- .../operator-specifications/math/sqr.md | 9 +- .../operator-specifications/math/sqr_fc.md | 9 +- .../operator-specifications/math/sqrt.md | 12 +- .../operator-specifications/math/sqrt_fc.md | 12 +- .../math/sweeping_phase.md | 13 +- .../math/sweeping_phase_fc.md | 16 +- .../math/time_freq_interpolation.md | 23 +- .../math/unit_convert.md | 12 +- .../math/unit_convert_fc.md | 13 +- .../math/absolute_value_by_component.md | 2 +- .../math/absolute_value_by_component_fc.md | 8 +- .../operators/math/accumulate.md | 14 +- .../operators/math/accumulate_fc.md | 14 +- .../Ans.DataProcessing/operators/math/add.md | 2 +- .../operators/math/add_fc.md | 2 +- .../operators/math/amplitude.md | 10 +- .../operators/math/amplitude_fc.md | 12 +- .../operators/math/centroid.md | 14 +- .../operators/math/centroid_fc.md | 20 +- .../operators/math/component_wise_divide.md | 117 ++++----- .../math/component_wise_divide_fc.md | 10 +- .../operators/math/conjugate.md | 12 +- .../Ans.DataProcessing/operators/math/cos.md | 14 +- .../operators/math/cos_fc.md | 14 +- .../operators/math/cplx_derive.md | 18 +- .../operators/math/cplx_divide.md | 16 +- .../operators/math/cplx_dot.md | 12 +- .../operators/math/cplx_multiply.md | 12 +- .../operators/math/dot_tensor.md | 2 +- .../operators/math/exponential.md | 4 +- .../operators/math/exponential_fc.md | 12 +- .../math/generalized_inner_product.md | 13 +- .../math/generalized_inner_product_fc.md | 13 +- .../operators/math/img_part.md | 8 +- .../operators/math/index.md | 86 +++--- .../operators/math/invert.md | 4 +- .../operators/math/invert_fc.md | 4 +- .../operators/math/kronecker_prod.md | 14 +- .../operators/math/linear_combination.md | 18 +- .../Ans.DataProcessing/operators/math/ln.md | 4 +- .../operators/math/ln_fc.md | 12 +- .../operators/math/minus.md | 2 +- .../operators/math/minus_fc.md | 2 +- .../operators/math/modulus.md | 12 +- .../Ans.DataProcessing/operators/math/norm.md | 14 +- .../operators/math/norm_fc.md | 14 +- .../operators/math/phase.md | 10 +- .../operators/math/phase_fc.md | 12 +- .../operators/math/polar_to_cplx.md | 16 +- .../Ans.DataProcessing/operators/math/pow.md | 2 +- .../operators/math/pow_fc.md | 2 +- .../operators/math/real_part.md | 8 +- .../Ans.DataProcessing/operators/math/sin.md | 14 +- .../operators/math/sin_fc.md | 14 +- .../Ans.DataProcessing/operators/math/sqr.md | 10 +- .../operators/math/sqr_fc.md | 10 +- .../Ans.DataProcessing/operators/math/sqrt.md | 14 +- .../operators/math/sqrt_fc.md | 14 +- .../operators/math/sweeping_phase.md | 14 +- .../operators/math/sweeping_phase_fc.md | 18 +- .../operators/math/time_freq_interpolation.md | 8 +- .../operators/math/unit_convert.md | 16 +- .../operators/math/unit_convert_fc.md | 16 +- 110 files changed, 1288 insertions(+), 356 deletions(-) diff --git a/2027R1/dpf-framework-27-r1/changelog/changelog.md b/2027R1/dpf-framework-27-r1/changelog/changelog.md index ae7d97410..8b6466b4e 100644 --- a/2027R1/dpf-framework-27-r1/changelog/changelog.md +++ b/2027R1/dpf-framework-27-r1/changelog/changelog.md @@ -1,6 +1,6 @@ # Changelog -Changes since the last released version for DPF 27.1.pre0 (as of 2026-05-12). +Changes since the last released version for DPF 27.1.pre0 (as of 2026-05-13). This changelog is organized by category, with sections for different types of updates (new features, bug fixes, changes, performance improvements). @@ -50,7 +50,7 @@ The following table shows which components have updates in each category. | multiphysics | [2 items](#Features_multiphysics) | | | multiphysicsmapper | |[6 items](#Fixes_multiphysicsmapper) | | name | |[1 item](#Fixes_name) | -| native | [8 items](#Features_native) |[23 items](#Fixes_native) | +| native | [8 items](#Features_native) |[24 items](#Fixes_native) | | nuget | |[1 item](#Fixes_nuget) | | perf | [2 items](#Features_perf) |[1 item](#Fixes_perf) | | prime | [4 items](#Features_prime) |[2 items](#Fixes_prime) | @@ -2326,6 +2326,15 @@ The following table shows which components have updates in each category. ### Fixes +- Fix labels issue in adapt_with_scopings_container: + > + > + > Fix issue in `adapt_with_scopings_container` when input FieldsContainer and ScopingsContainer don't share labels. + > + > + > + > + - Fix int connection to time_scoping pin for cyclic models: > > @@ -3902,6 +3911,26 @@ The following table shows which components have updates in each category. #### math +- [absolute_value_by_component](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/absolute_value_by_component.md) + + > 0.0.1: Improve operator description with formula and Wikipedia link. Improve output pin description. + + +- [absolute_value_by_component_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/absolute_value_by_component_fc.md) + + > 0.0.1: Improve operator description with formula and Wikipedia link. Improve output pin description. + + +- [accumulate](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/accumulate.md) + + > 0.0.1: Improve operator description with weighted sum formula. Improve pin 2 and output pin descriptions. + + +- [accumulate_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/accumulate_fc.md) + + > 0.0.1: Improve operator description with weighted sum formula. Improve pin 2 and output pin descriptions. + + - [accumulate_level_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/accumulate_level_over_label_fc.md) > 0.0.1: Fixed issue with crash due to empty label. @@ -3917,11 +3946,51 @@ The following table shows which components have updates in each category. > 0.0.1: Fixed issue with crash due to empty label. +- [add](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/add.md) + + > 0.0.1: Improve operator description to document formula, broadcast behaviour, unit handling, and inplace option. Improve output pin description. Add entity-wise addition synonym. + + +- [add_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/add_fc.md) + + > 0.0.1: Improve operator description. Improve output pin description. Add entity-wise addition synonym. + + +- [amplitude](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/amplitude.md) + + > 0.0.1: Improve operator description. Add output pin description. Add Wikipedia link. + + +- [amplitude_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/amplitude_fc.md) + + > 0.0.1: Improve operator description with amplitude formula, fallback behaviour and Wikipedia link. Add input and output pin descriptions. + + - [average_over_label_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/average_over_label_fc.md) > 0.0.1: Fixed issue with crash due to empty label. +- [centroid](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/centroid.md) + + > 0.0.1: Improve operator description with interpolation formula, convexity criterion and Wikipedia link. Improve pin 2 and output pin descriptions. + + +- [centroid_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/centroid_fc.md) + + > 0.0.1: Improve operator description with interpolation formula, exact-match behaviour and Wikipedia link. Improve pin descriptions. + + +- [component_wise_divide](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/component_wise_divide.md) + + > 0.0.1: Improve operator description with formula and zero-denominator behaviour. Add output pin description. Add Wikipedia link. + + +- [component_wise_divide_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/component_wise_divide_fc.md) + + > 0.0.1: Improve operator description. Add output pin description. Add Wikipedia link. + + - [compute_residual_and_error](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/compute_residual_and_error.md) > 0.1.0: Support generic labels (not only time) in the input FieldsContainer @@ -3932,6 +4001,41 @@ The following table shows which components have updates in each category. Upgraded documentation +- [conjugate](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/conjugate.md) + + > 0.0.1: Improve operator description with conjugate formula and Wikipedia link. Add input and output pin descriptions. + + +- [cos](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/cos.md) + + > 0.0.1: Improve operator description to document unit constraints and formula. Improve input and output pin descriptions. Add Wikipedia link. + + +- [cos_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/cos_fc.md) + + > 0.0.1: Improve operator description to document unit constraints and formula. Improve input and output pin descriptions. Add Wikipedia link. + + +- [cplx_derive](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/cplx_derive.md) + + > 0.0.1: Improve operator description with frequency-domain derivation formula and Wikipedia link. Add input and output pin descriptions. + + +- [cplx_divide](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/cplx_divide.md) + + > 0.0.1: Improve operator description with complex division formula, zero-denominator error and Wikipedia link. Improve pin and output pin descriptions. + + +- [cplx_dot](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/cplx_dot.md) + + > 0.0.1: Improve operator description with Hermitian inner product formula and Wikipedia link. + + +- [cplx_multiply](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/cplx_multiply.md) + + > 0.0.1: Improve operator description with complex multiplication formula and Wikipedia link. Add output pin description. + + - [entity_extractor](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/entity_extractor.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -3942,11 +4046,56 @@ Upgraded documentation > 0.0.1: Fix handling of empty fields in mode shapes. +- [exponential](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/exponential.md) + + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. + + +- [exponential_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/exponential_fc.md) + + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. + + - [fft_approx](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/fft_approx.md) > 0.0.1: Fix exception type preservation during parallel execution. +- [generalized_inner_product](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/generalized_inner_product.md) + + > 0.0.1: Improve operator description with Wikipedia links and dispatch table. Add missing optional input pin 2 (mesh) for elemental-nodal/nodal dot product. Improve output pin description. + + +- [generalized_inner_product_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/generalized_inner_product_fc.md) + + > 0.0.1: Improve operator description with Wikipedia links and dispatch table. Add missing optional input pin 2 (mesh) for elemental-nodal/nodal dot product. Improve output pin description. + + +- [img_part](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/img_part.md) + + > 0.0.1: Improve operator description. Add input and output pin descriptions. + + +- [kronecker_prod](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/kronecker_prod.md) + + > 0.0.1: Improve operator description with Kronecker product formula and Wikipedia link. Add output pin description. + + +- [linear_combination](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/linear_combination.md) + + > 0.0.1: Improve operator description with LaTeX formula and Wikipedia link. Improve pin 0, 3, 4 and output pin descriptions. + + +- [ln](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/ln.md) + + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. + + +- [ln_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/ln_fc.md) + + > 0.0.1: Improve operator description with formula and dimensionless constraint. Improve input and output pin descriptions. Add Wikipedia link. + + - [mac](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/mac.md) > 0.0.1: Internal refactoring to use Scoping Iterators. @@ -3957,14 +4106,34 @@ Upgraded documentation > 0.0.1: Internal refactoring to use Scoping Iterators. +- [minus](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/minus.md) + + > 0.0.1: Improve operator description to document formula, broadcast behaviour, unit handling, and temperature-difference unit. Improve output pin description. Add entity-wise subtraction synonym. + + +- [minus_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/minus_fc.md) + + > 0.0.1: Improve operator description to document formula, broadcast behaviour, unit handling, and temperature-difference unit. Improve output pin description. Add entity-wise subtraction synonym. + + - [modal_participation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/modal_participation.md) > 0.0.1: Internal refactoring to use Scoping Iterators. +- [modulus](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/modulus.md) + + > 0.0.1: Improve operator description with complex modulus formula and Wikipedia link. Add input and output pin descriptions. + + +- [norm](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/norm.md) + + > 0.0.1: Improve operator description with $L_p$ norm formula and Wikipedia link. Improve pin 1 and output pin descriptions. + + - [norm_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/norm_fc.md) - > 0.0.1: Fix exception type preservation during parallel execution. + > 0.0.1: Fix exception type preservation during parallel execution. Fix operator description accuracy: now documents $L_p$ norm (not just $L_2$). Improve pin 1 and output pin descriptions. Add Wikipedia link. - [outer_product](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/outer_product.md) @@ -3972,6 +4141,21 @@ Upgraded documentation > 0.0.1: Internal refactoring to use Scoping Iterators. +- [phase](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/phase.md) + + > 0.0.1: Improve operator description with atan2 formula and Wikipedia link. Add output pin description. + + +- [phase_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/phase_fc.md) + + > 0.0.1: Improve operator description with atan2 formula, zero-field fallback and Wikipedia link. Add input and output pin descriptions. + + +- [polar_to_cplx](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/polar_to_cplx.md) + + > 0.0.1: Improve operator description with polar-to-rectangular conversion formulas and Wikipedia link. Add input and output pin descriptions. + + - [pow](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/pow.md) > 0.1.0: Pin added to chose the value to set for division by zero for negative exponents @@ -3982,9 +4166,14 @@ Upgraded documentation > 0.1.0: Pin added to chose the value to set for division by zero for negative exponents +- [real_part](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/real_part.md) + + > 0.0.1: Improve operator description. Add input and output pin descriptions. + + - [scale](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/scale.md) - > 0.0.1: Fixed a segmentation fault. + > 0.0.1: Fixed a segmentation fault. Improve operator description with scalar and vector scale formulas. Fix 'scaler' typo. Add Hadamard product synonym for field-valued scale factor. - [scale_by_field](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/scale_by_field.md) @@ -3999,22 +4188,62 @@ Upgraded documentation - [scale_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/scale_fc.md) - > 0.0.1: Fix exception type preservation during parallel execution. + > 0.0.1: Fix exception type preservation during parallel execution. Improve operator description with supported scale-factor types. Fix 'scaler' typo. Add Hadamard product synonym for field-valued scale factor. + + +- [sin](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sin.md) + + > 0.0.1: Improve operator description to document unit constraints and formula. Add input and output pin descriptions. Add Wikipedia link. + + +- [sin_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sin_fc.md) + + > 0.0.1: Improve operator description to document unit constraints and formula. Add input and output pin descriptions. Add Wikipedia link. + + +- [sqr](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sqr.md) + + > 0.0.1: Improve operator description with formula and output unit. Improve output pin description. Add Wikipedia link. + + +- [sqr_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sqr_fc.md) + + > 0.0.1: Improve operator description with formula and output unit. Improve output pin description. Add Wikipedia link. + + +- [sqrt](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sqrt.md) + + > 0.0.1: Improve operator description with formula, non-negativity constraint, and output unit. Improve input and output pin descriptions. Add Wikipedia link. + + +- [sqrt_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sqrt_fc.md) + + > 0.0.1: Improve operator description with formula, non-negativity constraint, and output unit. Improve input and output pin descriptions. Add Wikipedia link. - [sweeping_phase](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sweeping_phase.md) - > 0.0.1: Clarify the documentation. + > 0.0.1: Improve operator description with projection formula and Wikipedia link. Improve pin 2, 4 and output pin descriptions. - [sweeping_phase_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/sweeping_phase_fc.md) - > 0.0.1: Clarify the documentation. + > 0.0.1: Improve operator description with projection formula and Wikipedia link. Improve pin 2, 4 and output pin descriptions. - [time_freq_interpolation](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/time_freq_interpolation.md) - > 0.0.1: Internal refactoring to use Scoping Iterators. + > 0.0.1: Internal refactoring to use Scoping Iterators. Improve operator description with interpolation formula and Wikipedia link. Add missing output pin 1 (TimeFreqSupport). Improve pin descriptions. + + +- [unit_convert](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/unit_convert.md) + + > 0.0.1: Improve operator description to document conversion formula, mesh handling, and permissive behaviour. Improve output pin description. + + +- [unit_convert_fc](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/math/unit_convert_fc.md) + + > 0.0.1: Improve operator description to document conversion formula and permissive behaviour. Add input pin description. Improve output pin description. diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md index 11455d6cf..e4503995b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component.md @@ -10,7 +10,11 @@ license: None ## Description -Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. + +Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise +to each scalar data entry: $\mathrm{out}[i] = |\mathrm{in}[i]|$. +This is a per-component operation and does not compute a vector norm. + ## Inputs @@ -48,7 +52,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md index 92d0e138e..d5056788c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/absolute_value_by_component_fc.md @@ -10,7 +10,11 @@ license: None ## Description -Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. + +Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise +to each scalar data entry: $\mathrm{out}[i] = |\mathrm{in}[i]|$. +This is a per-component operation and does not compute a vector norm. + ## Inputs @@ -48,7 +52,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md index ee31ee5ad..059fc3257 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md @@ -10,7 +10,13 @@ license: None ## Description -Sums all the elementary data of a field to produce one elementary data point. + +Reduces a field to a single entity by summing all entity data component-wise. +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, +where $w_k$ is the weight for entity $k$. +The weights field must be a scalar (1D) field providing one weight per entity. + ## Inputs @@ -47,7 +53,7 @@ Field containing weights, one weight per entity - **Required:** No - **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping) -time_scoping +Optional scoping that sets the output entity's location and ID. ## Outputs @@ -66,7 +72,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md index 730e6a39f..0ef106dc7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Sums all the elementary data of a field to produce one elementary data point. + +Reduces a field to a single entity by summing all entity data component-wise. +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, +where $w_k$ is the weight for entity $k$. +The weights field must be a scalar (1D) field providing one weight per entity. + ## Inputs @@ -47,7 +53,7 @@ Field containing weights, one weight per entity - **Required:** No - **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping) -time_scoping +Optional scoping that sets the output entity's location and ID. ## Outputs @@ -66,7 +72,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md index aefc9d9f4..7c91e89a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md @@ -10,7 +10,15 @@ license: None ## Description -Computes the sum of two fields. If one field's scoping has 'overall' location, then these field's values are applied on the entire other field. If one of the input field is empty, the remaining is forwarded to the output. When using a constant or 'work_by_index', it's possible to use 'inplace' to reuse one of the fields. + +Computes the entity-wise sum $\mathrm{out}[i] = A[i] + B[i]$, +also known as entity-wise addition. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +If either input is empty, the other is forwarded unchanged to the output. +When units differ but are homogeneous, pin B values are converted to pin A's unit before addition; +the output carries pin A's unit. +Inplace execution is supported when working with constants or using 'work_by_index'. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the element-wise sum of the two input fields +Field whose data equals $A[i] + B[i]$, with pin A's unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md index df7d045fd..682620c9e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Selects all fields with the same label space in the input fields container and add those together. If fields, doubles, or vectors of doubles, are put in input they are added to all the fields. + +Entity-wise addition across all input fields containers: +for each label space, sums the matching fields from every container. +Scalar inputs (field, double, or vector of doubles) are broadcast and added to every field in each container. +If only one fields container is provided and no scalar inputs are given, it is forwarded to the output unchanged. + ## Inputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with summed fields by label space +Fields container with fields summed by matching label space. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md index 77e0d7cc4..3bfb0f7bb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md @@ -10,7 +10,12 @@ license: None ## Description -Computes amplitude of a real and an imaginary field. + +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) +of a complex quantity given as separate real and imaginary fields: +$\mathrm{out}[i] = \sqrt{A[i]^2 + B[i]^2}$. +The output carries the unit of pin A. + ## Inputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Scalar field with $\sqrt{A[i]^2 + B[i]^2}$ for each data entry, carrying the unit of pin A. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md index 14b6f3700..ba68ab564 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes the amplitude of a real and an imaginary field. + +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) +$\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each complex-valued field pair in the input fields container, +where pairs are matched by complex label. +If no imaginary part is found for a real field, that real field is returned unchanged. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with amplitude fields $\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$, carrying the unit of the real input field. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md index 92e99b9c1..c30eab281 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md @@ -10,7 +10,13 @@ license: None ## Description -Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2*(fact). Only works by index. + +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between two fields +using a scalar factor $t$: $\mathrm{out}[i] = (1 - t) \cdot A[i] + t \cdot B[i]$. +The interpolation is convex (no extrapolation) when $t \in [0, 1]$; +values outside this range extrapolate beyond the two input fields. +This operator works by index only. + ## Inputs @@ -47,7 +53,7 @@ field or fields container with only one field is expected - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Scalar +Interpolation factor $t$: $t = 0$ returns fieldA unchanged, $t = 1$ returns fieldB unchanged. Values in $[0, 1]$ interpolate; values outside extrapolate. ## Outputs @@ -66,7 +72,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with centroid calculation: fieldA*(1-factor) + fieldB*factor +Interpolated field $(1 - t) \cdot A + t \cdot B$, with the unit of pin A. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md index fb36065f7..4afe64e13 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes the centroid of all the matching fields of a fields container at a given time or frequency, using fieldOut = field1*(1.-fact)+field2*(fact). + +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between the two fields +in the input fields container that bracket the requested time or frequency value $t$: +$\mathrm{out}[i] = (1 - s) \cdot f_1[i] + s \cdot f_2[i]$, +where $s = (t - t_1) / (t_2 - t_1)$ and $t_1$, $t_2$ are the bracketing time/frequency values. +If the requested value exactly matches an available one, that field is returned directly. + ## Inputs @@ -32,7 +38,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with fields for centroid calculation +Fields container with fields over time or frequency. ### time_freq (Pin 1) @@ -40,7 +46,7 @@ FieldsContainer with fields for centroid calculation - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Time or frequency value for field selection +Time or frequency value at which to interpolate. ### step (Pin 2) @@ -48,7 +54,7 @@ Time or frequency value for field selection - **Required:** No - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) -Optional step specification +Optional step specification. ### time_freq_support (Pin 8) @@ -56,7 +62,7 @@ Optional step specification - **Required:** No - **Expected type(s):** [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) -Optional TimeFreqSupport for field resolution +Optional time/frequency support for field resolution. ## Outputs @@ -75,7 +81,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with centroid calculation results at specified time/frequency +Fields container with the interpolated fields at the requested time or frequency. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md index c4cf03f25..95300e684 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide.md @@ -10,7 +10,15 @@ license: None ## Description -Computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. + +Computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ +(also known as the [Hadamard division](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)) +for fields of the same dimensionality. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +When $|B[k]| < 10^{-14}$ the corresponding output component is set to $0$. +Inplace execution is supported when working with constants or using 'work_by_index'. +The output unit is $u_A / u_B$. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Field with $A[k] / B[k]$ for each component (zero where $|B[k]| < 10^{-14}$); unit is $u_A / u_B$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md index fe1749a6c..a628754a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_divide_fc.md @@ -10,7 +10,12 @@ license: None ## Description -For every two fields with the same label space (from the two input fields containers), computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. + +For every pair of fields with matching label space in the two input fields containers, +computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ +(also known as the [Hadamard division](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)). +Both containers must have identical label spaces and the same number of fields. + ## Inputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the component-wise quotient fields; unit is $u_A / u_B$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md index 776d0486a..d4b79e451 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise conjugate of field containers containing complex fields. + +Computes the [complex conjugate](https://en.wikipedia.org/wiki/Complex_conjugate) +$\bar{z}[i] = \mathrm{Re}[i] - j \cdot \mathrm{Im}[i]$ for each value in a complex-valued fields container +(the imaginary part is negated). +Input and output containers have the same structure. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with conjugate values; the imaginary-part fields carry negated data. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md index c16ffb341..71bd84d50 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise cosine function on field data: cos(field[i]). + +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the cosine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md index 4f7e44a7b..f2d4650ef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise cosine function on field data: cos(field[i]). + +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the cosine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md index d6bb140f3..13e99ef56 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_derive.md @@ -10,7 +10,15 @@ license: None ## Description -Derives field containers containing complex fields. + +Computes the time derivative of a [phasor](https://en.wikipedia.org/wiki/Phasor) field +in the frequency domain by multiplying by $j\omega$, +where $\omega = 2\pi f$ and $f$ is taken from the fields container's time-frequency support. +The result components are: +$\mathrm{Re}(\dot{z})[i] = -\omega \cdot \mathrm{Im}(z)[i]$, +$\mathrm{Im}(\dot{z})[i] = \omega \cdot \mathrm{Re}(z)[i]$. +The output unit is the input field unit multiplied by the time-frequency support unit. + ## Inputs @@ -29,7 +37,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with a time-frequency support defining the frequencies. ## Outputs @@ -48,7 +56,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container containing the frequency-domain time derivative $j\omega z$ (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md index 37de81ae5..6ae3d538a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_divide.md @@ -10,7 +10,13 @@ license: None ## Description -Computes division between two field containers containing complex fields. + +Computes the [complex division](https://en.wikipedia.org/wiki/Complex_number#Multiplicative_inverse) +$z_1 / z_2$ for matching fields in two complex-valued fields containers: +$\mathrm{Re}(z_\mathrm{out}[i]) = (\mathrm{Re}_1 \mathrm{Re}_2 + \mathrm{Im}_1 \mathrm{Im}_2) / D$, +$\mathrm{Im}(z_\mathrm{out}[i]) = (\mathrm{Im}_1 \mathrm{Re}_2 - \mathrm{Re}_1 \mathrm{Im}_2) / D$ +where $D = \mathrm{Re}_2^2 + \mathrm{Im}_2^2$. Raises an error if $D = 0$. + ## Inputs @@ -30,7 +36,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Numerator complex-valued fields container. ### fields_containerB (Pin 1) @@ -38,7 +44,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Denominator complex-valued fields container. ## Outputs @@ -57,7 +63,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the complex quotient $z_1 / z_2$ (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md index cf6a90d23..d6e1dc9a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_dot.md @@ -10,7 +10,14 @@ license: None ## Description -Computes product between two field containers containing complex fields. + +Computes the real-valued inner product +$\mathrm{out}[i] = \mathrm{Re}_1[i] \cdot \mathrm{Re}_2[i] + \mathrm{Im}_1[i] \cdot \mathrm{Im}_2[i]$ +between matching fields in two complex-valued fields containers. +This equals the real part of the [Hermitian inner product](https://en.wikipedia.org/wiki/Dot_product#Complex_vectors) +$\mathrm{Re}(z_1 \cdot \overline{z_2})$. +Only the real-part result fields (complex label 0) are produced. + ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md index 91f4de3bc..504ecc2d5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cplx_multiply.md @@ -10,7 +10,13 @@ license: None ## Description -Computes multiplication between two field containers containing complex fields. + +Computes the standard [complex multiplication](https://en.wikipedia.org/wiki/Complex_number#Multiplication_and_square) +$z_1 \cdot z_2$ for matching fields in two complex-valued fields containers: +$\mathrm{Re}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Re}_2 - \mathrm{Im}_1 \mathrm{Im}_2$, +$\mathrm{Im}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Im}_2 + \mathrm{Im}_1 \mathrm{Re}_2$. +Both containers must have the same size. + ## Inputs @@ -57,7 +63,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the complex product fields (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md index 9e0b35063..47dd400ec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/dot_tensor.md @@ -10,7 +10,7 @@ license: None ## Description -DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot product between two tensor fields. +DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes entity-wise dot product between two tensor fields. ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md index 4ed4c3b68..36320391c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise exponential function on field data: exp(field[i]). + +Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): +$\mathrm{out}[i] = e^{\mathrm{in}[i]}$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md index 7bd37af5a..c19f6147a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise exponential function on field data: exp(field[i]). + +Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): +$\mathrm{out}[i] = e^{\mathrm{in}[i]}$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md index 520bef7f2..ce6a32568 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product.md @@ -10,7 +10,24 @@ license: None ## Description -Computes a general notion of inner product between two fields of possibly different dimensionality. + +Computes the generalized inner product between two fields, +dispatching the appropriate operation based on their dimensionalities: + +| Pin 0 | Pin 1 | Operation | Result | +|---|---|---|---| +| vector field | vector field | [dot product](https://en.wikipedia.org/wiki/Dot_product) | scalar field | +| scalar field | any field | scaling | field (same dimensionality as B) | +| matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | +| matrix field | vector field | matrix-vector product | vector field | + +In Cartesian coordinates the vector $\cdot$ vector case is equivalent to the standard dot product. +An optional mesh (pin 2) is required when computing the finite-element dot product +between an elemental-nodal field and a nodal field. +If either input is empty, a dimensionless zero scalar field is returned. +The result covers the union of both field scopings; +entities present in only one field contribute zero. + ## Inputs @@ -22,6 +39,7 @@ Each parameter is detailed in the sections that follow the table. |------------|------|--------|------------------| | 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -40,6 +58,14 @@ field or fields container with only one field is expected field or fields container with only one field is expected + +### mesh (Pin 2) + +- **Required:** No +- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + ## Outputs @@ -57,7 +83,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. ## Configurations @@ -146,6 +172,7 @@ Each example shows how to instantiate the operator, connect the required inputs, ansys::dpf::Operator op("generalized_inner_product"); // operator instantiation op.connect(0, my_fieldA); op.connect(1, my_fieldB); +op.connect(2, my_mesh); ansys::dpf::Field my_field = op.getOutput(0); ``` @@ -159,6 +186,7 @@ import ansys.dpf.core as dpf op = dpf.operators.math.generalized_inner_product() # operator instantiation op.inputs.fieldA.connect(my_fieldA) op.inputs.fieldB.connect(my_fieldB) +op.inputs.mesh.connect(my_mesh) my_field = op.outputs.field() ``` @@ -173,6 +201,7 @@ import Ans.DataProcessing as dpf op = dpf.operators.math.generalized_inner_product() # operator instantiation op.inputs.fieldA.Connect(my_fieldA) op.inputs.fieldB.Connect(my_fieldB) +op.inputs.mesh.Connect(my_mesh) my_field = op.outputs.field.GetData() ``` diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md index fa376f74d..04a6cfdb1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/generalized_inner_product_fc.md @@ -10,7 +10,24 @@ license: None ## Description -Computes a general notion of inner product between two fields of possibly different dimensionality. + +Computes the generalized inner product between two fields, +dispatching the appropriate operation based on their dimensionalities: + +| Pin 0 | Pin 1 | Operation | Result | +|---|---|---|---| +| vector field | vector field | [dot product](https://en.wikipedia.org/wiki/Dot_product) | scalar field | +| scalar field | any field | scaling | field (same dimensionality as B) | +| matrix field | matrix field | [matrix product](https://en.wikipedia.org/wiki/Matrix_multiplication) | matrix field | +| matrix field | vector field | matrix-vector product | vector field | + +In Cartesian coordinates the vector $\cdot$ vector case is equivalent to the standard dot product. +An optional mesh (pin 2) is required when computing the finite-element dot product +between an elemental-nodal field and a nodal field. +If either input is empty, a dimensionless zero scalar field is returned. +The result covers the union of both field scopings; +entities present in only one field contribute zero. + ## Inputs @@ -22,6 +39,7 @@ Each parameter is detailed in the sections that follow the table. |------------|------|--------|------------------| | 0 | [field_or_fields_container_A](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | | 1 | [field_or_fields_container_B](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -40,6 +58,14 @@ field or fields container with only one field is expected field or fields container with only one field is expected + +### mesh (Pin 2) + +- **Required:** No +- **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + ## Outputs @@ -57,7 +83,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. ## Configurations @@ -146,6 +172,7 @@ Each example shows how to instantiate the operator, connect the required inputs, ansys::dpf::Operator op("generalized_inner_product_fc"); // operator instantiation op.connect(0, my_field_or_fields_container_A); op.connect(1, my_field_or_fields_container_B); +op.connect(2, my_mesh); ansys::dpf::FieldsContainer my_fields_container = op.getOutput(0); ``` @@ -159,6 +186,7 @@ import ansys.dpf.core as dpf op = dpf.operators.math.generalized_inner_product_fc() # operator instantiation op.inputs.field_or_fields_container_A.connect(my_field_or_fields_container_A) op.inputs.field_or_fields_container_B.connect(my_field_or_fields_container_B) +op.inputs.mesh.connect(my_mesh) my_fields_container = op.outputs.fields_container() ``` @@ -173,6 +201,7 @@ import Ans.DataProcessing as dpf op = dpf.operators.math.generalized_inner_product_fc() # operator instantiation op.inputs.field_or_fields_container_A.Connect(my_field_or_fields_container_A) op.inputs.field_or_fields_container_B.Connect(my_field_or_fields_container_B) +op.inputs.mesh.Connect(my_mesh) my_fields_container = op.outputs.fields_container.GetData() ``` diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md index b903adec0..0da5396b1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/img_part.md @@ -10,7 +10,10 @@ license: None ## Description -Extracts element-wise imaginary part of field containers containing complex fields. + +Extracts the imaginary-part fields (complex label 1) from a complex-valued fields container. +The output container preserves all labels except the complex label. + ## Inputs @@ -29,7 +32,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +51,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container containing only the imaginary-part fields, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md index 112940a15..c505c1170 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md @@ -10,7 +10,7 @@ license: None ## Description -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ## Inputs @@ -48,7 +48,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md index f5676972a..9ecd53431 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert_fc.md @@ -10,7 +10,7 @@ license: None ## Description -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ## Inputs @@ -48,7 +48,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md index 331d156cd..6481e18e6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/kronecker_prod.md @@ -10,7 +10,14 @@ license: None ## Description -Computes element-wise Kronecker product between two tensor fields. + +Computes the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product) +of two matrix-valued fields per entity. +For each entity, if $A$ is an $(m \times n)$ matrix and $B$ is a $(p \times q)$ matrix, +the result is an $(mp \times nq)$ matrix: +$(A \otimes B)_{(ip+k),(jq+l)} = A_{i,j} \cdot B_{k,l}$. +Both input fields must have the same number of entities. + ## Inputs @@ -57,7 +64,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Matrix field containing the Kronecker product $A \otimes B$ for each entity; unit is $u_A \cdot u_B$. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md index 3a8306d1d..c5e025521 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/linear_combination.md @@ -10,7 +10,13 @@ license: None ## Description -Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are complex numbers. + +Computes the [linear combination](https://en.wikipedia.org/wiki/Linear_combination) +$a \cdot X \cdot Y + b \cdot Z$, +where $a$ (pin 0) and $b$ (pin 3) are real scalars, +and $X$ (pin 1), $Y$ (pin 2), $Z$ (pin 4) are complex-valued fields containers. +The product $X \cdot Y$ is a standard complex multiplication. + ## Inputs @@ -33,7 +39,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Double +Real scalar factor $a$ applied to the complex product $X \cdot Y$. ### fields_containerA (Pin 1) @@ -57,7 +63,7 @@ Double - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) -Double +Real scalar factor $b$ applied to the complex addend $Z$. ### fields_containerC (Pin 4) @@ -65,7 +71,7 @@ Double - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Third complex-valued fields container $Z$. ## Outputs @@ -84,7 +90,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the complex result $a \cdot X \cdot Y + b \cdot Z$ (real and imaginary parts). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md index d56b2df44..e2f1b5dc7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise ln(field[i]). + +Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): +$\mathrm{out}[i] = \ln(\mathrm{in}[i])$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md index c092f6ec6..6899f3cc4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise ln(field[i]). + +Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): +$\mathrm{out}[i] = \ln(\mathrm{in}[i])$. +The input must be dimensionless; a dimensional input raises an error. +The output is dimensionless. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md index a05c9b807..9f6fd17b4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md @@ -10,7 +10,15 @@ license: None ## Description -Computes the difference of two fields. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. + +Computes the entity-wise difference $\mathrm{out}[i] = A[i] - B[i]$, +also known as entity-wise subtraction. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +If either input is empty, the other is forwarded unchanged. +When units differ but are homogeneous, pin B values are converted to pin A's unit before subtraction. +Subtracting two temperature fields automatically produces a temperature-difference quantity with the appropriate unit. +Inplace execution is supported when working with constants or using 'work_by_index'. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md index 9e0fc7ccd..9c39354ec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus_fc.md @@ -10,7 +10,15 @@ license: None ## Description -Computes the difference of two fields. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. + +Computes the entity-wise difference $\mathrm{out}[i] = A[i] - B[i]$, +also known as entity-wise subtraction. +If one field's scoping has the 'overall' location, its values are broadcast across all entities of the other field. +If either input is empty, the other is forwarded unchanged. +When units differ but are homogeneous, pin B values are converted to pin A's unit before subtraction. +Subtracting two temperature fields automatically produces a temperature-difference quantity with the appropriate unit. +Inplace execution is supported when working with constants or using 'work_by_index'. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md index 99f19f9ed..ed557b618 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise modulus of field containers containing complex fields. + +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) +$|z[i]| = \sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each value in a complex-valued fields container, +where $\mathrm{Re}$ and $\mathrm{Im}$ are the real and imaginary parts (complex labels 0 and 1 respectively). +The output container has no complex label. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the modulus $\sqrt{\mathrm{Re}^2 + \mathrm{Im}^2}$ for each entry, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md index 7fd076dc1..05e34b7d8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md @@ -10,7 +10,13 @@ license: None ## Description -Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 + +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector +for each entity in the field: +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$, +where $n_c$ is the number of components. Default is $p = 2$ (Euclidean norm). +The output is a scalar field with one value per entity. + ## Inputs @@ -38,7 +44,7 @@ field or fields container with only one field is expected - **Required:** No - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) -Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). ## Outputs @@ -57,7 +63,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Scalar field containing the Lp norm values for each element +Scalar field containing the $L_p$ norm value for each entity. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md index 1ea83c696..6af6fc225 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes the element-wise L2 norm of the field elementary data. This process is applied on each field of the input fields container. + +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector +for each entity in every field of the input fields container: +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$. +Default is $p = 2$ (Euclidean norm). Each output field is scalar. + ## Inputs @@ -30,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer containing fields for norm calculation +Fields container containing fields for norm calculation ### scalar_int (Pin 1) @@ -38,7 +43,7 @@ FieldsContainer containing fields for norm calculation - **Required:** No - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) -Lp normalisation type, p = 1, 2, ...n - Default Lp=2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). ## Outputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with computed norms for each field +Fields container of scalar fields, one per input field, each containing the $L_p$ norm per entity. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md index d712a3c6d..c0f24d53e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md @@ -10,7 +10,12 @@ license: None ## Description -Computes the phase (in rad) between a real and an imaginary field. + +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) +of a complex quantity given as separate real and imaginary fields: +$\phi[i] = \mathrm{atan2}(B[i],\, A[i])$. +The output is in radians. + ## Inputs @@ -57,7 +62,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Field containing the phase angle $\mathrm{atan2}(B[i],\, A[i])$ in radians for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md index 42d23107a..c1fdd23c1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes phase (in rad) between real and imaginary fields. + +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) +$\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians for each complex-valued field pair +in the input fields container, where pairs are matched by complex label. +If no imaginary part is found for a real field, a zero-valued field is produced. + ## Inputs @@ -29,7 +34,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. ## Outputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with phase angle fields $\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians; zero-valued fields are produced where no imaginary part is found. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md index c051f222c..b24d649ef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/polar_to_cplx.md @@ -10,7 +10,14 @@ license: None ## Description -Converts a complex number from polar form to complex. + +Converts a complex-valued fields container from +[polar form](https://en.wikipedia.org/wiki/Complex_number#Polar_complex_plane) (amplitude, phase) +to rectangular form (real, imaginary): +$\mathrm{Re}[i] = A[i] \cdot \cos(\phi[i])$, $\mathrm{Im}[i] = A[i] \cdot \sin(\phi[i])$. +The input must contain amplitude fields tagged with complex label 2 +and phase fields tagged with complex label 3. + ## Inputs @@ -29,7 +36,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with amplitude fields (complex label 2) paired with phase angle fields (complex label 3). ## Outputs @@ -48,7 +55,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container in rectangular form: real parts (complex label 0) and imaginary parts (complex label 1). ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md index 2d67e87dd..8a3a56abe 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md @@ -10,7 +10,7 @@ license: None ## Description -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md index 9a7c2f865..a5b8ef3a0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow_fc.md @@ -10,7 +10,7 @@ license: None ## Description -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md index b86753929..3c574e8f8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/real_part.md @@ -10,7 +10,10 @@ license: None ## Description -Extracts element-wise real part of field containers containing complex fields. + +Extracts the real-part fields (complex label 0) from a complex-valued fields container. +The output container preserves all labels except the complex label. + ## Inputs @@ -29,7 +32,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. ## Outputs @@ -48,7 +51,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container containing only the real-part fields, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md index 0b42e54e4..950d3b7c9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md @@ -10,7 +10,16 @@ license: None ## Description -Scales a field by a constant factor. This factor can be a scalar or a vector, where each value of the vector represents a scaler per component. Number of the components are corresponding to the input field dimensionality + +Scales a field by a constant factor $k$: $\mathrm{out}[i] = k \cdot \mathrm{field}[i]$. +The factor can be a scalar (same $k$ for every component), +a vector of length $n_c$ (one $k_j$ per component, +applied as $\mathrm{out}[i \cdot n_c + j] = k_j \cdot \mathrm{field}[i \cdot n_c + j]$), +or a field whose values are matched by entity or location +(entity-wise multiplication, also known as the +[Hadamard product](https://en.wikipedia.org/wiki/Hadamard_product_(matrices))). +Setting pin 2 to true makes the output dimensionless. + ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md index af7453c35..39ee58319 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_fc.md @@ -10,7 +10,15 @@ license: None ## Description -Scales a fields container by a constant factor. This factor can be a scalar, a vector a field, a fields container, where each value of the vector represents a scaler per component. Number of the components are corresponding to the input field dimensionality + +Scales every field in a fields container by a constant factor. +The factor can be a scalar (same value applied to all components), +a vector of length $n_c$ (one value per component), +a field or a fields container (values matched by entity or label space), +in which case the operation is an entity-wise multiplication +(also known as the [Hadamard product](https://en.wikipedia.org/wiki/Hadamard_product_(matrices))). +Parallelised over fields. + ## Inputs diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md index 8f6aeda76..d82187faa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise sine function on field data: sin(field[i]). + +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the sine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md index 57a34ef71..d7ae0851a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise sine function on field data: sin(field[i]). + +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. +The input must be dimensionless or carry an angle unit; any other unit raises an error. +When the input unit is an angle (e.g. degrees), values are automatically converted to radians +before the sine is applied. The output is dimensionless. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md index 47fa4c10d..06954f857 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise field[i]^2. + +Computes the entity-wise square +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): +$\mathrm{out}[i] = \mathrm{in}[i]^2$. +The output unit is $u^2$ where $u$ is the input unit. + ## Inputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md index c4ec9cfb3..549778c12 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr_fc.md @@ -10,7 +10,12 @@ license: None ## Description -Computes element-wise field[i]^2. + +Computes the entity-wise square +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): +$\mathrm{out}[i] = \mathrm{in}[i]^2$. +The output unit is $u^2$ where $u$ is the input unit. + ## Inputs @@ -48,7 +53,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md index 0187aaf89..9dae369b9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise square root function on field data: sqrt(field[i]). + +Computes the entity-wise square root +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. +All input values must be non-negative; a negative value raises an error. +The output unit is $\sqrt{u}$ where $u$ is the input unit. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md index ab1b4e29c..0f3db34a1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Computes element-wise square root function on field data: sqrt(field[i]). + +Computes the entity-wise square root +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. +All input values must be non-negative; a negative value raises an error. +The output unit is $\sqrt{u}$ where $u$ is the input unit. + ## Inputs @@ -29,7 +35,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. ## Outputs @@ -48,7 +54,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md index e09e59e54..217565460 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase.md @@ -10,7 +10,12 @@ license: None ## Description -Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). + +Projects a [phasor](https://en.wikipedia.org/wiki/Phasor) field onto a given phase angle $\theta$: +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. +When pin 4 is true, the absolute value of the projection is returned instead. +If the imaginary field is absent and pin 5 is true, the imaginary part is treated as zero. + ## Inputs @@ -50,7 +55,7 @@ field or fields container with only one field is expected - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) - +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). ### unit_name (Pin 3) @@ -66,7 +71,7 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". - **Required:** Yes - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - +If true, the absolute value of the projection is returned (default: false). ### imaginary_part_null (Pin 5) @@ -93,7 +98,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field) - +Projected field $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, with the unit of pin 0. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md index 23f88d352..9b6c0ca90 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sweeping_phase_fc.md @@ -10,7 +10,13 @@ license: None ## Description -Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). + +Projects every [phasor](https://en.wikipedia.org/wiki/Phasor) field pair in the input fields container +onto a given phase angle $\theta$: +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. +Pairs are matched by complex label. +When pin 4 is true, the absolute value of each projection is returned. + ## Inputs @@ -32,7 +38,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Complex-valued fields container with paired real and imaginary part fields. ### angle (Pin 2) @@ -40,7 +46,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`double`](../../core-concepts/dpf-types.md#standard-types) - +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). ### unit_name (Pin 3) @@ -56,7 +62,7 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". - **Required:** Yes - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - +If true, the absolute value of each projection is returned (default: false). ## Outputs @@ -75,7 +81,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container with the projected fields $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, without the complex label. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md index 9da2b22d2..7ef72b29b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_freq_interpolation.md @@ -10,7 +10,15 @@ license: None ## Description -Interpolates between all the matching fields of a fields container at given times or frequencies, using ramped: fieldOut = field1*(1.-fact)+field2*(fact), or stepped: fieldOut=field2. If the time freq is higher than the max available, the field at the max time freq is taken. Computes the output time freq support to support the fields container + +Interpolates the fields in a fields container at the requested times or frequencies +using [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation). +Ramped interpolation ($p = 1$, default): $\mathrm{out}[i] = (1 - s) \cdot f_1[i] + s \cdot f_2[i]$ +where $s = (t - t_1) / (t_2 - t_1)$. +Stepped interpolation ($p = 2$): $\mathrm{out}[i] = f_2[i]$. +If the requested value exceeds the available range, the field at the maximum available value is used. +A new time-frequency support aligned with the requested values is produced as a second output. + ## Inputs @@ -86,6 +94,7 @@ Each output is detailed in the sections that follow the table. | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| **1**| [time_freq_support](#output_1) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -93,7 +102,14 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with interpolated fields at specified time/frequency values +Fields container with one interpolated field set per requested time or frequency value. + + +### time_freq_support (Pin 1) + +- **Expected type(s):** [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) + +Time or frequency support aligned with the output fields container. ## Configurations @@ -152,6 +168,7 @@ op.connect(3, my_interpolation_type); op.connect(4, my_force_new_time_freq_support); op.connect(8, my_time_freq_support); ansys::dpf::FieldsContainer my_fields_container = op.getOutput(0); +ansys::dpf::TimeFreqSupport my_time_freq_support = op.getOutput(1); ``` @@ -169,6 +186,7 @@ op.inputs.interpolation_type.connect(my_interpolation_type) op.inputs.force_new_time_freq_support.connect(my_force_new_time_freq_support) op.inputs.time_freq_support.connect(my_time_freq_support) my_fields_container = op.outputs.fields_container() +my_time_freq_support = op.outputs.time_freq_support() ``` @@ -187,6 +205,7 @@ op.inputs.interpolation_type.Connect(my_interpolation_type) op.inputs.force_new_time_freq_support.Connect(my_force_new_time_freq_support) op.inputs.time_freq_support.Connect(my_time_freq_support) my_fields_container = op.outputs.fields_container.GetData() +my_time_freq_support = op.outputs.time_freq_support.GetData() ```
diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md index 195d9ef92..fbb5692f2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert.md @@ -10,7 +10,15 @@ license: None ## Description -Converts an input field/fields container or mesh of a given unit to another unit. + +Converts an input entity from one unit to another using the linear relation +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, +where $k$ and $\delta$ are the unit conversion factor and shift. +Accepts fields, fields containers, meshes, and meshes containers. +For mesh inputs only the coordinate field is converted. +When the permissive option is enabled and units are not homogeneous with the target unit, +the conversion is silently skipped. + ## Inputs @@ -57,7 +65,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) -the output entity is the same as the input (inplace operator) +Converted entity of the same type as the input, modified in place. ## Configurations diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md index d160d30e5..b59ed69e1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/unit_convert_fc.md @@ -10,7 +10,14 @@ license: None ## Description -Converts an input fields container of a given unit to another unit. + +Converts a fields container from one unit to another using the linear relation +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, +where $k$ and $\delta$ are the unit conversion factor and shift. +All fields must be homogeneous with the target unit. +When the permissive option is enabled and units are not homogeneous, +the container is returned unchanged. + ## Inputs @@ -30,7 +37,7 @@ Each parameter is detailed in the sections that follow the table. - **Required:** Yes - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) - +Fields container to convert. All fields are converted in place. ### unit_name (Pin 1) @@ -57,7 +64,7 @@ Each output is detailed in the sections that follow the table. - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) -FieldsContainer with converted units (inplace operation) +Fields container with all field data converted to the requested unit, modified in place. ## Configurations diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md index 548562a73..b74cce670 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component.md @@ -28,7 +28,7 @@ Field, fields container, or numeric data for which to compute absolute values ### field -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md index 05f0a2fa6..fe7f51246 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/absolute_value_by_component_fc.md @@ -4,7 +4,11 @@ uid: Ans.DataProcessing.operators.math.absolute_value_by_component_fc # *class* absolute_value_by_component_fc(fields_container: object = None, config: OperatorConfig = None) -Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. +Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise + +to each scalar data entry: $\mathrm{out}[i] = |\mathrm{in}[i]|$. + +This is a per-component operation and does not compute a vector norm. available inputs: `fields_container` (FieldsContainer) @@ -37,7 +41,7 @@ Field, fields container, or numeric data for which to compute absolute values ### fields_container -Field with absolute values applied to each component +Field with $|\mathrm{in}[i]|$ applied to each data component, preserving the input unit and dimensionality. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md index 0b83bb913..0a1fdbe99 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.accumulate # *class* accumulate(fieldA: object = None, weights: object = None, time_scoping: object = None, config: OperatorConfig = None) -Sums all the elementary data of a field to produce one elementary data point. +Reduces a field to a single entity by summing all entity data component-wise. + +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. + +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, + +where $w_k$ is the weight for entity $k$. + +The weights field must be a scalar (1D) field providing one weight per entity. available inputs: `fieldA` (Field, FieldsContainer), `weights` (Field) (optional), `time_scoping` (Scoping) (optional) @@ -49,7 +57,7 @@ Deprecated alias of: weights ### time_scoping -time_scoping +Optional scoping that sets the output entity's location and ID. **Type:** *LinkableInput* @@ -57,7 +65,7 @@ time_scoping ### field -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md index 2528eace2..279839686 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/accumulate_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.accumulate_fc # *class* accumulate_fc(fields_container: object = None, weights: object = None, time_scoping: object = None, config: OperatorConfig = None) -Sums all the elementary data of a field to produce one elementary data point. +Reduces a field to a single entity by summing all entity data component-wise. + +Without weights: $\mathrm{out}[c] = \sum_k \mathrm{field}[k, c]$ for each component $c$. + +With an optional weights field (pin 1): $\mathrm{out}[c] = \sum_k w_k \cdot \mathrm{field}[k, c]$, + +where $w_k$ is the weight for entity $k$. + +The weights field must be a scalar (1D) field providing one weight per entity. available inputs: `fields_container` (FieldsContainer), `weights` (Field) (optional), `time_scoping` (Scoping) (optional) @@ -49,7 +57,7 @@ Deprecated alias of: weights ### time_scoping -time_scoping +Optional scoping that sets the output entity's location and ID. **Type:** *LinkableInput* @@ -57,7 +65,7 @@ time_scoping ### fields_container -Field containing the (weighted) sum for each component in an elementary data +Field with one entity containing the (weighted) component sums $\sum_k w_k \cdot \mathrm{field}[k, c]$ for each component $c$. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md index b7b496653..f72281b3d 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add.md @@ -35,7 +35,7 @@ field or fields container with only one field is expected ### field -Field containing the element-wise sum of the two input fields +Field whose data equals $A[i] + B[i]$, with pin A's unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md index 6cac74828..26c6c8787 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/add_fc.md @@ -31,7 +31,7 @@ add_fc(config: OperatorConfig) ### fields_container -FieldsContainer with summed fields by label space +Fields container with fields summed by matching label space. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md index 6f687adc3..2ddd1cc85 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.amplitude # *class* amplitude(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -Computes amplitude of a real and an imaginary field. +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) + +of a complex quantity given as separate real and imaginary fields: + +$\mathrm{out}[i] = \sqrt{A[i]^2 + B[i]^2}$. + +The output carries the unit of pin A. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) @@ -44,6 +50,8 @@ field or fields container with only one field is expected ### field +Scalar field with $\sqrt{A[i]^2 + B[i]^2}$ for each data entry, carrying the unit of pin A. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md index 4484fbcd7..83d2fc494 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/amplitude_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.amplitude_fc # *class* amplitude_fc(fields_container: object = None, config: OperatorConfig = None) -Computes the amplitude of a real and an imaginary field. +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) + +$\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each complex-valued field pair in the input fields container, + +where pairs are matched by complex label. + +If no imaginary part is found for a real field, that real field is returned unchanged. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = amplitude_fc(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with amplitude fields $\sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$, carrying the unit of the real input field. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md index 37c10b984..d5d3040ab 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.centroid # *class* centroid(fieldA: object = None, fieldB: object = None, factor: object = None, config: OperatorConfig = None) -Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2*(fact). Only works by index. +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between two fields + +using a scalar factor $t$: $\mathrm{out}[i] = (1 - t) \cdot A[i] + t \cdot B[i]$. + +The interpolation is convex (no extrapolation) when $t \in [0, 1]$; + +values outside this range extrapolate beyond the two input fields. + +This operator works by index only. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer), `factor` (double) @@ -43,7 +51,7 @@ field or fields container with only one field is expected ### factor -Scalar +Interpolation factor $t$: $t = 0$ returns fieldA unchanged, $t = 1$ returns fieldB unchanged. Values in $[0, 1]$ interpolate; values outside extrapolate. **Type:** *LinkableInput* @@ -51,7 +59,7 @@ Scalar ### field -Field with centroid calculation: fieldA*(1-factor) + fieldB*factor +Interpolated field $(1 - t) \cdot A + t \cdot B$, with the unit of pin A. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md index 4dfb35825..7215d2579 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/centroid_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.centroid_fc # *class* centroid_fc(fields_container: object = None, time_freq: object = None, step: object = None, time_freq_support: object = None, config: OperatorConfig = None) -Computes the centroid of all the matching fields of a fields container at a given time or frequency, using fieldOut = field1*(1.-fact)+field2*(fact). +Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between the two fields + +in the input fields container that bracket the requested time or frequency value $t$: + +$\mathrm{out}[i] = (1 - s) \cdot f_1[i] + s \cdot f_2[i]$, + +where $s = (t - t_1) / (t_2 - t_1)$ and $t_1$, $t_2$ are the bracketing time/frequency values. + +If the requested value exactly matches an available one, that field is returned directly. available inputs: `fields_container` (FieldsContainer), `time_freq` (double), `step` (Int32) (optional), `time_freq_support` (TimeFreqSupport) (optional) @@ -32,25 +40,25 @@ op = centroid_fc(fields_container=my_fields_container,time_freq=my_time_freq,ste ### fields_container -FieldsContainer with fields for centroid calculation +Fields container with fields over time or frequency. **Type:** *LinkableInput* ### time_freq -Time or frequency value for field selection +Time or frequency value at which to interpolate. **Type:** *LinkableInput* ### step -Optional step specification +Optional step specification. **Type:** *LinkableInput* ### time_freq_support -Optional TimeFreqSupport for field resolution +Optional time/frequency support for field resolution. **Type:** *LinkableInput* @@ -58,7 +66,7 @@ Optional TimeFreqSupport for field resolution ### fields_container -FieldsContainer with centroid calculation results at specified time/frequency +Fields container with the interpolated fields at the requested time or frequency. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md index 6487b7515..852ed9ed2 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide.md @@ -1,63 +1,54 @@ ---- -uid: Ans.DataProcessing.operators.math.component_wise_divide ---- - -# *class* component_wise_divide(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) - -Computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. - -available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) - -available outputs: `field` (Field) - -**DPF Framework Reference:** [component_wise_divide operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/math/component_wise_divide.md) - -**Parameters:** - -* **fieldA** -* **fieldB** -* **config** - -**Example:** - -```python -op = component_wise_divide() - -op = component_wise_divide(fieldA=my_fieldA,fieldB=my_fieldB) -``` - -## Inputs - -### fieldA - -field or fields container with only one field is expected - -**Type:** *LinkableInput* - -### fieldB - -field or fields container with only one field is expected - -**Type:** *LinkableInput* - -## Outputs - -### field - -**Type:** *LinkableOutput* - -## Methods - -## Properties - -#### *property* inputs: InputSpec - -*get/set* - -#### *property* outputs: OutputSpec - -*get/set* - -#### *property* defaultConfig: Config - -*get* +--- +uid: Ans.DataProcessing.operators.math.component_wise_divide +--- + +# *class* component_wise_divide(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) + +component_wise_divide() +component_wise_divide(fieldA: object, fieldB: object, config: OperatorConfig) +component_wise_divide(config: OperatorConfig) + + +**DPF Framework Reference:** [component_wise_divide operator specification](https://developer.ansys.com/docs/dpf-framework-2027-r1/operator-specifications/math/component_wise_divide.md) + +**Parameters:** + +* **fieldA** +* **fieldB** +* **config** + +## Inputs + +### fieldA + +field or fields container with only one field is expected + +**Type:** *LinkableInput* + +### fieldB + +field or fields container with only one field is expected + +**Type:** *LinkableInput* + +## Outputs + +### field + +**Type:** *LinkableOutput* + +## Methods + +## Properties + +#### *property* inputs: InputSpec + +*get/set* + +#### *property* outputs: OutputSpec + +*get/set* + +#### *property* defaultConfig: Config + +*get* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md index dd5715c10..e6124d3c7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/component_wise_divide_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.component_wise_divide_fc # *class* component_wise_divide_fc(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -For every two fields with the same label space (from the two input fields containers), computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. +For every pair of fields with matching label space in the two input fields containers, + +computes the component-wise fraction $\mathrm{out}[k] = A[k] / B[k]$ + +(also known as the [Hadamard division](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)). + +Both containers must have identical label spaces and the same number of fields. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) @@ -40,6 +46,8 @@ op = component_wise_divide_fc(fields_containerA=my_fields_containerA,fields_cont ### fields_container +Fields container with the component-wise quotient fields; unit is $u_A / u_B$. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md index dc58d3745..ccd11b60b 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/conjugate.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.conjugate # *class* conjugate(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise conjugate of field containers containing complex fields. +Computes the [complex conjugate](https://en.wikipedia.org/wiki/Complex_conjugate) + +$\bar{z}[i] = \mathrm{Re}[i] - j \cdot \mathrm{Im}[i]$ for each value in a complex-valued fields container + +(the imaginary part is negated). + +Input and output containers have the same structure. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = conjugate(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with conjugate values; the imaginary-part fields carry negated data. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md index 5a6315ff3..9a8309af7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cos # *class* cos(field: object = None, config: OperatorConfig = None) -Computes element-wise cosine function on field data: cos(field[i]). +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the cosine is applied. The output is dimensionless. available inputs: `field` (Field, FieldsContainer) @@ -29,7 +37,7 @@ op = cos(field=my_field) ### field -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for cosine calculation ### field -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md index 6525bf81e..e499e91e7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cos_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cos_fc # *class* cos_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise cosine function on field data: cos(field[i]). +Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \cos(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the cosine is applied. The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +37,7 @@ op = cos_fc(fields_container=my_fields_container) ### fields_container -Field or fields container containing numeric data for cosine calculation +Dimensionless or angle-unit field or fields container. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for cosine calculation ### fields_container -Field with cosine values applied element-wise to input data +Dimensionless field with $\cos(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md index fd2f87207..f006d9b34 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_derive.md @@ -4,7 +4,19 @@ uid: Ans.DataProcessing.operators.math.cplx_derive # *class* cplx_derive(fields_container: object = None, config: OperatorConfig = None) -Derives field containers containing complex fields. +Computes the time derivative of a [phasor](https://en.wikipedia.org/wiki/Phasor) field + +in the frequency domain by multiplying by $j\omega$, + +where $\omega = 2\pi f$ and $f$ is taken from the fields container's time-frequency support. + +The result components are: + +$\mathrm{Re}(\dot{z})[i] = -\omega \cdot \mathrm{Im}(z)[i]$, + +$\mathrm{Im}(\dot{z})[i] = \omega \cdot \mathrm{Re}(z)[i]$. + +The output unit is the input field unit multiplied by the time-frequency support unit. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +41,16 @@ op = cplx_derive(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with a time-frequency support defining the frequencies. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container containing the frequency-domain time derivative $j\omega z$ (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md index ed0b17ea0..78daced41 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_divide.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cplx_divide # *class* cplx_divide(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -Computes division between two field containers containing complex fields. +Computes the [complex division](https://en.wikipedia.org/wiki/Complex_number#Multiplicative_inverse) + +$z_1 / z_2$ for matching fields in two complex-valued fields containers: + +$\mathrm{Re}(z_\mathrm{out}[i]) = (\mathrm{Re}_1 \mathrm{Re}_2 + \mathrm{Im}_1 \mathrm{Im}_2) / D$, + +$\mathrm{Im}(z_\mathrm{out}[i]) = (\mathrm{Im}_1 \mathrm{Re}_2 - \mathrm{Re}_1 \mathrm{Im}_2) / D$ + +where $D = \mathrm{Re}_2^2 + \mathrm{Im}_2^2$. Raises an error if $D = 0$. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) @@ -30,16 +38,22 @@ op = cplx_divide(fields_containerA=my_fields_containerA,fields_containerB=my_fie ### fields_containerA +Numerator complex-valued fields container. + **Type:** *LinkableInput* ### fields_containerB +Denominator complex-valued fields container. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the complex quotient $z_1 / z_2$ (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md index 578ef4825..56ef6a462 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_dot.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.cplx_dot # *class* cplx_dot(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -Computes product between two field containers containing complex fields. +Computes the real-valued inner product + +$\mathrm{out}[i] = \mathrm{Re}_1[i] \cdot \mathrm{Re}_2[i] + \mathrm{Im}_1[i] \cdot \mathrm{Im}_2[i]$ + +between matching fields in two complex-valued fields containers. + +This equals the real part of the [Hermitian inner product](https://en.wikipedia.org/wiki/Dot_product#Complex_vectors) + +$\mathrm{Re}(z_1 \cdot \overline{z_2})$. + +Only the real-part result fields (complex label 0) are produced. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md index 5e20edd2f..f653a24e9 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/cplx_multiply.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.cplx_multiply # *class* cplx_multiply(fields_containerA: object = None, fields_containerB: object = None, config: OperatorConfig = None) -Computes multiplication between two field containers containing complex fields. +Computes the standard [complex multiplication](https://en.wikipedia.org/wiki/Complex_number#Multiplication_and_square) + +$z_1 \cdot z_2$ for matching fields in two complex-valued fields containers: + +$\mathrm{Re}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Re}_2 - \mathrm{Im}_1 \mathrm{Im}_2$, + +$\mathrm{Im}(z_\mathrm{out})[i] = \mathrm{Re}_1 \mathrm{Im}_2 + \mathrm{Im}_1 \mathrm{Re}_2$. + +Both containers must have the same size. available inputs: `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer) @@ -40,6 +48,8 @@ op = cplx_multiply(fields_containerA=my_fields_containerA,fields_containerB=my_f ### fields_container +Fields container with the complex product fields (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md index c4eee9a38..fcc7fe792 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/dot_tensor.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.dot_tensor # *class* dot_tensor(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot product between two tensor fields. +DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes entity-wise dot product between two tensor fields. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md index 2b5eba7d2..cd7169342 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential.md @@ -20,7 +20,7 @@ exponential(config: OperatorConfig) ### field -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -28,7 +28,7 @@ Field, fields container, or numeric data for exponential calculation ### field -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md index b699bf7a8..f71e1b285 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/exponential_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.exponential_fc # *class* exponential_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise exponential function on field data: exp(field[i]). +Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): + +$\mathrm{out}[i] = e^{\mathrm{in}[i]}$. + +The input must be dimensionless; a dimensional input raises an error. + +The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +35,7 @@ op = exponential_fc(fields_container=my_fields_container) ### fields_container -Field, fields container, or numeric data for exponential calculation +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -37,7 +43,7 @@ Field, fields container, or numeric data for exponential calculation ### fields_container -Field with exponential values applied element-wise to input data +Dimensionless field with $e^{\mathrm{in}[i]}$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md index ca04dd316..53195072f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product.md @@ -2,10 +2,10 @@ uid: Ans.DataProcessing.operators.math.generalized_inner_product --- -# *class* generalized_inner_product(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) +# *class* generalized_inner_product(fieldA: object = None, fieldB: object = None, mesh: object = None, config: OperatorConfig = None) generalized_inner_product() -generalized_inner_product(fieldA: object, fieldB: object, config: OperatorConfig) +generalized_inner_product(fieldA: object, fieldB: object, mesh: object, config: OperatorConfig) generalized_inner_product(config: OperatorConfig) @@ -15,6 +15,7 @@ generalized_inner_product(config: OperatorConfig) * **fieldA** * **fieldB** +* **mesh** * **config** ## Inputs @@ -31,11 +32,17 @@ field or fields container with only one field is expected **Type:** *LinkableInput* +### mesh + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + +**Type:** *LinkableInput* + ## Outputs ### field -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md index 8e6aa9fe9..f7f4265d7 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/generalized_inner_product_fc.md @@ -2,10 +2,10 @@ uid: Ans.DataProcessing.operators.math.generalized_inner_product_fc --- -# *class* generalized_inner_product_fc(field_or_fields_container_A: object = None, field_or_fields_container_B: object = None, config: OperatorConfig = None) +# *class* generalized_inner_product_fc(field_or_fields_container_A: object = None, field_or_fields_container_B: object = None, mesh: object = None, config: OperatorConfig = None) generalized_inner_product_fc() -generalized_inner_product_fc(field_or_fields_container_A: object, field_or_fields_container_B: object, config: OperatorConfig) +generalized_inner_product_fc(field_or_fields_container_A: object, field_or_fields_container_B: object, mesh: object, config: OperatorConfig) generalized_inner_product_fc(config: OperatorConfig) @@ -15,6 +15,7 @@ generalized_inner_product_fc(config: OperatorConfig) * **field_or_fields_container_A** * **field_or_fields_container_B** +* **mesh** * **config** ## Inputs @@ -31,11 +32,17 @@ field or fields container with only one field is expected **Type:** *LinkableInput* +### mesh + +Mesh required when computing the finite-element dot product between an elemental-nodal field (pin 0 or 1) and a nodal field. + +**Type:** *LinkableInput* + ## Outputs ### fields_container -Field containing the generalized inner product result +Inner product result field; dimensionality and unit are determined by the dispatched operation. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md index da860a53a..8338a0900 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/img_part.md @@ -4,7 +4,9 @@ uid: Ans.DataProcessing.operators.math.img_part # *class* img_part(fields_container: object = None, config: OperatorConfig = None) -Extracts element-wise imaginary part of field containers containing complex fields. +Extracts the imaginary-part fields (complex label 1) from a complex-valued fields container. + +The output container preserves all labels except the complex label. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +31,16 @@ op = img_part(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container containing only the imaginary-part fields, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md index 01f29a1fa..9db24073f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/index.md @@ -9,9 +9,9 @@ uid: Ans.DataProcessing.operators.math | Class | Description | |-------|-------------| | [absolute_value_by_component](Ans_DataProcessing_operators_math_absolute_value_by_component.md) | absolute_value_by_component() | -| [absolute_value_by_component_fc](Ans_DataProcessing_operators_math_absolute_value_by_component_fc.md) | Computes the absolute value of each data value in the input field component-wise, without performing vector norm operations. ///available inputs: fields_container (FieldsContainer) | -| [accumulate](Ans_DataProcessing_operators_math_accumulate.md) | Sums all the elementary data of a field to produce one elementary data point. ///available inputs: fieldA (Field, FieldsContainer), weights (Field) (optional), time_scoping (Scoping) (optional) | -| [accumulate_fc](Ans_DataProcessing_operators_math_accumulate_fc.md) | Sums all the elementary data of a field to produce one elementary data point. ///available inputs: fields_container (FieldsContainer), weights (Field) (optional), time_scoping (Scoping) (optional) | +| [absolute_value_by_component_fc](Ans_DataProcessing_operators_math_absolute_value_by_component_fc.md) | Applies the [absolute value](https://en.wikipedia.org/wiki/Absolute_value) function component-wise | +| [accumulate](Ans_DataProcessing_operators_math_accumulate.md) | Reduces a field to a single entity by summing all entity data component-wise. | +| [accumulate_fc](Ans_DataProcessing_operators_math_accumulate_fc.md) | Reduces a field to a single entity by summing all entity data component-wise. | | [accumulate_level_over_label_fc](Ans_DataProcessing_operators_math_accumulate_level_over_label_fc.md) | Compute the component-wise sum over all the fields that have the same ID as the label set as input in the fields container and apply 10.0xlog10(data/10xx-12) on the result. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | | [accumulate_min_over_label_fc](Ans_DataProcessing_operators_math_accumulate_min_over_label_fc.md) | Compute the component-wise sum over all the fields that have the same ID as the label set as input in the fields container and take its opposite. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | | [accumulate_over_label_fc](Ans_DataProcessing_operators_math_accumulate_over_label_fc.md) | Compute the component-wise sum over all the fields that have the same ID as the label set as input in the fields container. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | @@ -20,33 +20,33 @@ uid: Ans.DataProcessing.operators.math | [add_constant](Ans_DataProcessing_operators_math_add_constant.md) | add_constant() | | [add_constant_fc](Ans_DataProcessing_operators_math_add_constant_fc.md) | add_constant_fc() | | [add_fc](Ans_DataProcessing_operators_math_add_fc.md) | add_fc() | -| [amplitude](Ans_DataProcessing_operators_math_amplitude.md) | Computes amplitude of a real and an imaginary field. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [amplitude_fc](Ans_DataProcessing_operators_math_amplitude_fc.md) | Computes the amplitude of a real and an imaginary field. ///available inputs: fields_container (FieldsContainer) | +| [amplitude](Ans_DataProcessing_operators_math_amplitude.md) | Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) | +| [amplitude_fc](Ans_DataProcessing_operators_math_amplitude_fc.md) | Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) (amplitude) | | [average_over_label_fc](Ans_DataProcessing_operators_math_average_over_label_fc.md) | Compute the component-wise average over all the fields that have the same ID as the label set as input in the fields container. This computation can be incremental. If the input fields container is connected and the operator is run multiple times, the output field will be on all the connected inputs. ///available inputs: fields_container (FieldsContainer), label (string) (optional) | -| [centroid](Ans_DataProcessing_operators_math_centroid.md) | Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2*(fact). Only works by index. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer), factor (double) | -| [centroid_fc](Ans_DataProcessing_operators_math_centroid_fc.md) | Computes the centroid of all the matching fields of a fields container at a given time or frequency, using fieldOut = field1*(1.-fact)+field2*(fact). ///available inputs: fields_container (FieldsContainer), time_freq (double), step (Int32) (optional), time_freq_support (TimeFreqSupport) (optional) | -| [component_wise_divide](Ans_DataProcessing_operators_math_component_wise_divide.md) | Computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [component_wise_divide_fc](Ans_DataProcessing_operators_math_component_wise_divide_fc.md) | For every two fields with the same label space (from the two input fields containers), computes component-wise fraction between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | +| [centroid](Ans_DataProcessing_operators_math_centroid.md) | Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between two fields | +| [centroid_fc](Ans_DataProcessing_operators_math_centroid_fc.md) | Computes a [linear interpolation](https://en.wikipedia.org/wiki/Linear_interpolation) between the two fields | +| [component_wise_divide](Ans_DataProcessing_operators_math_component_wise_divide.md) | component_wise_divide() | +| [component_wise_divide_fc](Ans_DataProcessing_operators_math_component_wise_divide_fc.md) | For every pair of fields with matching label space in the two input fields containers, | | [component_wise_product](Ans_DataProcessing_operators_math_component_wise_product.md) | Computes component-wise product between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | | [component_wise_product_fc](Ans_DataProcessing_operators_math_component_wise_product_fc.md) | Computes component-wise product between two fields of same dimensionality. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields. ///available inputs: fields_container (FieldsContainer), fieldB (Field, FieldsContainer) | | [compute_residual_and_error](Ans_DataProcessing_operators_math_compute_residual_and_error.md) | Computes the \\(L_p\\) norm of a normalized field or a field container. | -| [conjugate](Ans_DataProcessing_operators_math_conjugate.md) | Computes element-wise conjugate of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | +| [conjugate](Ans_DataProcessing_operators_math_conjugate.md) | Computes the [complex conjugate](https://en.wikipedia.org/wiki/Complex_conjugate) | | [correlation](Ans_DataProcessing_operators_math_correlation.md) | correlation() | -| [cos](Ans_DataProcessing_operators_math_cos.md) | Computes element-wise cosine function on field data: cos(field[i]). ///available inputs: field (Field, FieldsContainer) | -| [cos_fc](Ans_DataProcessing_operators_math_cos_fc.md) | Computes element-wise cosine function on field data: cos(field[i]). ///available inputs: fields_container (FieldsContainer) | -| [cplx_derive](Ans_DataProcessing_operators_math_cplx_derive.md) | Derives field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | -| [cplx_divide](Ans_DataProcessing_operators_math_cplx_divide.md) | Computes division between two field containers containing complex fields. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | -| [cplx_dot](Ans_DataProcessing_operators_math_cplx_dot.md) | Computes product between two field containers containing complex fields. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | -| [cplx_multiply](Ans_DataProcessing_operators_math_cplx_multiply.md) | Computes multiplication between two field containers containing complex fields. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer) | +| [cos](Ans_DataProcessing_operators_math_cos.md) | Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [cos_fc](Ans_DataProcessing_operators_math_cos_fc.md) | Computes the entity-wise [cosine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [cplx_derive](Ans_DataProcessing_operators_math_cplx_derive.md) | Computes the time derivative of a [phasor](https://en.wikipedia.org/wiki/Phasor) field | +| [cplx_divide](Ans_DataProcessing_operators_math_cplx_divide.md) | Computes the [complex division](https://en.wikipedia.org/wiki/Complex_number#Multiplicative_inverse) | +| [cplx_dot](Ans_DataProcessing_operators_math_cplx_dot.md) | Computes the real-valued inner product | +| [cplx_multiply](Ans_DataProcessing_operators_math_cplx_multiply.md) | Computes the standard [complex multiplication](https://en.wikipedia.org/wiki/Complex_number#Multiplication_and_square) | | [cross_product](Ans_DataProcessing_operators_math_cross_product.md) | cross_product() | | [cross_product_fc](Ans_DataProcessing_operators_math_cross_product_fc.md) | cross_product_fc() | | [dot](Ans_DataProcessing_operators_math_dot.md) | DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element - wise dot product between two vector fields. If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely.When using a constant or 'work_by_index', you can use 'inplace' to reuse one of the fields, but only in the case where both fields are scalar. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [dot_tensor](Ans_DataProcessing_operators_math_dot_tensor.md) | DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot product between two tensor fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | +| [dot_tensor](Ans_DataProcessing_operators_math_dot_tensor.md) | DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes entity-wise dot product between two tensor fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | | [eim_solver](Ans_DataProcessing_operators_math_eim_solver.md) | eim_solver() | | [entity_extractor](Ans_DataProcessing_operators_math_entity_extractor.md) | Extracts an entity from a field, based on its ID. ///available inputs: fieldA (Field), scalar_int (Int32) | | [expansion_psd](Ans_DataProcessing_operators_math_expansion_psd.md) | Computes the PSD response for one-sigma solution. ///available inputs: mode_shapes (FieldsContainer), static_shapes (FieldsContainer) (optional), rel_rel_covar_matrix (FieldsContainer), stat_stat_covar_matrix (FieldsContainer) (optional), rel_stat_covar_matrix (FieldsContainer) (optional) | | [exponential](Ans_DataProcessing_operators_math_exponential.md) | exponential() | -| [exponential_fc](Ans_DataProcessing_operators_math_exponential_fc.md) | Computes element-wise exponential function on field data: exp(field[i]). ///available inputs: fields_container (FieldsContainer) | +| [exponential_fc](Ans_DataProcessing_operators_math_exponential_fc.md) | Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function): | | [fastnvh_loadfile](Ans_DataProcessing_operators_math_fastnvh_loadfile.md) | fastnvh_loadfile() | | [fft_approx](Ans_DataProcessing_operators_math_fft_approx.md) | Computes the fitting curve using FFT filtering and cubic fitting in space (node i: x=time, y=data), with the possibility to compute the first and the second derivatives of the curve. ///available inputs: time_scoping (IList int, Scoping, System.Collections.IEnumerable) (optional), mesh_scoping (Scoping, ScopingsContainer) (optional), entity_to_fit (FieldsContainer), component_number (Int32), first_derivative (bool), second_derivative (bool), fit_data (bool), cutoff_fr (double, Int32) (optional) | | [fft_eval](Ans_DataProcessing_operators_math_fft_eval.md) | Evaluate the fast fourier transforms at a given set of fields. ///available inputs: field_t (Field), time_scoping (Scoping) (optional) | @@ -54,14 +54,14 @@ uid: Ans.DataProcessing.operators.math | [fft_multi_harmonic_minmax](Ans_DataProcessing_operators_math_fft_multi_harmonic_minmax.md) | Evaluate min max fields on multi harmonic solution. min and max fields are calculated based on evaluating a fourier series sum wrt rpms and using the gradient method for adaptive time steping ///available inputs: fields_container (FieldsContainer), rpm_scoping (Scoping) (optional), fs_ratio (Int32) (optional), num_subdivisions (Int32) (optional), max_num_subdivisions (Int32) (optional), num_cycles (Int32) (optional), use_harmonic_zero (bool) (optional), calculate_time_series (bool) (optional), substeps_selector (IList int, System.Collections.IEnumerable) (optional) | | [generalized_inner_product](Ans_DataProcessing_operators_math_generalized_inner_product.md) | generalized_inner_product() | | [generalized_inner_product_fc](Ans_DataProcessing_operators_math_generalized_inner_product_fc.md) | generalized_inner_product_fc() | -| [img_part](Ans_DataProcessing_operators_math_img_part.md) | Extracts element-wise imaginary part of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | -| [invert](Ans_DataProcessing_operators_math_invert.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). ///available inputs: field (Field, FieldsContainer) | -| [invert_fc](Ans_DataProcessing_operators_math_invert_fc.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). ///available inputs: fields_container (FieldsContainer) | -| [kronecker_prod](Ans_DataProcessing_operators_math_kronecker_prod.md) | Computes element-wise Kronecker product between two tensor fields. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [linear_combination](Ans_DataProcessing_operators_math_linear_combination.md) | Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are complex numbers. ///available inputs: a (double), fields_containerA (FieldsContainer), fields_containerB (FieldsContainer), b (double), fields_containerC (FieldsContainer) | +| [img_part](Ans_DataProcessing_operators_math_img_part.md) | Extracts the imaginary-part fields (complex label 1) from a complex-valued fields container. | +| [invert](Ans_DataProcessing_operators_math_invert.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ///available inputs: field (Field, FieldsContainer) | +| [invert_fc](Ans_DataProcessing_operators_math_invert_fc.md) | DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). ///available inputs: fields_container (FieldsContainer) | +| [kronecker_prod](Ans_DataProcessing_operators_math_kronecker_prod.md) | Computes the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product) | +| [linear_combination](Ans_DataProcessing_operators_math_linear_combination.md) | Computes the [linear combination](https://en.wikipedia.org/wiki/Linear_combination) | | [linearized_stress](Ans_DataProcessing_operators_math_linearized_stress.md) | get linearized stress ///available inputs: stress_comps (FieldsContainer), iComp (Int32), path_coords (Field), rho (double), kbr (Int32), ksxbzro (Int32), out_type (Int32) | | [ln](Ans_DataProcessing_operators_math_ln.md) | ln() | -| [ln_fc](Ans_DataProcessing_operators_math_ln_fc.md) | Computes element-wise ln(field[i]). ///available inputs: fields_container (FieldsContainer) | +| [ln_fc](Ans_DataProcessing_operators_math_ln_fc.md) | Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): | | [mac](Ans_DataProcessing_operators_math_mac.md) | Computes MAC Matrix between two fields container, both for real and complex cases. For mixed cases (real-complex and complex) only the real part is considered. Providing inputs with the same component scoping is an user responsability. ///available inputs: fields_containerA (FieldsContainer), fields_containerB (FieldsContainer), weights (Field) | | [make_one_on_comp](Ans_DataProcessing_operators_math_make_one_on_comp.md) | Takes the input field's scoping and creates a field full of zeros, except for the indexes from pin 1 that will hold 1.0. ///available inputs: fieldA (Field), scalar_int (Int32) | | [matrix_inverse](Ans_DataProcessing_operators_math_matrix_inverse.md) | Computes the complex matrix inverse for each field in the given fields container. ///available inputs: fields_container (FieldsContainer) | @@ -70,38 +70,38 @@ uid: Ans.DataProcessing.operators.math | [modal_damping_ratio](Ans_DataProcessing_operators_math_modal_damping_ratio.md) | modal_damping_ratio() | | [modal_participation](Ans_DataProcessing_operators_math_modal_participation.md) | Compute the modal participation factor for a given vector field V, defined as sum_i ( V .dot. mode_shape_i * ponderation ). ///available inputs: v_real (Field), v_imag (Field), mode_shapes (FieldsContainer), ponderation (Field) (optional), force_label_space (LabelSpace) (optional) | | [modal_superposition](Ans_DataProcessing_operators_math_modal_superposition.md) | Computes the solution in the time/frequency space from a modal solution by multiplying a modal basis (in 0)by the solution in this modal space (coefficients for each mode for each time/frequency) (in 1). ///available inputs: modal_basis (FieldsContainer), solution_in_modal_space (FieldsContainer), incremental_fc (FieldsContainer) (optional), time_scoping (Scoping, IList int, System.Collections.IEnumerable) (optional), mesh_scoping (Scoping, ScopingsContainer) (optional) | -| [modulus](Ans_DataProcessing_operators_math_modulus.md) | Computes element-wise modulus of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | -| [norm](Ans_DataProcessing_operators_math_norm.md) | Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 ///available inputs: field (Field, FieldsContainer), scalar_int (Int32) (optional) | -| [norm_fc](Ans_DataProcessing_operators_math_norm_fc.md) | Computes the element-wise L2 norm of the field elementary data. This process is applied on each field of the input fields container. ///available inputs: fields_container (FieldsContainer), scalar_int (Int32) (optional) | +| [modulus](Ans_DataProcessing_operators_math_modulus.md) | Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) | +| [norm](Ans_DataProcessing_operators_math_norm.md) | Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector | +| [norm_fc](Ans_DataProcessing_operators_math_norm_fc.md) | Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector | | [nvh_curve_fitting_solver](Ans_DataProcessing_operators_math_nvh_curve_fitting_solver.md) | nvh_curve_fitting_solver() | | [outer_product](Ans_DataProcessing_operators_math_outer_product.md) | outer_product() | | [overall_dot](Ans_DataProcessing_operators_math_overall_dot.md) | Computes a dot product between two fields (fields are seen like a single large vector) and returns a scalar. ///available inputs: fieldA (Field), fieldB (Field) | -| [phase](Ans_DataProcessing_operators_math_phase.md) | Computes the phase (in rad) between a real and an imaginary field. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | -| [phase_fc](Ans_DataProcessing_operators_math_phase_fc.md) | Computes phase (in rad) between real and imaginary fields. ///available inputs: fields_container (FieldsContainer) | -| [polar_to_cplx](Ans_DataProcessing_operators_math_polar_to_cplx.md) | Converts a complex number from polar form to complex. ///available inputs: fields_container (FieldsContainer) | -| [pow](Ans_DataProcessing_operators_math_pow.md) | Computes element-wise field[i]^p. ///available inputs: field (Field), factor (double), division_by_zero_value (double) (optional) | -| [pow_fc](Ans_DataProcessing_operators_math_pow_fc.md) | Computes element-wise field[i]^p. ///available inputs: fields_container (FieldsContainer), factor (double), division_by_zero_value (double) (optional) | +| [phase](Ans_DataProcessing_operators_math_phase.md) | Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) | +| [phase_fc](Ans_DataProcessing_operators_math_phase_fc.md) | Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) | +| [polar_to_cplx](Ans_DataProcessing_operators_math_polar_to_cplx.md) | Converts a complex-valued fields container from | +| [pow](Ans_DataProcessing_operators_math_pow.md) | Computes entity-wise field[i]^p. ///available inputs: field (Field), factor (double), division_by_zero_value (double) (optional) | +| [pow_fc](Ans_DataProcessing_operators_math_pow_fc.md) | Computes entity-wise field[i]^p. ///available inputs: fields_container (FieldsContainer), factor (double), division_by_zero_value (double) (optional) | | [qr_solve](Ans_DataProcessing_operators_math_qr_solve.md) | Computes the solution using QR factorization. ///available inputs: fields_container (FieldsContainer), rhs (FieldsContainer) | -| [real_part](Ans_DataProcessing_operators_math_real_part.md) | Extracts element-wise real part of field containers containing complex fields. ///available inputs: fields_container (FieldsContainer) | +| [real_part](Ans_DataProcessing_operators_math_real_part.md) | Extracts the real-part fields (complex label 0) from a complex-valued fields container. | | [relative_error](Ans_DataProcessing_operators_math_relative_error.md) | relative_error() | | [scale](Ans_DataProcessing_operators_math_scale.md) | scale() | | [scale_by_field](Ans_DataProcessing_operators_math_scale_by_field.md) | DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. ///available inputs: fieldA (Field, FieldsContainer), fieldB (Field, FieldsContainer) | | [scale_by_field_fc](Ans_DataProcessing_operators_math_scale_by_field_fc.md) | DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If one field's scoping has an 'overall' location, then this field's values are applied on the other field entirely. ///available inputs: field_or_fields_container_A (Field, FieldsContainer), field_or_fields_container_B (Field, FieldsContainer) | | [scale_fc](Ans_DataProcessing_operators_math_scale_fc.md) | scale_fc() | -| [sin](Ans_DataProcessing_operators_math_sin.md) | Computes element-wise sine function on field data: sin(field[i]). ///available inputs: field (Field) | -| [sin_fc](Ans_DataProcessing_operators_math_sin_fc.md) | Computes element-wise sine function on field data: sin(field[i]). ///available inputs: fields_container (FieldsContainer) | -| [sqr](Ans_DataProcessing_operators_math_sqr.md) | Computes element-wise field[i]^2. ///available inputs: field (Field, FieldsContainer) | -| [sqr_fc](Ans_DataProcessing_operators_math_sqr_fc.md) | Computes element-wise field[i]^2. ///available inputs: fields_container (FieldsContainer) | -| [sqrt](Ans_DataProcessing_operators_math_sqrt.md) | Computes element-wise square root function on field data: sqrt(field[i]). ///available inputs: field (Field, FieldsContainer) | -| [sqrt_fc](Ans_DataProcessing_operators_math_sqrt_fc.md) | Computes element-wise square root function on field data: sqrt(field[i]). ///available inputs: fields_container (FieldsContainer) | +| [sin](Ans_DataProcessing_operators_math_sin.md) | Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [sin_fc](Ans_DataProcessing_operators_math_sin_fc.md) | Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): | +| [sqr](Ans_DataProcessing_operators_math_sqr.md) | Computes the entity-wise square | +| [sqr_fc](Ans_DataProcessing_operators_math_sqr_fc.md) | Computes the entity-wise square | +| [sqrt](Ans_DataProcessing_operators_math_sqrt.md) | Computes the entity-wise square root | +| [sqrt_fc](Ans_DataProcessing_operators_math_sqrt_fc.md) | Computes the entity-wise square root | | [svd](Ans_DataProcessing_operators_math_svd.md) | Computes the matrix singular value decomposition (SVD) for each field in the given fields container. ///available inputs: fields_container (FieldsContainer) | -| [sweeping_phase](Ans_DataProcessing_operators_math_sweeping_phase.md) | Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). ///available inputs: real_field (Field, FieldsContainer), imaginary_field (Field, FieldsContainer), angle (double), unit_name (string) (optional), abs_value (bool), imaginary_part_null (bool) | -| [sweeping_phase_fc](Ans_DataProcessing_operators_math_sweeping_phase_fc.md) | Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). ///available inputs: fields_container (FieldsContainer), angle (double), unit_name (string) (optional), abs_value (bool) | +| [sweeping_phase](Ans_DataProcessing_operators_math_sweeping_phase.md) | Projects a [phasor](https://en.wikipedia.org/wiki/Phasor) field onto a given phase angle $\theta$: | +| [sweeping_phase_fc](Ans_DataProcessing_operators_math_sweeping_phase_fc.md) | Projects every [phasor](https://en.wikipedia.org/wiki/Phasor) field pair in the input fields container | | [time_derivation](Ans_DataProcessing_operators_math_time_derivation.md) | Derives a field of time varying quantities with respect to time ///available inputs: field (Field), spline_fitting (bool) (optional) | | [time_freq_interpolation](Ans_DataProcessing_operators_math_time_freq_interpolation.md) | time_freq_interpolation() | | [time_integration](Ans_DataProcessing_operators_math_time_integration.md) | Integrates a field of time varying quantities over time ///available inputs: field (Field), resample_output (bool) (optional), absolute_error (double) (optional), minimum_step_size (double) (optional), integration_constant (double) (optional) | -| [unit_convert](Ans_DataProcessing_operators_math_unit_convert.md) | Converts an input field/fields container or mesh of a given unit to another unit. ///available inputs: entity_to_convert (Field, FieldsContainer, MeshedRegion, MeshesContainer), unit_name (string, Int32, Field) | -| [unit_convert_fc](Ans_DataProcessing_operators_math_unit_convert_fc.md) | Converts an input fields container of a given unit to another unit. ///available inputs: fields_container (FieldsContainer), unit_name (string) | +| [unit_convert](Ans_DataProcessing_operators_math_unit_convert.md) | Converts an input entity from one unit to another using the linear relation | +| [unit_convert_fc](Ans_DataProcessing_operators_math_unit_convert_fc.md) | Converts a fields container from one unit to another using the linear relation | | [window_bartlett](Ans_DataProcessing_operators_math_window_bartlett.md) | Apply bartlett windowing on a given FieldsContainer having time label or a Field located on time. Assume that time sampling is evenly spaced (use time_freq_interpolation before otherwise). ///available inputs: field (Field, FieldsContainer) | | [window_bartlett_fc](Ans_DataProcessing_operators_math_window_bartlett_fc.md) | Apply bartlett windowing on a given FieldsContainer having time label or a Field located on time. Assume that time sampling is evenly spaced (use time_freq_interpolation before otherwise). ///available inputs: fields_container (FieldsContainer) | | [window_blackman](Ans_DataProcessing_operators_math_window_blackman.md) | Apply blackman windowing on a given FieldsContainer having time label or a Field located on time. Assume that time sampling is evenly spaced (use time_freq_interpolation before otherwise). ///available inputs: field (Field, FieldsContainer) | diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md index 5a16d3152..dd97aef77 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.invert # *class* invert(field: object = None, config: OperatorConfig = None) -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). available inputs: `field` (Field, FieldsContainer) @@ -37,7 +37,7 @@ field or fields container with only one field is expected ### field -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md index bbc906af7..87a4434ec 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/invert_fc.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.invert_fc # *class* invert_fc(fields_container: object = None, config: OperatorConfig = None) -DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inverse of a field (1./x). +DEPRECATED, PLEASE USE DIVIDE. Computes the entity-wise and component-wise inverse of a field (1./x). available inputs: `fields_container` (FieldsContainer) @@ -37,7 +37,7 @@ field or fields container with only one field is expected ### fields_container -Field with inverse values (1/x) applied element-wise to input data +Field with inverse values (1/x) applied entity-wise to input data **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md index d55dd9dc9..6b34d8af9 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/kronecker_prod.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.kronecker_prod # *class* kronecker_prod(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -Computes element-wise Kronecker product between two tensor fields. +Computes the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product) + +of two matrix-valued fields per entity. + +For each entity, if $A$ is an $(m \times n)$ matrix and $B$ is a $(p \times q)$ matrix, + +the result is an $(mp \times nq)$ matrix: + +$(A \otimes B)_{(ip+k),(jq+l)} = A_{i,j} \cdot B_{k,l}$. + +Both input fields must have the same number of entities. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) @@ -44,6 +54,8 @@ field or fields container with only one field is expected ### field +Matrix field containing the Kronecker product $A \otimes B$ for each entity; unit is $u_A \cdot u_B$. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md index c0c25491a..711c8bf0f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/linear_combination.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.linear_combination # *class* linear_combination(a: object = None, fields_containerA: object = None, fields_containerB: object = None, b: object = None, fields_containerC: object = None, config: OperatorConfig = None) -Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are complex numbers. +Computes the [linear combination](https://en.wikipedia.org/wiki/Linear_combination) + +$a \cdot X \cdot Y + b \cdot Z$, + +where $a$ (pin 0) and $b$ (pin 3) are real scalars, + +and $X$ (pin 1), $Y$ (pin 2), $Z$ (pin 4) are complex-valued fields containers. + +The product $X \cdot Y$ is a standard complex multiplication. available inputs: `a` (double), `fields_containerA` (FieldsContainer), `fields_containerB` (FieldsContainer), `b` (double), `fields_containerC` (FieldsContainer) @@ -33,7 +41,7 @@ op = linear_combination(a=my_a,fields_containerA=my_fields_containerA,fields_con ### a -Double +Real scalar factor $a$ applied to the complex product $X \cdot Y$. **Type:** *LinkableInput* @@ -47,18 +55,22 @@ Double ### b -Double +Real scalar factor $b$ applied to the complex addend $Z$. **Type:** *LinkableInput* ### fields_containerC +Third complex-valued fields container $Z$. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the complex result $a \cdot X \cdot Y + b \cdot Z$ (real and imaginary parts). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md index 42738edb4..0b96d0bf6 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln.md @@ -20,7 +20,7 @@ ln(config: OperatorConfig) ### field -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -28,7 +28,7 @@ field or fields container with only one field is expected ### field -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md index 56e84707b..1fd383fc4 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/ln_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.ln_fc # *class* ln_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise ln(field[i]). +Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm): + +$\mathrm{out}[i] = \ln(\mathrm{in}[i])$. + +The input must be dimensionless; a dimensional input raises an error. + +The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +35,7 @@ op = ln_fc(fields_container=my_fields_container) ### fields_container -field or fields container with only one field is expected +Dimensionless field, fields container, or numeric data. **Type:** *LinkableInput* @@ -37,7 +43,7 @@ field or fields container with only one field is expected ### fields_container -Field with natural logarithm values applied element-wise +Dimensionless field with $\ln(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md index 3efcabdf9..a25a10842 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus.md @@ -35,7 +35,7 @@ field or fields container with only one field is expected ### field -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md index 90512812b..231ac81cf 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/minus_fc.md @@ -35,7 +35,7 @@ field or fields container with only one field is expected ### fields_container -Field containing the element-wise difference (fieldA - fieldB) +Field whose data equals $A[i] - B[i]$, carrying pin A's unit (or the corresponding temperature-difference unit when subtracting two temperature fields). **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md index 6bf576778..acbecbe52 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/modulus.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.modulus # *class* modulus(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise modulus of field containers containing complex fields. +Computes the [complex modulus](https://en.wikipedia.org/wiki/Absolute_value#Complex_numbers) + +$|z[i]| = \sqrt{\mathrm{Re}[i]^2 + \mathrm{Im}[i]^2}$ for each value in a complex-valued fields container, + +where $\mathrm{Re}$ and $\mathrm{Im}$ are the real and imaginary parts (complex labels 0 and 1 respectively). + +The output container has no complex label. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = modulus(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the modulus $\sqrt{\mathrm{Re}^2 + \mathrm{Im}^2}$ for each entry, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md index 28cbe23d6..160c164f4 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.norm # *class* norm(field: object = None, scalar_int: object = None, config: OperatorConfig = None) -Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector + +for each entity in the field: + +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$, + +where $n_c$ is the number of components. Default is $p = 2$ (Euclidean norm). + +The output is a scalar field with one value per entity. available inputs: `field` (Field, FieldsContainer), `scalar_int` (Int32) (optional) @@ -36,7 +44,7 @@ field or fields container with only one field is expected ### scalar_int -Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). **Type:** *LinkableInput* @@ -44,7 +52,7 @@ Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 ### field -Scalar field containing the Lp norm values for each element +Scalar field containing the $L_p$ norm value for each entity. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md index 1391a9b07..ae3a8e29f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/norm_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.norm_fc # *class* norm_fc(fields_container: object = None, scalar_int: object = None, config: OperatorConfig = None) -Computes the element-wise L2 norm of the field elementary data. This process is applied on each field of the input fields container. +Computes the [$L_p$ norm](https://en.wikipedia.org/wiki/Norm_(mathematics)#p-norm) of the component vector + +for each entity in every field of the input fields container: + +$\mathrm{out}[k] = \left(\sum_{j=0}^{n_c-1} |v_{k,j}|^p\right)^{1/p}$. + +Default is $p = 2$ (Euclidean norm). Each output field is scalar. available inputs: `fields_container` (FieldsContainer), `scalar_int` (Int32) (optional) @@ -30,13 +36,13 @@ op = norm_fc(fields_container=my_fields_container,scalar_int=my_scalar_int) ### fields_container -FieldsContainer containing fields for norm calculation +Fields container containing fields for norm calculation **Type:** *LinkableInput* ### scalar_int -Lp normalisation type, p = 1, 2, ...n - Default Lp=2 +$L_p$ norm order $p$ (positive integer, default is 2 for the Euclidean norm). **Type:** *LinkableInput* @@ -44,7 +50,7 @@ Lp normalisation type, p = 1, 2, ...n - Default Lp=2 ### fields_container -FieldsContainer with computed norms for each field +Fields container of scalar fields, one per input field, each containing the $L_p$ norm per entity. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md index 984564d6e..136f8efa2 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.phase # *class* phase(fieldA: object = None, fieldB: object = None, config: OperatorConfig = None) -Computes the phase (in rad) between a real and an imaginary field. +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) + +of a complex quantity given as separate real and imaginary fields: + +$\phi[i] = \mathrm{atan2}(B[i],\, A[i])$. + +The output is in radians. available inputs: `fieldA` (Field, FieldsContainer), `fieldB` (Field, FieldsContainer) @@ -44,6 +50,8 @@ field or fields container with only one field is expected ### field +Field containing the phase angle $\mathrm{atan2}(B[i],\, A[i])$ in radians for each data entry. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md index c14266615..19355e3bd 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/phase_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.phase_fc # *class* phase_fc(fields_container: object = None, config: OperatorConfig = None) -Computes phase (in rad) between real and imaginary fields. +Computes the [argument](https://en.wikipedia.org/wiki/Argument_(complex_analysis)) (phase angle) + +$\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians for each complex-valued field pair + +in the input fields container, where pairs are matched by complex label. + +If no imaginary part is found for a real field, a zero-valued field is produced. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +35,16 @@ op = phase_fc(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with paired real (complex label 0) and imaginary (complex label 1) fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with phase angle fields $\mathrm{atan2}(\mathrm{Im}[i],\, \mathrm{Re}[i])$ in radians; zero-valued fields are produced where no imaginary part is found. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md index 2717cade9..7101f2749 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/polar_to_cplx.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.polar_to_cplx # *class* polar_to_cplx(fields_container: object = None, config: OperatorConfig = None) -Converts a complex number from polar form to complex. +Converts a complex-valued fields container from + +[polar form](https://en.wikipedia.org/wiki/Complex_number#Polar_complex_plane) (amplitude, phase) + +to rectangular form (real, imaginary): + +$\mathrm{Re}[i] = A[i] \cdot \cos(\phi[i])$, $\mathrm{Im}[i] = A[i] \cdot \sin(\phi[i])$. + +The input must contain amplitude fields tagged with complex label 2 + +and phase fields tagged with complex label 3. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +39,16 @@ op = polar_to_cplx(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with amplitude fields (complex label 2) paired with phase angle fields (complex label 3). + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container in rectangular form: real parts (complex label 0) and imaginary parts (complex label 1). + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md index d79537403..d7d5b4688 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.pow # *class* pow(field: object = None, factor: object = None, division_by_zero_value: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. available inputs: `field` (Field), `factor` (double), `division_by_zero_value` (double) (optional) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md index 529c2d42a..9053260b0 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/pow_fc.md @@ -4,7 +4,7 @@ uid: Ans.DataProcessing.operators.math.pow_fc # *class* pow_fc(fields_container: object = None, factor: object = None, division_by_zero_value: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^p. +Computes entity-wise field[i]^p. available inputs: `fields_container` (FieldsContainer), `factor` (double), `division_by_zero_value` (double) (optional) diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md index cc069e52c..ccb9407ce 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/real_part.md @@ -4,7 +4,9 @@ uid: Ans.DataProcessing.operators.math.real_part # *class* real_part(fields_container: object = None, config: OperatorConfig = None) -Extracts element-wise real part of field containers containing complex fields. +Extracts the real-part fields (complex label 0) from a complex-valued fields container. + +The output container preserves all labels except the complex label. available inputs: `fields_container` (FieldsContainer) @@ -29,12 +31,16 @@ op = real_part(fields_container=my_fields_container) ### fields_container +Complex-valued fields container with real (complex label 0) and imaginary (complex label 1) part fields. + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container containing only the real-part fields, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md index 1d50882f7..7b3729cef 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sin # *class* sin(field: object = None, config: OperatorConfig = None) -Computes element-wise sine function on field data: sin(field[i]). +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the sine is applied. The output is dimensionless. available inputs: `field` (Field) @@ -29,7 +37,7 @@ op = sin(field=my_field) ### field -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field containing numeric data for sine calculation ### field -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md index 2c7c660c9..57ecee15f 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sin_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sin_fc # *class* sin_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise sine function on field data: sin(field[i]). +Computes the entity-wise [sine](https://en.wikipedia.org/wiki/Sine_and_cosine): + +$\mathrm{out}[i] = \sin(\mathrm{in}[i])$. + +The input must be dimensionless or carry an angle unit; any other unit raises an error. + +When the input unit is an angle (e.g. degrees), values are automatically converted to radians + +before the sine is applied. The output is dimensionless. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +37,7 @@ op = sin_fc(fields_container=my_fields_container) ### fields_container -Field containing numeric data for sine calculation +Dimensionless or angle-unit field. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field containing numeric data for sine calculation ### fields_container -Field with sine values applied element-wise to input data +Dimensionless field with $\sin(\mathrm{in}[i])$ for each data entry. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md index 8008b62d2..99a2dd537 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.sqr # *class* sqr(field: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^2. +Computes the entity-wise square + +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): + +$\mathrm{out}[i] = \mathrm{in}[i]^2$. + +The output unit is $u^2$ where $u$ is the input unit. available inputs: `field` (Field, FieldsContainer) @@ -37,7 +43,7 @@ field or fields container with only one field is expected ### field -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md index 5c83ce4bd..3be512423 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqr_fc.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.sqr_fc # *class* sqr_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise field[i]^2. +Computes the entity-wise square + +([Hadamard power](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations) of two): + +$\mathrm{out}[i] = \mathrm{in}[i]^2$. + +The output unit is $u^2$ where $u$ is the input unit. available inputs: `fields_container` (FieldsContainer) @@ -37,7 +43,7 @@ field or fields container with only one field is expected ### fields_container -Field with squared values applied element-wise to input data +Field with $\mathrm{in}[i]^2$ for each data entry; unit is $u^2$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md index d250b0a6e..3d76b7e9a 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sqrt # *class* sqrt(field: object = None, config: OperatorConfig = None) -Computes element-wise square root function on field data: sqrt(field[i]). +Computes the entity-wise square root + +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): + +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. + +All input values must be non-negative; a negative value raises an error. + +The output unit is $\sqrt{u}$ where $u$ is the input unit. available inputs: `field` (Field, FieldsContainer) @@ -29,7 +37,7 @@ op = sqrt(field=my_field) ### field -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for square root calculation ### field -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md index 469b92e67..511080ded 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sqrt_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sqrt_fc # *class* sqrt_fc(fields_container: object = None, config: OperatorConfig = None) -Computes element-wise square root function on field data: sqrt(field[i]). +Computes the entity-wise square root + +([Hadamard root](https://en.wikipedia.org/wiki/Hadamard_product_(matrices)#Analogous_operations)): + +$\mathrm{out}[i] = \sqrt{\mathrm{in}[i]}$. + +All input values must be non-negative; a negative value raises an error. + +The output unit is $\sqrt{u}$ where $u$ is the input unit. available inputs: `fields_container` (FieldsContainer) @@ -29,7 +37,7 @@ op = sqrt_fc(fields_container=my_fields_container) ### fields_container -Field or fields container containing numeric data for square root calculation +Field or fields container containing non-negative numeric data. **Type:** *LinkableInput* @@ -37,7 +45,7 @@ Field or fields container containing numeric data for square root calculation ### fields_container -Field with square root values applied element-wise to input data +Field with $\sqrt{\mathrm{in}[i]}$ for each data entry; unit is $\sqrt{u}$, where $u$ is the input unit. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md index 060d41cd9..990ec26c0 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase.md @@ -4,7 +4,13 @@ uid: Ans.DataProcessing.operators.math.sweeping_phase # *class* sweeping_phase(real_field: object = None, imaginary_field: object = None, angle: object = None, unit_name: object = None, abs_value: object = None, imaginary_part_null: object = None, config: OperatorConfig = None) -Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle (in 3) of a unit (in 4). The resulting field is computed as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). +Projects a [phasor](https://en.wikipedia.org/wiki/Phasor) field onto a given phase angle $\theta$: + +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. + +When pin 4 is true, the absolute value of the projection is returned instead. + +If the imaginary field is absent and pin 5 is true, the imaginary part is treated as zero. available inputs: `real_field` (Field, FieldsContainer), `imaginary_field` (Field, FieldsContainer), `angle` (double), `unit_name` (string) (optional), `abs_value` (bool), `imaginary_part_null` (bool) @@ -46,6 +52,8 @@ field or fields container with only one field is expected ### angle +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). + **Type:** *LinkableInput* ### unit_name @@ -56,6 +64,8 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". ### abs_value +If true, the absolute value of the projection is returned (default: false). + **Type:** *LinkableInput* ### imaginary_part_null @@ -68,6 +78,8 @@ If the imaginary part field is empty and this pin is true, then the imaginary pa ### field +Projected field $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, with the unit of pin 0. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md index ead381c5a..f070febda 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/sweeping_phase_fc.md @@ -4,7 +4,15 @@ uid: Ans.DataProcessing.operators.math.sweeping_phase_fc # *class* sweeping_phase_fc(fields_container: object = None, angle: object = None, unit_name: object = None, abs_value: object = None, config: OperatorConfig = None) -Shifts the phase of all the corresponding real and imaginary fields of a fields container for a given angle (in 2) of a unit (in 4). An output field is computed for each pair of real and imaginary fields in the input fields_container as field_out = real_field`*`cos(angle) - imaginary_field`*`sin(angle). +Projects every [phasor](https://en.wikipedia.org/wiki/Phasor) field pair in the input fields container + +onto a given phase angle $\theta$: + +$\mathrm{out}[i] = \mathrm{fieldReal}[i] \cdot \cos(\theta) - \mathrm{fieldImaginary}[i] \cdot \sin(\theta)$. + +Pairs are matched by complex label. + +When pin 4 is true, the absolute value of each projection is returned. available inputs: `fields_container` (FieldsContainer), `angle` (double), `unit_name` (string) (optional), `abs_value` (bool) @@ -32,10 +40,14 @@ op = sweeping_phase_fc(fields_container=my_fields_container,angle=my_angle,unit_ ### fields_container +Complex-valued fields container with paired real and imaginary part fields. + **Type:** *LinkableInput* ### angle +Phase angle $\theta$ to project onto, in the unit specified by pin 3 (default: radians). + **Type:** *LinkableInput* ### unit_name @@ -46,12 +58,16 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". ### abs_value +If true, the absolute value of each projection is returned (default: false). + **Type:** *LinkableInput* ## Outputs ### fields_container +Fields container with the projected fields $\mathrm{fieldReal} \cdot \cos(\theta) - \mathrm{fieldImaginary} \cdot \sin(\theta)$, without the complex label. + **Type:** *LinkableOutput* ## Methods diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md index 24e56908b..6593aa4d4 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md @@ -59,7 +59,13 @@ If set to true, the output fields container will always have a new time freq sup ### fields_container -FieldsContainer with interpolated fields at specified time/frequency values +Fields container with one interpolated field set per requested time or frequency value. + +**Type:** *LinkableOutput* + +### time_freq_support + +Time or frequency support aligned with the output fields container. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md index 8373c55d6..9ecf430df 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert.md @@ -4,7 +4,19 @@ uid: Ans.DataProcessing.operators.math.unit_convert # *class* unit_convert(entity_to_convert: object = None, unit_name: object = None, config: OperatorConfig = None) -Converts an input field/fields container or mesh of a given unit to another unit. +Converts an input entity from one unit to another using the linear relation + +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, + +where $k$ and $\delta$ are the unit conversion factor and shift. + +Accepts fields, fields containers, meshes, and meshes containers. + +For mesh inputs only the coordinate field is converted. + +When the permissive option is enabled and units are not homogeneous with the target unit, + +the conversion is silently skipped. available inputs: `entity_to_convert` (Field, FieldsContainer, MeshedRegion, MeshesContainer), `unit_name` (string, Int32, Field) @@ -42,7 +54,7 @@ unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's I ### converted_entity -the output entity is the same as the input (inplace operator) +Converted entity of the same type as the input, modified in place. **Type:** *LinkableOutput* diff --git a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md index ff2bd5d7f..bf945d0c6 100644 --- a/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md +++ b/Markdown/dpf_mechanical_27r1/api/Ans.DataProcessing/operators/math/unit_convert_fc.md @@ -4,7 +4,17 @@ uid: Ans.DataProcessing.operators.math.unit_convert_fc # *class* unit_convert_fc(fields_container: object = None, unit_name: object = None, config: OperatorConfig = None) -Converts an input fields container of a given unit to another unit. +Converts a fields container from one unit to another using the linear relation + +$v_\mathrm{out}[i] = k \cdot v_\mathrm{in}[i] + \delta$, + +where $k$ and $\delta$ are the unit conversion factor and shift. + +All fields must be homogeneous with the target unit. + +When the permissive option is enabled and units are not homogeneous, + +the container is returned unchanged. available inputs: `fields_container` (FieldsContainer), `unit_name` (string) @@ -30,6 +40,8 @@ op = unit_convert_fc(fields_container=my_fields_container,unit_name=my_unit_name ### fields_container +Fields container to convert. All fields are converted in place. + **Type:** *LinkableInput* ### unit_name @@ -42,7 +54,7 @@ unit as a string, ex 'm' for meter, 'Pa' for pascal,... ### fields_container -FieldsContainer with converted units (inplace operation) +Fields container with all field data converted to the requested unit, modified in place. **Type:** *LinkableOutput* From 67466cb3c3e608664ebf373948f076194def5703 Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@win.ansys.com> Date: Thu, 14 May 2026 20:13:39 -0400 Subject: [PATCH 4/6] DPF doc update for 271 (2026.05.14) --- 2027R1/dpf-framework-27-r1/changelog/changelog.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/2027R1/dpf-framework-27-r1/changelog/changelog.md b/2027R1/dpf-framework-27-r1/changelog/changelog.md index 8b6466b4e..67cdf4ec8 100644 --- a/2027R1/dpf-framework-27-r1/changelog/changelog.md +++ b/2027R1/dpf-framework-27-r1/changelog/changelog.md @@ -1,6 +1,6 @@ # Changelog -Changes since the last released version for DPF 27.1.pre0 (as of 2026-05-13). +Changes since the last released version for DPF 27.1.pre0 (as of 2026-05-14). This changelog is organized by category, with sections for different types of updates (new features, bug fixes, changes, performance improvements). @@ -28,7 +28,7 @@ The following table shows which components have updates in each category. | fbs | [2 items](#Features_fbs) | | | femutils | [3 items](#Features_femutils) |[16 items](#Fixes_femutils) | | flatbuffers | |[1 item](#Fixes_flatbuffers) | -| framework | [2 items](#Features_framework) |[8 items](#Fixes_framework) | +| framework | [2 items](#Features_framework) |[9 items](#Fixes_framework) | | gate | |[1 item](#Fixes_gate) | | grpc | [1 item](#Features_grpc) |[5 items](#Fixes_grpc) | | grpcclient | |[1 item](#Fixes_grpcclient) | @@ -606,6 +606,9 @@ The following table shows which components have updates in each category. ### Fixes +- Refactor handling of named selections in CMeshedRegion: + > + - Add missing throw on errors in eventlogger: > > @@ -4974,6 +4977,8 @@ Upgraded documentation > 0.0.1: Fix exception type preservation during parallel execution. + > 0.0.2: Fix issue when input FieldsContainer and ScopingsContainer don't share labels. + - [intersect](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/scoping/intersect.md) From ce7f094c457891a35f94ad19b445d293f84f94a6 Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@win.ansys.com> Date: Mon, 18 May 2026 20:14:59 -0400 Subject: [PATCH 5/6] DPF doc update for 271 (2026.05.18) --- .../changelog/changelog.md | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/2027R1/dpf-framework-27-r1/changelog/changelog.md b/2027R1/dpf-framework-27-r1/changelog/changelog.md index 67cdf4ec8..b242875fa 100644 --- a/2027R1/dpf-framework-27-r1/changelog/changelog.md +++ b/2027R1/dpf-framework-27-r1/changelog/changelog.md @@ -1,6 +1,6 @@ # Changelog -Changes since the last released version for DPF 27.1.pre0 (as of 2026-05-14). +Changes since the last released version for DPF 27.1.pre0 (as of 2026-05-18). This changelog is organized by category, with sections for different types of updates (new features, bug fixes, changes, performance improvements). @@ -16,7 +16,7 @@ The following table shows which components have updates in each category. | cgns | [1 item](#Features_cgns) | | | changelog | [2 items](#Features_changelog) |[1 item](#Fixes_changelog) | | ci | [1 item](#Features_ci) |[3 items](#Fixes_ci) | -| compression | [3 items](#Features_compression) |[2 items](#Fixes_compression) | +| compression | [4 items](#Features_compression) |[2 items](#Fixes_compression) | | core | |[1 item](#Fixes_core) | | cs | [4 items](#Features_cs) |[1 item](#Fixes_cs) | | cyclic | [1 item](#Features_cyclic) |[1 item](#Fixes_cyclic) | @@ -58,7 +58,7 @@ The following table shows which components have updates in each category. | refactor | [1 item](#Features_refactor) | | | rotation | |[1 item](#Fixes_rotation) | | utilities | |[1 item](#Fixes_utilities) | -| vtk | [2 items](#Features_vtk) |[2 items](#Fixes_vtk) | +| vtk | [3 items](#Features_vtk) |[2 items](#Fixes_vtk) | | workflows | [3 items](#Features_workflows) |[2 items](#Fixes_workflows) | @@ -212,6 +212,11 @@ The following table shows which components have updates in each category. ## compression ### Features +- Complete usage of ScopingIterators and eliminate GetIds calls in Ans.Dpf.Compression: + > + > + > + - Quantization operator enhancements: > - Added parallelization in _quantization_fc_ > @@ -2626,6 +2631,11 @@ The following table shows which components have updates in each category. ## vtk ### Features +- Add pins for extra connectivity & input scoping in op:mesh_to_pyvista: + > Introduce capability to accept input mesh scoping that allows construction of vtk meshes for a specified subset of the original mesh. Add 'as_modified_connectivity' boolean input pin that returns VTK version>9 compatible connectivity representation consisting of an array of concatenated node indices for cells without node count headers and an offset array to it. + > + > + - Perf improvement of mesh_to_pyvista (part 2): > @@ -3543,6 +3553,14 @@ The following table shows which components have updates in each category. +#### compression + +- [kmeans_clustering](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/compression/kmeans_clustering.md) + + > 0.0.1: Internal refactoring to use Scoping Iterators. + + + #### filter - [abc_weightings](https://ansys-a.devportal.io/docs/dpf-framework-2026-r2/operator-specifications/filter/abc_weightings.md) From 9d6957779f2c70cb495935bebab9a42fc50c29e3 Mon Sep 17 00:00:00 2001 From: 4rmuuser <4rmuuser@ansys.com> Date: Tue, 19 May 2026 03:25:49 -0700 Subject: [PATCH 6/6] DPF doc update for 271 (2026.05.19) --- .../api-reference/classansys-dpf-any.md | 62 +++-- .../api-reference/classansys-dpf-changelog.md | 8 +- .../api-reference/classansys-dpf-client.md | 18 +- .../classansys-dpf-collection.md | 18 +- .../api-reference/classansys-dpf-context.md | 22 +- ...lassansys-dpf-core-logging-loggerconfig.md | 8 +- .../api-reference/classansys-dpf-core.md | 8 +- .../classansys-dpf-customtypefield.md | 90 ++++--- ...lassansys-dpf-customtypefieldscontainer.md | 81 ++++--- .../classansys-dpf-cyclicsupport.md | 18 +- .../classansys-dpf-datasources.md | 22 +- .../api-reference/classansys-dpf-datatree.md | 22 +- .../api-reference/classansys-dpf-dpftypes.md | 2 +- .../api-reference/classansys-dpf-dpfvector.md | 20 +- .../classansys-dpf-elementcursor.md | 6 +- .../classansys-dpf-eventhandler.md | 2 +- .../api-reference/classansys-dpf-field.md | 75 ++++-- .../classansys-dpf-fieldcursor.md | 2 +- .../classansys-dpf-fielddefinition.md | 16 +- .../classansys-dpf-fieldscontainer.md | 50 +++- .../classansys-dpf-genericdatacontainer.md | 4 +- .../classansys-dpf-genericsupport.md | 24 +- .../classansys-dpf-homogeneity.md | 12 +- .../classansys-dpf-labelspace.md | 26 +-- .../classansys-dpf-libraryhandle.md | 12 +- .../api-reference/classansys-dpf-mapping.md | 12 +- .../classansys-dpf-meshedregion.md | 36 +-- .../classansys-dpf-meshescontainer.md | 20 +- .../api-reference/classansys-dpf-meshinfo.md | 6 +- .../api-reference/classansys-dpf-operator.md | 44 ++-- .../classansys-dpf-operatorconfig.md | 12 +- .../classansys-dpf-operatormain.md | 33 +++ .../classansys-dpf-operatorspecification.md | 12 +- .../classansys-dpf-propertyfield.md | 66 ++++-- .../classansys-dpf-propfieldcursor.md | 2 +- .../classansys-dpf-resultinfo.md | 18 +- .../classansys-dpf-runtimeclientconfig.md | 4 +- .../classansys-dpf-runtimecoreconfig.md | 4 +- .../api-reference/classansys-dpf-scoping.md | 22 +- .../classansys-dpf-scopingscontainer.md | 20 +- .../classansys-dpf-semanticversion.md | 4 +- .../api-reference/classansys-dpf-session.md | 12 +- .../api-reference/classansys-dpf-streams.md | 22 +- .../classansys-dpf-stringfield.md | 22 +- .../api-reference/classansys-dpf-support.md | 212 +++++++++++++++-- .../classansys-dpf-timefreqsupport.md | 36 +-- .../api-reference/classansys-dpf-unit.md | 20 +- .../api-reference/classansys-dpf-workflow.md | 58 ++--- .../classansys-dpf-workflowstep.md | 34 ++- 2027R1/dpf-cpp-27-r1/api-reference/classes.md | 1 + .../dpf-cpp-27-r1/api-reference/deprecated.md | 2 +- .../api-reference/dir-dd83be0cfbcc27aa9f.md | 4 +- .../dir-fca9ddd4acaabdc476476.md | 2 +- .../api-reference/dpf-api-base-h.md | 14 ++ .../api-reference/namespaceansys-dpf.md | 221 +++++++++--------- ...ys-dpf-constructhelpers-construct-trait.md | 2 +- .../structansys-dpf-context-internal.md | 4 +- .../structansys-dpf-core-fbsserverdata.md | 2 +- .../structansys-dpf-core-logging.md | 2 +- .../structansys-dpf-dimensionality.md | 7 +- .../structansys-dpf-dpfvector-iterator.md | 14 +- .../structansys-dpf-elementdescriptor.md | 2 +- .../api-reference/structansys-dpf-label.md | 10 +- .../api-reference/structansys-dpf-labels.md | 27 +++ .../api-reference/structansys-dpf-location.md | 10 +- .../structansys-dpf-locations.md | 54 +++++ .../structansys-dpf-pindefinition.md | 18 +- .../structansys-dpf-propertytype.md | 10 +- .../structansys-dpf-quantitytype.md | 10 +- .../api-reference/structansys-dpf-spec.md | 4 +- .../structansys-dpf-typedescriptor.md | 24 +- .../structansys-dpf-unitsystem.md | 2 +- 2027R1/dpf-cpp-27-r1/docfx_local.json | 2 +- .../examples/resulttest-cpp-example.md | 72 +++++- 2027R1/dpf-cpp-27-r1/getting-started.md | 4 +- 2027R1/dpf-cpp-27-r1/index.md | 4 +- 2027R1/dpf-cpp-27-r1/operators.md | 2 +- 2027R1/dpf-cpp-27-r1/toc.yml | 2 + .../user-guide/concepts-and-terms.md | 4 +- 2027R1/dpf-cpp-27-r1/user-guide/how-tos.md | 4 +- .../user-guide/starting-to-use-dpf.md | 4 +- .../changelog/changelog.md | 50 +--- 82 files changed, 1243 insertions(+), 710 deletions(-) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md index 4bf5e3a28..54975ef0d 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md @@ -37,6 +37,7 @@ * [getAsField](classansys-dpf-any.md#classansys-dpf-any-1a8bb8b9c5c9b8caccff78ff66a16780cb) * [getAsFieldsContainer](classansys-dpf-any.md#classansys-dpf-any-1af48a4b58d4d52dd107e75fdb6db2cdea) * [getAsGenericDataContainer](classansys-dpf-any.md#classansys-dpf-any-1a8a4ae829c4e5142a390158b7f1842cfb) +* [getAsGenericSupport](classansys-dpf-any.md#classansys-dpf-any-1a31d1d3ef7e7043252be52ab9a75ac926) * [getAsInt](classansys-dpf-any.md#classansys-dpf-any-1a00cce5475752905812ab028e4c1ca97b) * [getAsIntVector](classansys-dpf-any.md#classansys-dpf-any-1a9b3531295f844610cc131f78c96ef04d) * [getAsLabelSpace](classansys-dpf-any.md#classansys-dpf-any-1a53dda1baccbaa272f72df5195f30591b) @@ -167,7 +168,7 @@ ansys::dpf::Any::Any(Any const &) **Parameters**: -* Any const & +* [Any](classansys-dpf-any.md#classansys-dpf-any) const & **Return type**: @@ -196,7 +197,7 @@ ansys::dpf::Any::Any(Any &&) noexcept **Parameters**: -* Any && +* [Any](classansys-dpf-any.md#classansys-dpf-any) && **Return type**: @@ -225,9 +226,9 @@ Any & ansys::dpf::Any::operator=(Any const &) **Parameters**: -* Any const & +* [Any](classansys-dpf-any.md#classansys-dpf-any) const & -**Return type**: Any & +**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any) & + +### Function getAsGenericSupport + +![][public] +![][const] + + +```cpp +GenericSupport ansys::dpf::Any::getAsGenericSupport() const +``` + + + + +**Returns**: + +[GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) held in the [Any](classansys-dpf-any.md#classansys-dpf-any) object. + + +**Exceptions**: + +* **[DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)**: + + + +**Return type**: [GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) + + + ### Function getAsDataSources @@ -1233,7 +1267,7 @@ Make a deep copy on a given client. * [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client** = nullptr : [in] Remote client -**Return type**: Any +**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any) - + ### Function setSupport ![][public] ```cpp -void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::Support &s) +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::Support const &s) ``` @@ -1234,7 +1235,7 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). **Parameters**: -* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) & **s**: [in] [Field](classansys-dpf-field.md#classansys-dpf-field) to support. +* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) const & **s**: [in] [Support](classansys-dpf-support.md#classansys-dpf-support) to support. **Return type**: void @@ -1244,14 +1245,14 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::CustomTypeField::setSupport"}]}` --> - + ### Function setSupport ![][public] ```cpp -void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::TimeFreqSupport &s) +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::TimeFreqSupport const &s) ``` @@ -1263,7 +1264,7 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). **Parameters**: -* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) & **s**: [in] [Field](classansys-dpf-field.md#classansys-dpf-field) to support. +* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) const & **s**: [in] [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) to support. **Return type**: void @@ -1273,14 +1274,14 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::CustomTypeField::setSupport"}]}` --> - + ### Function setSupport ![][public] ```cpp -void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::MeshedRegion &s) +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::MeshedRegion const &s) ``` @@ -1292,7 +1293,36 @@ Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). **Parameters**: -* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) & **s**: [in] [Field](classansys-dpf-field.md#classansys-dpf-field) to support. +* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) const & **s**: [in] [MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) to support. + +**Return type**: void + + + + +### Function setSupport + +![][public] + + +```cpp +void ansys::dpf::CustomTypeField::setSupport(ansys::dpf::CyclicSupport const &s) +``` + + + + +Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). + + + +**Parameters**: + +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & **s**: [in] [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) to support. **Return type**: void @@ -1383,7 +1413,7 @@ Creates a new custom type field object from current field without its data. * bool const **copy_data_ptr** = true : [in] Boolean to decide if data pointer is to be copied * bool const **copy_support** = true : [in] Boolean to decide if the support reference is to be copied -**Return type**: CustomTypeField +**Return type**: [CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) - -### Function getSizeFor - -![][public] -![][const] - - -```cpp -dp_int ansys::dpf::CustomTypeFieldsContainer::getSizeFor(LabelSpace const &label_space) const -``` - - - - -**Returns**: - -Number of CustomTypeFields for given label space. - - - -**Parameters**: - -* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **label_space**: [in] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get number of entities. - -**Return type**: [dp_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) - - - ### Function getCustomTypeFields @@ -631,7 +600,7 @@ create a [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md * [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **lab_space** -**Return type**: CustomTypeFieldsContainer +**Return type**: [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) + +### Function deep_copy + +![][public] +![][const] + + +```cpp +CustomTypeFieldsContainer ansys::dpf::CustomTypeFieldsContainer::deep_copy(ansys::dpf::Client const *const client=nullptr) const +``` + + + + +Create a new [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) on a server by copying all the data of this [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer). + + + +**Parameters**: + +* [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client** = nullptr : [in] [Client](classansys-dpf-client.md#classansys-dpf-client) instance designating the IP, port and protocol to use. + +**Return type**: [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) + + + ## Public static functions @@ -662,7 +661,7 @@ Empty container. -**Return type**: CustomTypeFieldsContainer +**Return type**: [CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) ## Public functions @@ -93,7 +93,7 @@ ansys::dpf::ElementCursor::ElementCursor(ElementCursor const &)=delete **Parameters**: -* ElementCursor const & +* [ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) const & **Return type**: @@ -122,7 +122,7 @@ ansys::dpf::ElementCursor::ElementCursor(ElementCursor &&)=delete **Parameters**: -* ElementCursor && +* [ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) && **Return type**: diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md index b9460ba8f..0a7fc6e97 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-eventhandler.md @@ -161,7 +161,7 @@ A workflow has finished. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Session"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::EventHandler::Session"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Session"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Session"},"children":[{"type":"text","text":"Session"}]}]},{"type":"text","text":"\n "}]}` --> ## Public functions diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md index f5f75fb05..49fba93d6 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-field.md @@ -25,7 +25,7 @@ The field is the main simulation data container. In numerical simulations, resul * [data](classansys-dpf-field.md#classansys-dpf-field-1ad435429e8f1b152c7b4dad665665d9a4) * [dataPointer](classansys-dpf-field.md#classansys-dpf-field-1a47656e1ead80a6f2cac7c21266429212) * [dataSize](classansys-dpf-field.md#classansys-dpf-field-1a9bb7ac154ee6720cbb98b1c09e056942) -* [deep_copy](classansys-dpf-field.md#classansys-dpf-field-1ad91f3c235727ec55359488edd877ba9f) +* [deep_copy](classansys-dpf-field.md#classansys-dpf-field-1a8a3a031e901d5f571c047a2131ecc93c) * [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2) * [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459) * [emptyField](classansys-dpf-field.md#classansys-dpf-field-1a5b60dee96313f0f9791c11e1c7f58d5b) @@ -76,6 +76,7 @@ The field is the main simulation data container. In numerical simulations, resul * [setSupport](classansys-dpf-field.md#classansys-dpf-field-1ab71f825765a7ce1b37373443917ec23e) * [setSupport](classansys-dpf-field.md#classansys-dpf-field-1a14d300919db7ae24a917af9e1262cea3) * [setSupport](classansys-dpf-field.md#classansys-dpf-field-1ae846597f402a69d4d78d5c8b5e80d219) +* [setSupport](classansys-dpf-field.md#classansys-dpf-field-1a0d5aa669792de7257dcdea01463dc0ac) * [support](classansys-dpf-field.md#classansys-dpf-field-1a773481e9f7efb04d74c72be914b317d6) * [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f) * [~Field](classansys-dpf-field.md#classansys-dpf-field-1ad4e2524e104248f824921d6755daa36a) @@ -160,7 +161,7 @@ ansys::dpf::Field::Field(int id, Client const *const client) -Retrieve an existing instance of [Field](classansys-dpf-field.md#classansys-dpf-field) on a server. +Retrieve an existing instance of [Field](classansys-dpf-field.md#classansys-dpf-field) on a server.
@@ -221,7 +222,7 @@ ansys::dpf::Field::Field(Field const &) **Parameters**: -* Field const & +* [Field](classansys-dpf-field.md#classansys-dpf-field) const & **Return type**: @@ -250,7 +251,7 @@ ansys::dpf::Field::Field(Field &&) noexcept **Parameters**: -* Field && +* [Field](classansys-dpf-field.md#classansys-dpf-field) && **Return type**: @@ -279,9 +280,9 @@ Field & ansys::dpf::Field::operator=(Field const &) **Parameters**: -* Field const & +* [Field](classansys-dpf-field.md#classansys-dpf-field) const & -**Return type**: Field & +**Return type**: [Field](classansys-dpf-field.md#classansys-dpf-field) & + +### Function setSupport + +![][public] + + +```cpp +void ansys::dpf::Field::setSupport(ansys::dpf::CyclicSupport const &s) +``` + + + + +Set the support of the [Field](classansys-dpf-field.md#classansys-dpf-field). + + + +**Parameters**: + +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & **s**: [in] [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) to support. + +**Return type**: void + + + ### Function reserve @@ -1488,7 +1518,7 @@ Push back the entity data. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Field::push_back"}]}` --> - + ### Function deep_copy ![][public] @@ -1496,7 +1526,7 @@ Push back the entity data. ```cpp -Field ansys::dpf::Field::deep_copy(ansys::dpf::Client const *const client=nullptr) const +Field ansys::dpf::Field::deep_copy(ansys::dpf::Client const *const client=nullptr, const bool copy_data=true) const ``` @@ -1509,8 +1539,9 @@ Make a deep copy on a given client. **Parameters**: * [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client** = nullptr : [in] Remote client +* const bool **copy_data** = true : [in] Boolean that allows to decide if data is to be copied -**Return type**: Field +**Return type**: [Field](classansys-dpf-field.md#classansys-dpf-field) ## Public functions diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md index 787cc467d..08766e619 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-fielddefinition.md @@ -157,7 +157,7 @@ ansys::dpf::FieldDefinition::FieldDefinition(FieldDefinition const &) **Parameters**: -* FieldDefinition const & +* [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) const & **Return type**: @@ -186,7 +186,7 @@ ansys::dpf::FieldDefinition::FieldDefinition(FieldDefinition &&) noexcept **Parameters**: -* FieldDefinition && +* [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) && **Return type**: @@ -339,9 +339,9 @@ FieldDefinition & ansys::dpf::FieldDefinition::operator=(FieldDefinition const & **Parameters**: -* FieldDefinition const & +* [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) const & -**Return type**: FieldDefinition & +**Return type**: [FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) & + +### Function setBaseName + +![][public] + + +```cpp +void ansys::dpf::FieldsContainer::setBaseName(const std::string &base_name) +``` + + + + +Set the name of [FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) and inside Fields based on the name set as argument. + + + +**Parameters**: + +* const std::string & **base_name** + +**Return type**: void + + + ## Public static functions @@ -799,7 +829,7 @@ Empty [FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldsc -**Return type**: FieldsContainer +**Return type**: [FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) + +### Function testInputCustom + +![][public] + + +```cpp +bool ansys::dpf::OperatorMain::testInputCustom(dp_int pin_index) +``` + + + + +**Returns**: + +Indication that input pin contains typed data. + + + +**Parameters**: + +* [dp_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **pin_index**: [in] Input pin for which to check data type. + +**Return type**: bool + + + ### Function hasInput diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md index 72f784406..532dd80a6 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-operatorspecification.md @@ -141,7 +141,7 @@ ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification c **Parameters**: -* OperatorSpecification const & +* [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) const & **Return type**: @@ -170,7 +170,7 @@ ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification & **Parameters**: -* OperatorSpecification && +* [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) && **Return type**: @@ -199,9 +199,9 @@ OperatorSpecification & ansys::dpf::OperatorSpecification::operator=(OperatorSpe **Parameters**: -* OperatorSpecification const & +* [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) const & -**Return type**: OperatorSpecification & +**Return type**: [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) & + +### Function setSupport + +![][public] + + +```cpp +void ansys::dpf::PropertyField::setSupport(ansys::dpf::CyclicSupport const &s) +``` + + + + +Set the support of the [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield). + + + +**Parameters**: + +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & **s**: [in] [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) to support. + +**Return type**: void + + + ### Function name @@ -1157,7 +1187,7 @@ DpfVector< int > ansys::dpf::PropertyField::data() const -**Return type**: DpfVector< int > +**Return type**: [DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector)< int > ## Public functions diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md index 705fb0229..1edfa39d9 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-resultinfo.md @@ -307,8 +307,8 @@ ansys::dpf::ResultInfo::ResultInfo(analysis_type const &analysis_type=analysis_t **Parameters**: -* [analysis_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a7242b85e3d035f0953356a1146e742ae) const & **analysis_type** = [analysis_type::eUnknownAnalysis](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a7242b85e3d035f0953356a1146e742aea533f3644550f70cbfc2a2892f9aba9c5) -* [physics_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a4c9d8d076df7a3899011b1b2195dfaba) const & **physics_type** = [physics_type::eUnknownPhysics](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a4c9d8d076df7a3899011b1b2195dfabaad00f4b71e4db56a56048bc9ecd1786f3) +* [analysis_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a7242b85e3d035f0953356a1146e742ae) const & **analysis_type** = analysis_type::eUnknownAnalysis +* [physics_type](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo-1a4c9d8d076df7a3899011b1b2195dfaba) const & **physics_type** = physics_type::eUnknownPhysics **Return type**: @@ -362,7 +362,7 @@ ansys::dpf::ResultInfo::ResultInfo(ResultInfo const &) **Parameters**: -* ResultInfo const & +* [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) const & **Return type**: @@ -391,7 +391,7 @@ ansys::dpf::ResultInfo::ResultInfo(ResultInfo &&) noexcept **Parameters**: -* ResultInfo && +* [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) && **Return type**: @@ -420,9 +420,9 @@ ResultInfo & ansys::dpf::ResultInfo::operator=(ResultInfo const &) **Parameters**: -* ResultInfo const & +* [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) const & -**Return type**: ResultInfo & +**Return type**: [ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) & @@ -89,7 +95,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class CustomTypeField"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::CustomTypeField"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"CustomTypeField"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1CustomTypeField"},"children":[{"type":"text","text":"CustomTypeField"}]}]},{"type":"text","text":"\n "}]}` --> @@ -111,7 +117,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class PropertyField"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::PropertyField"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"PropertyField"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1PropertyField"},"children":[{"type":"text","text":"PropertyField"}]}]},{"type":"text","text":"\n "}]}` --> @@ -155,7 +161,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Operator"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::Operator"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Operator"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Operator"},"children":[{"type":"text","text":"Operator"}]}]},{"type":"text","text":"\n "}]}` --> @@ -221,7 +227,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class ResultInfo"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::ResultInfo"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"ResultInfo"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1ResultInfo"},"children":[{"type":"text","text":"ResultInfo"}]}]},{"type":"text","text":"\n "}]}` --> @@ -243,7 +249,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Any"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::Any"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Any"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Any"},"children":[{"type":"text","text":"Any"}]}]},{"type":"text","text":"\n "}]}` --> @@ -287,7 +293,7 @@ Define an abstract support notion. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class core"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::core"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"core"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1core"},"children":[{"type":"text","text":"core"}]}]},{"type":"text","text":"\n "}]}` --> ## Public functions @@ -336,7 +342,123 @@ ansys::dpf::Support::Support(Support const &) **Parameters**: -* Support const & +* [Support](classansys-dpf-support.md#classansys-dpf-support) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(MeshedRegion const &) +``` + + + + + + + + +**Parameters**: + +* [MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(CyclicSupport const &) +``` + + + + + + + + +**Parameters**: + +* [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(GenericSupport const &) +``` + + + + + + + + +**Parameters**: + +* [GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) const & + +**Return type**: + + + + +### Function Support + +![][public] + + +```cpp +ansys::dpf::Support::Support(TimeFreqSupport const &) +``` + + + + + + + + +**Parameters**: + +* [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) const & **Return type**: @@ -365,7 +487,7 @@ ansys::dpf::Support::Support(Support &&) noexcept **Parameters**: -* Support && +* [Support](classansys-dpf-support.md#classansys-dpf-support) && **Return type**: @@ -394,9 +516,9 @@ Support & ansys::dpf::Support::operator=(Support const &) **Parameters**: -* Support const & +* [Support](classansys-dpf-support.md#classansys-dpf-support) const & -**Return type**: Support & +**Return type**: [Support](classansys-dpf-support.md#classansys-dpf-support) & + +### Function type + +![][public] +![][const] + + +```cpp +std::string ansys::dpf::Support::type() const +``` + + + + +**Returns**: + +The support type as a string ([MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion), [CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport), [TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport), ...). + + + +**Return type**: std::string + + + ### Function getAsDomainMesh @@ -545,6 +695,34 @@ TimeFreqSupport ansys::dpf::Support::getAsTimeFreqSupport() const * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Support::getAsTimeFreqSupport"}]}` --> + +### Function getAsGenericSupport + +![][public] +![][const] + + +```cpp +GenericSupport ansys::dpf::Support::getAsGenericSupport() const +``` + + + + +**Returns**: + +[Support](classansys-dpf-support.md#classansys-dpf-support) as generic support. + + + +**Return type**: [GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) + + + ### Function getFieldSupportByProperty @@ -571,7 +749,7 @@ return empty [Field](classansys-dpf-field.md#classansys-dpf-field) if the proper * [PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) const & **property_name** -**Return type**: Field +**Return type**: [Field](classansys-dpf-field.md#classansys-dpf-field) @@ -240,7 +240,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class core"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::core"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"core"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1core"},"children":[{"type":"text","text":"core"}]}]},{"type":"text","text":"\n "}]}` --> @@ -262,7 +262,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Operator"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::Operator"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Operator"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Operator"},"children":[{"type":"text","text":"Operator"}]}]},{"type":"text","text":"\n "}]}` --> @@ -328,7 +328,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Any"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::Any"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Any"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Any"},"children":[{"type":"text","text":"Any"}]}]},{"type":"text","text":"\n "}]}` --> @@ -350,7 +350,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class Field"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::Field"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"Field"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1Field"},"children":[{"type":"text","text":"Field"}]}]},{"type":"text","text":"\n "}]}` --> @@ -372,7 +372,7 @@ * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class PropertyField"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::PropertyField"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"PropertyField"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1PropertyField"},"children":[{"type":"text","text":"PropertyField"}]}]},{"type":"text","text":"\n "}]}` --> @@ -757,7 +757,7 @@ Add operator to workflow. **Parameters**: -* Operator & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to add. +* [Operator](classansys-dpf-operator.md#classansys-dpf-operator) & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to add. **Return type**: void @@ -967,7 +967,7 @@ Add an input name to given pin of operator. * std::string const & **pin_name**: [in] Pin name. * int **operator_input_pin**: [in] Input pin. -* Operator & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. +* [Operator](classansys-dpf-operator.md#classansys-dpf-operator) & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. **Return type**: void @@ -996,7 +996,7 @@ Add an output name to given pin of operator. **Parameters**: -* Operator & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. +* [Operator](classansys-dpf-operator.md#classansys-dpf-operator) & **op**: [in] [Operator](classansys-dpf-operator.md#classansys-dpf-operator) to which to add pin name. * int **operator_output_pin**: [in] Output pin. * std::string const & **pin_name**: [in] Pin name. @@ -1500,7 +1500,7 @@ First operator in workflow chain. -**Return type**: Operator +**Return type**: [Operator](classansys-dpf-operator.md#classansys-dpf-operator) - + ### Function WorkflowStep ![][public] ```cpp -ansys::dpf::WorkflowStep::WorkflowStep(const std::vector< int > &ids) +ansys::dpf::WorkflowStep::WorkflowStep(const std::vector< int > &ids, int cachePriority=0) ``` @@ -64,6 +65,7 @@ ansys::dpf::WorkflowStep::WorkflowStep(const std::vector< int > &ids) **Parameters**: * const std::vector< int > & **ids** +* int **cachePriority** = 0 **Return type**: @@ -125,6 +127,32 @@ std::vector< int > ansys::dpf::WorkflowStep::getOperatorIds() const * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::WorkflowStep::getOperatorIds"}]}` --> + +### Function cachePriority + +![][public] +![][const] + + +```cpp +int ansys::dpf::WorkflowStep::cachePriority() const +``` + + + + + + + + +**Return type**: int + + + ### Function get diff --git a/2027R1/dpf-cpp-27-r1/api-reference/classes.md b/2027R1/dpf-cpp-27-r1/api-reference/classes.md index a64f27abc..9001d02c2 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/classes.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/classes.md @@ -138,6 +138,7 @@ List of Classes: - [ansys::dpf::reflect< short >](structansys-dpf-reflect-short.md) - [ansys::dpf::reflect< size_t >](structansys-dpf-reflect-size-t.md) - [ansys::dpf::reflect< unsigned int >](structansys-dpf-reflect-unsigned-int.md) +- [ansys::dpf::reflect< unsigned short >](structansys-dpf-reflect-unsigned-short.md) - [ansys::dpf::reflect< wchar_t >](structansys-dpf-reflect-wchar-t.md) - [ansys::dpf::spec](structansys-dpf-spec.md) - [ansys::dpf::spec::category](structansys-dpf-spec-category.md) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md b/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md index b3e8f036c..fc2f38164 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/deprecated.md @@ -10,7 +10,7 @@ use eFilterResults pin instead -Member [ansys::dpf::LibraryHandle::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle-1a0651cd01e74e2cb90f320435bc7fc87a) (std::string const &key, std::string const &shared_object_root_name, [ApiType](namespaceansys-dpf.md#namespaceansys-dpf-1a318ab16f856ec8d2ef6e13af94a6dc56) api_type, [LoadType](namespaceansys-dpf.md#namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3) load_type=[LoadType::try_load](namespaceansys-dpf.md#namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f), std::string const &dpf_client_api="DPFClientAPI"): +Member [ansys::dpf::LibraryHandle::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle-1a0651cd01e74e2cb90f320435bc7fc87a) (std::string const &key, std::string const &shared_object_root_name, ApiType api_type, LoadType load_type=[LoadType::try_load](namespaceansys-dpf.md#namespaceansys-dpf-1ac4f1380f00170887891b5cf54d8c94b3a6d450e9598ea0dffeaff74fbcccb116f), std::string const &dpf_client_api="DPFClientAPI"): This call is deprecated. usage is not maintained. diff --git a/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md b/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md index 1538e22a9..abed68f14 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/dir-dd83be0cfbcc27aa9f.md @@ -1,4 +1,4 @@ -# Directory D:/ANSYSDev/Sandbox/DPF/Ans.Dpf.Hgp +# Directory E:/ANSYSDev/TFSAgent/_work/38/s/DPF/Ans.Dpf.Hgp @@ -8,7 +8,7 @@ ## Subdirectories -* [D:/ANSYSDev/Sandbox/DPF/Ans.Dpf.Hgp/helpers](dir-fca9ddd4acaabdc476476.md#dir-fca9ddd4acaabdc476476) +* [E:/ANSYSDev/TFSAgent/_work/38/s/DPF/Ans.Dpf.Hgp/helpers](dir-fca9ddd4acaabdc476476.md#dir-fca9ddd4acaabdc476476) ## Files diff --git a/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md b/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md index 19eee58fc..8c3a036d7 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/dir-fca9ddd4acaabdc476476.md @@ -1,4 +1,4 @@ -# Directory D:/ANSYSDev/Sandbox/DPF/Ans.Dpf.Hgp/helpers +# Directory E:/ANSYSDev/TFSAgent/_work/38/s/DPF/Ans.Dpf.Hgp/helpers diff --git a/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md b/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md index 89ff9a3fc..9ad4525e9 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/dpf-api-base-h.md @@ -56,6 +56,7 @@ * [ansys::dpf::reflect\< float \>](structansys-dpf-reflect-float.md#structansys-dpf-reflect-float-4) * [ansys::dpf::reflect\< unsigned int \>](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4) * [ansys::dpf::reflect\< short \>](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4) +* [ansys::dpf::reflect\< unsigned short \>](structansys-dpf-reflect-unsigned-short.md#structansys-dpf-reflect-unsigned-short-4) * [ansys::dpf::reflect\< int8_t \>](structansys-dpf-reflect-int8-t.md#structansys-dpf-reflect-int8-t-4) ## Namespaces @@ -117,6 +118,19 @@ click 1 "dpf__api__base_8h.md#dpf__api__base_8h" * [dpf/include/dpf_api.h](dpf-api-h.md#dpf-api-h) +## Macros + + +### Macro DPF_HAVE_STD_SPAN + +![][public] + +```cpp +#define DPF_HAVE_STD_SPAN (__cplusplus >= 202002L) +``` + +When set to 1, DPF_HAVE_STD_SPAN will add additional functions returning std::span in addition to raw pointer APIs By default this is enabled with C++20 and later, and disabled in previous versions. + [C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) [const]: https://img.shields.io/badge/-const-lightblue (const) [public]: https://img.shields.io/badge/-public-brightgreen (public) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md b/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md index 7ecc9793f..be31685e9 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/namespaceansys-dpf.md @@ -10,132 +10,133 @@ This namespace encapsulates all of the HGP functionality. ## Classes -* [ansys::dpf::Model](classansys-dpf-model.md#classansys-dpf-model) -* [ansys::dpf::Result](classansys-dpf-result.md#classansys-dpf-result) -* [ansys::dpf::MeshQuery](classansys-dpf-meshquery.md#classansys-dpf-meshquery) -* [ansys::dpf::Collection](classansys-dpf-collection.md#classansys-dpf-collection) -* [ansys::dpf::ExternalData](classansys-dpf-externaldata.md#classansys-dpf-externaldata) -* [ansys::dpf::ExternalDataT](classansys-dpf-externaldatat.md#classansys-dpf-externaldatat) +* [ansys::dpf::Any](classansys-dpf-any.md#classansys-dpf-any) * [ansys::dpf::array_to_pointer_decay](structansys-dpf-array-to-pointer-decay.md#structansys-dpf-array-to-pointer-decay) * [ansys::dpf::array_to_pointer_decay\< T[N]\>](structansys-dpf-array-to-pointer-decay-t-fn-e.md#structansys-dpf-array-to-pointer-decay-t-fn-e-4) +* [ansys::dpf::CacheInformation](classansys-dpf-cacheinformation.md#classansys-dpf-cacheinformation) +* [ansys::dpf::Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) +* [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) +* [ansys::dpf::Collection](classansys-dpf-collection.md#classansys-dpf-collection) +* [ansys::dpf::CollectionBase](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase) +* [ansys::dpf::ConfigOptionSpecification](structansys-dpf-configoptionspecification.md#structansys-dpf-configoptionspecification) * [ansys::dpf::ConstructHelpers](structansys-dpf-constructhelpers.md#structansys-dpf-constructhelpers) -* [ansys::dpf::SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion) -* [ansys::dpf::Any](classansys-dpf-any.md#classansys-dpf-any) -* [ansys::dpf::Unit](classansys-dpf-unit.md#classansys-dpf-unit) -* [ansys::dpf::ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) -* [ansys::dpf::FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) -* [ansys::dpf::LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) -* [ansys::dpf::Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping) -* [ansys::dpf::ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) -* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) -* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) -* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) -* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) -* [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) -* [ansys::dpf::DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) +* [ansys::dpf::Context](classansys-dpf-context.md#classansys-dpf-context) +* [ansys::dpf::core](classansys-dpf-core.md#classansys-dpf-core) +* [ansys::dpf::CustomContainerBase](classansys-dpf-customcontainerbase.md#classansys-dpf-customcontainerbase) * [ansys::dpf::CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield) -* [ansys::dpf::FieldCursor](classansys-dpf-fieldcursor.md#classansys-dpf-fieldcursor) -* [ansys::dpf::Field](classansys-dpf-field.md#classansys-dpf-field) -* [ansys::dpf::PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor) -* [ansys::dpf::PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) -* [ansys::dpf::StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield) -* [ansys::dpf::CollectionBase](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase) -* [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) -* [ansys::dpf::ScopingsContainer](classansys-dpf-scopingscontainer.md#classansys-dpf-scopingscontainer) -* [ansys::dpf::MeshesContainer](classansys-dpf-meshescontainer.md#classansys-dpf-meshescontainer) * [ansys::dpf::CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) +* [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) * [ansys::dpf::DataSources](classansys-dpf-datasources.md#classansys-dpf-datasources) +* [ansys::dpf::DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) +* [ansys::dpf::dimensionalities](structansys-dpf-dimensionalities.md#structansys-dpf-dimensionalities) +* [ansys::dpf::Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality) +* [ansys::dpf::DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) +* [ansys::dpf::DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception) +* [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes) +* [ansys::dpf::DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) +* [ansys::dpf::DpfVectorData](classansys-dpf-dpfvectordata.md#classansys-dpf-dpfvectordata) +* [ansys::dpf::DpfVectorDataHelper](structansys-dpf-dpfvectordatahelper.md#structansys-dpf-dpfvectordatahelper) +* [ansys::dpf::ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) +* [ansys::dpf::ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) +* [ansys::dpf::elements](structansys-dpf-elements.md#structansys-dpf-elements) +* [ansys::dpf::EventHandler](classansys-dpf-eventhandler.md#classansys-dpf-eventhandler) +* [ansys::dpf::ExternalData](classansys-dpf-externaldata.md#classansys-dpf-externaldata) +* [ansys::dpf::ExternalDataT](classansys-dpf-externaldatat.md#classansys-dpf-externaldatat) * [ansys::dpf::ExternalStream](classansys-dpf-externalstream.md#classansys-dpf-externalstream) -* [ansys::dpf::Streams](classansys-dpf-streams.md#classansys-dpf-streams) +* [ansys::dpf::Field](classansys-dpf-field.md#classansys-dpf-field) +* [ansys::dpf::FieldCursor](classansys-dpf-fieldcursor.md#classansys-dpf-fieldcursor) +* [ansys::dpf::FieldDefinition](classansys-dpf-fielddefinition.md#classansys-dpf-fielddefinition) +* [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) * [ansys::dpf::GenericDataContainer](classansys-dpf-genericdatacontainer.md#classansys-dpf-genericdatacontainer) +* [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) +* [ansys::dpf::homogeneities](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities) +* [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) +* [ansys::dpf::Interface](classansys-dpf-interface.md#classansys-dpf-interface) +* [ansys::dpf::Label](structansys-dpf-label.md#structansys-dpf-label) +* [ansys::dpf::labels](structansys-dpf-labels.md#structansys-dpf-labels) +* [ansys::dpf::LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) +* [ansys::dpf::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle) +* [ansys::dpf::LibraryHolder](classansys-dpf-libraryholder.md#classansys-dpf-libraryholder) +* [ansys::dpf::LicenseContextManager](classansys-dpf-licensecontextmanager.md#classansys-dpf-licensecontextmanager) +* [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) +* [ansys::dpf::locations](structansys-dpf-locations.md#structansys-dpf-locations) +* [ansys::dpf::Mapping](classansys-dpf-mapping.md#classansys-dpf-mapping) +* [ansys::dpf::MeshedRegion](classansys-dpf-meshedregion.md#classansys-dpf-meshedregion) +* [ansys::dpf::MeshesContainer](classansys-dpf-meshescontainer.md#classansys-dpf-meshescontainer) +* [ansys::dpf::MeshInfo](classansys-dpf-meshinfo.md#classansys-dpf-meshinfo) +* [ansys::dpf::MeshQuery](classansys-dpf-meshquery.md#classansys-dpf-meshquery) +* [ansys::dpf::Model](classansys-dpf-model.md#classansys-dpf-model) * [ansys::dpf::Operator](classansys-dpf-operator.md#classansys-dpf-operator) -* [ansys::dpf::CacheInformation](classansys-dpf-cacheinformation.md#classansys-dpf-cacheinformation) -* [ansys::dpf::Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow) * [ansys::dpf::OperatorConfig](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig) -* [ansys::dpf::CustomContainerBase](classansys-dpf-customcontainerbase.md#classansys-dpf-customcontainerbase) -* [ansys::dpf::MeshInfo](classansys-dpf-meshinfo.md#classansys-dpf-meshinfo) -* [ansys::dpf::Mapping](classansys-dpf-mapping.md#classansys-dpf-mapping) -* [ansys::dpf::Interface](classansys-dpf-interface.md#classansys-dpf-interface) -* [ansys::dpf::WorkflowStep](classansys-dpf-workflowstep.md#classansys-dpf-workflowstep) -* [ansys::dpf::OperatorMain](classansys-dpf-operatormain.md#classansys-dpf-operatormain) * [ansys::dpf::OperatorDerivativeMain](classansys-dpf-operatorderivativemain.md#classansys-dpf-operatorderivativemain) -* [ansys::dpf::PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) -* [ansys::dpf::ConfigOptionSpecification](structansys-dpf-configoptionspecification.md#structansys-dpf-configoptionspecification) +* [ansys::dpf::OperatorMain](classansys-dpf-operatormain.md#classansys-dpf-operatormain) * [ansys::dpf::OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification) -* [ansys::dpf::RemoteOperator](classansys-dpf-remoteoperator.md#classansys-dpf-remoteoperator) -* [ansys::dpf::RemoteWorkflow](classansys-dpf-remoteworkflow.md#classansys-dpf-remoteworkflow) -* [ansys::dpf::EventHandler](classansys-dpf-eventhandler.md#classansys-dpf-eventhandler) -* [ansys::dpf::Session](classansys-dpf-session.md#classansys-dpf-session) -* [ansys::dpf::RuntimeConfig](classansys-dpf-runtimeconfig.md#classansys-dpf-runtimeconfig) -* [ansys::dpf::RuntimeCoreConfig](classansys-dpf-runtimecoreconfig.md#classansys-dpf-runtimecoreconfig) -* [ansys::dpf::RuntimeClientConfig](classansys-dpf-runtimeclientconfig.md#classansys-dpf-runtimeclientconfig) -* [ansys::dpf::Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) -* [ansys::dpf::core](classansys-dpf-core.md#classansys-dpf-core) +* [ansys::dpf::param_helpers](structansys-dpf-param-helpers.md#structansys-dpf-param-helpers) +* [ansys::dpf::PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) +* [ansys::dpf::property_types](structansys-dpf-property-types.md#structansys-dpf-property-types) +* [ansys::dpf::PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) +* [ansys::dpf::PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) +* [ansys::dpf::PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor) +* [ansys::dpf::quantity_types](structansys-dpf-quantity-types.md#structansys-dpf-quantity-types) +* [ansys::dpf::QuantityType](structansys-dpf-quantitytype.md#structansys-dpf-quantitytype) +* [ansys::dpf::reflect](structansys-dpf-reflect.md#structansys-dpf-reflect) +* [ansys::dpf::reflect\< bool \>](structansys-dpf-reflect-bool.md#structansys-dpf-reflect-bool-4) +* [ansys::dpf::reflect\< char \>](structansys-dpf-reflect-char.md#structansys-dpf-reflect-char-4) +* [ansys::dpf::reflect\< CustomTypeField \>](structansys-dpf-reflect-customtypefield.md#structansys-dpf-reflect-customtypefield-4) +* [ansys::dpf::reflect\< CustomTypeFieldsContainer \>](structansys-dpf-reflect-customtypefieldscontainer.md#structansys-dpf-reflect-customtypefieldscontainer-4) +* [ansys::dpf::reflect\< DataSources \>](structansys-dpf-reflect-datasources.md#structansys-dpf-reflect-datasources-4) +* [ansys::dpf::reflect\< DataTree \>](structansys-dpf-reflect-datatree.md#structansys-dpf-reflect-datatree-4) +* [ansys::dpf::reflect\< double \>](structansys-dpf-reflect-double.md#structansys-dpf-reflect-double-4) * [ansys::dpf::reflect\< Field \>](structansys-dpf-reflect-field.md#structansys-dpf-reflect-field-4) * [ansys::dpf::reflect\< FieldsContainer \>](structansys-dpf-reflect-fieldscontainer.md#structansys-dpf-reflect-fieldscontainer-4) +* [ansys::dpf::reflect\< float \>](structansys-dpf-reflect-float.md#structansys-dpf-reflect-float-4) +* [ansys::dpf::reflect\< GenericDataContainer \>](structansys-dpf-reflect-genericdatacontainer.md#structansys-dpf-reflect-genericdatacontainer-4) +* [ansys::dpf::reflect\< int \>](structansys-dpf-reflect-int.md#structansys-dpf-reflect-int-4) +* [ansys::dpf::reflect\< int64_t \>](structansys-dpf-reflect-int64-t.md#structansys-dpf-reflect-int64-t-4) +* [ansys::dpf::reflect\< int8_t \>](structansys-dpf-reflect-int8-t.md#structansys-dpf-reflect-int8-t-4) +* [ansys::dpf::reflect\< LabelSpace \>](structansys-dpf-reflect-labelspace.md#structansys-dpf-reflect-labelspace-4) * [ansys::dpf::reflect\< MeshedRegion \>](structansys-dpf-reflect-meshedregion.md#structansys-dpf-reflect-meshedregion-4) -* [ansys::dpf::reflect\< DataSources \>](structansys-dpf-reflect-datasources.md#structansys-dpf-reflect-datasources-4) -* [ansys::dpf::reflect\< Streams \>](structansys-dpf-reflect-streams.md#structansys-dpf-reflect-streams-4) -* [ansys::dpf::reflect\< Scoping \>](structansys-dpf-reflect-scoping.md#structansys-dpf-reflect-scoping-4) -* [ansys::dpf::reflect\< ScopingsContainer \>](structansys-dpf-reflect-scopingscontainer.md#structansys-dpf-reflect-scopingscontainer-4) * [ansys::dpf::reflect\< MeshesContainer \>](structansys-dpf-reflect-meshescontainer.md#structansys-dpf-reflect-meshescontainer-4) -* [ansys::dpf::reflect\< PropertyField \>](structansys-dpf-reflect-propertyfield.md#structansys-dpf-reflect-propertyfield-4) -* [ansys::dpf::reflect\< ResultInfo \>](structansys-dpf-reflect-resultinfo.md#structansys-dpf-reflect-resultinfo-4) -* [ansys::dpf::reflect\< TimeFreqSupport \>](structansys-dpf-reflect-timefreqsupport.md#structansys-dpf-reflect-timefreqsupport-4) -* [ansys::dpf::reflect\< DataTree \>](structansys-dpf-reflect-datatree.md#structansys-dpf-reflect-datatree-4) -* [ansys::dpf::reflect\< Workflow \>](structansys-dpf-reflect-workflow.md#structansys-dpf-reflect-workflow-4) * [ansys::dpf::reflect\< Operator \>](structansys-dpf-reflect-operator.md#structansys-dpf-reflect-operator-4) +* [ansys::dpf::reflect\< PropertyField \>](structansys-dpf-reflect-propertyfield.md#structansys-dpf-reflect-propertyfield-4) * [ansys::dpf::reflect\< RemoteOperator \>](structansys-dpf-reflect-remoteoperator.md#structansys-dpf-reflect-remoteoperator-4) * [ansys::dpf::reflect\< RemoteWorkflow \>](structansys-dpf-reflect-remoteworkflow.md#structansys-dpf-reflect-remoteworkflow-4) +* [ansys::dpf::reflect\< ResultInfo \>](structansys-dpf-reflect-resultinfo.md#structansys-dpf-reflect-resultinfo-4) +* [ansys::dpf::reflect\< Scoping \>](structansys-dpf-reflect-scoping.md#structansys-dpf-reflect-scoping-4) +* [ansys::dpf::reflect\< ScopingsContainer \>](structansys-dpf-reflect-scopingscontainer.md#structansys-dpf-reflect-scopingscontainer-4) +* [ansys::dpf::reflect\< short \>](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4) +* [ansys::dpf::reflect\< size_t \>](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4) +* [ansys::dpf::reflect\< Streams \>](structansys-dpf-reflect-streams.md#structansys-dpf-reflect-streams-4) * [ansys::dpf::reflect\< StringField \>](structansys-dpf-reflect-stringfield.md#structansys-dpf-reflect-stringfield-4) -* [ansys::dpf::reflect\< CustomTypeField \>](structansys-dpf-reflect-customtypefield.md#structansys-dpf-reflect-customtypefield-4) -* [ansys::dpf::reflect\< LabelSpace \>](structansys-dpf-reflect-labelspace.md#structansys-dpf-reflect-labelspace-4) -* [ansys::dpf::reflect\< GenericDataContainer \>](structansys-dpf-reflect-genericdatacontainer.md#structansys-dpf-reflect-genericdatacontainer-4) -* [ansys::dpf::reflect\< CustomTypeFieldsContainer \>](structansys-dpf-reflect-customtypefieldscontainer.md#structansys-dpf-reflect-customtypefieldscontainer-4) -* [ansys::dpf::LicenseContextManager](classansys-dpf-licensecontextmanager.md#classansys-dpf-licensecontextmanager) -* [ansys::dpf::reflect](structansys-dpf-reflect.md#structansys-dpf-reflect) -* [ansys::dpf::param_helpers](structansys-dpf-param-helpers.md#structansys-dpf-param-helpers) -* [ansys::dpf::QuantityType](structansys-dpf-quantitytype.md#structansys-dpf-quantitytype) -* [ansys::dpf::quantity_types](structansys-dpf-quantity-types.md#structansys-dpf-quantity-types) -* [ansys::dpf::Location](structansys-dpf-location.md#structansys-dpf-location) -* [ansys::dpf::locations](structansys-dpf-locations.md#structansys-dpf-locations) -* [ansys::dpf::PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) -* [ansys::dpf::property_types](structansys-dpf-property-types.md#structansys-dpf-property-types) -* [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) -* [ansys::dpf::homogeneities](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities) -* [ansys::dpf::UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem) -* [ansys::dpf::unit_systems](structansys-dpf-unit-systems.md#structansys-dpf-unit-systems) -* [ansys::dpf::Label](structansys-dpf-label.md#structansys-dpf-label) -* [ansys::dpf::labels](structansys-dpf-labels.md#structansys-dpf-labels) +* [ansys::dpf::reflect\< TimeFreqSupport \>](structansys-dpf-reflect-timefreqsupport.md#structansys-dpf-reflect-timefreqsupport-4) +* [ansys::dpf::reflect\< unsigned int \>](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4) +* [ansys::dpf::reflect\< unsigned short \>](structansys-dpf-reflect-unsigned-short.md#structansys-dpf-reflect-unsigned-short-4) +* [ansys::dpf::reflect\< wchar_t \>](structansys-dpf-reflect-wchar-t.md#structansys-dpf-reflect-wchar-t-4) +* [ansys::dpf::reflect\< Workflow \>](structansys-dpf-reflect-workflow.md#structansys-dpf-reflect-workflow-4) +* [ansys::dpf::RemoteOperator](classansys-dpf-remoteoperator.md#classansys-dpf-remoteoperator) +* [ansys::dpf::RemoteWorkflow](classansys-dpf-remoteworkflow.md#classansys-dpf-remoteworkflow) +* [ansys::dpf::Result](classansys-dpf-result.md#classansys-dpf-result) +* [ansys::dpf::ResultInfo](classansys-dpf-resultinfo.md#classansys-dpf-resultinfo) +* [ansys::dpf::RuntimeClientConfig](classansys-dpf-runtimeclientconfig.md#classansys-dpf-runtimeclientconfig) +* [ansys::dpf::RuntimeConfig](classansys-dpf-runtimeconfig.md#classansys-dpf-runtimeconfig) +* [ansys::dpf::RuntimeCoreConfig](classansys-dpf-runtimecoreconfig.md#classansys-dpf-runtimecoreconfig) +* [ansys::dpf::Scoping](classansys-dpf-scoping.md#classansys-dpf-scoping) +* [ansys::dpf::ScopingsContainer](classansys-dpf-scopingscontainer.md#classansys-dpf-scopingscontainer) +* [ansys::dpf::SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion) +* [ansys::dpf::Session](classansys-dpf-session.md#classansys-dpf-session) * [ansys::dpf::ShellDescriptor](structansys-dpf-shelldescriptor.md#structansys-dpf-shelldescriptor) -* [ansys::dpf::ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) -* [ansys::dpf::elements](structansys-dpf-elements.md#structansys-dpf-elements) +* [ansys::dpf::spec](structansys-dpf-spec.md#structansys-dpf-spec) +* [ansys::dpf::Streams](classansys-dpf-streams.md#classansys-dpf-streams) +* [ansys::dpf::StringField](classansys-dpf-stringfield.md#classansys-dpf-stringfield) +* [ansys::dpf::Support](classansys-dpf-support.md#classansys-dpf-support) +* [ansys::dpf::TimeFreqSupport](classansys-dpf-timefreqsupport.md#classansys-dpf-timefreqsupport) * [ansys::dpf::TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) * [ansys::dpf::types](structansys-dpf-types.md#structansys-dpf-types) -* [ansys::dpf::Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality) -* [ansys::dpf::dimensionalities](structansys-dpf-dimensionalities.md#structansys-dpf-dimensionalities) -* [ansys::dpf::spec](structansys-dpf-spec.md#structansys-dpf-spec) -* [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes) -* [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) -* [ansys::dpf::DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) -* [ansys::dpf::DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception) -* [ansys::dpf::DpfVectorDataHelper](structansys-dpf-dpfvectordatahelper.md#structansys-dpf-dpfvectordatahelper) -* [ansys::dpf::DpfVectorData](classansys-dpf-dpfvectordata.md#classansys-dpf-dpfvectordata) -* [ansys::dpf::DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) -* [ansys::dpf::Context](classansys-dpf-context.md#classansys-dpf-context) -* [ansys::dpf::LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle) -* [ansys::dpf::LibraryHolder](classansys-dpf-libraryholder.md#classansys-dpf-libraryholder) -* [ansys::dpf::reflect\< int \>](structansys-dpf-reflect-int.md#structansys-dpf-reflect-int-4) -* [ansys::dpf::reflect\< double \>](structansys-dpf-reflect-double.md#structansys-dpf-reflect-double-4) -* [ansys::dpf::reflect\< bool \>](structansys-dpf-reflect-bool.md#structansys-dpf-reflect-bool-4) -* [ansys::dpf::reflect\< size_t \>](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4) -* [ansys::dpf::reflect\< int64_t \>](structansys-dpf-reflect-int64-t.md#structansys-dpf-reflect-int64-t-4) -* [ansys::dpf::reflect\< char \>](structansys-dpf-reflect-char.md#structansys-dpf-reflect-char-4) -* [ansys::dpf::reflect\< wchar_t \>](structansys-dpf-reflect-wchar-t.md#structansys-dpf-reflect-wchar-t-4) -* [ansys::dpf::reflect\< float \>](structansys-dpf-reflect-float.md#structansys-dpf-reflect-float-4) -* [ansys::dpf::reflect\< unsigned int \>](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4) -* [ansys::dpf::reflect\< short \>](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4) -* [ansys::dpf::reflect\< int8_t \>](structansys-dpf-reflect-int8-t.md#structansys-dpf-reflect-int8-t-4) +* [ansys::dpf::Unit](classansys-dpf-unit.md#classansys-dpf-unit) +* [ansys::dpf::unit_systems](structansys-dpf-unit-systems.md#structansys-dpf-unit-systems) +* [ansys::dpf::UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem) +* [ansys::dpf::Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow) +* [ansys::dpf::WorkflowStep](classansys-dpf-workflowstep.md#classansys-dpf-workflowstep) ## Enumeration types @@ -514,7 +515,7 @@ Bottom shell layer -Both Top and Bottom shell layer +Both Top and Bottom shell layer. Order of results: 1.Bottom Shell Layer results. 2.Top Shell Layer results #### Enumerator eMid @@ -528,7 +529,7 @@ Middle shell layer -All shell layers +All shell layers. Order of results: 1.Bottom Shell Layer results. 2.Top Shell Layer results. 3.Mid Shell Layer results #### Enumerator eNoneLayer @@ -902,14 +903,14 @@ typedef void(* ansys::dpf::OperatorDerivateFunction) (OperatorDerivativeMain &) * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::OperatorDerivateFunction"}]}` --> - + ### Typedef FbsClient ![][public] ```cpp -using ansys::dpf::FbsClient = Any +using ansys::dpf::FbsClient = typedef Any ``` @@ -927,14 +928,14 @@ using ansys::dpf::FbsClient = Any * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::FbsClient"}]}` --> - + ### Typedef HasGenericDataContainerConstructor ![][public] ```cpp -using ansys::dpf::HasGenericDataContainerConstructor = std::is_constructible +using ansys::dpf::HasGenericDataContainerConstructor = typedef std::is_constructible ``` @@ -1139,7 +1140,7 @@ typedef UnitSystem ansys::dpf::UnitSytem ``` -using [UnitSytem](namespaceansys-dpf.md#namespaceansys-dpf-1aae1038d08681cf4311d36bd77661272c) = [UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem); +using UnitSytem = [UnitSystem](structansys-dpf-unitsystem.md#structansys-dpf-unitsystem); diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md index 4d61faaaf..3331e25d6 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-constructhelpers-construct-trait.md @@ -12,7 +12,7 @@ traits specialized below to handle derived class of [CustomContainerBase](classa **Template parameters**: * typename DataT -* typename IsGDC = typename [HasGenericDataContainerConstructor](namespaceansys-dpf.md#namespaceansys-dpf-1acc01990faa84aba04f8d6534727dd204)::type +* typename IsGDC = typename [HasGenericDataContainerConstructor](namespaceansys-dpf.md#namespaceansys-dpf-1a5f3f18dc09482854dd40ed01d0d6e583)::type ## Members diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md index cc14964f8..631ac6928 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-context-internal.md @@ -36,7 +36,7 @@ static int ansys::dpf::Context::internal::getAPIVersion(Context const &context) **Parameters**: -* [Context](classansys-dpf-context.md#classansys-dpf-context-1ae26354fe1dea7b2691e115275704278b) const & **context** +* [Context](classansys-dpf-context.md#classansys-dpf-context) const & **context** **Return type**: int @@ -66,7 +66,7 @@ static DataTree ansys::dpf::Context::internal::contextToDataTree(Context const & **Parameters**: -* [Context](classansys-dpf-context.md#classansys-dpf-context-1ae26354fe1dea7b2691e115275704278b) const & **context** +* [Context](classansys-dpf-context.md#classansys-dpf-context) const & **context** * [Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client** = nullptr **Return type**: [DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md index 7352a2f4a..cbc1aca4f 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-core-fbsserverdata.md @@ -33,7 +33,7 @@ FbsClient ansys::dpf::core::FbsServerData::server_holder -**Type**: FbsClient +**Type**: [FbsClient](classansys-dpf-any.md#classansys-dpf-any) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md index a6e262ce5..7a48aa5f0 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-elementdescriptor.md @@ -338,7 +338,7 @@ bool ansys::dpf::ElementDescriptor::operator==(ElementDescriptor const &rhs) con **Parameters**: -* [ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor-1ab19bfe010b78317bd83e6d1d2b9b1ebf) const & **rhs** +* [ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) const & **rhs** **Return type**: bool diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md index d3420f91e..66ae623ae 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-label.md @@ -71,7 +71,7 @@ ansys::dpf::Label::Label(Label const &)=default **Parameters**: -* Label const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: @@ -101,7 +101,7 @@ bool ansys::dpf::Label::operator==(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool @@ -131,7 +131,7 @@ bool ansys::dpf::Label::operator<(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool @@ -161,7 +161,7 @@ bool ansys::dpf::Label::operator<=(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool @@ -191,7 +191,7 @@ bool ansys::dpf::Label::operator!=(Label const &) const **Parameters**: -* [Label](structansys-dpf-label.md#structansys-dpf-label-1aa16652a3ceeda62dce2af07722a0ec80) const & +* [Label](structansys-dpf-label.md#structansys-dpf-label) const & **Return type**: bool diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md index 90336e8ef..7a3510756 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-labels.md @@ -19,6 +19,7 @@ Predefined labels. * [dofs](structansys-dpf-labels.md#structansys-dpf-labels-1ad2788c414a549ad634c56f272ecd0607) * [domain](structansys-dpf-labels.md#structansys-dpf-labels-1ae97916221f9fab4003318668faf26b87) * [ghost](structansys-dpf-labels.md#structansys-dpf-labels-1ac0403bfca2736100f8d4881f12b50ed9) +* [input_dof_index](structansys-dpf-labels.md#structansys-dpf-labels-1a92f62c0505698cea4cfff620c8e2838e) * [panel](structansys-dpf-labels.md#structansys-dpf-labels-1a6e29cda8e31c6c272d2ae30d3c2491ea) * [partition](structansys-dpf-labels.md#structansys-dpf-labels-1a57963c7165b37fb727a885b561171a86) * [phase](structansys-dpf-labels.md#structansys-dpf-labels-1a3536d0ec8b45d3388ddf47337fe0eca9) @@ -340,6 +341,32 @@ const Label ansys::dpf::labels::ghost * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::labels::ghost"}]}` --> + +### Variable input_dof_index + +![][public] +![][static] + + +```cpp +const Label ansys::dpf::labels::input_dof_index +``` + + + + +[Label](structansys-dpf-label.md#structansys-dpf-label) for input_dof_index. + + + +**Type**: const [Label](structansys-dpf-label.md#structansys-dpf-label) + + + [C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) [const]: https://img.shields.io/badge/-const-lightblue (const) [public]: https://img.shields.io/badge/-public-brightgreen (public) diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md index 403f134a6..3cefc6810 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-location.md @@ -72,7 +72,7 @@ ansys::dpf::Location::Location(Location const &)=default **Parameters**: -* Location const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: @@ -102,7 +102,7 @@ bool ansys::dpf::Location::operator==(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool @@ -132,7 +132,7 @@ bool ansys::dpf::Location::operator<(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool @@ -162,7 +162,7 @@ bool ansys::dpf::Location::operator<=(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool @@ -192,7 +192,7 @@ bool ansys::dpf::Location::operator!=(Location const &) const **Parameters**: -* [Location](structansys-dpf-location.md#structansys-dpf-location-1a2b3efab2807517d182bc9a486a0fb837) const & +* [Location](structansys-dpf-location.md#structansys-dpf-location) const & **Return type**: bool diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md index 7643061a6..8e1ed3973 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-locations.md @@ -24,12 +24,14 @@ Results are evaluated at locations. * [elemental_nodal_centroid](structansys-dpf-locations.md#structansys-dpf-locations-1a5b54316cebce849e6a8489d19a990246) * [faces](structansys-dpf-locations.md#structansys-dpf-locations-1a111716841842157a978ebebdc9c503b6) * [harmonic_index](structansys-dpf-locations.md#structansys-dpf-locations-1a46ac72d7066346bc309dfb44de1a20cf) +* [input_dof_index](structansys-dpf-locations.md#structansys-dpf-locations-1aad4c73875803704a0e4c6dcc43a7fb51) * [joint](structansys-dpf-locations.md#structansys-dpf-locations-1a0a7d57a4476a34178090d4fa96f0c550) * [nodal](structansys-dpf-locations.md#structansys-dpf-locations-1aa4e1967b0838d8597200c606c8564d29) * [nodal_elemental](structansys-dpf-locations.md#structansys-dpf-locations-1aba56d24e91e52e4742ee5505dff04b94) * [overall](structansys-dpf-locations.md#structansys-dpf-locations-1ada5a62dea9a6a1bf156f90282a273959) * [phase](structansys-dpf-locations.md#structansys-dpf-locations-1abaf9f2158d14707096139ab5eb27d70d) * [species](structansys-dpf-locations.md#structansys-dpf-locations-1a76bdfc819d94d708b849281adf480677) +* [time](structansys-dpf-locations.md#structansys-dpf-locations-1af97eb8c6e2585662148a029e71591567) * [time_set](structansys-dpf-locations.md#structansys-dpf-locations-1a3cf1bbc2ad6d8b8f6173e83b5118031a) * [time_step](structansys-dpf-locations.md#structansys-dpf-locations-1abc48364ef6b184ddf696099c9a2993cd) * [topology](structansys-dpf-locations.md#structansys-dpf-locations-1a3049c32b1dc96441810bd53803916a58) @@ -429,6 +431,32 @@ Predefined time_set location. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::locations::time_set"}]}` --> + +### Variable time + +![][public] +![][static] + + +```cpp +const Location ansys::dpf::locations::time +``` + + + + +Predefined time location. + + + +**Type**: const [Location](structansys-dpf-location.md#structansys-dpf-location) + + + ### Variable harmonic_index @@ -559,6 +587,32 @@ Predefined band location. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::locations::band"}]}` --> + +### Variable input_dof_index + +![][public] +![][static] + + +```cpp +const Location ansys::dpf::locations::input_dof_index +``` + + + + +Predefined input_dof_index location. + + + +**Type**: const [Location](structansys-dpf-location.md#structansys-dpf-location) + + + ### Variable unknown diff --git a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md index 2c8a9fca4..1f4cf8a92 100644 --- a/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md +++ b/2027R1/dpf-cpp-27-r1/api-reference/structansys-dpf-pindefinition.md @@ -339,7 +339,7 @@ Pin definition. * std::string const & **n**: [in] Name of pin. -**Return type**: PinDefinition & +**Return type**: [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) & @@ -67,7 +67,7 @@ Description of type. * `definition {"type":"element","name":"definition","attributes":{},"children":[{"type":"text","text":"friend class OperatorSpecification"}]}` * `argsstring {"type":"element","name":"argsstring","attributes":{},"children":[]}` * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::TypeDescriptor::OperatorSpecification"}]}` -* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"text","text":"OperatorSpecification"}]},{"type":"text","text":"\n "}]}` +* `param {"type":"element","name":"param","attributes":{},"children":[{"type":"text","text":"\n "},{"type":"element","name":"type","attributes":{},"children":[{"type":"element","name":"ref","attributes":{"kindref":"compound","refid":"classansys_1_1dpf_1_1OperatorSpecification"},"children":[{"type":"text","text":"OperatorSpecification"}]}]},{"type":"text","text":"\n "}]}` --> ## Public functions @@ -120,7 +120,7 @@ ansys::dpf::TypeDescriptor::TypeDescriptor(TypeDescriptor const &)=default **Parameters**: -* TypeDescriptor const & +* [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) const & **Return type**: @@ -149,7 +149,7 @@ ansys::dpf::TypeDescriptor::TypeDescriptor(TypeDescriptor &&)=default **Parameters**: -* TypeDescriptor && +* [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) && **Return type**: @@ -178,9 +178,9 @@ TypeDescriptor & ansys::dpf::TypeDescriptor::operator=(TypeDescriptor const &)=d **Parameters**: -* TypeDescriptor const & +* [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) const & -**Return type**: TypeDescriptor & +**Return type**: [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) &