diff --git a/2027R1/dpf-framework-27-r1/changelog/changelog.md b/2027R1/dpf-framework-27-r1/changelog/changelog.md index 71f89da0b1..eed8a65d62 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-02-07). +Changes since the last released version for DPF 27.1.pre0 (as of 2026-02-10). This changelog is organized by category, with sections for different types of updates (new features, bug fixes, changes, performance improvements). @@ -22,7 +22,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 | [1 item](#Features_femutils) |[11 items](#Fixes_femutils) | +| femutils | [1 item](#Features_femutils) |[12 items](#Fixes_femutils) | | flatbuffers | |[1 item](#Fixes_flatbuffers) | | framework | [2 items](#Features_framework) |[5 items](#Fixes_framework) | | grpc | [1 item](#Features_grpc) |[3 items](#Fixes_grpc) | @@ -31,12 +31,12 @@ The following table shows which components have updates in each category. | hdf5 | [6 items](#Features_hdf5) |[5 items](#Fixes_hdf5) | | hgp | [3 items](#Features_hgp) |[2 items](#Fixes_hgp) | | hgptests | |[1 item](#Fixes_hgptests) | -| kernel | [2 items](#Features_kernel) |[7 items](#Fixes_kernel) | +| kernel | [2 items](#Features_kernel) |[8 items](#Fixes_kernel) | | lsdyna | [1 item](#Features_lsdyna) | | | mapd | [1 item](#Features_mapd) | | | mapdl | [14 items](#Features_mapdl) |[40 items](#Fixes_mapdl) | | mapdlpluggin | |[1 item](#Fixes_mapdlpluggin) | -| math | [9 items](#Features_math) |[1 item](#Fixes_math) | +| math | [10 items](#Features_math) |[1 item](#Fixes_math) | | mechanical | [2 items](#Features_mechanical) |[4 items](#Fixes_mechanical) | | mesh | |[3 items](#Fixes_mesh) | | misc | [13 items](#Features_misc) |[19 items](#Fixes_misc) | @@ -48,7 +48,7 @@ The following table shows which components have updates in each category. | pydpf | |[1 item](#Fixes_pydpf) | | refactor | [1 item](#Features_refactor) | | | rotation | |[1 item](#Fixes_rotation) | -| workflows | |[2 items](#Fixes_workflows) | +| workflows | [1 item](#Features_workflows) |[2 items](#Fixes_workflows) | ## 1297620 @@ -346,6 +346,13 @@ The following table shows which components have updates in each category. ### Fixes +- Bug 1398238 Fail to extract structural temperature at multiple time steps: + > Fix random failure in multistep transient simulation + > + > + > + > + - Keep the input unit when computing torque and force summation: > > @@ -732,6 +739,9 @@ The following table shows which components have updates in each category. ### Fixes +- Follow-up on units: + > + - Complete unit strings for existing Unit Systems: > > @@ -1207,6 +1217,9 @@ The following table shows which components have updates in each category. ## math ### Features +- Create a new operator to compute modal loads for MSUP workflow: + > + - Add new MKL BLAS wrapper for scaling operation: > Add new MKL BLAS wrapper for scaling operation > @@ -1863,6 +1876,16 @@ The following table shows which components have updates in each category. > > ## workflows +### Features + +- Setup a shared live migration to hdf5 workflow: + > + > + > Add a shared workflow suitable for H5DPF writing from solvers + > + > + > + > ### Fixes diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference.md index 902baeaca8..cd8869ae8a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference.md @@ -14,12 +14,16 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 10| [through_layers](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 10 | [through_layers](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ The maximum elemental difference is taken through the different shell layers if ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ The maximum elemental difference is taken through the different shell layers if ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference_fc.md index e04bfd5367..c9167b221f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_difference_fc.md @@ -14,12 +14,16 @@ Transforms an Elemental Nodal or Nodal field into an Elemental field. Each eleme ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 10| [collapse_shell_layers](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 10 | [collapse_shell_layers](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ If true, the data across different shell layers is averaged as well (default is ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -72,22 +80,24 @@ If true, the data across different shell layers is averaged as well (default is ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -98,6 +108,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -112,6 +124,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_fraction_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_fraction_fc.md index 841d21eca6..c272dc4266 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_fraction_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_fraction_fc.md @@ -14,13 +14,17 @@ Transforms Elemental Nodal fields into Elemental fields. Each elemental value is ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 6| [denominator](#input_6) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 10| [collapse_shell_layers](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 6 | [denominator](#input_6) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 10 | [collapse_shell_layers](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ If true, the data across different shell layers is averaged as well (default is ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,22 +89,24 @@ If true, the data across different shell layers is averaged as well (default is ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -107,6 +117,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -121,6 +133,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean.md index b1ab5a3d44..a4404d5f7d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean.md @@ -14,12 +14,16 @@ Computes the average of a multi-entity field, (ElementalNodal -> Elemental), (No ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [collapse_shell_layers](#input_1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [force_averaging](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [collapse_shell_layers](#input_1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [force_averaging](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -57,6 +61,10 @@ Average only on these elements. If it is a scoping container, the label must cor ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ Average only on these elements. If it is a scoping container, the label must cor ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean_fc.md index 5dee570c20..e1537d54a3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_mean_fc.md @@ -14,15 +14,19 @@ Computes the average of a multi-entity container of fields, (ElementalNodal -> E ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [collapse_shell_layers](#input_1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [force_averaging](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 4| [abstract_meshed_region](#input_4) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 26| [merge_solid_shell](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [e_shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [collapse_shell_layers](#input_1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [force_averaging](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 4 | [abstract_meshed_region](#input_4) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 26 | [merge_solid_shell](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [e_shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -84,6 +88,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,8 +107,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -111,6 +121,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -125,6 +137,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md index 4fdf11e9ed..207766c1d2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal.md @@ -14,14 +14,18 @@ Transforms an Elemental Nodal field into a Nodal field using an averaging proces ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [should_average](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [extend_to_mid_nodes](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [extend_weights_to_mid_nodes](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [should_average](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [extend_to_mid_nodes](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [extend_weights_to_mid_nodes](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -75,6 +79,10 @@ Extends weights to mid nodes (when available). Default is false. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -98,8 +106,10 @@ Provides the number of times it was found in the elemental nodal field, for each ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -110,6 +120,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -124,6 +136,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md index f8ef7f1f68..94b2cda5a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental.md @@ -14,10 +14,14 @@ Transforms an Elemental Nodal field to Nodal Elemental. The result is computed o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md index f9b625075f..1188047daf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_elemental_fc.md @@ -14,10 +14,14 @@ Transforms Elemental Nodal fields to Nodal Elemental fields. The result is compu ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -39,6 +43,10 @@ Transforms Elemental Nodal fields to Nodal Elemental fields. The result is compu ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,22 +62,24 @@ Transforms Elemental Nodal fields to Nodal Elemental fields. The result is compu ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md index 2485522e85..2683d685f9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_nodal_to_nodal_fc.md @@ -14,16 +14,20 @@ Transforms Elemental Nodal fields into Nodal fields using an averaging process. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 2| [should_average](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 4| [extend_to_mid_nodes](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [extend_weights_to_mid_nodes](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [merge_solid_shell](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 2 | [should_average](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 4 | [extend_to_mid_nodes](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [extend_weights_to_mid_nodes](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [merge_solid_shell](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -116,22 +124,24 @@ Gives for each node, the number of times it was found in the Elemental Nodal fie ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -142,6 +152,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -156,6 +168,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md index 9870151ef9..a8738c842a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal.md @@ -14,11 +14,15 @@ Transforms an Elemental field to an Elemental Nodal field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ average only on these entities ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ average only on these entities ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md index cd0e0ed208..db54633c07 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_elemental_nodal_fc.md @@ -14,11 +14,15 @@ Transforms Elemental field to Elemental Nodal field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3| [mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ Transforms Elemental field to Elemental Nodal field. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Transforms Elemental field to Elemental Nodal field. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal.md index a0302c2fbe..3b6b5b0b69 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal.md @@ -23,12 +23,16 @@ Transforms an Elemental field to a Nodal field. The result is computed on a give ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [force_averaging](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [algorithm](#input_200) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [force_averaging](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [algorithm](#input_200) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -81,15 +89,17 @@ Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal_fc.md index d9e7f457d2..47800f3cd1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/elemental_to_nodal_fc.md @@ -21,13 +21,17 @@ Transforms Elemental Nodal fields to Nodal fields. The result is computed on a g ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 2| [force_averaging](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 200| [algorithm](#input_200) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 2 | [force_averaging](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 200 | [algorithm](#input_200) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -73,6 +77,10 @@ Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -88,22 +96,24 @@ Forces the usage of algorithm 1, 2 or 3 (default is chosen based on the type of ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -114,6 +124,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -128,6 +140,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes.md index 9cd6633506..9b2fe01180 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes.md @@ -14,10 +14,14 @@ Extends an Elemental Nodal or Nodal field defined on corner nodes to a field def ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,15 +62,17 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md index 5678dcc13a..3ea9ff30e5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/extend_to_mid_nodes_fc.md @@ -14,10 +14,14 @@ Extends Elemental Nodal or Nodal fields defined on corner nodes to Elemental Nod ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -39,6 +43,10 @@ The mesh region in this pin is used to perform the averaging. It is used if ther ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,29 +62,31 @@ The mesh region in this pin is used to perform the averaging. It is used if ther ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this configuration is set to true. Only supported for nodal fields in input. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -87,6 +97,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -101,6 +113,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md index 2742a0964d..bbfdfb5640 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation.md @@ -14,16 +14,20 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [nodal_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 2| [elemental_scoping](#input_2) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [force_type](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [spoint](#input_6) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 9| [scoping_filter](#input_9) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [nodal_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 2 | [elemental_scoping](#input_2) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [force_type](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [spoint](#input_6) | |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 9 | [scoping_filter](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -98,6 +102,10 @@ Selected set of nodes. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [force_accumulation](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -153,8 +161,10 @@ Selected set of nodes. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -165,6 +175,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -179,6 +191,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation_psd.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation_psd.md index 98efac25e5..2f11fc21c6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation_psd.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/force_summation_psd.md @@ -14,15 +14,19 @@ Computes the sum of elemental forces contribution on a set of nodes in Global Co ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [nodal_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 2| [elemental_scoping](#input_2) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [spoint](#input_6) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 7| [abs_rel_key](#input_7) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [signif](#input_8) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [nodal_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 2 | [elemental_scoping](#input_2) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [spoint](#input_6) | |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 7 | [abs_rel_key](#input_7) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [signif](#input_8) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -84,6 +88,10 @@ Significance threshold, defaults to 0.0001. Any mode with a significance level a ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [force_accumulation](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -123,8 +131,10 @@ Returns the nodal moments for the 1-sigma displacement solution on the scoped no ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -135,6 +145,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -149,6 +161,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/gauss_to_node_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/gauss_to_node_fc.md index c954363fb4..e557eb6851 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/gauss_to_node_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/gauss_to_node_fc.md @@ -14,11 +14,15 @@ Extrapolates results available at Gauss or quadrature points to nodal points for ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ Extrapolating results on the selected scoping. If it is a scoping container, the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Extrapolating results on the selected scoping. If it is a scoping container, the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference.md index 1554c08dc4..698f57f01a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference.md @@ -14,11 +14,15 @@ Transforms an Elemental Nodal field into a Nodal field. Each nodal value is the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ average only on these entities ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ average only on these entities ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference_fc.md index c01a6bbe4e..4d767fb4a5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_difference_fc.md @@ -14,11 +14,15 @@ Transforms Elemental Nodal fields into Nodal fields. Each nodal value is the max ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -48,6 +52,10 @@ Average only on these nodes. If it is a scoping container, the label must corres ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,22 +71,24 @@ Average only on these nodes. If it is a scoping container, the label must corres ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_fraction_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_fraction_fc.md index 35fd32bb7b..2d744b92ed 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_fraction_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_fraction_fc.md @@ -14,12 +14,16 @@ Transforms Elemental Nodal fields into Nodal fields. Each nodal value is the fra ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 6| [denominator](#input_6) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 6 | [denominator](#input_6) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -57,6 +61,10 @@ If a fields container is set in this pin, it is used as the denominator of the f ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -72,22 +80,24 @@ If a fields container is set in this pin, it is used as the denominator of the f ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -98,6 +108,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -112,6 +124,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental.md index f5781f87b8..3fbf18ecab 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental.md @@ -14,11 +14,15 @@ Transforms a Nodal field to an Elemental field, The result is computed on a give ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 10| [collapse_shell_layers](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 10 | [collapse_shell_layers](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If true, the data across different shell layers is averaged as well (default is ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ If true, the data across different shell layers is averaged as well (default is ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_fc.md index 59497f29a8..624c7e293f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_fc.md @@ -14,14 +14,18 @@ Transforms Nodal fields into Elemental fields using an averaging process. The re ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 3| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 10| [collapse_shell_layers](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [merge_solid_shell](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 3 | [scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 10 | [collapse_shell_layers](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [merge_solid_shell](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -90,22 +98,24 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -116,6 +126,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -130,6 +142,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md index b1fe97ece4..5d56377bd3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal.md @@ -14,12 +14,16 @@ Transforms a Nodal field to an ElementalNodal field, The result is computed on a ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4| [extend_to_mid_nodes](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [collapse_shell_layers](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [extend_to_mid_nodes](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [collapse_shell_layers](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ If true, the data across different shell layers is averaged as well (default is ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ If true, the data across different shell layers is averaged as well (default is ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md index 600aa7ded0..068ab6d273 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/nodal_to_elemental_nodal_fc.md @@ -14,12 +14,16 @@ Transforms Nodal fields_container to Elemental Nodal fields_container. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3| [mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4| [extend_to_mid_nodes](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [extend_to_mid_nodes](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Copy values from midside nodes to ElementalNodal field. Default: false ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -72,8 +80,10 @@ Copy values from midside nodes to ElementalNodal field. Default: false ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_fc.md index 5098df89bb..3640da2d62 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_fc.md @@ -14,15 +14,19 @@ Transforms Input fields into Elemental fields using an averaging process. The re ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3| [mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7| [smoothen_values](#input_7) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [collapse_shell_layers](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [merge_solid_shell](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [smoothen_values](#input_7) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [collapse_shell_layers](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [merge_solid_shell](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -84,6 +88,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_nodal_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_nodal_fc.md index b42cc603c5..5d81ea1467 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_nodal_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_elemental_nodal_fc.md @@ -14,11 +14,15 @@ Transforms fields into Elemental Nodal fields using an averaging process. The re ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Transforms fields into Elemental Nodal fields using an averaging process. The re ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,22 +71,24 @@ Transforms fields into Elemental Nodal fields using an averaging process. The re ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal.md index b741d6d4a0..cecb4c803e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal.md @@ -14,12 +14,16 @@ Transforms a field into a Nodal field using an averaging process. The result is ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 26| [merge_solid_shell](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 26 | [merge_solid_shell](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal_fc.md index 1045354a37..9f23e8beef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/averaging/to_nodal_fc.md @@ -14,13 +14,17 @@ Transforms fields into Nodal fields using an averaging process. The result is co ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3| [mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 26| [merge_solid_shell](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 26 | [merge_solid_shell](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,22 +89,24 @@ For shell/solid mixed fields, group in the same field all solids and shells (fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -107,6 +117,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: averaging **Plugin**: core @@ -121,6 +133,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_svd.md b/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_svd.md index 8a7c5b3886..b2c2823692 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_svd.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_svd.md @@ -14,12 +14,16 @@ Computes the coefficients (=U*Sigma) and VT components from SVD. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_contaner_to_compress](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [scalar_int](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [scalar_double](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [boolean](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_contaner_to_compress](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [scalar_int](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [scalar_double](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [boolean](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Apply SVD on the initial data (Default : false), otherwise use reduced data (squ ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [us_svd](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -88,22 +96,24 @@ The output entity is a field (or a field container if input fc contains several ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -114,6 +124,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: compression **Plugin**: N/A @@ -128,6 +140,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_zfp.md b/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_zfp.md index a68bfa3ee1..00f231f494 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_zfp.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/compression/apply_zfp.md @@ -14,15 +14,19 @@ Compressing input data using one of zfp compression algorithm modes. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [dataIn](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mode](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`char`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [mode_parameter](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [dim](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [order](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [double_absthreshold](#input_5) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [double_relthreshold](#input_6) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [dataIn](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mode](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`char`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mode_parameter](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [dim](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [order](#input_4) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [double_absthreshold](#input_5) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [double_relthreshold](#input_6) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -84,6 +88,10 @@ Double relative threshold. Values smaller than (v1 - v2) < max(small value, v1 * ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [compress_speed](#output_0) |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -115,29 +123,31 @@ the output entity is a 'custom type field container'; each o ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cuda +### [use_cuda](../../core-concepts/operator-configurations.md#use_cuda) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -148,6 +158,8 @@ If this option is set to true, zfp fixed-rate parallel (de)compression will use ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: compression **Plugin**: core @@ -162,6 +174,9 @@ If this option is set to true, zfp fixed-rate parallel (de)compression will use ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/compression/kmeans_clustering.md b/2027R1/dpf-framework-27-r1/operator-specifications/compression/kmeans_clustering.md index 7518e7eea0..b9981ba1d4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/compression/kmeans_clustering.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/compression/kmeans_clustering.md @@ -14,12 +14,16 @@ Apply kMeans clustering to group data depending on the data's non-linearity. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [clusters_number](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [formula](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [component_number](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [clusters_number](#input_0) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [formula](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [fields_container](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [component_number](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ component number as an int (default is 0), ex '0' for X-displacement, '1' for Y- ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping_clusters](#output_0) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -72,8 +80,10 @@ Scopings container with the space scoping (entities' ids) corresponding to each ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: compression **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization.md b/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization.md index 30b0f03fc5..918fb42f19 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization.md @@ -14,10 +14,14 @@ Scales a field to a given precision threshold, then rounds all the values to the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input_field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input_field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | @@ -44,6 +48,10 @@ Case field with the same number of values than the input field : quantization is ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [output_field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -59,8 +67,10 @@ Scaled and rounded field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -71,6 +81,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: compression **Plugin**: N/A @@ -85,6 +97,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization_fc.md index 25260fdbbf..ca01216481 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/compression/quantization_fc.md @@ -14,10 +14,14 @@ Scales all the fields of a fields container to a given precision threshold, then ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input_fc](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input_fc](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -43,6 +47,10 @@ Case fields container : the corresponding threshold field is found by matching l ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [output_fc](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -58,8 +66,10 @@ Quantized fields container. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -70,6 +80,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: compression **Plugin**: N/A @@ -84,6 +96,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/compression/zfp_decompress.md b/2027R1/dpf-framework-27-r1/operator-specifications/compression/zfp_decompress.md index 4fc011d6e7..87e6741e44 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/compression/zfp_decompress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/compression/zfp_decompress.md @@ -14,9 +14,13 @@ zfp decompression using the information about compression written into the prope ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [dataIn](#input_0) |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [dataIn](#input_0) | Required|[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | @@ -30,6 +34,10 @@ custom type field container from zfp_compression operator to decompress ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [dataOut](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -53,8 +61,10 @@ the output entity is a double, containing decompression speed (mb/sec) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -65,6 +75,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: compression **Plugin**: core @@ -79,6 +91,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/abc_weightings.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/abc_weightings.md index 92abbe5271..1a7cad02ab 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/abc_weightings.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/abc_weightings.md @@ -14,11 +14,15 @@ Computes ABC-weightings for the amplitude spectrum in dB units. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [weighting_type](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [shape_by_tf_scoping](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [weighting_type](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [shape_by_tf_scoping](#input_2) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ if this pin is set to true, each field of the input fields container is defined ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [weightings](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -63,15 +71,17 @@ weighted data in dB units. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass.md index eec280a89f..c95f785e08 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass.md @@ -14,11 +14,15 @@ The band pass filter returns all the values above (but not equal to) the minimum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [min_threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [max_threshold](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [min_threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [max_threshold](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass_fc.md index 81f815727b..a642e822f4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_band_pass_fc.md @@ -14,11 +14,15 @@ The band pass filter returns all the values above (but not equal to) the minimum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [min_threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [max_threshold](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [min_threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [max_threshold](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass.md index 8a9b96c7b2..f12a63a862 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above (but not equal to) the thresho ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass_fc.md index caab9ef0a6..ebfb417c6c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_high_pass_fc.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above (but not equal to) the thresho ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass.md index 9eaba0ec30..42ddb605c6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass.md @@ -14,11 +14,15 @@ The low pass filter returns all the values below (but not equal to) the threshol ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass_fc.md index dd9a89bd6b..6e78e43fe7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_low_pass_fc.md @@ -14,11 +14,15 @@ The low pass filter returns all the values below (but not equal to) the threshol ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass.md index 172662bab8..8a116c4a88 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above, or equal, in absolute value t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass_fc.md index 406de48882..f5da4291ca 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/field_signed_high_pass_fc.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above, or equal, in absolute value t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/filtering_max_over_time.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/filtering_max_over_time.md index a527236f6d..bae6a97d4a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/filtering_max_over_time.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/filtering_max_over_time.md @@ -14,12 +14,16 @@ Creates a filtering workflow that will filter results based on a threshold of a ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [invariant_fc_operator](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [output_pin](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [list_of_results](#input_2) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [threshold](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [invariant_fc_operator](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [output_pin](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [list_of_results](#input_2) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [threshold](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Threshold from which the operator will filter. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,8 +80,10 @@ Threshold from which the operator will filter. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_band_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_band_pass.md index 5141c1f490..1555e02371 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_band_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_band_pass.md @@ -14,11 +14,15 @@ The band pass filter returns all the values above (but not equal to) the minimum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [min_threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [max_threshold](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [min_threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [max_threshold](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_high_pass.md index 12f734a0b1..02b516eba9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above (but not equal to) the thresho ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_low_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_low_pass.md index c333e74bba..890633ee51 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_low_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_low_pass.md @@ -14,11 +14,15 @@ The low pass filter returns all the values below (but not equal to) the threshol ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_signed_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_signed_high_pass.md index 72dce83e0d..9468c2d8b9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_signed_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/scoping_signed_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above, or equal, in absolute value t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_band_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_band_pass.md index 8a7f8e4da2..0a6c3369f6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_band_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_band_pass.md @@ -14,11 +14,15 @@ The band pass filter returns all the values above (but not equal to) the minimum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [min_threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [max_threshold](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [min_threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [max_threshold](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [time_freq_support](#output_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -71,8 +79,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_high_pass.md index cda66d4b1f..b0ab16819e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above (but not equal to) the thresho ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [time_freq_support](#output_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -71,8 +79,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_low_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_low_pass.md index f030a44c47..b2439b238a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_low_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_low_pass.md @@ -14,11 +14,15 @@ The low pass filter returns all the values below (but not equal to) the threshol ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [time_freq_support](#output_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -71,8 +79,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_signed_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_signed_high_pass.md index c005ad17d3..5430a29d51 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_signed_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timefreq_signed_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above, or equal, in absolute value t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [time_freq_support](#output_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -71,8 +79,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_band_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_band_pass.md index a51df31676..49e253a77e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_band_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_band_pass.md @@ -14,11 +14,15 @@ The band pass filter returns all the values above (but not equal to) the minimum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [min_threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [max_threshold](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [min_threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [max_threshold](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ A maximum threshold scalar or a field containing one value is expected. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_high_pass.md index 0aa5b2a527..426d61ff42 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above (but not equal to) the thresho ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_low_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_low_pass.md index 13a13b01ed..fc7aeb3332 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_low_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_low_pass.md @@ -14,11 +14,15 @@ The low pass filter returns all the values below (but not equal to) the threshol ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_signed_high_pass.md b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_signed_high_pass.md index 8568ed4c3c..8d69ad6299 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_signed_high_pass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/filter/timescoping_signed_high_pass.md @@ -14,11 +14,15 @@ The high pass filter returns all the values above, or equal, in absolute value t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [both](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [both](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ The default is false. If set to true, the complement of the filtered fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: filter **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical.md index a4740787a4..e520c6aff0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical.md @@ -14,9 +14,13 @@ Converts 3D field from cartesian coordinates to spherical coordinates. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Converts 3D field from cartesian coordinates to spherical coordinates. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,22 +53,24 @@ Converts 3D field from cartesian coordinates to spherical coordinates. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical_fc.md index a05a3b618c..d8948f48e8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/cartesian_to_spherical_fc.md @@ -14,9 +14,13 @@ Converts 3D field from cartesian coordinates to spherical coordinates. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Converts 3D field from cartesian coordinates to spherical coordinates. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,22 +53,24 @@ Converts 3D field from cartesian coordinates to spherical coordinates. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/element_nodal_contribution.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/element_nodal_contribution.md index 7c6cd2e061..b7a7ab8306 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/element_nodal_contribution.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/element_nodal_contribution.md @@ -14,11 +14,15 @@ Compute the fraction of the element measure attributed to each node of each elem ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [volume_fraction](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [volume_fraction](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If true, returns influence volume, area or length. If false, the values are norm ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ If true, returns influence volume, area or length. If false, the values are norm ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md index 20998e9d1f..02d4ea8121 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_facets_surfaces_over_time.md @@ -14,11 +14,15 @@ Calculates for a mesh, the surface of each element's facet over time for each sp ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [displacement](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [displacement](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Mesh must be defined if the displacement field's container does not contain it, ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -71,8 +79,10 @@ Mesh made of surface elements only. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volume.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volume.md index 3ca50a5c9f..fe5a521365 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volume.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volume.md @@ -14,10 +14,14 @@ Compute the measure of the Elements (volume for 3D elements, surface for 2D elem ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [mesh_scoping](#input_1) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -39,6 +43,10 @@ If not provided, the measure of all elements for the mesh is computed. If provid ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,22 +62,24 @@ If not provided, the measure of all elements for the mesh is computed. If provid ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volumes_over_time.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volumes_over_time.md index 2aae1bf5e9..60f3bdbb4c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volumes_over_time.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/elements_volumes_over_time.md @@ -14,11 +14,15 @@ Calculates for a mesh, the volume of each element over time for each specified t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [displacement](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [displacement](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Mesh must be defined if the displacement field's container does not contain it, ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Mesh must be defined if the displacement field's container does not contain it, ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/faces_area.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/faces_area.md index 93bdd8b359..1f597ba1d4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/faces_area.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/faces_area.md @@ -14,10 +14,14 @@ Compute the measure of the Faces (surface for 2D faces of a 3D model or length f ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [mesh_scoping](#input_1) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -39,6 +43,10 @@ If not provided, the measure of all Faces in the mesh is computed. If provided, ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ If not provided, the measure of all Faces in the mesh is computed. If provided, ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/gauss_to_node.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/gauss_to_node.md index c6aa814cd1..e69a5e4c52 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/gauss_to_node.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/gauss_to_node.md @@ -14,11 +14,15 @@ Extrapolating results available at Gauss or quadrature points to nodal points fo ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Mesh to integrate on. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Mesh to integrate on. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/integrate_over_elements.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/integrate_over_elements.md index 1b2ec02f35..00794825a0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/integrate_over_elements.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/integrate_over_elements.md @@ -14,11 +14,15 @@ Integration of an input field over mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Mesh to integrate on. If not provided, the one from input field is employed. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,22 +71,24 @@ Mesh to integrate on. If not provided, the one from input field is employed. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals.md index 21f1d5abfe..07cbd403a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals.md @@ -14,11 +14,15 @@ compute the normals at the given nodes or element scoping based on the given mes ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [field](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [field](#input_3) | |[`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ compute the normals at the given nodes or element scoping based on the given mes ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ compute the normals at the given nodes or element scoping based on the given mes ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals_provider_nl.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals_provider_nl.md index 699e8ae0b8..12c55e9e96 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals_provider_nl.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/normals_provider_nl.md @@ -14,11 +14,15 @@ Computes the normals on nodes/faces/elements based on integration points (more a ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If no scoping, specifies location. If scoping is Elemental or ElementalNodal thi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ If no scoping, specifies location. If scoping is Elemental or ElementalNodal thi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate.md index 234fe4df80..8b9f85d7f1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate.md @@ -14,10 +14,14 @@ Applies a transformation (rotation) matrix on a field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [field_rotation_matrix](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [field_rotation_matrix](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,22 +62,24 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_fc.md index e8d7f28bfd..7ac68deb5f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_fc.md @@ -14,10 +14,14 @@ Apply a transformation (rotation) matrix on all the fields of a fields container ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [coordinate_system](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [coordinate_system](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ Apply a transformation (rotation) matrix on all the fields of a fields container ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,22 +62,24 @@ Apply a transformation (rotation) matrix on all the fields of a fields container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md index 08befd3f79..eab5222768 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs.md @@ -14,11 +14,15 @@ Rotates a field to its corresponding values into the specified cylindrical coord ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [coordinate_system](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [coordinate_system](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Mesh support of the input field. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,22 +71,24 @@ Mesh support of the input field. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md index 2b25e88f22..a65cbc1060 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/rotate_in_cylindrical_cs_fc.md @@ -14,11 +14,15 @@ Rotates all the fields of a fields container (not defined with a cynlindrical co ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [coordinate_system](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [coordinate_system](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Mesh support of the input fields_container, in case it does not have one defined ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,22 +71,24 @@ Mesh support of the input fields_container, in case it does not have one defined ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian.md index 421a82f348..2bb1066d34 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian.md @@ -14,9 +14,13 @@ Converts 3D field from spherical coordinates to cartesian coordinates. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Converts 3D field from spherical coordinates to cartesian coordinates. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,22 +53,24 @@ Converts 3D field from spherical coordinates to cartesian coordinates. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian_fc.md index 6378696946..077264c62d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/spherical_to_cartesian_fc.md @@ -14,9 +14,13 @@ Converts 3D field from spherical coordinates to cartesian coordinates. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Converts 3D field from spherical coordinates to cartesian coordinates. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,22 +53,24 @@ Converts 3D field from spherical coordinates to cartesian coordinates. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/geo/to_polar_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/geo/to_polar_coordinates.md index 486a4fd524..dd869a2d0f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/geo/to_polar_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/geo/to_polar_coordinates.md @@ -14,10 +14,14 @@ Finds r, theta (rad), and z coordinates of a coordinates (nodal) field in a cart ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [coordinate_system](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [coordinate_system](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,22 +62,24 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: geo **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/info/markdown_latex_example.md b/2027R1/dpf-framework-27-r1/operator-specifications/info/markdown_latex_example.md index 6881c24659..a42293674a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/info/markdown_latex_example.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/info/markdown_latex_example.md @@ -98,9 +98,13 @@ $$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}.$$ ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [bogus_input](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [bogus_input](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -198,6 +202,10 @@ An equation on its own using square bracket delimiters: ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [bogus_output](#output_0) | | @@ -297,8 +305,10 @@ An equation on its own using square bracket delimiters: ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -309,6 +319,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: info **Plugin**: documentation @@ -323,6 +335,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md index ce6cd1eb66..306624acb5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_bcs_to_nod.md @@ -14,10 +14,14 @@ Converts a fields container from BCS to NOD ordering. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 2 Required| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 2 | [fields_container](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -39,6 +43,10 @@ Data_sources (must contain the full file). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Data_sources (must contain the full file). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: mapdl @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md index 91d162b5aa..14ad913eec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_nod_to_bcs.md @@ -14,10 +14,14 @@ Converts a fields container from NOD to BCS ordering. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 2 Required| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 2 | [fields_container](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -39,6 +43,10 @@ Data_sources (must contain the full file). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Data_sources (must contain the full file). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: mapdl @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_op.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_op.md index 303864feba..005deb4b68 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_op.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/convertnum_op.md @@ -14,12 +14,16 @@ Converts a fields container from one mapdl ordering to another mapdl ordering. S ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input_ordering](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [output_ordering](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input_ordering](#input_0) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [output_ordering](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [fields_container](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -57,6 +61,10 @@ Data_sources (must contain the full file). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -72,8 +80,10 @@ Data_sources (must contain the full file). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: mapdl @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values.md index 4d54bfb227..6513cffc6f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values.md @@ -14,9 +14,13 @@ Computes the element-wise Eigen values of a tensor field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,22 +53,24 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values_fc.md index 8613ad32f0..4197a5c3c5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_values_fc.md @@ -14,9 +14,13 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,22 +53,24 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors.md index 6f513970d7..060649716f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors.md @@ -14,9 +14,13 @@ Computes the element-wise Eigen vectors for each tensor in the field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: mapdl @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors_fc.md index 19a6c73cce..c8a4b66aee 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/eigen_vectors_fc.md @@ -14,9 +14,13 @@ Computes the element-wise Eigen vectors for each tensor in the fields of the fie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -30,6 +34,10 @@ Computes the element-wise Eigen vectors for each tensor in the fields of the fie ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,22 +53,24 @@ Computes the element-wise Eigen vectors for each tensor in the fields of the fie ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: mapdl @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants.md index d330760b02..942ea65c9a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants.md @@ -14,10 +14,14 @@ Computes the element-wise invariants of a tensor field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1| [generate_principal_stress](#input_-1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [generate_principal_stress](#input_-1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ if true, generate principal stress in output pin 3/4/5 (default is false) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_int](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -94,22 +102,24 @@ third eigen value field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -120,6 +130,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -134,6 +146,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants_fc.md index 0b242abb8e..35c0e0a448 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/invariants_fc.md @@ -14,10 +14,14 @@ Computes the element-wise invariants of all the tensor fields of a fields contai ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1| [generate_principal_stress](#input_-1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [generate_principal_stress](#input_-1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ if true, generate principal stress in output pin 3/4/5 (default is false) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields_int](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -94,22 +102,24 @@ third eigen value field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -120,6 +130,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -134,6 +146,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants.md index 3ec46856c5..3f4ff9ce29 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants.md @@ -14,9 +14,13 @@ Computes the element-wise Eigen values of a tensor field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -30,6 +34,10 @@ Computes the element-wise Eigen values of a tensor field. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_eig_1](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -61,22 +69,24 @@ third eigen value field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -87,6 +97,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -101,6 +113,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants_fc.md index eb9e671900..ac140c1cb0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/principal_invariants_fc.md @@ -14,9 +14,13 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Computes the element-wise Eigen values of all the tensor fields of a fields cont ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields_eig_1](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -61,22 +69,24 @@ third eigen value fields ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -87,6 +97,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -101,6 +113,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv.md index f8c3b18ba3..b1d8f2826d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv.md @@ -14,9 +14,13 @@ Computes the element-wise Segalman Von-Mises criteria on a tensor field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,22 +53,24 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md index a149c9449e..688df1dbc0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/segalman_von_mises_eqv_fc.md @@ -14,9 +14,13 @@ Computes the element-wise Segalman Von-Mises criteria on all the tensor fields o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Computes the element-wise Segalman Von-Mises criteria on all the tensor fields o ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,22 +53,24 @@ Computes the element-wise Segalman Von-Mises criteria on all the tensor fields o ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -71,6 +81,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -85,6 +97,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv.md index c7a029d3bb..dfa5f47af9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv.md @@ -14,10 +14,14 @@ Computes the element-wise Von-Mises criteria on a tensor field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 13 Required| [poisson_ratio](#input_13) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 13 | [poisson_ratio](#input_13) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Poisson ratio to be used in equivalent strain calculation. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,22 +62,24 @@ Poisson ratio to be used in equivalent strain calculation. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv_fc.md index 87003af83f..2a32dd1d12 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/invariant/von_mises_eqv_fc.md @@ -14,10 +14,14 @@ Computes the element-wise Von-Mises criteria on all the tensor fields of a field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 13 Required| [poisson_ratio](#input_13) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 13 | [poisson_ratio](#input_13) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Poisson ratio to be used in equivalent strain calculation. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,22 +62,24 @@ Poisson ratio to be used in equivalent strain calculation. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: invariant **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort.md index 3c33669a55..c8b67de303 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort.md @@ -14,11 +14,15 @@ Sort a field (in 0) in ascending order with an optional component priority table ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [component_priority_table](#input_1) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [sort_by_scoping](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [component_priority_table](#input_1) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [sort_by_scoping](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ if true, uses scoping to sort the field (default is false) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ if true, uses scoping to sort the field (default is false) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort_fc.md index 0b85253368..acfd7cff04 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/ascending_sort_fc.md @@ -14,11 +14,15 @@ Sort a field (in 0) in ascending order with an optional component priority table ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [component_priority_table](#input_1) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [sort_by_scoping](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [component_priority_table](#input_1) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [sort_by_scoping](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ if true, uses scoping to sort the field (default is false) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ if true, uses scoping to sort the field (default is false) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector.md index f78b4a02c4..eaff2b1cc9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector.md @@ -14,11 +14,15 @@ Creates a scalar/vector field based on the selected component. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [component_number](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [component_number](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Set a default value for components that do not exist. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Set a default value for components that do not exist. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector_fc.md index 3e2b808ed0..896502a754 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_selector_fc.md @@ -14,10 +14,14 @@ Creates a scalar fields container based on the selected component for each field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [component_number](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [component_number](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ one or several component index that will be extracted from the initial field. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ one or several component index that will be extracted from the initial field. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer.md index 554d9532ef..5e59839af8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer.md @@ -14,11 +14,15 @@ Takes the input field and creates a field with overriden value on given componen ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [component_number](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [component_number](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Set a default value for components selected. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Set a default value for components selected. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer_fc.md index ee3899aef0..048a6e355e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/component_transformer_fc.md @@ -14,11 +14,15 @@ Takes the input field and creates a field with overriden value on given componen ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [component_number](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [component_number](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Set a default value for components selected. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Set a default value for components selected. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort.md index 5e51f70a08..c686884a8f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort.md @@ -14,11 +14,15 @@ Sort a field (in 0) in descending order, with an optional component priority tab ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [component_priority_table](#input_1) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [sort_by_scoping](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [component_priority_table](#input_1) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [sort_by_scoping](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ if true, uses scoping to sort the field (default is false) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ if true, uses scoping to sort the field (default is false) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort_fc.md index c1360d41ac..381889f4dc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/descending_sort_fc.md @@ -14,11 +14,15 @@ Sort a field (in 0) in descending order, with an optional component priority tab ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [component_priority_table](#input_1) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [sort_by_scoping](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [component_priority_table](#input_1) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [sort_by_scoping](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ if true, uses scoping to sort the field (default is false) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ if true, uses scoping to sort the field (default is false) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector.md index 3919445be6..38078429f7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector.md @@ -14,12 +14,16 @@ Creates a scalar/vector field based on the selected elementary data. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [elementary_data_index](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [elementary_data_index_2](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [elementary_data_index](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [elementary_data_index_2](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ For field with nature matrix, this is the column indices to extract. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ For field with nature matrix, this is the column indices to extract. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector_fc.md index 98b00d2d6c..bfaa5946a9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/elementary_data_selector_fc.md @@ -14,11 +14,15 @@ Creates a scalar fields container based on the selected elementary data for each ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [elementary_data_index](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [elementary_data_index_2](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [elementary_data_index](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [elementary_data_index_2](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ For a field with nature matrix, this extracts the column indices. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ For a field with nature matrix, this extracts the column indices. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/enrich_materials.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/enrich_materials.md index 607a37294e..0114d65b16 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/enrich_materials.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/enrich_materials.md @@ -14,11 +14,15 @@ Takes a MaterialContainer and a stream and enriches the MaterialContainer using ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [MaterialContainer](#input_0) | | -| 1 Required| [streams](#input_1) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [streams_mapping](#input_2) |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [MaterialContainer](#input_0) | Required| | +| 1 | [streams](#input_1) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [streams_mapping](#input_2) | Required|[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | @@ -48,6 +52,10 @@ Takes a MaterialContainer and a stream and enriches the MaterialContainer using ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [MaterialContainer](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -63,8 +71,10 @@ Takes a MaterialContainer and a stream and enriches the MaterialContainer using ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_anys.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_anys.md index bbc123dd38..6595c03d9e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_anys.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_anys.md @@ -14,13 +14,17 @@ Takes two Any objects and compares them.Supported types: Field, FieldsContainer, ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [anyA](#input_0) |[`any`](../../core-concepts/dpf-types.md#any) | -| 1 Required| [anyB](#input_1) |[`any`](../../core-concepts/dpf-types.md#any) | -| 2 Required| [double_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [double_tolerance](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [compare_auxiliary](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [anyA](#input_0) | Required|[`any`](../../core-concepts/dpf-types.md#any) | +| 1 | [anyB](#input_1) | Required|[`any`](../../core-concepts/dpf-types.md#any) | +| 2 | [double_value](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [double_tolerance](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compare_auxiliary](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ For meshes and meshescontainer: compare auxiliary data (i.e property fields, sco ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [included](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -89,8 +97,10 @@ bool (true if belongs...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fc.md index bddad0b707..c799371395 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fc.md @@ -14,12 +14,16 @@ Checks if two fields_container are identical. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2| [small_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [tolerance](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [small_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [tolerance](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Double relative tolerance. Maximum tolerance gap between two compared values. Va ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [boolean](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -80,8 +88,10 @@ bool (true if identical...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -92,6 +102,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -106,6 +118,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fields.md index e7d1fef877..b1a57a56cf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_fields.md @@ -21,12 +21,16 @@ Check if two fields are identical according to the following behavior: ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [double_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [double_tolerance](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [double_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [double_tolerance](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -64,6 +68,10 @@ Double relative tolerance. Maximum tolerance gap between two compared values. Va ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [boolean](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -87,8 +95,10 @@ bool (true if identical...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -99,6 +109,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -113,6 +125,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_generic_data_containers.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_generic_data_containers.md index 03f89f9bb0..e833d03409 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_generic_data_containers.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_generic_data_containers.md @@ -14,13 +14,17 @@ Takes two generic data containers and compares them. Supported types: Field, Fie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [generic_data_containerA](#input_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | -| 1 Required| [generic_data_containerB](#input_1) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | -| 2 Required| [double_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [double_tolerance](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [compare_auxiliary](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [generic_data_containerA](#input_0) | Required|[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +| 1 | [generic_data_containerB](#input_1) | Required|[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +| 2 | [double_value](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [double_tolerance](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compare_auxiliary](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ For meshes and meshescontainer: compare auxiliary data (i.e property fields, sco ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [included](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -89,8 +97,10 @@ bool (true if belongs...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_mc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_mc.md index df05cb5876..332dad2212 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_mc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_mc.md @@ -14,13 +14,17 @@ Checks if two meshes_container are identical. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [meshes_containerA](#input_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 1 Required| [meshes_containerB](#input_1) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 2| [small_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [tolerance](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [compare_auxiliary](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [meshes_containerA](#input_0) | Required|[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 1 | [meshes_containerB](#input_1) | Required|[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 2 | [small_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [tolerance](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compare_auxiliary](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ compare auxiliary data (i.e property fields, scopings...). Default value is 'fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [boolean](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -89,8 +97,10 @@ bool (true if identical...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_meshes.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_meshes.md index 4366adea93..e7e7c1629a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_meshes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_meshes.md @@ -14,13 +14,17 @@ Takes two meshes and compares them. Note: When comparing mesh properties, the cu ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [meshA](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [meshB](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2| [small_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [tolerance](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [compare_auxiliary](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [meshA](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [meshB](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [small_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [tolerance](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compare_auxiliary](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ compare auxiliary data (i.e property fields, scopings...). Default value is 'fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [are_identical](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -81,8 +89,10 @@ compare auxiliary data (i.e property fields, scopings...). Default value is 'fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_pfc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_pfc.md index ca6296a5eb..e79fe877cd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_pfc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_pfc.md @@ -14,10 +14,14 @@ Checks if two property_fields_container are identical. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [property_fields_containerA](#input_0) |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | -| 1 Required| [property_fields_containerB](#input_1) |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [property_fields_containerA](#input_0) | Required|[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | +| 1 | [property_fields_containerB](#input_1) | Required|[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | @@ -39,6 +43,10 @@ Checks if two property_fields_container are identical. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [boolean](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ bool (true if identical...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_property_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_property_fields.md index 4555aef8e2..4dab8dd147 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_property_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_property_fields.md @@ -14,10 +14,14 @@ Takes two property fields and compares them. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [property_fieldA](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [property_fieldB](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [property_fieldA](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [property_fieldB](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -39,6 +43,10 @@ Takes two property fields and compares them. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [are_identical](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ Takes two property fields and compares them. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_sc.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_sc.md index 0b1fb2b7ca..ae57474a8d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_sc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_sc.md @@ -14,10 +14,14 @@ Checks if two scopings_container are identical. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [scopings_containerA](#input_0) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 1 Required| [scopings_containerB](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [scopings_containerA](#input_0) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 1 | [scopings_containerB](#input_1) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -39,6 +43,10 @@ Checks if two scopings_container are identical. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [boolean](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ bool (true if identical...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_scopings.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_scopings.md index 40fab8ab7d..13410fe638 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_scopings.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_scopings.md @@ -14,10 +14,14 @@ Check if two scopings are identical. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [scopingA](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1 Required| [scopingB](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [scopingA](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [scopingB](#input_1) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -39,6 +43,10 @@ Check if two scopings are identical. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [boolean](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ bool (true if identical...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_string_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_string_fields.md index 4101fbb3ec..393dce0823 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_string_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/identical_string_fields.md @@ -14,10 +14,14 @@ Takes two string fields and compares them. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [string_fieldA](#input_0) |[`string_field`](../../core-concepts/dpf-types.md#string-field) | -| 1 Required| [string_fieldB](#input_1) |[`string_field`](../../core-concepts/dpf-types.md#string-field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [string_fieldA](#input_0) | Required|[`string_field`](../../core-concepts/dpf-types.md#string-field) | +| 1 | [string_fieldB](#input_1) | Required|[`string_field`](../../core-concepts/dpf-types.md#string-field) | @@ -39,6 +43,10 @@ Takes two string fields and compares them. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [are_identical](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ Takes two string fields and compares them. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/included_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/included_fields.md index 52fdc8c3f8..56247e5a87 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/included_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/included_fields.md @@ -14,12 +14,16 @@ Checks if one field belongs to another. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [double_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [double_tolerance](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [double_value](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [double_tolerance](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Double relative tolerance. Maximum tolerance gap between two compared values. Va ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [included](#output_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -80,8 +88,10 @@ bool (true if belongs...) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -92,6 +102,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -106,6 +118,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/solid_shell_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/solid_shell_fields.md index 2708766d1c..999d8cf79c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/solid_shell_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/solid_shell_fields.md @@ -14,9 +14,13 @@ Merges shell and solid fields for each time step/frequency in the fields contain ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Merges shell and solid fields for each time step/frequency in the fields contain ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Merges shell and solid fields for each time step/frequency in the fields contain ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_data_sources.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_data_sources.md index 80df390e4b..500b60c3a1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_data_sources.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_data_sources.md @@ -14,10 +14,14 @@ Splits a Data Sources into multiple coherent data sources, actual number of outp ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [data_sources](#input_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 1 Required| [output_count](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [data_sources](#input_0) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 1 | [output_count](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Number of desired outputs. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **-1**| [output_count](#output_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ Data sources outputs. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_streams.md b/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_streams.md index 49c371c31c..ca8cfecb9a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_streams.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/logic/split_streams.md @@ -14,10 +14,14 @@ Splits a Streams into multiple coherent streams, actual number of outputs is alw ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [streams](#input_0) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 1 Required| [output_count](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [streams](#input_0) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 1 | [output_count](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Number of desired outputs. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **-1**| [output_count](#output_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ Streams outputs. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: logic **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/apply_mechanical_native_mapping.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/apply_mechanical_native_mapping.md index f47c504c31..b710dfbca8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/apply_mechanical_native_mapping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/apply_mechanical_native_mapping.md @@ -14,16 +14,20 @@ Maps source data from source mesh to target mesh (computes interpolation).This o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [source_mesh_id](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [target_mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3 Required| [target_mesh_id](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [mapping_manager_data](#input_4) | | -| 5 Required| [source_data](#input_5) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 9| [threads_user_requested](#input_9) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [source_mesh_id](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [target_mesh](#input_2) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [target_mesh_id](#input_3) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [mapping_manager_data](#input_4) | Required| | +| 5 | [source_data](#input_5) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 9 | [threads_user_requested](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ Number of threads to be used to parallelize apply operations. Default: 1 (run in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapped_data](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -116,8 +124,10 @@ A Map containing the outputs of the interpolation as a key value pair ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -128,6 +138,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -142,6 +154,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_kriging_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_kriging_workflow.md index 05667b93a3..c5db96b2a0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_kriging_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_kriging_workflow.md @@ -14,12 +14,16 @@ Prepares a workflow able to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 10| [options_data_tree](#input_10) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 10 | [options_data_tree](#input_10) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -57,6 +61,10 @@ DataTree that contains a 'mapping_options' subtree with the mapping options, and ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,8 +80,10 @@ Workflow with input pin 'source_data'; optionally 'source_mesh', 'target_mesh', ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_point_cloud_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_point_cloud_workflow.md index 20faedab62..7239b8e485 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_point_cloud_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_point_cloud_workflow.md @@ -14,12 +14,16 @@ Prepares a workflow able to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 1| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 10| [options_data_tree](#input_10) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [target_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 10 | [options_data_tree](#input_10) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -57,6 +61,10 @@ DataTree that contains a 'mapping_options' subtree with the mapping options, and ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,8 +80,10 @@ Workflow with input pin 'source_data'; optionally 'source_mesh', 'target_mesh', ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_surf_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_surf_workflow.md index 970fff0cce..4a3a59873a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_surf_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_surf_workflow.md @@ -14,12 +14,16 @@ Prepares a workflow able to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 10| [options_data_tree](#input_10) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 10 | [options_data_tree](#input_10) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -57,6 +61,10 @@ DataTree that contains a 'mapping_options' subtree with the mapping options, and ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,8 +80,10 @@ Workflow with input pin 'source_data'; optionally 'source_mesh', 'target_mesh', ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_vol_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_vol_workflow.md index 2753c08728..de206b55d2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_vol_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_mech_shape_func_vol_workflow.md @@ -14,12 +14,16 @@ Prepares a workflow able to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 10| [options_data_tree](#input_10) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 10 | [options_data_tree](#input_10) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -57,6 +61,10 @@ DataTree that contains a 'mapping_options' subtree with the mapping options, and ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,8 +80,10 @@ Workflow with input pin 'source_data'; optionally 'source_mesh', 'target_mesh', ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_sc_mapping_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_sc_mapping_workflow.md index 078365b1da..3d67fe7e62 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_sc_mapping_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/create_sc_mapping_workflow.md @@ -14,15 +14,19 @@ Prepares a workflow able to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2| [is_conservative](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [location](#input_3) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [dimensionality](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [is_pointcloud](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [target_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [is_conservative](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [location](#input_3) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [dimensionality](#input_4) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [is_pointcloud](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -84,6 +88,10 @@ Scoping that restricts the interpolation to a given set of nodes/elements in the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -99,15 +107,17 @@ Workflow with input pin "source_data"; optionally "source_mesh/source_coords", " ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -118,6 +128,8 @@ If permissive is set to false, the validity of the source and target meshes is c ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -132,6 +144,9 @@ If permissive is set to false, the validity of the source and target meshes is c ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/fft.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/fft.md index f7f85e65d9..c76b892688 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/fft.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/fft.md @@ -14,14 +14,18 @@ Computes the Fast Fourier Transform on each component of input Field or each fie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [scale_forward_transform](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [inplace](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [force_fft_points](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [cutoff_frequency](#input_6) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [scale_right_amplitude](#input_7) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [scale_forward_transform](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [inplace](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [force_fft_points](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [cutoff_frequency](#input_6) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [scale_right_amplitude](#input_7) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ If set to true (default is false), 2/field_num_entities scaling will be applied, ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -90,8 +98,10 @@ Output Complex Fields Container with labels matching input Fields Container. No ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/find_reduced_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/find_reduced_coordinates.md index ba1ac8dbb1..2a59c7cbfb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/find_reduced_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/find_reduced_coordinates.md @@ -14,11 +14,15 @@ Finds the elements corresponding to the given coordinates in input and computes ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1 Required| [coordinates](#input_1) |[`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) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 200| [use_quadratic_elements](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [coordinates](#input_1) | Required|[`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) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 200 | [use_quadratic_elements](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If this pin is set to true, reduced coordinates are computed on the quadratic el ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [reduced_coordinates](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -71,8 +79,10 @@ Ids of the elements where each set of reduced coordinates is found ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_coordinates.md index 44e2d2169c..d419b0e152 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_coordinates.md @@ -14,15 +14,19 @@ Evaluates a result on specified coordinates (interpolates results inside element ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [coordinates](#input_1) |[`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) | -| 2| [create_support](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [mapping_on_scoping](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [tolerance](#input_5) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 200| [use_quadratic_elements](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [coordinates](#input_1) | Required|[`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) | +| 2 | [create_support](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [mapping_on_scoping](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [tolerance](#input_5) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 200 | [use_quadratic_elements](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -84,6 +88,10 @@ If this pin is set to true, the element search for each coordinate is computed o ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,8 +107,10 @@ If this pin is set to true, the element search for each coordinate is computed o ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -111,6 +121,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -125,6 +137,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_reduced_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_reduced_coordinates.md index 6d2b2fda5d..0097bbdb51 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_reduced_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/on_reduced_coordinates.md @@ -14,13 +14,17 @@ Evaluates a result on specified reduced coordinates of given elements (interpola ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [reduced_coordinates](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [element_ids](#input_2) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 200| [use_quadratic_elements](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [reduced_coordinates](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [element_ids](#input_2) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 200 | [use_quadratic_elements](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ If this pin is set to true, the interpolation is computed on the quadratic eleme ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,8 +89,10 @@ If this pin is set to true, the interpolation is computed on the quadratic eleme ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prep_sampling_fft.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prep_sampling_fft.md index cbf7edaf85..837b17dcb1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prep_sampling_fft.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prep_sampling_fft.md @@ -14,11 +14,15 @@ Prepare time sampling optimum for FFT computation and expected frequencies in ou ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1| [cutoff_frequency](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [number_sampling_point](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [cutoff_frequency](#input_1) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [number_sampling_point](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ For number of sampling point (calculation with cutoff_frequency is ignored). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [time_tfs_sampled](#output_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -71,8 +79,10 @@ Frequency domain TimeFreqSupport expected in output of FFT. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mapping_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mapping_workflow.md index 574b75cb95..58ba30bcb3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mapping_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mapping_workflow.md @@ -14,12 +14,16 @@ Generates a workflow that can map results from a support to another one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input_support](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [output_support](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2 Required| [filter_radius](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [influence_box](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input_support](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [output_support](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [filter_radius](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [influence_box](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Radius size for the RBF filter ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,8 +80,10 @@ Radius size for the RBF filter ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping.md index 48f14de963..5be43ef16f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping.md @@ -14,23 +14,27 @@ Prepare mapping of source data from source mesh to target mesh by operating the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 3| [target_mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 8| [html_report_path](#input_8) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 9| [threads_user_requested](#input_9) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 30| [shape_function_volumes_mapping](#input_30) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 31| [shape_function_surfaces_mapping](#input_31) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 32| [point_cloud_mapping](#input_32) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 33| [kriging_mapping](#input_33) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 100| [is_element_centroidal_data_mapping](#input_100) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 101| [projection_options](#input_101) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 102| [dynamic_coordinate_system](#input_102) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 103| [source_dimension](#input_103) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 104| [wb_external_data_info](#input_104) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 105| [target_dimension](#input_105) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [target_mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 8 | [html_report_path](#input_8) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [threads_user_requested](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 30 | [shape_function_volumes_mapping](#input_30) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 31 | [shape_function_surfaces_mapping](#input_31) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 32 | [point_cloud_mapping](#input_32) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 33 | [kriging_mapping](#input_33) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 100 | [is_element_centroidal_data_mapping](#input_100) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 101 | [projection_options](#input_101) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 102 | [dynamic_coordinate_system](#input_102) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 103 | [source_dimension](#input_103) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 104 | [wb_external_data_info](#input_104) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 105 | [target_dimension](#input_105) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -156,6 +160,10 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [source_mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -219,8 +227,10 @@ A Map containing the outputs of the mapping as a key value pair ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -231,6 +241,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -245,6 +257,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_kriging.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_kriging.md index cd91981ad5..96394b66b6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_kriging.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_kriging.md @@ -14,30 +14,34 @@ Prepare mapping of source data from source mesh to target mesh by operating the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 3| [target_mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4| [unit](#input_4) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [location](#input_5) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [dimensionality](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [e_shell_layers](#input_7) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [html_report_path](#input_8) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 9| [threads_user_requested](#input_9) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [samples_limit](#input_10) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 11| [correlation_function_type](#input_11) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 12| [polynomial_type](#input_12) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 13| [outside_distance_checking](#input_13) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [bounding_box_tolerance](#input_14) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [adaptive_tolerance_percent](#input_15) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 16| [geometry_type](#input_16) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 100| [is_element_centroidal_data_mapping](#input_100) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 101| [projection_options](#input_101) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 102| [dynamic_coordinate_system](#input_102) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 103| [source_dimension](#input_103) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 104| [wb_external_data_info](#input_104) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 105| [target_dimension](#input_105) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [target_mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [unit](#input_4) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [location](#input_5) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [dimensionality](#input_6) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [e_shell_layers](#input_7) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [html_report_path](#input_8) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [threads_user_requested](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [samples_limit](#input_10) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 11 | [correlation_function_type](#input_11) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [polynomial_type](#input_12) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [outside_distance_checking](#input_13) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [bounding_box_tolerance](#input_14) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [adaptive_tolerance_percent](#input_15) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [geometry_type](#input_16) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 100 | [is_element_centroidal_data_mapping](#input_100) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 101 | [projection_options](#input_101) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 102 | [dynamic_coordinate_system](#input_102) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 103 | [source_dimension](#input_103) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 104 | [wb_external_data_info](#input_104) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 105 | [target_dimension](#input_105) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -219,6 +223,10 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [source_mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -282,8 +290,10 @@ A Map containing the outputs of the mapping as a key value pair ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -294,6 +304,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -308,6 +320,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_point_cloud.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_point_cloud.md index 4637687fad..4ed7c722a0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_point_cloud.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_point_cloud.md @@ -14,31 +14,35 @@ Prepare mapping of source data from source mesh to target mesh by operating the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 3| [target_mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4| [unit](#input_4) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [location](#input_5) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [dimensionality](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [e_shell_layers](#input_7) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [html_report_path](#input_8) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 9| [threads_user_requested](#input_9) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [weighting_type](#input_10) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 11| [outside_option](#input_11) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 12| [num_outside_points](#input_12) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 13| [max_outside_distance](#input_13) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [search_limit](#input_14) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [bounding_box_sizing](#input_15) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 16| [geometry_type](#input_16) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 17| [shell_thickness_factor](#input_17) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 100| [is_element_centroidal_data_mapping](#input_100) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 101| [projection_options](#input_101) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 102| [dynamic_coordinate_system](#input_102) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 103| [source_dimension](#input_103) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 104| [wb_external_data_info](#input_104) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 105| [target_dimension](#input_105) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [target_mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [target_mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [unit](#input_4) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [location](#input_5) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [dimensionality](#input_6) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [e_shell_layers](#input_7) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [html_report_path](#input_8) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [threads_user_requested](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [weighting_type](#input_10) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 11 | [outside_option](#input_11) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [num_outside_points](#input_12) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [max_outside_distance](#input_13) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [search_limit](#input_14) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [bounding_box_sizing](#input_15) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [geometry_type](#input_16) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 17 | [shell_thickness_factor](#input_17) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 100 | [is_element_centroidal_data_mapping](#input_100) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 101 | [projection_options](#input_101) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 102 | [dynamic_coordinate_system](#input_102) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 103 | [source_dimension](#input_103) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 104 | [wb_external_data_info](#input_104) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 105 | [target_dimension](#input_105) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -228,6 +232,10 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [source_mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -291,8 +299,10 @@ A Map containing the outputs of the mapping as a key value pair ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -303,6 +313,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -317,6 +329,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md index 7e76aad583..ab4ef6cee0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_surfaces.md @@ -14,34 +14,38 @@ Prepare mapping of source data from source mesh to target mesh by operating the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 3| [target_mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4| [unit](#input_4) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [location](#input_5) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [dimensionality](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [e_shell_layers](#input_7) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [html_report_path](#input_8) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 9| [threads_user_requested](#input_9) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [scale](#input_10) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 11| [edge_tolerance](#input_11) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 12| [conservative](#input_12) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 13| [ignore_outside_nodes](#input_13) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [key](#input_14) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [normal_distance_check](#input_15) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 16| [normal_tolerance](#input_16) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 17| [pinball_control](#input_17) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 18| [pinball_key](#input_18) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 19| [exclude_elements_outside_pinball](#input_19) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 20| [pinball_value](#input_20) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 100| [is_element_centroidal_data_mapping](#input_100) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 101| [projection_options](#input_101) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 102| [dynamic_coordinate_system](#input_102) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 103| [source_dimension](#input_103) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 104| [wb_external_data_info](#input_104) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 105| [target_dimension](#input_105) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [target_mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [unit](#input_4) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [location](#input_5) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [dimensionality](#input_6) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [e_shell_layers](#input_7) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [html_report_path](#input_8) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [threads_user_requested](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [scale](#input_10) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 11 | [edge_tolerance](#input_11) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [conservative](#input_12) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [ignore_outside_nodes](#input_13) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [key](#input_14) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [normal_distance_check](#input_15) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [normal_tolerance](#input_16) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 17 | [pinball_control](#input_17) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 18 | [pinball_key](#input_18) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 19 | [exclude_elements_outside_pinball](#input_19) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 20 | [pinball_value](#input_20) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 100 | [is_element_centroidal_data_mapping](#input_100) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 101 | [projection_options](#input_101) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 102 | [dynamic_coordinate_system](#input_102) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 103 | [source_dimension](#input_103) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 104 | [wb_external_data_info](#input_104) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 105 | [target_dimension](#input_105) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -255,6 +259,10 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [source_mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -318,8 +326,10 @@ A Map containing the outputs of the mapping as a key value pair ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -330,6 +340,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -344,6 +356,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md index 01ad8cfad6..38738c3206 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/prepare_mechanical_native_mapping_shape_functions_for_volume.md @@ -14,27 +14,31 @@ Prepare mapping of source data from source mesh to target mesh by operating the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 3| [target_mesh_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4| [unit](#input_4) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [location](#input_5) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [dimensionality](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [e_shell_layers](#input_7) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [html_report_path](#input_8) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 9| [threads_user_requested](#input_9) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [scale](#input_10) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 11| [edge_tolerance](#input_11) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 12| [conservative](#input_12) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 13| [ignore_outside_nodes](#input_13) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 100| [is_element_centroidal_data_mapping](#input_100) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 101| [projection_options](#input_101) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 102| [dynamic_coordinate_system](#input_102) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 103| [source_dimension](#input_103) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 104| [wb_external_data_info](#input_104) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 105| [target_dimension](#input_105) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [target_mesh_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [unit](#input_4) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [location](#input_5) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [dimensionality](#input_6) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [e_shell_layers](#input_7) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [html_report_path](#input_8) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [threads_user_requested](#input_9) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [scale](#input_10) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 11 | [edge_tolerance](#input_11) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [conservative](#input_12) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [ignore_outside_nodes](#input_13) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 100 | [is_element_centroidal_data_mapping](#input_100) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 101 | [projection_options](#input_101) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 102 | [dynamic_coordinate_system](#input_102) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 103 | [source_dimension](#input_103) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 104 | [wb_external_data_info](#input_104) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 105 | [target_dimension](#input_105) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -192,6 +196,10 @@ Default is empty string. The string contains either "2D" or "3D" which specifies ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [source_mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -255,8 +263,10 @@ A Map containing the outputs of the mapping as a key value pair ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -267,6 +277,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -281,6 +293,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sc_mapping.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sc_mapping.md index a50ebd8d4a..ef7c8effec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sc_mapping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sc_mapping.md @@ -14,15 +14,19 @@ Apply System Coupling to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2 Required| [is_conservative](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [location](#input_3) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [dimensionality](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [target_scoping](#input_5) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 6 Required| [source_data](#input_6) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [target_mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [is_conservative](#input_2) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [location](#input_3) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [dimensionality](#input_4) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [target_scoping](#input_5) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 6 | [source_data](#input_6) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -84,6 +88,10 @@ data to be mapped. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [target_data](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -99,15 +107,17 @@ data mapped on the target mesh ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -118,6 +128,8 @@ If permissive is set to false, the validity of the source and target meshes is c ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -132,6 +144,9 @@ If permissive is set to false, the validity of the source and target meshes is c ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/scoping_on_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/scoping_on_coordinates.md index 2f2b1a1cf1..65a206777c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/scoping_on_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/scoping_on_coordinates.md @@ -14,10 +14,14 @@ Finds the Elemental scoping of a set of coordinates. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [coordinates](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [coordinates](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -39,6 +43,10 @@ Finds the Elemental scoping of a set of coordinates. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -54,8 +62,10 @@ Finds the Elemental scoping of a set of coordinates. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin.md index 20e357bd3e..6e469c7a41 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin.md @@ -14,11 +14,15 @@ Maps a field defined on solid elements to a field defined on skin elements. Thre ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2| [solid_mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [solid_mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Solid mesh support (optional). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,22 +71,24 @@ Solid mesh support (optional). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin_fc.md index 71640fbc9f..43afeceb29 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/solid_to_skin_fc.md @@ -14,11 +14,15 @@ Maps a fields container defined on solid elements to a fields container defined ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2| [solid_mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [solid_mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Solid mesh support (optional). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,22 +71,24 @@ Solid mesh support (optional). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_point_cloud_wf.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_point_cloud_wf.md index a443246789..d5aab9cdbc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_point_cloud_wf.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_point_cloud_wf.md @@ -14,12 +14,16 @@ Prepares a workflow able to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 10| [options_data_tree](#input_10) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [target_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 10 | [options_data_tree](#input_10) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -57,6 +61,10 @@ DataTree that contains an optional 'mapping_options' subtree with 'conservative' ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,8 +80,10 @@ Workflow with input pin 'source_data'; optionally 'source_mesh', 'target_mesh', ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_shape_function_wf.md b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_shape_function_wf.md index ff604c30c1..0c8afd1ed1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_shape_function_wf.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mapping/sysc_shape_function_wf.md @@ -14,12 +14,16 @@ Prepares a workflow able to map data from an input mesh to a target mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [source_mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 1| [target_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 6| [target_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 10| [options_data_tree](#input_10) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [source_mesh](#input_0) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 1 | [target_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 6 | [target_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 10 | [options_data_tree](#input_10) | |[`data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -57,6 +61,10 @@ DataTree that contains an optional 'mapping_options' subtree with 'conservative' ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mapping_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -72,15 +80,17 @@ Workflow with input pin 'source_data'; optionally 'source_mesh', 'target_mesh', ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -91,6 +101,8 @@ If permissive is set to false, the validity of the source and target meshes is c ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mapping **Plugin**: N/A @@ -105,6 +117,9 @@ If permissive is set to false, the validity of the source and target meshes is c ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 07c97de24e..11455d6cf4 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 @@ -14,9 +14,13 @@ Computes the absolute value of each data value in the input field component-wise ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#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) | @@ -30,6 +34,10 @@ Field, fields container, or numeric data for which to compute absolute values ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with absolute values applied to each component ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 7ee7b23365..92d0e138eb 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 @@ -14,9 +14,13 @@ Computes the absolute value of each data value in the input field component-wise ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field, fields container, or numeric data for which to compute absolute values ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with absolute values applied to each component ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 4809d4af86..ee31ee5ad3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate.md @@ -14,11 +14,15 @@ Sums all the elementary data of a field to produce one elementary data point. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [weights](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [time_scoping](#input_2) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [weights](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [time_scoping](#input_2) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ time_scoping ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Field containing the (weighted) sum for each component in an elementary data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 c30dab0738..730e6a39f9 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 @@ -14,11 +14,15 @@ Sums all the elementary data of a field to produce one elementary data point. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [weights](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [time_scoping](#input_2) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [weights](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [time_scoping](#input_2) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ time_scoping ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Field containing the (weighted) sum for each component in an elementary data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_level_over_label_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_level_over_label_fc.md index ea16c455f3..f16c0174c9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_level_over_label_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_level_over_label_fc.md @@ -14,10 +14,14 @@ Compute the component-wise sum over all the fields that have the same ID as the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Label of the fields container where it should operate. If not defined and the in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,15 +62,17 @@ Label of the fields container where it should operate. If not defined and the in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_min_over_label_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_min_over_label_fc.md index d32a7d0cb9..8059c9f320 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_min_over_label_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_min_over_label_fc.md @@ -14,10 +14,14 @@ Compute the component-wise sum over all the fields that have the same ID as the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Label of the fields container where it should operate. If not defined and the in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,15 +62,17 @@ Label of the fields container where it should operate. If not defined and the in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_over_label_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_over_label_fc.md index baff0cca5e..fd9e42fb85 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_over_label_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulate_over_label_fc.md @@ -14,10 +14,14 @@ Compute the component-wise sum over all the fields that have the same ID as the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Label of the fields container where it should operate. If not defined and the in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,15 +62,17 @@ Label of the fields container where it should operate. If not defined and the in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulation_per_scoping.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulation_per_scoping.md index bca74f37da..1bbfc0c5c0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulation_per_scoping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/accumulation_per_scoping.md @@ -14,13 +14,17 @@ This operator calculates the sum and the percentage of total sum of the input fi ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3 Required| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5 Required| [scopings_container](#input_5) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [scopings_container](#input_5) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -66,6 +70,10 @@ The intersection between the of the first will be used. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [accumulation_per_scoping](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -89,8 +97,10 @@ The intersection between the of the first will be used. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 1e59721677..aefc9d9f4d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/add.md @@ -14,10 +14,14 @@ Computes the sum of two fields. If one field's scoping has 'overall' location, t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`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 Required| [fieldB](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,57 +62,59 @@ Field containing the element-wise sum of the two input fields ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -115,6 +125,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -129,6 +141,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant.md index eb7bf6ff06..72d995ccf0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant.md @@ -14,10 +14,14 @@ Computes the sum of a field (in 0) and a scalar (in 1). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [weights](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [weights](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ double or vector of double ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ double or vector of double ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant_fc.md index da04184aaf..846bc4f3bc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/add_constant_fc.md @@ -14,10 +14,14 @@ Computes the sum of a field (in 0) and a scalar (in 1). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [weights](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [weights](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ double or vector of double ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ double or vector of double ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 358abcfa6e..df7d045fd5 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 @@ -14,9 +14,13 @@ Selects all fields with the same label space in the input fields container and a ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -30,6 +34,10 @@ Selects all fields with the same label space in the input fields container and a ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,50 +53,52 @@ FieldsContainer with summed fields by label space ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -99,6 +109,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -113,6 +125,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 ad79f75f96..77e0d7cc40 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/amplitude.md @@ -14,10 +14,14 @@ Computes amplitude of a real and an imaginary field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 b6e3388111..14b6f37005 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 @@ -14,9 +14,13 @@ Computes the amplitude of a real and an imaginary field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Computes the amplitude of a real and an imaginary field. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Computes the amplitude of a real and an imaginary field. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/average_over_label_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/average_over_label_fc.md index d80797b835..2889558712 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/average_over_label_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/average_over_label_fc.md @@ -14,10 +14,14 @@ Compute the component-wise average over all the fields that have the same ID as ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Label of the fields container where it should operate. If not defined and the in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,15 +62,17 @@ Label of the fields container where it should operate. If not defined and the in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 d599ca3bed..92e99b9c1f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/centroid.md @@ -14,11 +14,15 @@ Computes centroid of field1 and field2, using fieldOut = field1*(1.-fact)+field2 ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [factor](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [factor](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Scalar ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,29 +71,31 @@ Field with centroid calculation: fieldA*(1-factor) + fieldB*factor ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -96,6 +106,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -110,6 +122,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 c7bb99edae..fb36065f72 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 @@ -14,12 +14,16 @@ Computes the centroid of all the matching fields of a fields container at a give ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [time_freq](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [step](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [time_freq_support](#input_8) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [time_freq](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [step](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [time_freq_support](#input_8) | |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -57,6 +61,10 @@ Optional TimeFreqSupport for field resolution ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -72,15 +80,17 @@ FieldsContainer with centroid calculation results at specified time/frequency ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 bdb92c1225..c4cf03f25a 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 @@ -14,10 +14,14 @@ Computes component-wise fraction between two fields of same dimensionality. If o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,57 +62,59 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -115,6 +125,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -129,6 +141,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 3dd16e1f80..fe1749a6c0 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 @@ -14,10 +14,14 @@ For every two fields with the same label space (from the two input fields contai ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ For every two fields with the same label space (from the two input fields contai ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,50 +62,52 @@ For every two fields with the same label space (from the two input fields contai ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product.md index 3b555a38ac..591aa6aa96 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product.md @@ -14,10 +14,14 @@ Computes component-wise product between two fields of same dimensionality. If on ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,57 +62,59 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -115,6 +125,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -129,6 +141,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product_fc.md index 4ae263f5e0..d159f1ac87 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/component_wise_product_fc.md @@ -14,10 +14,14 @@ Computes component-wise product between two fields of same dimensionality. If on ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,57 +62,59 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -115,6 +125,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -129,6 +141,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/compute_residual_and_error.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/compute_residual_and_error.md index efbb327b07..736679c5a1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/compute_residual_and_error.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/compute_residual_and_error.md @@ -16,13 +16,17 @@ When a second entry is not provided, the calculation is only completed for the f ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container1](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [normalization_type](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [norm_calculation_type](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [field_reference](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [field_or_fields_container2](#input_4) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_or_fields_container1](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [normalization_type](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [norm_calculation_type](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [field_reference](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [field_or_fields_container2](#input_4) | |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -82,6 +86,10 @@ Field or fields container of the exact same dimensions as pin 0 to be used for r ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [residual](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -135,8 +143,10 @@ Error scaling factor : ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -147,6 +157,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -161,6 +173,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 e589dec8f3..776d0486a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/conjugate.md @@ -14,9 +14,13 @@ Computes element-wise conjugate of field containers containing complex fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Computes element-wise conjugate of field containers containing complex fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Computes element-wise conjugate of field containers containing complex fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/correlation.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/correlation.md index 6582594b97..3c1351b3f1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/correlation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/correlation.md @@ -14,12 +14,16 @@ Takes two fields and a weighting and computes their correlation: aMb/(||aMa||.|| ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [weights](#input_2) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [absoluteValue](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`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) | +| 2 | [weights](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [absoluteValue](#input_3) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ If true, correlation factor is ||aMb||/(||aMa||.||bMb||) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -80,8 +88,10 @@ If several b are provided, this output contains the index of the highest correla ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -92,6 +102,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -106,6 +118,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 944a1cbbce..c16ffb3417 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cos.md @@ -14,9 +14,13 @@ Computes element-wise cosine function on field data: cos(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field or fields container containing numeric data for cosine calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with cosine values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 78eb1723f8..4f7e44a7b1 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 @@ -14,9 +14,13 @@ Computes element-wise cosine function on field data: cos(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field or fields container containing numeric data for cosine calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with cosine values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 07e2be0c98..d6bb140f3f 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 @@ -14,9 +14,13 @@ Derives field containers containing complex fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Derives field containers containing complex fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,29 +53,31 @@ Derives field containers containing complex fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -78,6 +88,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -92,6 +104,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 60cb551171..37de81ae58 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 @@ -14,10 +14,14 @@ Computes division between two field containers containing complex fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ Computes division between two field containers containing complex fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Computes division between two field containers containing complex fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 74732e9455..cf6a90d239 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 @@ -14,10 +14,14 @@ Computes product between two field containers containing complex fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ Computes product between two field containers containing complex fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,50 +62,52 @@ Computes product between two field containers containing complex fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 05c9c5c000..91f4de3bcd 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 @@ -14,10 +14,14 @@ Computes multiplication between two field containers containing complex fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ Computes multiplication between two field containers containing complex fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,50 +62,52 @@ Computes multiplication between two field containers containing complex fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product.md index 9363242aa5..890bd45944 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product.md @@ -14,10 +14,14 @@ Computes the cross product of two vector fields. Fields can have the same locati ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`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 Required| [fieldB](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,50 +62,52 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product_fc.md index 3530988e30..29b4da63e9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/cross_product_fc.md @@ -14,10 +14,14 @@ Computes the cross product of two vector fields. Fields can have the same locati ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container_A](#input_0) |[`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 Required| [field_or_fields_container_B](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,50 +62,52 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/dot.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/dot.md index fa1bd8ff27..97b300b335 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/dot.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/dot.md @@ -14,10 +14,14 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element - wise dot pr ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,57 +62,59 @@ Scalar field containing the dot product values between corresponding vectors ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -115,6 +125,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -129,6 +141,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 cdf704a4c2..9e0b350635 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 @@ -14,10 +14,14 @@ DEPRECATED, PLEASE USE GENERALIZED INNER PRODUCT. Computes element-wise dot prod ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,50 +62,52 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/entity_extractor.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/entity_extractor.md index 584ead9e90..2e654cfcb5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/entity_extractor.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/entity_extractor.md @@ -14,10 +14,14 @@ Extracts an entity from a field, based on its ID. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [scalar_int](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [scalar_int](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Extracts an entity from a field, based on its ID. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Extracts an entity from a field, based on its ID. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/expansion_psd.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/expansion_psd.md index 2216441a31..16fbf5135e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/expansion_psd.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/expansion_psd.md @@ -14,13 +14,17 @@ Computes the PSD response for one-sigma solution. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mode_shapes](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [static_shapes](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [rel_rel_covar_matrix](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [stat_stat_covar_matrix](#input_3) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4| [rel_stat_covar_matrix](#input_4) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mode_shapes](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [static_shapes](#input_1) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [rel_rel_covar_matrix](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [stat_stat_covar_matrix](#input_3) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [rel_stat_covar_matrix](#input_4) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -66,6 +70,10 @@ Fields container containing covariance matrices from a psd file: covariance matr ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [psd](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -81,22 +89,24 @@ PSD solution per label ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -107,6 +117,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -121,6 +133,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 e88f9d3205..4ed4c3b68c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/exponential.md @@ -14,9 +14,13 @@ Computes element-wise exponential function on field data: exp(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#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) | @@ -30,6 +34,10 @@ Field, fields container, or numeric data for exponential calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with exponential values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 3cd4c85f2d..7bd37af5a8 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 @@ -14,9 +14,13 @@ Computes element-wise exponential function on field data: exp(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field, fields container, or numeric data for exponential calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with exponential values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_approx.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_approx.md index 6eacc08b70..0709af90c7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_approx.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_approx.md @@ -15,16 +15,20 @@ Computes the fitting curve using FFT filtering and cubic fitting in space (node ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |`umap`, [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 2 Required| [entity_to_fit](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [component_number](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [first_derivative](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [second_derivative](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [fit_data](#input_6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [cutoff_fr](#input_7) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |`umap`, [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 2 | [entity_to_fit](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [component_number](#input_3) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [first_derivative](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [second_derivative](#input_5) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [fit_data](#input_6) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [cutoff_fr](#input_7) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -94,6 +98,10 @@ Cutoff frequency. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fitted_entity_y](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -125,22 +133,24 @@ The second derivative (d2Y) from the fitted Y. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -151,6 +161,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -165,6 +177,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_eval.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_eval.md index a60fefbb91..f52158f0d9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_eval.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_eval.md @@ -14,10 +14,14 @@ Evaluate the fast fourier transforms at a given set of fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_t](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [time_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_t](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [time_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -39,6 +43,10 @@ if specified only the results at these set ids are used ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -62,8 +70,10 @@ if specified only the results at these set ids are used ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_gradient_eval.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_gradient_eval.md index 4ed9501dd3..95a91a4891 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_gradient_eval.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_gradient_eval.md @@ -14,11 +14,15 @@ Evaluate min max based on the fast fourier transform at a given field, using gra ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [time_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fs_ratio](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [time_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fs_ratio](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ default value = 20 ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [coefficients](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -63,8 +71,10 @@ default value = 20 ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_multi_harmonic_minmax.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_multi_harmonic_minmax.md index 4f5bec47d4..b9927a9d87 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_multi_harmonic_minmax.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/fft_multi_harmonic_minmax.md @@ -14,17 +14,21 @@ Evaluate min max fields on multi harmonic solution. min and max fields are calcu ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [rpm_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fs_ratio](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [num_subdivisions](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [max_num_subdivisions](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [num_cycles](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [use_harmonic_zero](#input_6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [calculate_time_series](#input_7) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [substeps_selector](#input_8) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [rpm_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fs_ratio](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [num_subdivisions](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [max_num_subdivisions](#input_4) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [num_cycles](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [use_harmonic_zero](#input_6) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [calculate_time_series](#input_7) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [substeps_selector](#input_8) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -102,6 +106,10 @@ substeps to evaluate (frequencies), by default the operator is evaluated using a ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_min](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -133,8 +141,10 @@ substeps to evaluate (frequencies), by default the operator is evaluated using a ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -145,6 +155,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -159,6 +171,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 a9293e4b56..520bef7f20 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 @@ -14,10 +14,14 @@ Computes a general notion of inner product between two fields of possibly differ ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`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 Required| [fieldB](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,50 +62,52 @@ Field containing the generalized inner product result ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 07d2afcd58..fa376f74d5 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 @@ -14,10 +14,14 @@ Computes a general notion of inner product between two fields of possibly differ ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container_A](#input_0) |[`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 Required| [field_or_fields_container_B](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,50 +62,52 @@ Field containing the generalized inner product result ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_elemental_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_elemental_density.md index bb7c6a7812..2cc684c1ec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_elemental_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_elemental_density.md @@ -14,13 +14,17 @@ Extract Elemental Topology Density result from topo solver output. Default behav ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 200 Required| [custom_ponderation_name](#input_200) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 200 | [custom_ponderation_name](#input_200) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ take custom ponderation_field from the topo file by name ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -81,8 +89,10 @@ take custom ponderation_field from the topo file by name ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_nodal_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_nodal_density.md index af21c6d283..174420c68a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_nodal_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/hdf5_topo_nodal_density.md @@ -14,13 +14,17 @@ Extract Nodal Topology Density result from topo solver output. Default behavior ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 200 Required| [custom_ponderation_name](#input_200) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 200 | [custom_ponderation_name](#input_200) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ take custom ponderation_field from the topo file by name ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -81,8 +89,10 @@ take custom ponderation_field from the topo file by name ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 3e40ef9dd5..b903adec04 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 @@ -14,9 +14,13 @@ Extracts element-wise imaginary part of field containers containing complex fiel ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Extracts element-wise imaginary part of field containers containing complex fiel ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Extracts element-wise imaginary part of field containers containing complex fiel ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 aa9da521b2..112940a15b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/invert.md @@ -14,9 +14,13 @@ DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inve ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with inverse values (1/x) applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 03bd3a3b7f..f5676972a9 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 @@ -14,9 +14,13 @@ DEPRECATED, PLEASE USE DIVIDE. Computes the element-wise and component-wise inve ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with inverse values (1/x) applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 1492654ca3..331d156cd6 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 @@ -14,10 +14,14 @@ Computes element-wise Kronecker product between two tensor fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,22 +62,24 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 8338e5500c..3a8306d1de 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 @@ -14,13 +14,17 @@ Computes aXY + bZ where a,b (in 0, in 3) are scalar and X,Y,Z (in 1,2,4) are com ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [a](#input_0) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [fields_containerA](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [fields_containerB](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [b](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [fields_containerC](#input_4) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [a](#input_0) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [fields_containerA](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [fields_containerB](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [b](#input_3) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [fields_containerC](#input_4) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -66,6 +70,10 @@ Double ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,8 +89,10 @@ Double ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 e4683e02c9..d56b2df44e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/ln.md @@ -14,9 +14,13 @@ Computes element-wise ln(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#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) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with natural logarithm values applied element-wise ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 42e152c11d..c092f6ec62 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 @@ -14,9 +14,13 @@ Computes element-wise ln(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with natural logarithm values applied element-wise ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/mac.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/mac.md index 1ba2d9b119..8249c8d461 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/mac.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/mac.md @@ -14,11 +14,15 @@ Computes MAC Matrix between two fields container, both for real and complex case ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [weights](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [weights](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ Field M, optional weighting for MAC Matrix computation. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ MAC Matrix for all the combinations between mode fields of Field Container A and ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/make_one_on_comp.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/make_one_on_comp.md index 51fe936605..b2a654102b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/make_one_on_comp.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/make_one_on_comp.md @@ -14,10 +14,14 @@ Takes the input field's scoping and creates a field full of zeros, except for th ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [scalar_int](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [scalar_int](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Takes the input field's scoping and creates a field full of zeros, except for th ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Takes the input field's scoping and creates a field full of zeros, except for th ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_inverse.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_inverse.md index b37541a02e..4bfd2dedde 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_inverse.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/matrix_inverse.md @@ -14,9 +14,13 @@ Computes the complex matrix inverse for each field in the given fields container ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ fields_container ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ fields_container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/mechanical_min_max_over_time.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/mechanical_min_max_over_time.md index 3b0df8baab..d4208ce90b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/mechanical_min_max_over_time.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/mechanical_min_max_over_time.md @@ -14,10 +14,14 @@ Evaluates minimum/maximum over time/frequency. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 5 Required| [int32](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 5 | [int32](#input_5) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Define min or max. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_container_1](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -62,8 +70,10 @@ Define min or max. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 db101d9d49..a05c9b8070 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/minus.md @@ -14,10 +14,14 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`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 Required| [fieldB](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,57 +62,59 @@ Field containing the element-wise difference (fieldA - fieldB) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -115,6 +125,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -129,6 +141,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 0a48b2a249..9e0fc7ccdd 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 @@ -14,10 +14,14 @@ Computes the difference of two fields. If one field's scoping has an 'overall' l ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container_A](#input_0) |[`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 Required| [field_or_fields_container_B](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,57 +62,59 @@ Field containing the element-wise difference (fieldA - fieldB) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -115,6 +125,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -129,6 +141,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_damping_ratio.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_damping_ratio.md index 6a6b5cbea9..d3091d0949 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_damping_ratio.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_damping_ratio.md @@ -14,13 +14,17 @@ Computes damping ratio for each mode shape as X_i = const + ratio_i + m_coeffici ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [natural_freq](#input_0) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [const_ratio](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [ratio_by_modes](#input_2) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [m_coefficient](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [k_coefficient](#input_4) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [natural_freq](#input_0) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [const_ratio](#input_1) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [ratio_by_modes](#input_2) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [m_coefficient](#input_3) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [k_coefficient](#input_4) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ global stiffness matrix multiplier ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -81,8 +89,10 @@ field of modal damping ratio. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_participation.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_participation.md index 73bde9fd22..98e6d8786c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_participation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_participation.md @@ -14,13 +14,17 @@ Compute the modal participation factor for a given vector field V, defined as s ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [v_real](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [v_imag](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [mode_shapes](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [ponderation](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | -| 4| [force_label_space](#input_4) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [v_real](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [v_imag](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [mode_shapes](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [ponderation](#input_3) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 4 | [force_label_space](#input_4) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -66,6 +70,10 @@ If set, will force a label space for output result. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [output](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -81,8 +89,10 @@ If set, will force a label space for output result. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md index a1b3e66520..b1c0d9e226 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/modal_superposition.md @@ -14,13 +14,17 @@ Computes the solution in the time/frequency space from a modal solution by multi ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [modal_basis](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [solution_in_modal_space](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2| [incremental_fc](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [time_scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [mesh_scoping](#input_4) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [modal_basis](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [solution_in_modal_space](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [incremental_fc](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [time_scoping](#input_3) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [mesh_scoping](#input_4) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -66,6 +70,10 @@ Compute the result on a subset of the space domain defined in the modal_basis fi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,29 +89,31 @@ Compute the result on a subset of the space domain defined in the modal_basis fi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the operator's inputs will be evaluated in parallel. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -114,6 +124,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -128,6 +140,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 6dd3e12cad..99f19f9edf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/modulus.md @@ -14,9 +14,13 @@ Computes element-wise modulus of field containers containing complex fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Computes element-wise modulus of field containers containing complex fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Computes element-wise modulus of field containers containing complex fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 a41d239a9d..7fd076dc10 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/norm.md @@ -14,10 +14,14 @@ Computes the element-wise Lp norm of the field elementary data. Default Lp=L2 ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [scalar_int](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [scalar_int](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Lp normalisation type, p = 1, 2, ...n - Default Lp=L2 ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Scalar field containing the Lp norm values for each element ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 ac14a7d92d..1ea83c6968 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 @@ -14,10 +14,14 @@ Computes the element-wise L2 norm of the field elementary data. This process is ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [scalar_int](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [scalar_int](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Lp normalisation type, p = 1, 2, ...n - Default Lp=2 ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,22 +62,24 @@ FieldsContainer with computed norms for each field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/outer_product.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/outer_product.md index ff4af3bb1b..e66b6d29e2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/outer_product.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/outer_product.md @@ -14,10 +14,14 @@ Computes the outer product of two vector fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`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 Required| [fieldB](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,50 +62,52 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/overall_dot.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/overall_dot.md index 770e05b451..2a455322c8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/overall_dot.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/overall_dot.md @@ -14,10 +14,14 @@ Computes a dot product between two fields (fields are seen like a single large v ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ Computes a dot product between two fields (fields are seen like a single large v ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Field defined on over-all location, contains a unique scalar value ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 8793169f19..d712a3c6da 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/phase.md @@ -14,10 +14,14 @@ Computes the phase (in rad) between a real and an imaginary field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 2cb3a6b37f..42d23107a5 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 @@ -14,9 +14,13 @@ Computes phase (in rad) between real and imaginary fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Computes phase (in rad) between real and imaginary fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Computes phase (in rad) between real and imaginary fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 c0e5c51afc..c051f222cb 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 @@ -14,9 +14,13 @@ Converts a complex number from polar form to complex. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Converts a complex number from polar form to complex. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Converts a complex number from polar form to complex. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 578d384225..2d67e87dda 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/pow.md @@ -14,11 +14,15 @@ Computes element-wise field[i]^p. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [factor](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [division_by_zero_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [factor](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [division_by_zero_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -49,6 +53,10 @@ Default = inf ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -64,8 +72,10 @@ Default = inf ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -76,6 +86,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -90,6 +102,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 e6c3747976..9a7c2f865d 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 @@ -14,11 +14,15 @@ Computes element-wise field[i]^p. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [factor](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [division_by_zero_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [factor](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [division_by_zero_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -49,6 +53,10 @@ Default = inf ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -64,8 +72,10 @@ Default = inf ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -76,6 +86,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -90,6 +102,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/qr_solve.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/qr_solve.md index b9c0bee3ee..96a2a6c8af 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/qr_solve.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/qr_solve.md @@ -14,10 +14,14 @@ Computes the solution using QR factorization. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [rhs](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [rhs](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ fields_container ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ fields_container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 ba2da370c0..b867539292 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 @@ -14,9 +14,13 @@ Extracts element-wise real part of field containers containing complex fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Extracts element-wise real part of field containers containing complex fields. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Extracts element-wise real part of field containers containing complex fields. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/relative_error.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/relative_error.md index a649745e18..15c2128f81 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/relative_error.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/relative_error.md @@ -14,10 +14,14 @@ Computes the relative error between a reference scalar field and another scalar ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [value](#input_0) |[`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 Required| [reference](#input_1) |[`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) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [value](#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 | [reference](#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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -70,50 +78,52 @@ Ids of entities where there are no reference value. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -124,6 +134,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -138,6 +150,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 65a5c00eea..0b42e54e4a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale.md @@ -14,12 +14,16 @@ Scales a field by a constant factor. This factor can be a scalar or a vector, wh ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [weights](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [boolean](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [algorithm](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [weights](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [boolean](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [algorithm](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Algorithm selection: 0 (default) uses MKL for optimization, 1 uses standard loop ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,15 +80,17 @@ Field with scaled values (input_field * scale_factor) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field.md index 29a6b7682e..f44bca97ac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field.md @@ -14,10 +14,14 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,50 +62,52 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field_fc.md index eceff1ac40..15c837384d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/scale_by_field_fc.md @@ -14,10 +14,14 @@ DEPRECATED, PLEASE USE SCALE. Scales a field (in 0) by a scalar field (in 1). If ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container_A](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [field_or_fields_container_B](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 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) | +| 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) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,50 +62,52 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### binary_operation +### [binary_operation](../../core-concepts/operator-configurations.md#binary_operation) - **Expected type(s):** `binary_operation_enum`, [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 This option allows to choose how two inputs will be treated together. eOnlyIntersection (0) means that the output will only contain the entities shared by all the inputs. eUnion (1) means that the output will contain all the entities contained in at least one of the inputs. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -108,6 +118,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -122,6 +134,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 8261cd67f8..af7453c356 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 @@ -14,12 +14,16 @@ Scales a fields container by a constant factor. This factor can be a scalar, a v ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [weights](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2| [boolean](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [algorithm](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [weights](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [boolean](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [algorithm](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Algorithm selection: 0 (default) uses MKL for optimization, 1 uses standard loop ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -72,29 +80,31 @@ FieldsContainer with scaled field values ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -105,6 +115,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -119,6 +131,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 57305fa5c2..8f6aeda76c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sin.md @@ -14,9 +14,13 @@ Computes element-wise sine function on field data: sin(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -30,6 +34,10 @@ Field containing numeric data for sine calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with sine values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 cb03dd3eab..57a34ef715 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 @@ -14,9 +14,13 @@ Computes element-wise sine function on field data: sin(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field containing numeric data for sine calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with sine values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 2f6a5c377c..47fa4c10de 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqr.md @@ -14,9 +14,13 @@ Computes element-wise field[i]^2. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,29 +53,31 @@ Field with squared values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -78,6 +88,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -92,6 +104,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 1caf7f8856..c4ec9cfb34 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 @@ -14,9 +14,13 @@ Computes element-wise field[i]^2. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,29 +53,31 @@ Field with squared values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -78,6 +88,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -92,6 +104,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 df25e882ba..0187aaf89a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/sqrt.md @@ -14,9 +14,13 @@ Computes element-wise square root function on field data: sqrt(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field or fields container containing numeric data for square root calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with square root values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 f7ccd71f1f..ab1b4e29c6 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 @@ -14,9 +14,13 @@ Computes element-wise square root function on field data: sqrt(field[i]). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field or fields container containing numeric data for square root calculation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with square root values applied element-wise to input data ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/svd.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/svd.md index fb1e84240e..20b53dd1d7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/svd.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/svd.md @@ -14,9 +14,13 @@ Computes the matrix singular value decomposition (SVD) for each field in the giv ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ fields_container ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [s_svd](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -61,8 +69,10 @@ Vt of the input data, where A=U.S.Vt ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 82b08e01c0..e09e59e542 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 @@ -14,14 +14,18 @@ Shifts the phase of a real and an imaginary field (in 0 and 1) of a given angle ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [real_field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [imaginary_field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [angle](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [unit_name](#input_3) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [abs_value](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [imaginary_part_null](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [real_field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [imaginary_field](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [angle](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [unit_name](#input_3) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [abs_value](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [imaginary_part_null](#input_5) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ If the imaginary part field is empty and this pin is true, then the imaginary pa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -90,8 +98,10 @@ If the imaginary part field is empty and this pin is true, then the imaginary pa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 92cabd4859..23f88d352e 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 @@ -14,12 +14,16 @@ Shifts the phase of all the corresponding real and imaginary fields of a fields ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [angle](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [unit_name](#input_3) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [abs_value](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [angle](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [unit_name](#input_3) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [abs_value](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -72,8 +80,10 @@ String Unit. Supported values: "deg" or "rad". Default: "rad". ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_derivation.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_derivation.md index 8a39b60d87..b192df928c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_derivation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_derivation.md @@ -14,10 +14,14 @@ Derives a field of time varying quantities with respect to time ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [spline_fitting](#input_1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [spline_fitting](#input_1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Uses spline fitting on the input field to compute smooth derivatives ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Uses spline fitting on the input field to compute smooth derivatives ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 7819148be8..9da2b22d2d 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 @@ -14,14 +14,18 @@ Interpolates between all the matching fields of a fields container at given time ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [time_freq_values](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | -| 2| [step](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [interpolation_type](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [force_new_time_freq_support](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 8| [time_freq_support](#input_8) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [time_freq_values](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [step](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [interpolation_type](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [force_new_time_freq_support](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [time_freq_support](#input_8) | |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -75,6 +79,10 @@ If set to true, the output fields container will always have a new time freq sup ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -90,15 +98,17 @@ FieldsContainer with interpolated fields at specified time/frequency values ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -109,6 +119,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -123,6 +135,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_integration.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_integration.md index bd1dcc1b47..6ea5e0c699 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/time_integration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/time_integration.md @@ -14,13 +14,17 @@ Integrates a field of time varying quantities over time ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [resample_output](#input_1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [absolute_error](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [minimum_step_size](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [integration_constant](#input_4) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [resample_output](#input_1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [absolute_error](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [minimum_step_size](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [integration_constant](#input_4) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ Constant to be added to the integrated field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -81,8 +89,10 @@ Constant to be added to the integrated field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 c54b4898e2..195d9ef927 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 @@ -14,10 +14,14 @@ Converts an input field/fields container or mesh of a given unit to another unit ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [entity_to_convert](#input_0) |[`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) | -| 1 Required| [unit_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [entity_to_convert](#input_0) | Required|[`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) | +| 1 | [unit_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ unit as a string, ex 'm' for meter, 'Pa' for pascal,... Or ansys unit system's I ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [converted_entity](#output_0) |[`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) | @@ -54,15 +62,17 @@ the output entity is the same as the input (inplace operator) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ 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 e1f1fbd8e3..d160d30e59 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 @@ -14,10 +14,14 @@ Converts an input fields container of a given unit to another unit. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [unit_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [unit_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ unit as a string, ex 'm' for meter, 'Pa' for pascal,... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,15 +62,17 @@ FieldsContainer with converted units (inplace operation) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett.md index dd996e4474..0555ef7073 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett.md @@ -14,9 +14,13 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -45,8 +53,10 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett_fc.md index ab24abaa3e..8207c55b51 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_bartlett_fc.md @@ -14,9 +14,13 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Apply bartlett windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman.md index cb106d460f..c960f8fc14 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman.md @@ -14,9 +14,13 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -45,8 +53,10 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman_fc.md index cf4d4889d2..095fbe14d7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_blackman_fc.md @@ -14,9 +14,13 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Apply blackman windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming.md index 0387245b89..ec9e5a25f3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming.md @@ -14,9 +14,13 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -45,8 +53,10 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming_fc.md index a52e367eda..1027830079 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hamming_fc.md @@ -14,9 +14,13 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Apply hamming windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning.md index 6c0761dc7b..833c25b047 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning.md @@ -14,9 +14,13 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -45,8 +53,10 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning_fc.md index 3f0fe28fb8..46ef246b38 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_hanning_fc.md @@ -14,9 +14,13 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Apply hanning windowing on a given FieldsContainer having time label or a Field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular.md index 4e0452d23f..c06cec0594 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular.md @@ -14,9 +14,13 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -45,8 +53,10 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular_fc.md index 2e59ac37eb..1dfef773d4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_triangular_fc.md @@ -14,9 +14,13 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Apply triangular windowing on a given FieldsContainer having time label or a Fie ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch.md index 07e6d51226..33647ce81a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch.md @@ -14,9 +14,13 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -45,8 +53,10 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch_fc.md index 6ca7c1981b..f4ace5ee40 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/math/window_welch_fc.md @@ -14,9 +14,13 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Apply welch windowing on a given FieldsContainer having time label or a Field lo ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: math **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/acmo_mesh_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/acmo_mesh_provider.md index 909f7f6f7a..91f4df82bb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/acmo_mesh_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/acmo_mesh_provider.md @@ -14,10 +14,14 @@ Converts an Assembly Mesh into a DPF Meshes container ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [assembly_mesh](#input_0) |`ans_dispatch_holder`, `struct IAnsDispatch` | -| 1| [unit](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [assembly_mesh](#input_0) | Required|`ans_dispatch_holder`, `struct IAnsDispatch` | +| 1 | [unit](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Converts an Assembly Mesh into a DPF Meshes container ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes_container](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -54,8 +62,10 @@ Converts an Assembly Mesh into a DPF Meshes container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md index e04f94393f..b8e4b1fadc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/beam_properties.md @@ -20,10 +20,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -45,6 +49,10 @@ Result file path container, used if no streams are set. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_out](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -164,22 +172,24 @@ This field contains offset z of beams. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -190,6 +200,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -204,6 +216,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/change_cs.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/change_cs.md index c87c718fcb..32b8564d44 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/change_cs.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/change_cs.md @@ -14,10 +14,14 @@ Applies a transformation (rotation and displacement) matrix on a mesh or meshes ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [meshes](#input_0) |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 1 Required| [coordinate_system](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [meshes](#input_0) | Required|[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 1 | [coordinate_system](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ Applies a transformation (rotation and displacement) matrix on a mesh or meshes ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshed_region](#output_0) |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -54,22 +62,24 @@ Applies a transformation (rotation and displacement) matrix on a mesh or meshes ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/combine_levelset.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/combine_levelset.md index 6ba87c6acc..4fa0b74e87 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/combine_levelset.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/combine_levelset.md @@ -14,10 +14,14 @@ Takes two level sets and computes their binary union. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ Takes two level sets and computes their binary union. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Takes two level sets and computes their binary union. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/decimate_mesh.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/decimate_mesh.md index 638a743738..e25d2ad70c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/decimate_mesh.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/decimate_mesh.md @@ -14,11 +14,15 @@ Decimate a meshed region ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [preservation_ratio](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [aggressiveness](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [preservation_ratio](#input_1) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [aggressiveness](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Quality measure for the resulting decimated mesh. Lower aggresiveness will provi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -63,8 +71,10 @@ Decimated mesh with triangle elements ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: mesh @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/exclude_levelset.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/exclude_levelset.md index b2c7926fe0..1b4e8ac6bc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/exclude_levelset.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/exclude_levelset.md @@ -14,10 +14,14 @@ Takes two level sets and excludes the second one from the first. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ Takes two level sets and excludes the second one from the first. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Takes two level sets and excludes the second one from the first. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/external_layer.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/external_layer.md index 78e3451699..951607e8bd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/external_layer.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/external_layer.md @@ -14,9 +14,13 @@ Extracts the external layer (thick skin) of the mesh (3D elements) in a new mesh ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -30,6 +34,10 @@ Extracts the external layer (thick skin) of the mesh (3D elements) in a new mesh ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -61,8 +69,10 @@ Extracts the external layer (thick skin) of the mesh (3D elements) in a new mesh ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_field.md index 38b34960b0..8f14d09603 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_field.md @@ -14,9 +14,13 @@ Extracts the meshed region from the support of a field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -30,6 +34,10 @@ Field containing a mesh support ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -45,8 +53,10 @@ Meshed region extracted from the field's support ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scoping.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scoping.md index 5cfa3f2eeb..f5ebbf1965 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scoping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scoping.md @@ -14,12 +14,16 @@ Extracts a meshed region from another meshed region based on a scoping. Regardin ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1 Required| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [inclusive](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [nodes_only](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [inclusive](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [nodes_only](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -57,6 +61,10 @@ returns mesh with nodes only (without any elements or property fields). Default ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -72,8 +80,10 @@ returns mesh with nodes only (without any elements or property fields). Default ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scopings.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scopings.md index f03a48bf8f..f2ff98316f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scopings.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/from_scopings.md @@ -14,12 +14,16 @@ Extracts multiple meshed region base on a scoping and saved in a MeshesContainer ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1 Required| [scopings_container](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 2| [inclusive](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [nodes_only](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scopings_container](#input_1) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 2 | [inclusive](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [nodes_only](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -57,6 +61,10 @@ returns mesh with nodes only (without any elements). Default is false. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -72,8 +80,10 @@ returns mesh with nodes only (without any elements). Default is false. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/iso_surfaces.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/iso_surfaces.md index 93ed0456bd..fdcce800d0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/iso_surfaces.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/iso_surfaces.md @@ -14,13 +14,17 @@ Extract multiple iso-contours from mesh_cut operator and set it into a meshes co ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [num_surfaces](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [mesh](#input_2) |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3 Required| [slice_surfaces](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [vector_iso_values](#input_4) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [num_surfaces](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mesh](#input_2) | |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [slice_surfaces](#input_3) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [vector_iso_values](#input_4) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ If provided, user defined iso_values to compute. If not provided, iso_values are ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -89,8 +97,10 @@ If provided, user defined iso_values to compute. If not provided, iso_values are ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_plane_levelset.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_plane_levelset.md index 0106ebb29c..8b2e780dd9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_plane_levelset.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_plane_levelset.md @@ -14,11 +14,15 @@ Computes the level set for a plane using coordinates. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [coordinates](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [normal](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [origin](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [coordinates](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [normal](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [origin](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ An overall 3d vector that gives a point of the plane. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ An overall 3d vector that gives a point of the plane. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_sphere_levelset.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_sphere_levelset.md index 39237dd99d..98881e6ee8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_sphere_levelset.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/make_sphere_levelset.md @@ -14,11 +14,15 @@ Computes the level set for a sphere using coordinates. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [coordinates](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [origin](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [radius](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [coordinates](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [origin](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [radius](#input_2) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Sphere radius. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Sphere radius. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_clip.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_clip.md index d3be750a25..3f59b2686f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_clip.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_clip.md @@ -14,13 +14,17 @@ Clips a volume mesh along an iso value x, and construct the volume mesh defined ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [iso_value](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [closed_surface](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [mesh](#input_3) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 4 Required| [slice_surfaces](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [iso_value](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [closed_surface](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [mesh](#input_3) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 4 | [slice_surfaces](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ True: slicing will also take into account shell and skin elements. False: slicin ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -89,8 +97,10 @@ True: slicing will also take into account shell and skin elements. False: slicin ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_cut.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_cut.md index 3448e86e07..4af9037f53 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_cut.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_cut.md @@ -14,13 +14,17 @@ Extracts a skin of the mesh in triangles in a new meshed region. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [iso_value](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [closed_surface](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [mesh](#input_3) |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 4 Required| [slice_surfaces](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [iso_value](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [closed_surface](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [mesh](#input_3) | |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 4 | [slice_surfaces](#input_4) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ True: slicing will also take into account shell and skin elements. False: slicin ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **2**| [mesh](#output_2) |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -81,8 +89,10 @@ True: slicing will also take into account shell and skin elements. False: slicin ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_extraction.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_extraction.md index 0902bd390d..0c2a00d11b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_extraction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_extraction.md @@ -14,11 +14,15 @@ Take a mesh and a scoping (elemental or nodal) and create a new mesh that contai ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [extension](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [mesh_scoping](#input_1) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [extension](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Number of extension layer ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [abstract_meshed_region](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -63,8 +71,10 @@ Number of extension layer ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_get_attribute.md index 19fb3c933d..cd9a9c5da7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_get_attribute.md @@ -14,11 +14,15 @@ Uses the MeshedRegion APIs to return a given attribute of the mesh in input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [abstract_meshed_region](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [property_identifier](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [abstract_meshed_region](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property_identifier](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Can be used to get a property at a given index, example: a named selection's num ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`field`](../../core-concepts/dpf-types.md#field), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`string_field`](../../core-concepts/dpf-types.md#string-field) | @@ -63,8 +71,10 @@ Returns a property field for properties: "connectivity", "reverse_connectivity", ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_plan_clip.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_plan_clip.md index 639ebfca90..c828b7580f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_plan_clip.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_plan_clip.md @@ -14,11 +14,15 @@ Clips a volume mesh along a plane and keeps one side. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh_or_field](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [normal](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [origin](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh_or_field](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [normal](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [origin](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ An overall 3D vector that gives a point of the plane. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -71,8 +79,10 @@ An overall 3D vector that gives a point of the plane. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md index 3ff33702a3..fce88ff18c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_provider.md @@ -28,14 +28,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [laziness](#input_200) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [laziness](#input_200) | |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -97,6 +101,10 @@ configurate whether lazy evaluation can be performed and to what extent. Support ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -112,29 +120,31 @@ configurate whether lazy evaluation can be performed and to what extent. Support ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -145,6 +155,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -159,6 +171,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics.md index 3a769e072e..6bda4dd898 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics.md @@ -14,11 +14,15 @@ Generate tessellation for input mesh ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [node_normals](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [node_normals](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ average element normals for node normals (default no, use element normals for no ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [nodes](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -79,8 +87,10 @@ node normals ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics_edges.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics_edges.md index 8c1686c80d..6f8cce40b8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics_edges.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_graphics_edges.md @@ -14,11 +14,15 @@ Generate edges of surface elements for input mesh ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 6| [include_mid_nodes](#input_6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 6 | [include_mid_nodes](#input_6) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ Generate edges of surface elements for input mesh ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [nodes](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -71,8 +79,10 @@ node coordinates ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md index 618b2c18e4..b4b3850d6f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_pyvista.md @@ -14,13 +14,17 @@ Export a MeshedRegion in the pyVista format. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 2| [coordinates](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | -| 6| [as_linear](#input_6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 60| [vtk_updated](#input_60) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [as_poly](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 2 | [coordinates](#input_2) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 6 | [as_linear](#input_6) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 60 | [vtk_updated](#input_60) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [as_poly](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ Export elements as polyhedrons (cell-face-node representation). Default false. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [nodes](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -105,8 +113,10 @@ If vtk_updated=false, offsets int vector ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: vtk @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_tetra.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_tetra.md index e102d4df1b..319eca654d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_tetra.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/mesh_to_tetra.md @@ -14,9 +14,13 @@ Converts 3D meshes of arbitrary 3D element types into a tetrahedral mesh, output ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -30,6 +34,10 @@ Mesh with arbitrary element types. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -61,8 +69,10 @@ Element mapping. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -73,6 +83,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -87,6 +99,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md index 0aa1415234..f0cc8c1636 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/meshes_provider.md @@ -26,13 +26,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -83,6 +87,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -98,29 +106,31 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -131,6 +141,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -145,6 +157,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphed_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphed_field.md index 766f4bb075..e5e525e985 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphed_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphed_field.md @@ -14,15 +14,19 @@ Computes the displacement to apply on input coordinates (in 2) if a morphing fie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [displacement](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [disp_coordinates](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2 Required| [coordinates](#input_2) |[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 4| [morphing_type](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [morphing_manager_data](#input_5) | | -| 6| [sliding_planes](#input_6) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7| [sliding_nodes](#input_7) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [displacement](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [disp_coordinates](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [coordinates](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 4 | [morphing_type](#input_4) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [morphing_manager_data](#input_5) | | | +| 6 | [sliding_planes](#input_6) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [sliding_nodes](#input_7) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -84,6 +88,10 @@ Sliding nodes ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [coordinates_displacement](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -99,22 +107,24 @@ displacement of each point of the input coordinates ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: N/A @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphing.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphing.md index 519521c967..bda96b3300 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphing.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/morphing.md @@ -14,16 +14,20 @@ Applies morphing on a meshed region depending on an input displacement field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [displacement](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [disp_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2 Required| [mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3| [in_place](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [morphing_type](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [morphing_manager_data](#input_5) | | -| 6| [sliding_planes](#input_6) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7| [sliding_nodes](#input_7) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [displacement](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [disp_mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [mesh](#input_2) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [in_place](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [morphing_type](#input_4) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [morphing_manager_data](#input_5) | | | +| 6 | [sliding_planes](#input_6) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [sliding_nodes](#input_7) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -93,6 +97,10 @@ Sliding nodes ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -108,22 +116,24 @@ morphed mesh ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 1 -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: N/A @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/node_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/node_coordinates.md index bbd6072d4d..53fddc880c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/node_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/node_coordinates.md @@ -14,9 +14,13 @@ Returns the node coordinates of the mesh(es) in input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -30,6 +34,10 @@ Returns the node coordinates of the mesh(es) in input. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [coordinates](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -45,8 +53,10 @@ if the input is a meshed region, a field of coordinates is the output, else if t ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/points_from_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/points_from_coordinates.md index 53db4e2212..5ba9d193ba 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/points_from_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/points_from_coordinates.md @@ -14,10 +14,14 @@ Extract a mesh made of points elements. This mesh is made from input meshes coor ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [nodes_to_keep](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 1 Required| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [nodes_to_keep](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 1 | [mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -39,6 +43,10 @@ Extract a mesh made of points elements. This mesh is made from input meshes coor ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [abstract_meshed_region](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -54,8 +62,10 @@ Extract a mesh made of points elements. This mesh is made from input meshes coor ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/prepare_morphing.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/prepare_morphing.md index 93721cbbe4..0e0a2903a0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/prepare_morphing.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/prepare_morphing.md @@ -14,11 +14,15 @@ Prepare morphing on a meshed region depending on an input displacement field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [displacement_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 1 Required| [disp_mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2 Required| [mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [displacement_scoping](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 1 | [disp_mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [mesh](#input_2) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ mesh to morph ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [morphing_manager_data](#output_0) | | @@ -63,8 +71,10 @@ Morphing manager data (can be used as input of morphed_field or morphing operato ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: N/A @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/skin.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/skin.md index 5d7bfd3a5b..2b3af29cb7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/skin.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/skin.md @@ -14,12 +14,16 @@ Extracts a skin of the mesh in a new meshed region. The material ID of initial e ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [duplicate_shell](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [add_beam_point](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [duplicate_shell](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [add_beam_point](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ If input mesh contains beam or point elements, output mesh beam point elements ( ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -104,8 +112,10 @@ This property field gives, for each new face element ID (in the scoping), the co ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -116,6 +126,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -130,6 +142,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_fields.md index 6648e1ff62..e1d65f01af 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_fields.md @@ -14,10 +14,14 @@ Split the input field or fields container based on the input mesh regions ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [meshes](#input_1) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_or_fields_container](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [meshes](#input_1) | Required|[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -39,6 +43,10 @@ body meshes in the mesh controller cannot be mixed shell/solid ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ body meshes in the mesh controller cannot be mixed shell/solid ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_mesh.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_mesh.md index 308c6e5b15..c32e4125a0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_mesh.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/split_mesh.md @@ -14,11 +14,15 @@ Split the input mesh into several meshes based on a given property (material pro ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 13 Required| [property](#input_13) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 13 | [property](#input_13) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Scoping ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -63,8 +71,10 @@ Scoping ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/stl_export.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/stl_export.md index b9b6bb028f..f2c59941bf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/stl_export.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/stl_export.md @@ -14,10 +14,14 @@ export a mesh into a stl file. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [file_path](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [file_path](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ export a mesh into a stl file. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -54,8 +62,10 @@ export a mesh into a stl file. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/tri_mesh_skin.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/tri_mesh_skin.md index 7d36fef780..2d367be37c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/tri_mesh_skin.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/tri_mesh_skin.md @@ -14,11 +14,15 @@ Extracts a skin of the mesh in triangles in a new meshed region. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [include_surfaces](#input_1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [mesh_scoping](#input_2) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [include_surfaces](#input_1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mesh_scoping](#input_2) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -71,8 +79,10 @@ Nodal scoping to restrict the skin extraction to a set of nodes. If provided, a ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/wireframe.md b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/wireframe.md index 9a20dfd895..e6080c05f8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/mesh/wireframe.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/mesh/wireframe.md @@ -14,11 +14,15 @@ Take a mesh and extracts its sharp edges, using pin 1 value as a threshold angle ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1 Required| [threshold](#input_1) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [element_restriction](#input_2) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [threshold](#input_1) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [element_restriction](#input_2) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ Restrict the list of elements that must be treated when extractiong edges. Can b ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [wireframe](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -63,8 +71,10 @@ Restrict the list of elements that must be treated when extractiong edges. Can b ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: mesh **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md index e738731b09..0e9aff4a42 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/boundary_condition_provider.md @@ -20,12 +20,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 13 Required| [property](#input_13) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 13 | [property](#input_13) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -77,6 +81,10 @@ Available boundary conditions are : ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_or_fields_container](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -92,22 +100,24 @@ Value of the boundary condition at each node (0 if there is not). It is a field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -118,6 +128,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -132,6 +144,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md index 0a5fbe0174..7cf6e13d0f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/coordinate_system_data_provider.md @@ -20,11 +20,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [solver_coordinate_system_ids](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [solver_coordinate_system_ids](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -54,6 +58,10 @@ Result file path container, used if no streams are set. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [coordinate_system_data](#output_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | @@ -69,22 +77,24 @@ Result file path container, used if no streams are set. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -95,6 +105,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -109,6 +121,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_mesh_expansion.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_mesh_expansion.md index 637c084bb3..15e853e8c6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_mesh_expansion.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_mesh_expansion.md @@ -14,11 +14,15 @@ Expand the mesh. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 7| [sector_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 16 Required| [cyclic_support](#input_16) |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 7 | [sector_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 16 | [cyclic_support](#input_16) | Required|[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -48,6 +52,10 @@ sectors to expand (start at 0), for multistage: use scopings container with 'sta ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshed_region](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -71,8 +79,10 @@ input cyclic support modified in place containing the new expanded meshed region ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md index 14db9d6c23..ab310e0a39 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/cyclic_support_provider.md @@ -21,13 +21,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [sector_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [sector_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -73,6 +77,10 @@ sectors to expand (start at 0), for multistage: use scopings container with 'sta ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [cyclic_support](#output_0) |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | @@ -96,22 +104,24 @@ sectors to expand (start at 0), for multistage: use scopings container with 'sta ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/datasources_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/datasources_provider.md index 4d32c76140..eba7888ab1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/datasources_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/datasources_provider.md @@ -14,9 +14,13 @@ Creates a DataSources by expanding another. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -30,6 +34,10 @@ Creates a DataSources by expanding another. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -45,8 +53,10 @@ Creates a DataSources by expanding another. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md index 89d5bdc213..a6f2279f9e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/element_types_provider.md @@ -29,12 +29,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [solver_element_types_ids](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 200| [output_type](#input_200) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [solver_element_types_ids](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 200 | [output_type](#input_200) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -72,6 +76,10 @@ Get the output as a GenericDataContainer (pin value 1, default) or as a Property ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [element_types_data](#output_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -87,22 +95,24 @@ Get the output as a GenericDataContainer (pin value 1, default) or as a Property ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -113,6 +123,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -127,6 +139,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/integrate_over_time_freq.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/integrate_over_time_freq.md index d678e11b9d..445bcf8344 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/integrate_over_time_freq.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/integrate_over_time_freq.md @@ -14,11 +14,15 @@ Integration of an input field over timefreq. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [time_freq_support](#input_2) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [time_freq_support](#input_2) | |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -48,6 +52,10 @@ Time Freq to integrate on, otherwise time freq support from the input field is t ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Time Freq to integrate on, otherwise time freq support from the input field is t ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md index 26a2acab5f..41ca63b9a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/is_cyclic.md @@ -21,10 +21,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -46,6 +50,10 @@ If the stream is null, retrieves the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [file_path](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -61,15 +69,17 @@ returns 'single_stage' or 'multi_stage' or an empty string for non cyclic model ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -80,6 +90,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -94,6 +106,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md index ab3565dd13..5df1ee1e81 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/material_support_provider.md @@ -20,10 +20,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -45,6 +49,10 @@ if the stream is null, get the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [abstract_field_support](#output_0) |`abstract_field_support` | @@ -60,22 +68,24 @@ if the stream is null, get the file path from the data sources. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -86,6 +96,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -100,6 +112,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md index 2b674fff4c..d9cd63eea9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_info_provider.md @@ -22,11 +22,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -56,6 +60,10 @@ If the stream is null, retrieves the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_info](#output_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | @@ -71,29 +79,31 @@ If the stream is null, retrieves the file path from the data sources. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -104,6 +114,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -118,6 +130,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md index 21fdd489ee..be3820834b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_property_provider.md @@ -24,13 +24,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 13 Required| [property_name](#input_13) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 17| [property_identifier](#input_17) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 13 | [property_name](#input_13) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 17 | [property_identifier](#input_17) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -76,6 +80,10 @@ Retrieves a property at a given index or by name. For example, a named selection ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`string_field`](../../core-concepts/dpf-types.md#string-field) | @@ -91,8 +99,10 @@ Returns a property field for properties: "mat", "apdl_element_type", "section", ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -103,6 +113,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -117,6 +129,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md index a97193abf1..e53eac6663 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_selection_manager_provider.md @@ -20,10 +20,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -45,6 +49,10 @@ If the stream is null, retrieves the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_selection_manager](#output_0) |`mesh_selection_manager` | @@ -60,22 +68,24 @@ If the stream is null, retrieves the file path from the data sources. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -86,6 +96,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -100,6 +112,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_support_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_support_provider.md index 2bd4698fc6..6fd059c738 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_support_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/mesh_support_provider.md @@ -14,10 +14,14 @@ Reads the mesh support. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -39,6 +43,10 @@ If the stream is null, retrieves the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [abstract_field_support](#output_0) |`abstract_field_support` | @@ -54,22 +62,24 @@ If the stream is null, retrieves the file path from the data sources. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/property_field_provider_by_name.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/property_field_provider_by_name.md index 74e68e48a0..3d1aff8ad4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/property_field_provider_by_name.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/property_field_provider_by_name.md @@ -14,12 +14,16 @@ Provides the property values for a set of elements for a defined property name. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 13 Required| [property_name](#input_13) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 13 | [property_name](#input_13) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ property to read, that can be the following: elements_connectivity, nodes_connec ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property_field](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -72,8 +80,10 @@ property field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md index f54c300e82..70cc312ebe 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/real_constants_provider.md @@ -20,11 +20,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [solver_real_constants_ids](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [solver_real_constants_ids](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -54,6 +58,10 @@ Result file path container, used if no streams are set. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [real_constants](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -69,22 +77,24 @@ Result file path container, used if no streams are set. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -95,6 +105,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -109,6 +121,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md index 10fada02b5..7dace5f90d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/result_info_provider.md @@ -25,10 +25,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -50,6 +54,10 @@ If the stream is null, retrieves the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [result_info](#output_0) |[`result_info`](../../core-concepts/dpf-types.md#result-info) | @@ -65,29 +73,31 @@ If the stream is null, retrieves the file path from the data sources. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -98,6 +108,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -112,6 +124,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/streams_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/streams_provider.md index c35b22953f..ac773318aa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/streams_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/streams_provider.md @@ -23,9 +23,13 @@ Throws a runtime error if data sources are missing or if all result files are in ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -44,6 +48,10 @@ Data sources describing one or more result files. Supports single or multiple re ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [streams_container](#output_0) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | @@ -59,29 +67,31 @@ Streams created from the input data sources, including aggregated streams across ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, warning checks (like unit or data sizes) won't be done. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -92,6 +102,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -106,6 +118,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md index 9754ae3747..1de586de07 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_provider.md @@ -24,10 +24,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -49,6 +53,10 @@ If the stream is null, retrieves the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [time_freq_support](#output_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -64,22 +72,24 @@ If the stream is null, retrieves the file path from the data sources. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -90,6 +100,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -104,6 +116,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_support_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_support_get_attribute.md index 2bbe941b24..af28e30570 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_support_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/metadata/time_freq_support_get_attribute.md @@ -14,12 +14,16 @@ Uses the TimeFreqSupport APIs to return a given attribute of the scoping in inpu ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [property_identifier](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [property_identifier_2](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property_identifier](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [property_identifier_2](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Additional pin for properties "set_id" and "cummulative_index": the substep id ( ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -72,8 +80,10 @@ Returns a double for property: "frequency_tolerance", a single-value Scoping for ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: metadata **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_by_component.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_by_component.md index e112065c30..54214f94ed 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_by_component.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_by_component.md @@ -14,10 +14,14 @@ Give the maximum for each element rank by comparing several fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [use_absolute_value](#input_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [use_absolute_value](#input_0) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [field](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_phase.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_phase.md index 7c5cfdab8e..df217df64f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_phase.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_phase.md @@ -14,12 +14,16 @@ Returns, for each entity, the maximum value of (real value * cos(theta) - imagin ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [real_field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [imaginary_field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [abs_value](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [phase_increment](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [real_field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [imaginary_field](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [abs_value](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [phase_increment](#input_3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Phase increment (default is 10.0 degrees). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ Phase increment (default is 10.0 degrees). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_time_by_entity.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_time_by_entity.md index 41eaadb95c..7d0dc077ba 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_time_by_entity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/max_over_time_by_entity.md @@ -14,11 +14,15 @@ Evaluates maximum over time/frequency. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [abs_value](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [compute_amplitude](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [abs_value](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compute_amplitude](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Do calculate amplitude. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,15 +71,17 @@ Do calculate amplitude. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_by_component.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_by_component.md index 02436fe64f..12a95c43df 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_by_component.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_by_component.md @@ -14,10 +14,14 @@ Give the minimum for each element rank by comparing several fields. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [use_absolute_value](#input_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [use_absolute_value](#input_0) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [field](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max.md index 775ca2cb70..42a9703649 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max.md @@ -14,9 +14,13 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_min](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -53,8 +61,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -65,6 +75,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -79,6 +91,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_entity.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_entity.md index dc2fe3c73e..3974b9a72d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_entity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_entity.md @@ -14,9 +14,13 @@ Compute the entity-wise minimum (out 0) and maximum (out 1) through all fields o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Compute the entity-wise minimum (out 0) and maximum (out 1) through all fields o ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_min](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -53,8 +61,10 @@ Compute the entity-wise minimum (out 0) and maximum (out 1) through all fields o ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -65,6 +75,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -79,6 +91,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_time.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_time.md index f4d568dddd..8b3f6eb2fd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_time.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_by_time.md @@ -14,10 +14,14 @@ Evaluates minimum, maximum by time or frequency over all the entities of each fi ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2| [compute_absolute_value](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [compute_absolute_value](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Calculate the absolute value of field entities before computing the min/max. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [min](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -62,15 +70,17 @@ Calculate the absolute value of field entities before computing the min/max. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -81,6 +91,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -95,6 +107,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc.md index 0a216c9904..c6fcbff8e6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc.md @@ -14,9 +14,13 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_min](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -53,8 +61,10 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -65,6 +75,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -79,6 +91,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc_inc.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc_inc.md index 135ef93145..047e608ad7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc_inc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_fc_inc.md @@ -14,9 +14,13 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_min](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -53,15 +61,17 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over a fields con ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -72,6 +82,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -86,6 +98,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_inc.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_inc.md index e7a9df647c..4f163725d8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_inc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_inc.md @@ -14,10 +14,14 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over coming field ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 17| [domain_id](#input_17) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 17 | [domain_id](#input_17) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over coming field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_min](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -78,8 +86,10 @@ Compute the component-wise minimum (out 0) and maximum (out 1) over coming field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -90,6 +100,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -104,6 +116,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_label_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_label_fc.md index 1c8a6aef9d..64ae81ed87 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_label_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_label_fc.md @@ -14,10 +14,14 @@ Create two fields (0 min 1 max) by looping over the fields container in input an ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ label name from the fields container ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_min](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -94,8 +102,10 @@ label name from the fields container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -106,6 +116,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -120,6 +132,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_time_by_entity.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_time_by_entity.md index f5cf839a8c..540b58881d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_time_by_entity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_max_over_time_by_entity.md @@ -17,11 +17,15 @@ if given input `fields_container` has a `time_freq_support`, output pins 2 and 3 ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [compute_absolute_value](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [compute_amplitude](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [compute_absolute_value](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compute_amplitude](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -51,6 +55,10 @@ Do calculate amplitude. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [min](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -90,15 +98,17 @@ Do calculate amplitude. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -109,6 +119,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -123,6 +135,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_over_time_by_entity.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_over_time_by_entity.md index e537b4f9d3..e2e31c5d14 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_over_time_by_entity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/min_over_time_by_entity.md @@ -14,11 +14,15 @@ Evaluates minimum over time/frequency. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [abs_value](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [compute_amplitude](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [abs_value](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compute_amplitude](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Do calculate amplitude. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,15 +71,17 @@ Do calculate amplitude. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/phase_of_max.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/phase_of_max.md index f3d5308bcf..6dd7ca83b7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/phase_of_max.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/phase_of_max.md @@ -14,12 +14,16 @@ Evaluates phase of maximum. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [real_field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [imaginary_field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [abs_value](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [phase_increment](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [real_field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [imaginary_field](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [abs_value](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [phase_increment](#input_3) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Phase increment. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ Phase increment. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_max_by_entity.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_max_by_entity.md index a4c26907c9..d5a58f4317 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_max_by_entity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_max_by_entity.md @@ -14,11 +14,15 @@ Evaluates time/frequency of maximum. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [abs_value](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [compute_amplitude](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [abs_value](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compute_amplitude](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Do calculate amplitude. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,15 +71,17 @@ Do calculate amplitude. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### incremental +### [incremental](../../core-concepts/operator-configurations.md#incremental) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true This operator can be run several times with different inputs so that the output will take all the inputs of the different runs into account. It can be used to save memory. For example, a large time scoping can be split in smaller ranges of time to compute the result range by range. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_min_by_entity.md b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_min_by_entity.md index bda198f010..f3ba8402f8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_min_by_entity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/min_max/time_of_min_by_entity.md @@ -14,11 +14,15 @@ Evaluates time/frequency of minimum. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [abs_value](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [compute_amplitude](#input_4) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [abs_value](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [compute_amplitude](#input_4) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Do calculate amplitude. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Do calculate amplitude. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: min_max **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md index 548ab48b2b..0f72552661 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration.md @@ -22,19 +22,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -128,6 +132,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -143,22 +151,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -169,6 +179,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -183,6 +195,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md index 02ae6258a1..997f9e8a60 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_X.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md index d0ff5df51e..293d7d960b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Y.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md index 9394cfdbf0..e730241dad 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acceleration_Z.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md index 630da80ee7..277e1296af 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_creep_strain.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md index 6dd1f02332..64c2556f18 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/accu_eqv_plastic_strain.md @@ -52,19 +52,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -158,6 +162,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -173,22 +181,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -199,6 +209,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -213,6 +225,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md index c96eb1406c..c43affacb5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/acoustic_energy_density.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion.md index efdf1aa845..712bf558e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion.md @@ -14,13 +14,17 @@ Adds a given rigid translation, center and rotation from a displacement field. T ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [displacement_field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [translation_field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [rotation_field](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | -| 3 Required| [center_field](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [displacement_field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [translation_field](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [rotation_field](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [center_field](#input_3) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -66,6 +70,10 @@ default is the mesh in the support ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -81,8 +89,10 @@ default is the mesh in the support ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion_fc.md index e16cf2823c..e0074fbd57 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/add_rigid_body_motion_fc.md @@ -14,13 +14,17 @@ Adds a given rigid translation, center and rotation from a displacement field. T ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [translation_field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [rotation_field](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | -| 3 Required| [center_field](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [translation_field](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [rotation_field](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [center_field](#input_3) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -66,6 +70,10 @@ default is the mesh in the support ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,8 +89,10 @@ default is the mesh in the support ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md index 52fffd67d3..1b1bdcf818 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/artificial_hourglass_energy.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -82,6 +86,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,22 +105,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -123,6 +133,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -137,6 +149,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md index a7de0ebd0f..cfaf3d6f0d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_force.md @@ -22,13 +22,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -74,6 +78,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -89,8 +97,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md index 1493fec1ff..c9ea9651e4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_plastic_strain.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [integration_point](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [integration_point](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -82,6 +86,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,8 +105,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -109,6 +119,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -123,6 +135,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md index 27b3d062e4..5cced79961 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_stress.md @@ -22,14 +22,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [integration_point](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [integration_point](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -83,6 +87,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -98,8 +106,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -110,6 +120,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -124,6 +136,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md index 5389a6e0ff..8facc46317 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_axial_total_strain.md @@ -22,14 +22,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [integration_point](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [integration_point](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -83,6 +87,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -98,8 +106,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -110,6 +120,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -124,6 +136,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md index 0fb43ab0f7..7e03daf3e9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_rs_shear_stress.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [integration_point](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [integration_point](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -82,6 +86,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,8 +105,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -109,6 +119,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -123,6 +135,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md index 0d26cd104b..e296360cea 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_bending_moment.md @@ -22,13 +22,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -74,6 +78,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -89,8 +97,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md index e22c0e8212..52d66f46df 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_s_shear_force.md @@ -22,13 +22,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -74,6 +78,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -89,8 +97,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md index 0b45786c65..8303309488 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_bending_moment.md @@ -22,13 +22,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -74,6 +78,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -89,8 +97,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md index e7034c3d14..f162901d8e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_t_shear_force.md @@ -22,13 +22,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -74,6 +78,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -89,8 +97,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md index d11785a02e..60b301e851 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_torsional_moment.md @@ -22,13 +22,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -74,6 +78,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -89,8 +97,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md index 42ef6b1016..7ea5010985 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/beam_tr_shear_stress.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [integration_point](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [integration_point](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -82,6 +86,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,8 +105,10 @@ integration point where the result will be read from. Default value: 0 (first in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -109,6 +119,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -123,6 +135,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/cgns_result_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/cgns_result_provider.md index 3738541683..5520a62e5e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/cgns_result_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/cgns_result_provider.md @@ -14,14 +14,18 @@ Read/compute names result from result streams. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 17| [result_name](#input_17) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 17 | [result_name](#input_17) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ Optional zone name/Id of the mesh. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -90,8 +98,10 @@ Results ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: cgns @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_dst_table_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_dst_table_provider.md index f95b2755f9..5ace1409e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_dst_table_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_dst_table_provider.md @@ -14,9 +14,13 @@ Read CST table from a subfile. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -30,6 +34,10 @@ Data_sources (must contain at least one subfile). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [dst_table](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -45,8 +53,10 @@ returns integer values of the dst table ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_matrices_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_matrices_provider.md index 9f3536d52b..b91d7c812c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_matrices_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_matrices_provider.md @@ -14,10 +14,14 @@ Read reduced matrices for cms elements. Extract stiffness, damping, mass matrice ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 200 Required| [matrix_form](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 200 | [matrix_form](#input_200) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ If this pin i set to true, data are return as matrix form. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Fields container containing in this order : stiffness, damping, mass matrices, a ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_subfile_info_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_subfile_info_provider.md index 9efff9623b..dc039e82ff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_subfile_info_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/cms_subfile_info_provider.md @@ -14,11 +14,15 @@ Read required information from a subfile. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 200 Required| [cms_subfile_data](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 300| [output_maxdof_on_masternodes](#input_300) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 200 | [cms_subfile_data](#input_200) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 300 | [output_maxdof_on_masternodes](#input_300) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If this pin is set to true, compute and add field with max degrees of freedom on ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [int32](#output_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -71,8 +79,10 @@ returns integer values in the order : number of load vectors (nvects), number of ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md index b51c39d5f7..0a75027634 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/co_energy.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -82,6 +86,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,22 +105,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -123,6 +133,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -137,6 +149,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_motion.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_motion.md index d2d2155e52..4da9199e9a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_motion.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_motion.md @@ -14,15 +14,19 @@ Set the required data for the invariant terms computation (reduced matrices, lum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [rom_matrices](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mode_shapes](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [lumped_mass](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [model_data](#input_3) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4 Required| [field_coordinates](#input_4) |[`field`](../../core-concepts/dpf-types.md#field) | -| 5 Required| [nod](#input_5) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [phi_ortho](#input_6) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [rom_matrices](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mode_shapes](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [lumped_mass](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [model_data](#input_3) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [field_coordinates](#input_4) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 5 | [nod](#input_5) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [phi_ortho](#input_6) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -84,6 +88,10 @@ Orthonormalizated modes transformation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [model_data](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -227,8 +235,10 @@ coordinates and euler angles of all nodes ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -239,6 +249,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -253,6 +265,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_rbd.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_rbd.md index 0678f23d41..9a0b2aaf4e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_rbd.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_invariant_terms_rbd.md @@ -14,18 +14,22 @@ Set the required data for the invariant terms computation (reduced matrices, lum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [rom_matrices](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mode_shapes](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [lumped_mass](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [model_data](#input_3) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4 Required| [center_of_mass](#input_4) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 5 Required| [inertia_relief](#input_5) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 6 Required| [model_size](#input_6) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [field_coordinates](#input_7) |[`field`](../../core-concepts/dpf-types.md#field) | -| 8 Required| [nod](#input_8) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 9| [constraint_mode_check](#input_9) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [rom_matrices](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mode_shapes](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [lumped_mass](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [model_data](#input_3) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [center_of_mass](#input_4) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 5 | [inertia_relief](#input_5) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 6 | [model_size](#input_6) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [field_coordinates](#input_7) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 8 | [nod](#input_8) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [constraint_mode_check](#input_9) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ if true, the orthogonality of the constraint modes are checked. Default is false ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [model_data](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -302,8 +310,10 @@ translational and rotational shape functions ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -314,6 +324,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -328,6 +340,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress.md index a488bcd3b3..70673b62ad 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_1.md index 05f7dc38bf..3eb19b5dcc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_1.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_2.md index 411388d6e6..caae3c7223 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_2.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_3.md index 52e02593b6..cc4da49f4e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_3.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_X.md index 352e5d0194..f57b54f272 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_X.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XY.md index acecc23aa2..91ad006f7e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XY.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XZ.md index deb21b1683..ed9f07e656 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_XZ.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Y.md index db0f198b8a..f073f8cba6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Y.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_YZ.md index 19c358af3c..50965a63c1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_YZ.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Z.md index b386b0e830..d442fb665f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_Z.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_von_mises.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_von_mises.md index c5b4b2ff03..502f4228c1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_von_mises.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_stress_von_mises.md @@ -14,13 +14,17 @@ Computes the stress from an elastic strain field. compute_total_strain limitatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [strain](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [strain](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -66,6 +70,10 @@ Field/or fields container containing only the elastic strain field (element noda ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,15 +89,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -100,6 +110,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -114,6 +126,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain.md index e475c7bc4e..e2847ff61c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_1.md index 468c111d93..292e2df8bb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_1.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_2.md index dbcb8bff9b..220a3f4f9a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_2.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_3.md index 2a0993e330..75bd960e5d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_3.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_X.md index 8b4c93efb9..68247fc1b0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_X.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XY.md index b7ca94370e..69adc7d6d0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XY.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XZ.md index 4fa617f253..172762bfe2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_XZ.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Y.md index 38ba94c5aa..8409f0a470 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Y.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_YZ.md index 16b87188f1..229363599c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_YZ.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Z.md index 16661df274..b35f471ed1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/compute_total_strain_Z.md @@ -22,17 +22,21 @@ Euler Angles need to be included in the database. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [extrapolate](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [nonlinear](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [displacement](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [extrapolate](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [nonlinear](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [displacement](#input_10) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -110,6 +114,10 @@ Field/or fields container containing only the displacement field (nodal). If non ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,15 +133,17 @@ The computed result fields container (elemental nodal). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -144,6 +154,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: live post @@ -158,6 +170,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md index 2df72037ab..02c8f1bd46 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_fluid_penetration_pressure.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md index 28f781a322..3730f8d932 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_friction_stress.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md index 21de0eeba8..b1c4d2b82a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_gap_distance.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md index 50ffbdc8fe..3b286214dc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_penetration.md @@ -53,23 +53,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -195,6 +199,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -210,22 +218,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -236,6 +246,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -250,6 +262,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md index bd026a9028..f10ef1321b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_pressure.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md index b2e4d676d0..7d55f8e667 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_sliding_distance.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md index 9c78c88a1d..2a114fb36b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_status.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md index 3cebf68081..9b1ddfd2bd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_surface_heat_flux.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md index 3ae350b658..8afa24d304 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/contact_total_stress.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md index f85a54a318..99999c41c6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinate_system.md @@ -20,11 +20,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [cs_id](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [cs_id](#input_0) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -54,6 +58,10 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -69,8 +77,10 @@ The first 9 double are the rotation (3x3 matrix) and the last 3 is the translati ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -81,6 +91,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -95,6 +107,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md index b4e2206eaa..a450e099e4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/coordinates.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md index ea5e898baa..0a6c16a823 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain.md @@ -52,20 +52,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -167,6 +171,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -182,22 +190,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -208,6 +218,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -222,6 +234,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md index 3b7ea5a27a..c363809544 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_X.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md index e7b60edf96..2c5abc0444 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XY.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md index 29edcfdfb5..ee10427890 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_XZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md index 9717580772..52ee17b5f8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Y.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md index cd4ee82ff0..a6639394f6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_YZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md index 349906868b..b0e13d5b27 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_Z.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md index c68a9f939b..5037c6bb8d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_energy_density.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md index 0c9b180deb..f21410b029 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_eqv.md @@ -52,19 +52,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -158,6 +162,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -173,22 +181,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -199,6 +209,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -213,6 +225,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md index 44a0381e03..5ab6486986 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_intensity.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md index e025953ab4..42ca667bd4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_max_shear.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md index a1f5aeb642..f456cc8c6b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_1.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md index 777c61b800..12d6286c95 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_2.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md index cf7974bf12..79ec6f1cd7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/creep_strain_principal_3.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md index cea501e30a..f7f5545b93 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/current_density.md @@ -28,15 +28,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -98,6 +102,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -113,22 +121,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -139,6 +149,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -153,6 +165,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_seqv_max.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_seqv_max.md index faf54e86ae..568479a5f5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_seqv_max.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_seqv_max.md @@ -14,13 +14,17 @@ Compute the maximum of the Von Mises equivalent stress that can be expected on 3 ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 16 Required| [cyclic_support](#input_16) |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [fields_container](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [cyclic_support](#input_16) | Required|[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | @@ -66,6 +70,10 @@ default is true ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,29 +89,31 @@ FieldsContainer filled in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -114,6 +124,8 @@ Some intermediate data is put in cache if this config is set to true. This optio ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -128,6 +140,9 @@ Some intermediate data is put in cache if this config is set to true. This optio ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_usum_max.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_usum_max.md index f4934cc0bf..1b678f302a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_usum_max.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_analytic_usum_max.md @@ -14,13 +14,17 @@ Compute the maximum of the total deformation that can be expected on 360 degrees ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 16 Required| [cyclic_support](#input_16) |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [fields_container](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [cyclic_support](#input_16) | Required|[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | @@ -66,6 +70,10 @@ default is true ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,29 +89,31 @@ FieldsContainer filled in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -114,6 +124,8 @@ Some intermediate data is put in cache if this config is set to true. This optio ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -128,6 +140,9 @@ Some intermediate data is put in cache if this config is set to true. This optio ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_expansion.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_expansion.md index fae48ae5e7..9ce81d3600 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_expansion.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/cyclic_expansion.md @@ -14,19 +14,23 @@ Expand cyclic results from a fieldsContainer for given sets, sectors and scoping ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [harmonic_index](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [map_size_scoping_out](#input_6) |`umap` | -| 7| [normalization_factor](#input_7) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [merge_stages](#input_14) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 16 Required| [cyclic_support](#input_16) |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [fields_container](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [harmonic_index](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [map_size_scoping_out](#input_6) | |`umap` | +| 7 | [normalization_factor](#input_7) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [merge_stages](#input_14) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [cyclic_support](#input_16) | Required|[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -120,6 +124,10 @@ angle phi in degrees (default value 0.0) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -135,29 +143,31 @@ FieldsContainer filled in ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -168,6 +178,8 @@ Some intermediate data is put in cache if this config is set to true. This optio ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -182,6 +194,9 @@ Some intermediate data is put in cache if this config is set to true. This optio ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md index 2a9337e548..26ffe1e390 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/density.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md index 5eb8d674fe..b46a8832d7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement.md @@ -22,19 +22,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -128,6 +132,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -143,22 +151,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -169,6 +179,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -183,6 +195,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md index a47b498dbb..efe1193d19 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_X.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md index efcbdd9ed9..124f17eac9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Y.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md index d919770c4b..64fe04a883 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/displacement_Z.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md index 8a1eeea4ca..d3b6f5c9ff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/div_lighthill_tensor.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md index ac46292f53..55c4185ece 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/dynamic_viscosity.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md index fce8461f1c..3ac7f53a8f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain.md @@ -52,24 +52,28 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -203,6 +207,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -218,22 +226,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -244,6 +254,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -258,6 +270,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md index 83b796421a..d184e20c93 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_X.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md index 4bf29c59b0..efc01a2176 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XY.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md index f29d936032..07768aa2a7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_XZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md index 18c5ffa983..b46818dadf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Y.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md index 0dc9fd63c4..755515c0a7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_YZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md index 3134b3f278..36173d356e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_Z.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md index 593b2a174c..d1b6eb0db8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_energy_density.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md index 215edaadf7..62f64a24cd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_eqv.md @@ -52,19 +52,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -158,6 +162,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -173,22 +181,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -199,6 +209,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -213,6 +225,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md index f4db6b3a08..62d7f54820 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_intensity.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md index b93329e03c..231d2850e2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_max_shear.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md index 1eaa847181..c090cd6e1a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_1.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md index 9d140aaac0..48445963cd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_2.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md index a4e172f665..4ea1ab90bb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_principal_3.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md index aa7604b477..182aa6f616 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elastic_strain_rotation_by_euler_nodes.md @@ -14,11 +14,15 @@ read Euler angles on elements from the result file and rotate the fields in the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -48,6 +52,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md index 3ad2cfcf78..7946c1aff4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field.md @@ -51,20 +51,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -166,6 +170,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -181,22 +189,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -207,6 +217,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -221,6 +233,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_X.md index 281fdc1db1..333a856520 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_X.md @@ -14,18 +14,22 @@ Read/compute electric field X component of the vector (1st component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Y.md index 5896881d0a..a5c09366f8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Y.md @@ -14,18 +14,22 @@ Read/compute electric field Y component of the vector (2nd component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Z.md index 749defac0f..1824f332bd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_field_Z.md @@ -14,18 +14,22 @@ Read/compute electric field Z component of the vector (3rd component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md index 8499b0aa44..e12236df8c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density.md @@ -51,20 +51,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -166,6 +170,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -181,22 +189,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -207,6 +217,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -221,6 +233,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_X.md index bbc468c0ad..4e804f6d83 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_X.md @@ -14,18 +14,22 @@ Read/compute Electric flux density X component of the vector (1st component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Y.md index dcf5445219..6408c1ad6f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Y.md @@ -14,18 +14,22 @@ Read/compute Electric flux density Y component of the vector (2nd component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Z.md index 7031c35c59..fc60d098e2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_flux_density_Z.md @@ -14,18 +14,22 @@ Read/compute Electric flux density Z component of the vector (3rd component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md index e452c0aebd..ea0d551b6d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/electric_potential.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md index bd68ff3b4a..ceea4b8b4b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_centroids.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md index eb6c407088..d8f589f962 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_nodal_forces.md @@ -52,25 +52,29 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [split_force_components](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [split_force_components](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -212,6 +216,10 @@ If this pin is set to true, the output fields container splits the ENF by degree ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -227,22 +235,24 @@ If this pin is set to true, the output fields container splits the ENF by degree ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -253,6 +263,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -267,6 +279,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md index 4b1dfbda41..f7dce73a3a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations.md @@ -52,19 +52,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -158,6 +162,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -173,22 +181,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -199,6 +209,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -213,6 +225,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_X.md index f9bb46360a..1da1d08815 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_X.md @@ -14,18 +14,22 @@ Read/compute element euler angles X component of the vector (1st component) by c ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Y.md index 623132b76b..52baf6c70e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Y.md @@ -14,18 +14,22 @@ Read/compute element euler angles Y component of the vector (2nd component) by c ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Z.md index 6b52f715c1..367c480800 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/element_orientations_Z.md @@ -14,18 +14,22 @@ Read/compute element euler angles Z component of the vector (3rd component) by c ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md index f51663810f..d2e3553721 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_heat_generation.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md index 985477859c..9a662ede00 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_mass.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md index 1236ddd10c..808e214bc6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/elemental_volume.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md index e780dfc578..a05130938f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/enf_rotation_by_euler_nodes.md @@ -14,11 +14,15 @@ read Euler angles on elements from the result file and rotate the fields in the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -48,6 +52,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md index 1ece866b33..3cdd1fe4e0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/enthalpy.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md index dc98e2f4db..f7edb5cde2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/entropy.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md index d885933d00..68db7b3058 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/epsilon.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md index 292f2b2ef3..9b553fbb78 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_mass.md @@ -20,19 +20,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [all_dofs](#input_6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [all_dofs](#input_6) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -126,6 +130,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -141,22 +149,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -167,6 +177,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -181,6 +193,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_radiated_power.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_radiated_power.md index b287dd88d0..70d95b57fc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_radiated_power.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/equivalent_radiated_power.md @@ -14,16 +14,20 @@ Compute the Equivalent Radiated Power (ERP) ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 2 Required| [time_scoping](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3 Required| [mass_density](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [speed_of_sound](#input_4) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [erp_type](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [boolean](#input_6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [factor](#input_7) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 2 | [time_scoping](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [mass_density](#input_3) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [speed_of_sound](#input_4) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [erp_type](#input_5) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [boolean](#input_6) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [factor](#input_7) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ erp reference value. Default is 1E-12 ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,8 +116,10 @@ erp reference value. Default is 1E-12 ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -120,6 +130,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -134,6 +146,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md index 5e3ee93a17..6e63cc1b46 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/eqv_stress_parameter.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/erp_radiation_efficiency.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/erp_radiation_efficiency.md index 533eddad55..be9474e121 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/erp_radiation_efficiency.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/erp_radiation_efficiency.md @@ -14,13 +14,17 @@ Compute the radiation efficiency (enhanced erp divided by classical erp) ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 2 Required| [time_scoping](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3 Required| [mass_density](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [speed_of_sound](#input_4) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 2 | [time_scoping](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [mass_density](#input_3) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [speed_of_sound](#input_4) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ speed of sound (if it's not specified, default value of the speed of sound in th ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,8 +89,10 @@ speed of sound (if it's not specified, default value of the speed of sound in th ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_load_buckling.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_load_buckling.md index 2d15f3b7de..0e3ea8e298 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_load_buckling.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_load_buckling.md @@ -14,12 +14,16 @@ Computing Euler's Critical Load. Formula: Ncr = n*E*I*pi*pi /(L*L) ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 5 Required| [field_beam_end_condition](#input_5) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | -| 6 Required| [field_beam_moment_inertia](#input_6) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7 Required| [field_beam_young_modulus](#input_7) |[`field`](../../core-concepts/dpf-types.md#field) | -| 8 Required| [field_beam_length](#input_8) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 5 | [field_beam_end_condition](#input_5) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | +| 6 | [field_beam_moment_inertia](#input_6) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [field_beam_young_modulus](#input_7) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 8 | [field_beam_length](#input_8) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -57,6 +61,10 @@ Field of beam's length ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_euler_critical_load](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -88,8 +96,10 @@ This field contains Euler's Critical Load on axis z. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -100,6 +110,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -114,6 +126,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md index dd43376be2..2f3ac2f171 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/euler_nodes.md @@ -21,13 +21,17 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5 Required| [filter_zeros](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [coord_and_euler](#input_6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [filter_zeros](#input_5) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [coord_and_euler](#input_6) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -73,6 +77,10 @@ if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -88,8 +96,10 @@ if true, then the field has ncomp=6 with 3 coordinates and 3 Euler angles, else ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -100,6 +110,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -114,6 +126,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md index eeae0bdb02..d9836c3557 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/fluid_velocity.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md index c6f399a856..8bcd2e348a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure.md @@ -52,18 +52,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -149,6 +153,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -164,22 +172,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -190,6 +200,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -204,6 +216,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md index 4bde88d8da..612f57c6bd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_X.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md index 341fd15f63..b0fbbd16c3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XY.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md index f42cc7b01d..fafd83255a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_inelastic_closure_XZ.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md index 365269e75e..3d555364b4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress.md @@ -52,18 +52,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -149,6 +153,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -164,22 +172,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -190,6 +200,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -204,6 +216,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md index 866f1a8904..1870c43058 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_X.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md index 8e206eaa46..f55cda4138 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XY.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md index 45f136b383..0b1673cc30 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_stress_XZ.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md index 3d99953fa1..6ba8be4cbd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure.md @@ -52,18 +52,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -149,6 +153,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -164,22 +172,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -190,6 +200,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -204,6 +216,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md index 912719537e..978b33e7ee 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_X.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md index f388216f81..f195e7a6e4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XY.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md index 3a7b2b553a..8180896d57 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_thermal_closure_XZ.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -108,6 +112,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure.md index f193aa0f16..db460a6254 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure.md @@ -14,17 +14,21 @@ computes the gasket total closure (sum of gasket thermal closure and gasket inel ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -102,6 +106,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -117,8 +125,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -129,6 +139,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -143,6 +155,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_X.md index 6cdcbec9a1..3057b415b8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_X.md @@ -14,17 +14,21 @@ Read/compute elemental gasket total closure XX normal component (00 component) b ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -102,6 +106,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -117,22 +125,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -143,6 +153,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -157,6 +169,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XY.md index f8878b171a..3126bb9c64 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XY.md @@ -14,17 +14,21 @@ Read/compute elemental gasket total closure XY shear component (01 component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -102,6 +106,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -117,22 +125,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -143,6 +153,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -157,6 +169,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XZ.md index 059ec86743..503b01756b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/gasket_total_closure_XZ.md @@ -14,17 +14,21 @@ Read/compute elemental gasket total closure XZ shear component (02 component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -102,6 +106,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -117,22 +125,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -143,6 +153,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -157,6 +169,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md index db01c927ed..f4042696fc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md index dd7884145f..b98215fbae 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_added_mass_pct.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md index 5661980e44..e746c88b08 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_center_mass.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md index bc53d8e529..03d242f2c3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md index 4588dc53d8..ee3d4b805d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_energy_ratio_wo_eroded.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md index 1a0217137c..7c8502f278 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_hourglass_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md index 1cbc94db4a..ebe3cb94fc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_internal_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md index 2b33861782..d249bd49f2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_eroded_kinetic_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md index 6c31ecd4d3..0e373878a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_external_work.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md index 43ae9f0a59..ac912a5093 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_hourglass_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md index f5d40d60a6..5a40a44ab8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_internal_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md index c1d9f4af8b..373eae02e5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_joint_internal_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md index 5dc45508fb..fdfb0921f3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_kinetic_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md index 3edfea94dc..8d4a1a7119 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_rigid_body_stopper_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md index ae0370233f..b9bbed385c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_sliding_interface_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md index dcaad5d1a0..b69d8bb527 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_spring_damper_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md index 501a0f4b73..d1f5552903 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_system_damping_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md index 2ecf14be89..cd1d74ec15 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_time_step.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md index f2fa61a7cb..f58b0c5dcf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_energy.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md index a0e03ebaca..9161bb489f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_total_mass.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md index 2fa1147806..f8ca9cbaf6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/global_velocity.md @@ -21,11 +21,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -55,6 +59,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -70,8 +78,10 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md index 778b588899..702a95db28 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux.md @@ -53,24 +53,28 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -204,6 +208,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -219,22 +227,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -245,6 +255,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -259,6 +271,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md index 2027cea8ab..560d1a8c75 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_X.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md index 240691c203..b125e3d1ac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Y.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md index c433cf3ccc..de29002409 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/heat_flux_Z.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md index 89e6835531..9ffe771903 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/hydrostatic_pressure.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md index dabc196077..e2f09070c3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/incremental_energy.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -82,6 +86,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,22 +105,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -123,6 +133,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -137,6 +149,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md index b36a5e4de1..ff3a123087 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/initial_coordinates.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md index b6cb4901a1..37da3696a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/input_sound_power.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md index 472bf56222..d5bf1012a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_area.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md index 7574d1667b..b7fe1f0eb6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_force.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md index c269e670c2..b066553631 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_mass.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md index b0f335a7f0..61f7d3c5c1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_contact_moment.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md index b7b83676da..fb3fbcc8d2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/interface_resultant_contact_force.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md index 7a03a37e2d..5fac7453cc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_force_reaction.md @@ -14,15 +14,19 @@ Read/compute joint force reaction by calling the readers defined by the datasour ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md index 87150b7394..2f50bc653f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_moment_reaction.md @@ -14,15 +14,19 @@ Read/compute joint moment reaction by calling the readers defined by the datasou ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md index 74265bd25c..360c47114a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_acceleration.md @@ -14,15 +14,19 @@ Read/compute joint relative acceleration by calling the readers defined by the d ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md index 0591163198..6075cf2d22 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_acceleration.md @@ -14,15 +14,19 @@ Read/compute joint relative angular acceleration by calling the readers defined ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md index 1c92ed535b..f3488f2162 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_angular_velocity.md @@ -14,15 +14,19 @@ Read/compute joint relative angular velocity by calling the readers defined by t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md index b595ec7829..6ffc8192fa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_displacement.md @@ -14,15 +14,19 @@ Read/compute joint relative displacement by calling the readers defined by the d ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md index 248866626c..8b7ce44b05 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_rotation.md @@ -14,15 +14,19 @@ Read/compute joint relative rotation by calling the readers defined by the datas ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md index 010121d5e9..8cbf873667 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/joint_relative_velocity.md @@ -14,15 +14,19 @@ Read/compute joint relative velocity by calling the readers defined by the datas ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md index 721689900a..0a38312853 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/kinetic_energy.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/layer_orientation_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/layer_orientation_provider.md index 04ce74732a..9fdeb372f1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/layer_orientation_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/layer_orientation_provider.md @@ -14,10 +14,14 @@ Read the layer orientations. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -39,6 +43,10 @@ Result file path container, used if no streams are set. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [layer_orientation_data](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -54,8 +62,10 @@ Requested data as FieldsContainer. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md index a391dc4e55..58711397cf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mach_number.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md index e275d87bc7..5dcf6aec0b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field.md @@ -51,20 +51,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -166,6 +170,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -181,22 +189,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -207,6 +217,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -221,6 +233,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_X.md index 6e339f2868..22c0c677fe 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_X.md @@ -14,18 +14,22 @@ Read/compute Magnetic Field X component of the vector (1st component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Y.md index 9b7d39e93b..5fbfe31d44 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Y.md @@ -14,18 +14,22 @@ Read/compute Magnetic Field Y component of the vector (2nd component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Z.md index 88ebe76899..3ce6d0bf79 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_field_Z.md @@ -14,18 +14,22 @@ Read/compute Magnetic Field Z component of the vector (3rd component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md index 508234f9df..633f80f6a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density.md @@ -51,20 +51,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -166,6 +170,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -181,22 +189,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -207,6 +217,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -221,6 +233,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_X.md index c7d519c17b..8d7ef2b7fd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_X.md @@ -14,18 +14,22 @@ Read/compute Magnetic Flux Density X component of the vector (1st component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Y.md index 45310b7aaf..da2aaf46e6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Y.md @@ -14,18 +14,22 @@ Read/compute Magnetic Flux Density Y component of the vector (2nd component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Z.md index bca27a0242..5aec3f190f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_flux_density_Z.md @@ -14,18 +14,22 @@ Read/compute Magnetic Flux Density Z component of the vector (3rd component) by ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,22 +134,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -152,6 +162,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -166,6 +178,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md index 6d634ea482..1b58be668f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_scalar_potential.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md index 9c202451d4..093ceae28b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/magnetic_vector_potential.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.global_to_nodal.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.global_to_nodal.md index 139b771f37..c7f17fffa1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.global_to_nodal.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.global_to_nodal.md @@ -14,10 +14,14 @@ Rotate results from global coordinate system to local coordinate system. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ Nodal euler angles defined from a result file. Those must be the rotations from ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Rotated field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.pres_to_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.pres_to_field.md index c764bd9f27..35c01717ee 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.pres_to_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.pres_to_field.md @@ -14,10 +14,14 @@ Read the presol generated file from mapdl. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [filepath](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [columns_to_read](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [filepath](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [columns_to_read](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ columns_to_read ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ columns_to_read ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.prns_to_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.prns_to_field.md index fa89f46da3..cdecc681fe 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.prns_to_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.prns_to_field.md @@ -14,10 +14,14 @@ Read the presol of nodal field generated file from mapdl. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [filepath](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [columns_to_read](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [filepath](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [columns_to_read](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ columns_to_read ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ columns_to_read ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.run.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.run.md index 26560341a2..dad0413933 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.run.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl.run.md @@ -14,14 +14,18 @@ Solve in mapdl a dat/inp file and returns a datasources with the rst file. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [mapdl_exe_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [working_dir](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [number_of_processes](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [number_of_threads](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [server_mode](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mapdl_exe_path](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [working_dir](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [number_of_processes](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [number_of_threads](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [server_mode](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ used when a user includes commands in the input file allowing to launch DPF serv ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -106,8 +114,10 @@ returns a port when the server mode pin is set to yes ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -118,6 +128,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -132,6 +144,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_material_properties.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_material_properties.md index 480cc87908..5a61ef3f4f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_material_properties.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_material_properties.md @@ -14,12 +14,16 @@ Read the values of the properties of a material for a given materials property f ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [properties_name](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [materials](#input_1) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 3 Required| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [properties_name](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [materials](#input_1) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 3 | [streams_container](#input_3) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -57,6 +61,10 @@ Property field that contains a material id per element. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [properties_value](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -72,8 +80,10 @@ Property field that contains a material id per element. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_section.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_section.md index 88acc1bc66..32d3a2a4e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_section.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_section.md @@ -14,14 +14,18 @@ Read the values of the section properties for a given section property field (pr ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [properties_name](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [section](#input_1) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 3 Required| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [layer_property](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [layers_requested](#input_6) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [properties_name](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [section](#input_1) | |[`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 3 | [streams_container](#input_3) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [layer_property](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [layers_requested](#input_6) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ Array with layers requested for the section. Default = AllLayers. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [properties_value](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -98,8 +106,10 @@ Only available if layer_property option is set to True. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -110,6 +120,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -124,6 +136,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_on_facet_indices.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_on_facet_indices.md index 48e3dd051f..83b77b5db4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_on_facet_indices.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_on_facet_indices.md @@ -14,14 +14,18 @@ Splits each Field in a FieldsContainer defined on the skin elements of a mesh ac ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [property_field_new_elements_to_old](#input_1) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 2 Required| [facet_indices](#input_2) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 3 Required| [volume_mesh](#input_3) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 185| [degenerated_tets](#input_185) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 285| [non_degenerated_tets](#input_285) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [property_field_new_elements_to_old](#input_1) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 2 | [facet_indices](#input_2) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 3 | [volume_mesh](#input_3) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 185 | [degenerated_tets](#input_185) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 285 | [non_degenerated_tets](#input_285) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -75,6 +79,10 @@ Elemental scoping of tet elements. If connected, the tets in the scoping are tre ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -90,8 +98,10 @@ Output splitted fields containter ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md index 18c41e5c2c..5001a8f740 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mapdl_split_to_acmo_facet_indices.md @@ -14,10 +14,14 @@ This will retain the already existing labels from the input FC and will change t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [property_fields_container_element_types](#input_1) |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [property_fields_container_element_types](#input_1) | Required|[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | @@ -39,6 +43,10 @@ It should only have the 'facet' label. For each facet, it stores a PropertyField ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Output splitted fields containter ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md index b79c6446ac..9476cf6bef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_flow_rate.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md index 5fb8113914..69b5f5b64e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mass_fraction.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md index 218a5850e5..1bd52b9cf4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/material_property_of_element.md @@ -20,10 +20,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -45,6 +49,10 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [material_properties](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -60,8 +68,10 @@ material properties ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -72,6 +82,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -86,6 +98,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md index 216b0baacb..85c8544302 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_static_pressure.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md index 188ed3e4f6..7faec5fbcf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_temperature.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md index 0ea87b30b2..a9f0530e9e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/mean_velocity.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_bending_not_certified.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_bending_not_certified.md index 8e7f8eee29..503d77bfde 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_bending_not_certified.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_bending_not_certified.md @@ -14,17 +14,21 @@ This operator is a non-certified example of buckling resistance verification for ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [field_yield_strength](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [class_cross_section](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6 Required| [partial_factor](#input_6) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 8 Required| [bending_moment_y](#input_8) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 9 Required| [bending_moment_z](#input_9) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [field_yield_strength](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [class_cross_section](#input_2) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [partial_factor](#input_6) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 8 | [bending_moment_y](#input_8) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 9 | [bending_moment_z](#input_9) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -102,6 +106,10 @@ Fields Container of bending moment on axis z defined by user ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [buckling_resistance_bending_yy](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -125,8 +133,10 @@ Fields Container of buckling resistance factor on axis z-z in case of bending(M) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -137,6 +147,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -151,6 +163,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_compression_not_certified.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_compression_not_certified.md index 3f4530bccb..4a1ad6610c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_compression_not_certified.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_compression_not_certified.md @@ -14,18 +14,22 @@ This operator is a non-certified example of buckling resistance verification for ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [field_yield_strength](#input_1) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [field_end_condition](#input_2) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5 Required| [manufacture](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [partial_factor](#input_6) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 8 Required| [axial_force](#input_8) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 12 Required| [fabrication_type](#input_12) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [field_yield_strength](#input_1) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [field_end_condition](#input_2) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [manufacture](#input_5) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [partial_factor](#input_6) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 8 | [axial_force](#input_8) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 12 | [fabrication_type](#input_12) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ If there is beam I in the structure, please define its fabrication type. True: R ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [buckling_resistance_compression_yy](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -134,8 +142,10 @@ Fields Container of buckling resistance factor on axis z-z in case of compressio ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -146,6 +156,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -160,6 +172,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md index 77a9b69d2f..bf043f11e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/members_in_linear_compression_bending_not_certified.md @@ -14,21 +14,25 @@ This operator is a non-certified example of buckling resistance verification for ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [field_yield_strength](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [field_end_condition](#input_2) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [manufacture](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [partial_factor](#input_6) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 8 Required| [bending_moment_y](#input_8) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 9 Required| [bending_moment_z](#input_9) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 10 Required| [axial_force](#input_10) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 11 Required| [class_cross_section](#input_11) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 12| [fabrication_type](#input_12) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [field_yield_strength](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [field_end_condition](#input_2) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [manufacture](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [partial_factor](#input_6) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 8 | [bending_moment_y](#input_8) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 9 | [bending_moment_z](#input_9) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 10 | [axial_force](#input_10) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 11 | [class_cross_section](#input_11) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [fabrication_type](#input_12) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -138,6 +142,10 @@ Selection of fabrication's type if there are beams I in the structure. TRUE: Rol ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [buckling_resistance_linear_summation_utilization_ratios](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -153,8 +161,10 @@ Linear summation of the utilization ratios in all members submitted under a comb ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -165,6 +175,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -179,6 +191,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/migrate_to_h5dpf.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/migrate_to_h5dpf.md index 5329cb4432..5e3e5c4fd6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/migrate_to_h5dpf.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/migrate_to_h5dpf.md @@ -14,19 +14,23 @@ Read mesh properties from the results files contained in the streams or data sou ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -7| [h5_chunk_size](#input_-7) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | -| -5| [dataset_size_compression_threshold](#input_-5) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | -| -2| [h5_native_compression](#input_-2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | -| -1| [export_floats](#input_-1) |[`bool`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | -| 0 Required| [filename](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [comma_separated_list_of_results](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [all_time_sets](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [compression_workflow](#input_6) |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | -| 7| [filtering_workflow](#input_7) |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -7 | [h5_chunk_size](#input_-7) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +| -5 | [dataset_size_compression_threshold](#input_-5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +| -2 | [h5_native_compression](#input_-2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +| -1 | [export_floats](#input_-1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +| 0 | [filename](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [comma_separated_list_of_results](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [all_time_sets](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [compression_workflow](#input_6) | |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | +| 7 | [filtering_workflow](#input_7) | |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | @@ -120,6 +124,10 @@ Applies input filtering workflow. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [migrated_file](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -135,8 +143,10 @@ Applies input filtering workflow. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -147,6 +157,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -161,6 +173,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md index 9cf4c058c2..084b3f5a01 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_acceleration.md @@ -20,11 +20,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -54,6 +58,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -69,22 +77,24 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -95,6 +105,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -109,6 +121,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md index a69d8ef2ce..9666187267 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_basis.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -90,6 +94,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,22 +113,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -131,6 +141,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -145,6 +157,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md index 905dad9d0e..98bfe6d984 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_coordinate.md @@ -20,11 +20,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -54,6 +58,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -69,22 +77,24 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -95,6 +105,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -109,6 +121,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md index ac82ce5206..f868941fd9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/modal_velocity.md @@ -20,11 +20,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -54,6 +58,10 @@ result file path container, used if no streams are set ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -69,22 +77,24 @@ result file path container, used if no streams are set ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -95,6 +105,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -109,6 +121,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md index 08cc0d4d08..b39e03d9ad 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nmisc.md @@ -21,19 +21,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 10| [item_index](#input_10) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 10 | [item_index](#input_10) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -127,6 +131,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -142,22 +150,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -168,6 +178,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -182,6 +194,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md index 5eb0930a8c..693a0938ed 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_force.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md index c9453a4e31..bc2ae9d935 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_X.md index 9b70f91b5f..8501a0c278 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_X.md @@ -14,16 +14,20 @@ Read/compute nodal rotation X component of the vector (1st component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Y.md index 78620459b9..4137582dc7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Y.md @@ -14,16 +14,20 @@ Read/compute nodal rotation Y component of the vector (2nd component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Z.md index 245fe3843c..d6b1ceacaf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotation_Z.md @@ -14,16 +14,20 @@ Read/compute nodal rotation Z component of the vector (3rd component) by calling ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md index f5f443fd31..5d5fa20711 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_X.md index 494af7364c..4e0b79974b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_X.md @@ -14,16 +14,20 @@ Read/compute nodal rotational acceleration X component of the vector (1st compon ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md index 615e5ad15a..7edb1da595 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Y.md @@ -14,16 +14,20 @@ Read/compute nodal rotational acceleration Y component of the vector (2nd compon ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md index e476884e97..1f2a49d3db 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_acceleration_Z.md @@ -14,16 +14,20 @@ Read/compute nodal rotational acceleration Z component of the vector (3rd compon ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md index 0977a47ee4..71b53efca7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_X.md index b602f8a50e..3ca9c67beb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_X.md @@ -14,16 +14,20 @@ Read/compute nodal rotational velocity X component of the vector (1st component) ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Y.md index 8b7509f639..1427b214ac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Y.md @@ -14,16 +14,20 @@ Read/compute nodal rotational velocity Y component of the vector (2nd component) ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Z.md index 37c4ba680f..52b629d7db 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_rotational_velocity_Z.md @@ -14,16 +14,20 @@ Read/compute nodal rotational velocity Z component of the vector (3rd component) ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_to_global.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_to_global.md index b285b1c61f..a631469e08 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_to_global.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/nodal_to_global.md @@ -14,11 +14,15 @@ Rotates nodal elemental results to global coordinate system ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fieldA](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [fieldB](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 200| [inverse_rotation](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fieldA](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [fieldB](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 200 | [inverse_rotation](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If true, we apply the inverse rotation (default is false). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Rotated field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md index 6c12ddf928..2cf6826484 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -82,6 +86,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,22 +105,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -123,6 +133,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -137,6 +149,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_X.md index b60b4f63b5..dd76488aef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_X.md @@ -14,16 +14,20 @@ Read/compute node euler angles X component of the vector (1st component) by call ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Y.md index a6856048d8..03f6a18085 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Y.md @@ -14,16 +14,20 @@ Read/compute node euler angles Y component of the vector (2nd component) by call ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Z.md index c966564829..c6fe1a4704 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/node_orientations_Z.md @@ -14,16 +14,20 @@ Read/compute node euler angles Z component of the vector (3rd component) by call ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -108,22 +116,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -134,6 +144,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -148,6 +160,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md index b7c0b5102a..362b57d6b6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_force.md @@ -14,15 +14,19 @@ Read/compute normal contact force by calling the readers defined by the datasour ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md index b72b28dfd1..489c041a85 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/normal_contact_moment.md @@ -14,15 +14,19 @@ Read/compute normal contact moment by calling the readers defined by the datasou ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md index f4ae6b68f8..bef3dd89a8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/num_surface_status_changes.md @@ -52,23 +52,27 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -194,6 +198,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -209,22 +217,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -235,6 +245,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -249,6 +261,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md index 6c19e8fef8..acc4b1f1eb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/omega.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md index e91d108240..8e85c841e4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/output_sound_power.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md index 949eca8c28..0caf7163b9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_added_mass.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md index d13f264078..ae15da19a8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_internal_energy.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md index 97ff075f4a..f34940c7b5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_eroded_kinetic_energy.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md index c85aa5ea7b..9db921898b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_hourglass_energy.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md index 71b65259e8..fe460af6e3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_internal_energy.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md index c83b2f57d2..8afae87640 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_kinetic_energy.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md index 207d82156a..87b9ae5b76 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_momentum.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md index 3063394894..801f01c340 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/part_rigid_body_velocity.md @@ -21,12 +21,16 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 6| [entity_scoping](#input_6) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 50| [unit_system](#input_50) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 6 | [entity_scoping](#input_6) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 50 | [unit_system](#input_50) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types), `class dataProcessing::unit::CUnitSystem` | @@ -64,6 +68,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -79,8 +87,10 @@ entity (part for matsum, interface for rcforc) where the result will be scoped ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -91,6 +101,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -105,6 +117,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md index a0f3f4d820..cc72d6455d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_state_variable.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md index 1e812ce31c..67d3c45a6c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain.md @@ -52,20 +52,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -167,6 +171,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -182,22 +190,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -208,6 +218,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -222,6 +234,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md index e1d9466df4..39a1b0dfe3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_X.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md index 9a21d03b63..37b86d5833 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XY.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md index b163d76461..1978966bfa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_XZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md index 52304f7d5d..278013bd8f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Y.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md index 278313be11..dac8794ed7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_YZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md index 3dc573185b..0782346d0d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_Z.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md index 1733d52a47..5a161ffde3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_energy_density.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md index 35d4aab0bb..051ff86c4c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_eqv.md @@ -53,19 +53,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -159,6 +163,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -174,22 +182,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -200,6 +210,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -214,6 +226,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md index a04e089eee..fab0ac7b16 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_intensity.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md index 53c5e25746..456fcabfd0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_max_shear.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md index ad003dbb4e..bff89a8498 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_1.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md index 0aa62157b4..c3b2ed1b28 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_2.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md index 79161057b3..383bd96afb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_principal_3.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md index f649c8896e..e530bbea96 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/plastic_strain_rotation_by_euler_nodes.md @@ -14,11 +14,15 @@ read Euler angles on elements from the result file and rotate the fields in the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -48,6 +52,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector.md index e835e8d4be..e241ba1de8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector.md @@ -14,14 +14,18 @@ Compute the Poynting Vector ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [fields_containerC](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [fields_containerD](#input_3) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4| [abstract_meshed_region](#input_4) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 5| [int32](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [fields_containerC](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [fields_containerD](#input_3) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [abstract_meshed_region](#input_4) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 5 | [int32](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ load step number, if it's specified, the Poynting Vector is computed only on the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -90,8 +98,10 @@ load step number, if it's specified, the Poynting Vector is computed only on the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector_surface.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector_surface.md index ee7efa6ce3..e5a315abf9 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector_surface.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/poynting_vector_surface.md @@ -14,14 +14,18 @@ Compute the Poynting Vector surface integral ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_containerA](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [fields_containerB](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [fields_containerC](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [fields_containerD](#input_3) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4| [abstract_meshed_region](#input_4) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 5| [int32](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_containerA](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [fields_containerB](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [fields_containerC](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [fields_containerD](#input_3) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [abstract_meshed_region](#input_4) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 5 | [int32](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ load step number, if it's specified, the Poynting Vector is computed only on the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -90,8 +98,10 @@ load step number, if it's specified, the Poynting Vector is computed only on the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md index 718dda1042..6acf9286ce 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/pressure.md @@ -22,14 +22,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -83,6 +87,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -98,22 +106,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -124,6 +134,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -138,6 +150,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/pretension.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/pretension.md index b38d29f929..f229bcd123 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/pretension.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/pretension.md @@ -14,18 +14,22 @@ Reads the pretension adjustment and tension force. Rotation is not allowed for t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [adjustment](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -134,8 +142,10 @@ Tension Force ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -146,6 +156,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -160,6 +172,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md index ef0a55b854..96dec61b0a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_displacement.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -82,6 +86,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,22 +105,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -123,6 +133,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -137,6 +149,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md index ee9d326f24..b9b1fc0845 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/raw_reaction_force.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md index 2d9e1b9130..7d595a5720 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md index 714ba94fba..aee388cb71 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_X.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md index 15f9d881ce..41159529af 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Y.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md index aaa5005d24..671d776e7c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/reaction_force_Z.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/read_cms_rbd_file.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/read_cms_rbd_file.md index df1f009924..a545bc6a92 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/read_cms_rbd_file.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/read_cms_rbd_file.md @@ -14,9 +14,13 @@ Read the invariant terms and the model data from a cms_rbd file ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [in_cms_rbd_file_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [in_cms_rbd_file_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -30,6 +34,10 @@ file name with cms_rbd extension where to read the input cms_rbd file. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [model_data](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -221,8 +229,10 @@ translational and rotational shape functions ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -233,6 +243,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -247,6 +259,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md index d771a9c39c..a7630fe331 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/recombine_harmonic_indeces_cyclic.md @@ -14,10 +14,14 @@ Add the fields corresponding to different load steps with the same frequencies t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [is_constant](#input_1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [is_constant](#input_1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ If the result is constant, it will only copy the first result found. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,36 +62,38 @@ If the result is constant, it will only copy the first result found. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Loops are allowed to run in parallel if the value of this config is set to true. -### use_cache +### [use_cache](../../core-concepts/operator-configurations.md#use_cache) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true Some intermediate data is put in cache if this config is set to true. This option can reduce computation time after the first run. -### work_by_index +### [work_by_index](../../core-concepts/operator-configurations.md#work_by_index) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -94,6 +104,8 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -108,6 +120,9 @@ If this option is set to true, loops and comparisons by entity will be done by i ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md index 6dc6bae98b..036882c6dd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/record_reader.md @@ -20,11 +20,15 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 60 Required| [record_name](#input_60) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 60 | [record_name](#input_60) | Required| | @@ -62,6 +66,10 @@ The MAPDL records tree can be found in the following links: ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field), [`field`](../../core-concepts/dpf-types.md#field) | @@ -77,8 +85,10 @@ Output is of type property_field for integer records and of type field for doubl ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -89,6 +99,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -103,6 +115,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion.md index 1975d37bc4..cbb173b7c5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion.md @@ -14,11 +14,15 @@ Removes rigid body mode from a total displacement field by minimization. Use a r ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [reference_node_id](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [reference_node_id](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ default is the mesh in the support ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -87,8 +95,10 @@ Center of the rigid rotation ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -99,6 +109,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -113,6 +125,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion_fc.md index 16ce91fde0..7c9a110464 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/remove_rigid_body_motion_fc.md @@ -14,11 +14,15 @@ Removes rigid body mode from a total displacement field by minimization. Use a r ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [reference_node_id](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [reference_node_id](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -48,6 +52,10 @@ default is the mesh in the support ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -87,8 +95,10 @@ Center of the rigid rotation ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -99,6 +109,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -113,6 +125,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md index 781a02731b..df38867982 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/result_provider.md @@ -20,17 +20,21 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 60 Required| [result_name](#input_60) | | -| 64| [result_scripting_name](#input_64) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 60 | [result_name](#input_60) | Required| | +| 64 | [result_scripting_name](#input_64) | | | @@ -108,6 +112,10 @@ Specifies the scripting name of the result to extract;see ResultInfo for details ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -123,22 +131,24 @@ Specifies the scripting name of the result to extract;see ResultInfo for details ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -149,6 +159,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -163,6 +175,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md index 3a7c77292e..6ccc3f4b6a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation.md @@ -20,10 +20,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -45,6 +49,10 @@ If the stream is null, retrieves the file path from the data sources. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -60,8 +68,10 @@ If the stream is null, retrieves the file path from the data sources. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -72,6 +82,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -86,6 +98,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md index 421fa79bfb..f38f44c7ac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rigid_transformation_provider.md @@ -14,10 +14,14 @@ Extracts rigid body transformation from dsub file. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams](#input_3) |`stream` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams](#input_3) | |`stream` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -39,6 +43,10 @@ data source of dsub file. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ data source of dsub file. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md index 1e043a5cc5..c5cfa16199 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_static_pressure.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md index a0bd3a8267..6800fed6a7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_temperature.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md index 3a4b79edad..b55e13ff2b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rms_velocity.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/rom_data_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/rom_data_provider.md index 0057dc95e9..e1777abd7e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/rom_data_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/rom_data_provider.md @@ -14,16 +14,20 @@ Set the required data for the invariant terms computation (reduced matrices, lum ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [rom_type](#input_0) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [reduced_stiff_matrix](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [reduced_damping_matrix](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [reduced_mass_matrix](#input_3) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5 Required| [reduced_rhs_vector](#input_5) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 6 Required| [lumped_mass_matrix](#input_6) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 7 Required| [mode_shapes](#input_7) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [rom_type](#input_0) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [reduced_stiff_matrix](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [reduced_damping_matrix](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [reduced_mass_matrix](#input_3) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [reduced_rhs_vector](#input_5) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 6 | [lumped_mass_matrix](#input_6) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 7 | [mode_shapes](#input_7) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -93,6 +97,10 @@ FieldsContainers containing the customized mode shapes ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [rom_matrices](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -188,8 +196,10 @@ Orthonormalized mode shape transformation ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -200,6 +210,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -214,6 +226,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md index 1938b3b9e5..4164b73dbc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/smisc.md @@ -21,19 +21,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 10| [item_index](#input_10) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 10 | [item_index](#input_10) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -127,6 +131,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -142,22 +150,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -168,6 +178,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -182,6 +194,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md index 55cbd64e8a..bd14b6c0e4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/specific_heat.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md index 22b3b85faa..c7b60923fd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/spectrum_data.md @@ -20,10 +20,14 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -45,6 +49,10 @@ Result file path container, used if no streams are set. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [participation_factors](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -100,22 +108,24 @@ Fields container holding for each spectrum: Rigid Response Mode (0: None, 1: Gup ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -126,6 +136,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -140,6 +152,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md index 9f125c576f..987123c31f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/squared_l2norm_pressure.md @@ -20,14 +20,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -81,6 +85,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -96,22 +104,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -122,6 +132,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -136,6 +148,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md index 53bd63358a..1d635c0dd6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/state_variable.md @@ -52,20 +52,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 10| [item_index](#input_10) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [item_index](#input_10) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -167,6 +171,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -182,22 +190,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -208,6 +218,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -222,6 +234,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md index fb8c90f005..3875e67169 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/static_pressure.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md index 6c5433bb42..7fc0c9119f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stiffness_matrix_energy.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ angle phi in degrees (default value 0.0), use if cyclic expansion is to be done. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical.md index d8ace16aff..6cbc016f2d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical.md @@ -14,17 +14,21 @@ Computes the equivalent (Von Mises) elastic strains and averages it to the nodes ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 13| [poisson_ratio](#input_13) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [average_across_bodies](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [poisson_ratio](#input_13) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [average_across_bodies](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -102,6 +106,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -125,8 +133,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -137,6 +147,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mechanical_results @@ -151,6 +163,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md index bdb672a9e9..547e2860a4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/strain_eqv_as_mechanical_workflow.md @@ -14,16 +14,20 @@ Generates a workflow that computes the equivalent (Von Mises) elastic strains an ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [average_across_bodies](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [average_across_bodies](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -108,8 +116,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -120,6 +130,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mechanical_results @@ -134,6 +146,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md index e6e63cac28..0ba604dbae 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress.md @@ -53,24 +53,28 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -204,6 +208,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -219,22 +227,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -245,6 +255,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -259,6 +271,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md index 9faa015ad9..30c3818007 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_X.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md index 66d7a49932..0d4c42169a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XY.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md index 4b4356c12e..7011cfbbf3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_XZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md index 31947f179f..abf1eaf6a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Y.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md index 939898a450..1e775f4ce7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_YZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md index 5490d595ab..c8a634b6b8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_Z.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical.md index bf5c2da1bd..9732857eec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical.md @@ -14,16 +14,20 @@ Computes the equivalent (Von Mises) stresses and averages it to the nodes (by de ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [average_across_bodies](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [average_across_bodies](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -116,8 +124,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -128,6 +138,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mechanical_results @@ -142,6 +154,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md index ab0bab794a..1d8d4d489a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_eqv_as_mechanical_workflow.md @@ -14,16 +14,20 @@ Generates a workflow that computes the equivalent (Von Mises) stresses and avera ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 200| [average_across_bodies](#input_200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 200 | [average_across_bodies](#input_200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -93,6 +97,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -108,8 +116,10 @@ for multibody simulations, the stresses are averaged across bodies if true or no ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -120,6 +130,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mechanical_results @@ -134,6 +146,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md index 4856dec4fe..168d1614dd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_intensity.md @@ -22,18 +22,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -119,6 +123,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -134,22 +142,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -160,6 +170,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -174,6 +186,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md index 33a312bc62..3589e9d95d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_max_shear.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md index bb35625884..863b327899 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_1.md @@ -22,18 +22,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -119,6 +123,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -134,22 +142,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -160,6 +170,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -174,6 +186,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md index 6715af1a7c..f16704a01e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_2.md @@ -22,18 +22,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -119,6 +123,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -134,22 +142,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -160,6 +170,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -174,6 +186,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md index 3055e6330f..731398fbea 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_principal_3.md @@ -22,18 +22,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -119,6 +123,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -134,22 +142,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -160,6 +170,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -174,6 +186,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md index 20db0cba37..1cb251fdf1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_ratio.md @@ -51,19 +51,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -157,6 +161,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -172,22 +180,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -198,6 +208,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -212,6 +224,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md index 2f5354f2f3..fe297d8c78 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_rotation_by_euler_nodes.md @@ -14,11 +14,15 @@ read Euler angles on elements from the result file and rotate the fields in the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container), `stream`, `class dataProcessing::CRstFileWrapper` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -48,6 +52,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ read Euler angles on elements from the result file and rotate the fields in the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md index 8d77ae437a..68e854d34d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/stress_von_mises.md @@ -23,18 +23,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -120,6 +124,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -135,22 +143,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -161,6 +171,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -175,6 +187,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md index 9263b93d67..82fc392b7e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/structural_temperature.md @@ -52,19 +52,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -158,6 +162,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -173,22 +181,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -199,6 +209,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -213,6 +225,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md index f5663c442b..c062a2ac03 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/superficial_velocity.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md index 87d844e93c..d6e36ca78d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/surface_heat_rate.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md index 47be5d24cd..63416e5f08 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/swelling_strains.md @@ -52,19 +52,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -158,6 +162,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -173,22 +181,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -199,6 +209,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -213,6 +225,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md index f284596507..3843dccac7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_force.md @@ -14,15 +14,19 @@ Read/compute tangential contact force by calling the readers defined by the data ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md index 9bf1aa0c0e..06ed0ccc3e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/tangential_contact_moment.md @@ -14,15 +14,19 @@ Read/compute tangential contact moment by calling the readers defined by the dat ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md index a12e6ee54a..2a60059ee3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature.md @@ -23,20 +23,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -138,6 +142,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -153,22 +161,24 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -179,6 +189,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -193,6 +205,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md index e402f2c81b..6d5fe8574b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad.md @@ -52,20 +52,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -167,6 +171,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -182,22 +190,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -208,6 +218,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -222,6 +234,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md index cadb9d22e7..6cd0642a2f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_X.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md index fe51e3fe78..8b8997eab3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Y.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md index 844f9c8bf7..0f6f8a42cb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/temperature_grad_Z.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md index 159c48ff14..92d3222925 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_conductivity.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md index ffa8927cfe..f5716e1ee8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_dissipation_energy.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -82,6 +86,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,22 +105,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -123,6 +133,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -137,6 +149,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md index 9f78e7aeb6..5235a82ef6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain.md @@ -52,20 +52,24 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -167,6 +171,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -182,22 +190,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -208,6 +218,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -222,6 +234,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md index 4f23f0bdbb..5f48ac93c6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_X.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md index a39ee8b0ab..1c0b33fddd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XY.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md index f5823a104c..e7f685cb17 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_XZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md index 372384c229..a47e43f182 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Y.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md index 6f6aea3f3a..d0bff0ddff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_YZ.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md index 36c126c498..78ee15a80f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_Z.md @@ -20,18 +20,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -117,6 +121,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -132,22 +140,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -158,6 +168,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -172,6 +184,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md index 38c0753102..b13369d9a6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_1.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md index ecdd1af16a..2da071dbea 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_2.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md index 2cb6c7084b..fc99519168 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strain_principal_3.md @@ -21,18 +21,22 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -118,6 +122,10 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -133,22 +141,24 @@ elemental nodal beam results are read if this pin is set to true (default is fal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -159,6 +169,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -173,6 +185,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md index e0bedd590e..292e48d52e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thermal_strains_eqv.md @@ -52,19 +52,23 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 22| [read_beams](#input_22) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 26| [split_shells](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 27| [shell_layer](#input_27) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 28| [extend_to_mid_nodes](#input_28) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [read_beams](#input_22) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 26 | [split_shells](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 27 | [shell_layer](#input_27) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 28 | [extend_to_mid_nodes](#input_28) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -158,6 +162,10 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -173,22 +181,24 @@ Compute mid nodes (when available) by averaging the neighbour corner nodes. Defa ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -199,6 +209,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -213,6 +225,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md index 624e99317a..73c1348c92 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/thickness.md @@ -21,14 +21,18 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -82,6 +86,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -97,22 +105,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -123,6 +133,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -137,6 +149,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/torque.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/torque.md index 2bc1e664ea..ed21c20cdc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/torque.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/torque.md @@ -14,10 +14,14 @@ Compute torque of a force based on a 3D point. The torque is computed in units c ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [spoint](#input_1) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [spoint](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -39,6 +43,10 @@ Field or fields container containing the summation points for each associated fi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Field or fields container containing the summation points for each associated fi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md index 9ca27b6483..f79985cb9c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_force.md @@ -14,15 +14,19 @@ Read/compute total contact force by calling the readers defined by the datasourc ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md index 6d63f1e6c3..2ba74c52b8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_contact_moment.md @@ -14,15 +14,19 @@ Read/compute total contact moment by calling the readers defined by the datasour ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -84,6 +88,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,22 +107,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -125,6 +135,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -139,6 +151,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md index 901fb2596f..920e537cce 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_mass.md @@ -14,9 +14,13 @@ Reads total mass from mode file. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -30,6 +34,10 @@ Data sources (must contain at least one mode file). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mass](#output_0) |[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -45,8 +53,10 @@ the unit should be grabbed from the rst file ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md index 8eb28484e6..b7de567262 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_pressure.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md index 56d0a93b3a..b576e38a3f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_strain.md @@ -21,15 +21,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -91,6 +95,10 @@ prevents from reading the mesh in the result files ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -106,22 +114,24 @@ prevents from reading the mesh in the result files ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -132,6 +142,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -146,6 +158,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md index d98b389343..efe73c23d5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/total_temperature.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/transform_invariant_terms_rbd.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/transform_invariant_terms_rbd.md index 5d8c99728f..4a2946f456 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/transform_invariant_terms_rbd.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/transform_invariant_terms_rbd.md @@ -14,33 +14,37 @@ Transform invariant terms rbd based on a coordinate system (translation + rotati ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [rotation_matrix](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [coordinate_system](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [model_data](#input_2) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 3 Required| [center_of_mass](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | -| 4 Required| [inertia_relief](#input_4) |[`field`](../../core-concepts/dpf-types.md#field) | -| 5 Required| [model_size](#input_5) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [master_node_coordinates](#input_6) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [v_trsf](#input_7) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 8 Required| [k_mat](#input_8) |[`field`](../../core-concepts/dpf-types.md#field) | -| 9 Required| [mass_mat](#input_9) |[`field`](../../core-concepts/dpf-types.md#field) | -| 10 Required| [c_mat](#input_10) |[`field`](../../core-concepts/dpf-types.md#field) | -| 11 Required| [rhs](#input_11) |[`field`](../../core-concepts/dpf-types.md#field) | -| 12 Required| [dn](#input_12) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 13 Required| [dr_cross_n](#input_13) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 14 Required| [drn](#input_14) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 15 Required| [dn_cross_n](#input_15) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 16 Required| [dnx_y](#input_16) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 17 Required| [dny_y](#input_17) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 18 Required| [dnz_y](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 19 Required| [dyx_n](#input_19) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 20 Required| [dyy_n](#input_20) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 21 Required| [dyz_n](#input_21) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 22 Required| [dnxn](#input_22) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 23 Required| [dnyn](#input_23) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 24 Required| [dnzn](#input_24) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [rotation_matrix](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [coordinate_system](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [model_data](#input_2) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 3 | [center_of_mass](#input_3) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 4 | [inertia_relief](#input_4) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 5 | [model_size](#input_5) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [master_node_coordinates](#input_6) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [v_trsf](#input_7) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [k_mat](#input_8) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 9 | [mass_mat](#input_9) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 10 | [c_mat](#input_10) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 11 | [rhs](#input_11) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 12 | [dn](#input_12) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [dr_cross_n](#input_13) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [drn](#input_14) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [dn_cross_n](#input_15) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [dnx_y](#input_16) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 17 | [dny_y](#input_17) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 18 | [dnz_y](#input_18) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 19 | [dyx_n](#input_19) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 20 | [dyy_n](#input_20) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 21 | [dyz_n](#input_21) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [dnxn](#input_22) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 23 | [dnyn](#input_23) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 24 | [dnzn](#input_24) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -246,6 +250,10 @@ translational and rotational shape functions ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [model_data](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -437,15 +445,17 @@ translational and rotational shape functions ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### inplace +### [inplace](../../core-concepts/operator-configurations.md#inplace) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false The output is written over the input to save memory if this config is set to true. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -456,6 +466,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -470,6 +482,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/transient_rayleigh_integration.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/transient_rayleigh_integration.md index 8cb51b74e2..905a87d2ef 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/transient_rayleigh_integration.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/transient_rayleigh_integration.md @@ -14,15 +14,19 @@ Computes the transient Rayleigh integral ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 2 Required| [time_scoping](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3 Required| [field](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | -| 4 Required| [observation_mesh](#input_4) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 5 Required| [mass_density](#input_5) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [speed_of_sound](#input_6) |[`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 2 | [time_scoping](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [field](#input_3) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 4 | [observation_mesh](#input_4) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 5 | [mass_density](#input_5) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [speed_of_sound](#input_6) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -84,6 +88,10 @@ Speed of sound (if it's not specified, default value of the speed of sound in th ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -99,8 +107,10 @@ Speed of sound (if it's not specified, default value of the speed of sound in th ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -111,6 +121,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -125,6 +137,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md index f8c6710314..af62514b6a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_kinetic_energy.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md index 129edd23b1..9ffda022eb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/turbulent_viscosity.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md index cbd6510ac7..c5081f3efc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity.md @@ -23,21 +23,25 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 15| [expanded_meshed_region](#input_15) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 18| [sectors_to_expand](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 19| [phi](#input_19) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [expanded_meshed_region](#input_15) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 18 | [sectors_to_expand](#input_18) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 19 | [phi](#input_19) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -147,6 +151,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -162,22 +170,24 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -188,6 +198,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -202,6 +214,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md index 3174832ffe..8b01f0b8ae 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_X.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md index 10b1a124e4..852c565f23 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Y.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md index 3f23b34ffa..746448fb2e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/velocity_Z.md @@ -20,16 +20,20 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [fields_container](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [bool_rotate_to_global](#input_5) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 14| [read_cyclic](#input_14) |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [fields_container](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [bool_rotate_to_global](#input_5) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 14 | [read_cyclic](#input_14) | |`enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -99,6 +103,10 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -114,22 +122,24 @@ if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -140,6 +150,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -154,6 +166,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md index 5427794507..7ace397d40 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/volume_fraction.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md index 8c36f59ea5..130fd1f050 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/wall_shear_stress.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_component.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_component.md index d943390556..94402d4b58 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_component.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_component.md @@ -14,14 +14,18 @@ Calculates the cumulated energy per component (Named Selection). For cyclic and ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 2| [energy_type](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [named_selection](#input_5) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 2 | [energy_type](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [named_selection](#input_5) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ Named Selections. Intersection of all Named Selections with the master scoping ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [component_energy](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -146,8 +154,10 @@ Named Selections. Intersection of all Named Selections with the master scoping ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -158,6 +168,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -172,6 +184,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_harmonic.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_harmonic.md index 74b73a6b8c..73ffc28f9f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_harmonic.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/workflow_energy_per_harmonic.md @@ -14,13 +14,17 @@ Calculates the cumulated energy per harmonic in a multistage multiharmonic model ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [energy_type](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [stream](#input_3) |`stream` | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [energy_type](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [stream](#input_3) | Required|`stream` | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -66,6 +70,10 @@ Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [harmonic_energy](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -89,8 +97,10 @@ Type of energy to be processed: (0: Strain + Kinetic energy (default), 1: Strain ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -101,6 +111,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: mapdl @@ -115,6 +127,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/write_cms_rbd_file.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/write_cms_rbd_file.md index 242edd03b7..ca593a3c6f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/write_cms_rbd_file.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/write_cms_rbd_file.md @@ -14,32 +14,36 @@ Write the invariant terms and the model data in a cms_rbd file ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [model_data](#input_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 1 Required| [center_of_mass](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2 Required| [inertia_relief](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | -| 3 Required| [model_size](#input_3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 4 Required| [master_node_coordinates](#input_4) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [v_trsf](#input_5) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [k_mat](#input_6) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7 Required| [mass_mat](#input_7) |[`field`](../../core-concepts/dpf-types.md#field) | -| 8 Required| [c_mat](#input_8) |[`field`](../../core-concepts/dpf-types.md#field) | -| 9 Required| [rhs](#input_9) |[`field`](../../core-concepts/dpf-types.md#field) | -| 10 Required| [dn](#input_10) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 11 Required| [dr_cross_n](#input_11) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 12 Required| [drn](#input_12) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 13 Required| [dn_cross_n](#input_13) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 14 Required| [dnx_y](#input_14) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 15 Required| [dny_y](#input_15) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 16 Required| [dnz_y](#input_16) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 17 Required| [dyx_n](#input_17) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 18 Required| [dyy_n](#input_18) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 19 Required| [dyz_n](#input_19) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 20 Required| [dnxn](#input_20) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 21 Required| [dnyn](#input_21) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 22 Required| [dnzn](#input_22) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 23 Required| [file_path](#input_23) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [model_data](#input_0) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 1 | [center_of_mass](#input_1) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [inertia_relief](#input_2) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [model_size](#input_3) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [master_node_coordinates](#input_4) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [v_trsf](#input_5) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [k_mat](#input_6) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [mass_mat](#input_7) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 8 | [c_mat](#input_8) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 9 | [rhs](#input_9) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 10 | [dn](#input_10) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 11 | [dr_cross_n](#input_11) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [drn](#input_12) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [dn_cross_n](#input_13) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [dnx_y](#input_14) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [dny_y](#input_15) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [dnz_y](#input_16) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 17 | [dyx_n](#input_17) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 18 | [dyy_n](#input_18) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 19 | [dyz_n](#input_19) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 20 | [dnxn](#input_20) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 21 | [dnyn](#input_21) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 22 | [dnzn](#input_22) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 23 | [file_path](#input_23) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -237,6 +241,10 @@ path with cms_rbd extension where the export occurs ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -252,8 +260,10 @@ Data Source containing the cms_rbd file generated. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -264,6 +274,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -278,6 +290,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/write_motion_dfmf_file.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/write_motion_dfmf_file.md index b1fd69bfac..983ad10d57 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/write_motion_dfmf_file.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/write_motion_dfmf_file.md @@ -14,27 +14,31 @@ Write the invariant terms and the model data in a motion dfmf file ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [model_data](#input_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 1 Required| [mode_shapes](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2 Required| [lumped_mass](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3 Required| [field_coordinates](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | -| 4 Required| [nod](#input_4) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 5 Required| [used_node_index](#input_5) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 6 Required| [eigenvalue](#input_6) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [translational_mode_shape](#input_7) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 8 Required| [rotational_mode_shape](#input_8) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 9 Required| [invrt_1](#input_9) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 10 Required| [invrt_2](#input_10) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 11 Required| [invrt_3](#input_11) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 12 Required| [invrt_4](#input_12) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 13 Required| [invrt_5](#input_13) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 14 Required| [invrt_6](#input_14) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 15 Required| [invrt_7](#input_15) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 16 Required| [invrt_8](#input_16) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 17 Required| [dfmffile_path](#input_17) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 18 Required| [rstfile_path](#input_18) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [model_data](#input_0) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 1 | [mode_shapes](#input_1) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [lumped_mass](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [field_coordinates](#input_3) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 4 | [nod](#input_4) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [used_node_index](#input_5) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [eigenvalue](#input_6) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [translational_mode_shape](#input_7) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [rotational_mode_shape](#input_8) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [invrt_1](#input_9) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 10 | [invrt_2](#input_10) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 11 | [invrt_3](#input_11) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [invrt_4](#input_12) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [invrt_5](#input_13) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 14 | [invrt_6](#input_14) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 15 | [invrt_7](#input_15) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 16 | [invrt_8](#input_16) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 17 | [dfmffile_path](#input_17) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 18 | [rstfile_path](#input_18) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -192,6 +196,10 @@ path with motion dfmf extension where the export occurs ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [dfmf_data_source](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -207,8 +215,10 @@ Data Source containing the dfmf file generated. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -219,6 +229,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -233,6 +245,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md b/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md index 83b0149dbb..398eb1d796 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/result/y_plus.md @@ -20,15 +20,19 @@ This operator supports the following keys ([file formats](../../index.md#overvie ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_scoping](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 25| [region_scoping](#input_25) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1000| [qualifiers](#input_1000) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_scoping](#input_1) | |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 25 | [region_scoping](#input_25) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [qualifiers](#input_1000) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -90,6 +94,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -105,8 +113,10 @@ region id (integer) or vector of region ids (vector) or region scoping (scoping) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -117,6 +127,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: result **Plugin**: core @@ -131,6 +143,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/adapt_with_scopings_container.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/adapt_with_scopings_container.md index 9faddb57a3..29bdabba11 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/adapt_with_scopings_container.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/adapt_with_scopings_container.md @@ -14,11 +14,15 @@ Rescopes/splits a fields container to correspond to a scopings container. Each f ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [scopings_container](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 2| [keep_empty_fields](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_or_fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [scopings_container](#input_1) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 2 | [keep_empty_fields](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Whether to keep fields that become empty after rescoping. Default is false. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,22 +71,24 @@ Fields container with rescoped fields, combining labels from input fields and sc ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/change_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/change_fc.md index 26130cab20..a73f7f7d69 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/change_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/change_fc.md @@ -14,10 +14,14 @@ DEPRECATED, PLEASE USE ADAPT WITH SCOPINGS CONTAINER. Rescopes/splits a fields c ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [scopings_container](#input_1) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_or_fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [scopings_container](#input_1) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -39,6 +43,10 @@ Scopings container for rescoping operation ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,22 +62,24 @@ FieldsContainer rescoped according to scopings container (DEPRECATED - use adapt ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -80,6 +90,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -94,6 +106,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/compute_element_centroids.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/compute_element_centroids.md index 03d2110ee1..928a790019 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/compute_element_centroids.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/compute_element_centroids.md @@ -14,10 +14,14 @@ Computes the element centroids of the mesh. It also outputs the element measure. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [element_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [element_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -39,6 +43,10 @@ Mesh to compute centroids ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [centroids](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -62,15 +70,17 @@ element measure (length, surface or volume depending on the dimension of the ele ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -81,6 +91,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -95,6 +107,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/connectivity_ids.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/connectivity_ids.md index 0cf0637984..f818a2b010 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/connectivity_ids.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/connectivity_ids.md @@ -14,11 +14,15 @@ Returns the ordered node ids corresponding to the element ids scoping in input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1 Required| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 10| [take_mid_nodes](#input_10) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 10 | [take_mid_nodes](#input_10) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ default is true ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -71,8 +79,10 @@ same as the input scoping but with ids duplicated to have the same size as nodal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -83,6 +93,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -97,6 +109,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/elemental_from_mesh.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/elemental_from_mesh.md index 910d98855a..5e8ea6fffb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/elemental_from_mesh.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/elemental_from_mesh.md @@ -14,9 +14,13 @@ Retrieves the elemental scoping from a mesh, containing all element IDs with ele ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -30,6 +34,10 @@ Mesh from which to extract the elemental scoping ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -45,8 +53,10 @@ Scoping containing all element IDs in the mesh with 'Elemental' location ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/from_mesh.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/from_mesh.md index aba635b4d7..35f7b27776 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/from_mesh.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/from_mesh.md @@ -14,10 +14,14 @@ Provides the entire mesh scoping based on the requested location ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [requested_location](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [requested_location](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ if nothing the operator returns the nodes scoping, possible locations are: Nodal ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -54,8 +62,10 @@ if nothing the operator returns the nodes scoping, possible locations are: Nodal ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/intersect.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/intersect.md index ff64e35a74..9f7e927ce3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/intersect.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/intersect.md @@ -14,10 +14,14 @@ Intersect 2 scopings and return the intersection and the difference between the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [scopingA](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1 Required| [scopingB](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [scopingA](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [scopingB](#input_1) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -39,6 +43,10 @@ Intersect 2 scopings and return the intersection and the difference between the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [intersection](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -62,8 +70,10 @@ Intersect 2 scopings and return the intersection and the difference between the ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/nodal_from_mesh.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/nodal_from_mesh.md index 6da55f7626..8fdc14f2bd 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/nodal_from_mesh.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/nodal_from_mesh.md @@ -14,9 +14,13 @@ Retrieves the nodal scoping from a mesh, containing all node IDs. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -30,6 +34,10 @@ Mesh from which to extract the nodal scoping ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -45,8 +53,10 @@ Scoping containing all node IDs in the mesh ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_mesh_property.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_mesh_property.md index 2efceebfe9..fe7cdec708 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_mesh_property.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_mesh_property.md @@ -14,13 +14,17 @@ Provides a scoping on a given property name and a property number. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [requested_location](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [property_id](#input_2) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [inclusive](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [requested_location](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property_id](#input_2) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [inclusive](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -66,6 +70,10 @@ Default is 1 (inclusive is true). Only used if 'shape_values' property is reques ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -81,8 +89,10 @@ Scoping ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_named_selection.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_named_selection.md index 48533df440..968b0f67cc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_named_selection.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_named_selection.md @@ -14,13 +14,17 @@ provides a scoping at a given location based on a given named selection ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [requested_location](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [named_selection_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [int_inclusive](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [requested_location](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [named_selection_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [int_inclusive](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -66,6 +70,10 @@ If element scoping is requested on a nodal named selection, if Inclusive == 1 th ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -81,8 +89,10 @@ If element scoping is requested on a nodal named selection, if Inclusive == 1 th ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_property.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_property.md index bc53b3ab0f..d08d5c240c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_property.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/on_property.md @@ -14,14 +14,18 @@ Provides a scoping at a given location based on a given property name and a prop ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [requested_location](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [property_id](#input_2) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [inclusive](#input_5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [requested_location](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property_id](#input_2) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [inclusive](#input_5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ If element scoping is requested on a nodal named selection, if inclusive == 1 th ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -90,8 +98,10 @@ Scoping ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/reduce_sampling.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/reduce_sampling.md index d3977861e4..2462dbf529 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/reduce_sampling.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/reduce_sampling.md @@ -14,10 +14,14 @@ Take a scoping and remove half of it's content. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [denominator](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh_scoping](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [denominator](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Set the number of time the scoping is reduced (default is 2). Must be integer va ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -54,8 +62,10 @@ Set the number of time the scoping is reduced (default is 2). Must be integer va ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope.md index 52bcc51951..7b1cd81420 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope.md @@ -14,11 +14,15 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If pin 2 is used, the IDs not found in the field are added with this default val ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -63,22 +71,24 @@ If pin 2 is used, the IDs not found in the field are added with this default val ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_custom_type_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_custom_type_field.md index e491bb14a2..e5b70989a1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_custom_type_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_custom_type_field.md @@ -14,11 +14,15 @@ Rescopes a custom type field on the given scoping. If an ID does not exist in th ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields](#input_0) |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields](#input_0) | Required|[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | @@ -48,6 +52,10 @@ If pin 2 is used, the IDs not found in the custom type field are added with this ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields](#output_0) |[`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field) | @@ -63,22 +71,24 @@ If pin 2 is used, the IDs not found in the custom type field are added with this ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_fc.md index 4e2f12e703..3183528d25 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_fc.md @@ -14,11 +14,15 @@ Rescopes a field on the given scoping. If an ID does not exist in the original f ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If pin 2 is used, the IDs not found in the field are added with this default val ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,22 +71,24 @@ If pin 2 is used, the IDs not found in the field are added with this default val ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_property_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_property_field.md index 978e72ef9b..20146dc678 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_property_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/rescope_property_field.md @@ -14,11 +14,15 @@ Rescopes a property field on the given scoping. If an ID does not exist in the o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields](#input_0) |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [default_value](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields](#input_0) | Required|[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [default_value](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If pin 2 is used, the IDs not found in the property field are added with this de ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [fields](#output_0) |[`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -63,22 +71,24 @@ If pin 2 is used, the IDs not found in the property field are added with this de ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/scoping_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/scoping_get_attribute.md index 69bb9f2e56..9208a71f68 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/scoping_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/scoping_get_attribute.md @@ -14,10 +14,14 @@ Uses the Scoping APIs to return a given attribute of the scoping in input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [scoping](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Supported property names are: "ids", "location". ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -54,8 +62,10 @@ Returns a vector of int for property: "ids" and a string for property: "location ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/split_on_property_type.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/split_on_property_type.md index 9976f4dfce..74109b0901 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/split_on_property_type.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/split_on_property_type.md @@ -14,13 +14,17 @@ Splits a given scoping or the mesh scoping (nodal or elemental) on given propert ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 9 Required| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 12| [skin_case](#input_12) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 13| [label](#input_13) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 9 | [requested_location](#input_9) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 12 | [skin_case](#input_12) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 13 | [label](#input_13) | |[`string`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ properties to apply the filtering 'mat' and/or 'elshape' (since 2025R1 it suppor ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -81,8 +89,10 @@ Scoping ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/transpose.md b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/transpose.md index 6232fdc22a..ffd395f367 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/scoping/transpose.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/scoping/transpose.md @@ -14,12 +14,16 @@ Transposes the input scoping or scopings container (Elemental/Faces --> Nodal, o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 1 Required| [meshed_region](#input_1) |[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 2| [inclusive](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 9| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh_scoping](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 1 | [meshed_region](#input_1) | Required|[`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 2 | [inclusive](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 9 | [requested_location](#input_9) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Output scoping location for meshes with nodes, faces and elements. By default, e ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -72,8 +80,10 @@ Scoping or scopings container (the input type is the output type) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: scoping **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/csv_to_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/csv_to_field.md index e719c9cfbc..50294f35bb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/csv_to_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/csv_to_field.md @@ -14,10 +14,14 @@ transform csv file to a field or fields container ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -39,6 +43,10 @@ data sources containing a file with csv extension ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ data sources containing a file with csv extension ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: csv @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_json.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_json.md index b58712e1cf..6baec6070c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_json.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_json.md @@ -14,10 +14,14 @@ Writes a json file or string from a DataTree ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [data_tree](#input_0) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 1| [path](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [data_tree](#input_0) | Required|[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 1 | [path](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Writes a json file or string from a DataTree ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -54,8 +62,10 @@ Writes a json file or string from a DataTree ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_txt.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_txt.md index a918561cba..35e6aff9f6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_txt.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/data_tree_to_txt.md @@ -14,10 +14,14 @@ Writes a txt file or string from a DataTree ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [data_tree](#input_0) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 1| [path](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [data_tree](#input_0) | Required|[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 1 | [path](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Writes a txt file or string from a DataTree ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -54,8 +62,10 @@ Writes a txt file or string from a DataTree ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/deserializer.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/deserializer.md index 3430faa3a5..0eb2bbae2a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/deserializer.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/deserializer.md @@ -14,10 +14,14 @@ Takes a file generated by the serializer and deserializes it into DPF's entities ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1 Required| [stream_type](#input_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [file_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [stream_type](#input_-1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [file_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ file path ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **1**| [any_output](#output_1) |[`any`](../../core-concepts/dpf-types.md#any) | @@ -54,8 +62,10 @@ number and types of outputs corresponding of the inputs used in the serializatio ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_mesh_with_prime.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_mesh_with_prime.md index 52b4ac664b..d8b650a525 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_mesh_with_prime.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_mesh_with_prime.md @@ -14,10 +14,14 @@ Transfer DPF's meshed region into an external layer prime model and serialize it ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [mesh](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [mesh](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -39,6 +43,10 @@ path(with the file extension) to export ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| @@ -46,8 +54,10 @@ path(with the file extension) to export ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -58,6 +68,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: N/A @@ -72,6 +84,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md index 887950d0aa..f35c159940 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/export_symbolic_workflow.md @@ -14,12 +14,16 @@ Transforms a Workflow into a symbolic Workflow and writes it to a file (if a pat ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [workflow](#input_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | -| 1| [path](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [format](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [options](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [workflow](#input_0) | Required|[`workflow`](../../core-concepts/dpf-types.md#workflow) | +| 1 | [path](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [format](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [options](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Transforms a Workflow into a symbolic Workflow and writes it to a file (if a pat ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources), [`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -72,8 +80,10 @@ Transforms a Workflow into a symbolic Workflow and writes it to a file (if a pat ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/field_to_csv.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/field_to_csv.md index 4d91cb457c..d539b2c277 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/field_to_csv.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/field_to_csv.md @@ -14,11 +14,15 @@ Exports a field or a fields container into a csv file. Currently only homogenous ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field_or_fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [file_path](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [storage_type](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_or_fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [file_path](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [storage_type](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ storage type : if matrices (without any particularity) are included in the field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| @@ -55,8 +63,10 @@ storage type : if matrices (without any particularity) are included in the field ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -67,6 +77,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: csv @@ -81,6 +93,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_custom_read.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_custom_read.md index 6c9a0be1de..c045400bb8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_custom_read.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_custom_read.md @@ -14,14 +14,18 @@ Extract a custom result from an hdf5dpf file. This operator is deprecated, pleas ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 24| [meta_data](#input_24) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 60 Required| [result_name](#input_60) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 24 | [meta_data](#input_24) | |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 60 | [result_name](#input_60) | Required| | @@ -75,6 +79,10 @@ Name of the result that must be extracted from the hdf5dpf file ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_or_fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -90,8 +98,10 @@ Name of the result that must be extracted from the hdf5dpf file ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md index 8d0cade989..eebd307118 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/hdf5dpf_generate_result_file.md @@ -14,18 +14,22 @@ Generate a dpf result file from provided information. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -7| [h5_chunk_size](#input_-7) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| -6| [append_mode](#input_-6) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| -5| [dataset_size_compression_threshold](#input_-5) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| -2| [h5_native_compression](#input_-2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| -1| [export_floats](#input_-1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [filename](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh_provider_out](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2| [time_freq_support_out](#input_2) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 3| [ansys_unit_system_id](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`result_info`](../../core-concepts/dpf-types.md#result-info) | -| 4| [input_name](#input_4) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`any`](../../core-concepts/dpf-types.md#any) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -7 | [h5_chunk_size](#input_-7) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| -6 | [append_mode](#input_-6) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| -5 | [dataset_size_compression_threshold](#input_-5) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| -2 | [h5_native_compression](#input_-2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| -1 | [export_floats](#input_-1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [filename](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh_provider_out](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [time_freq_support_out](#input_2) | |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 3 | [ansys_unit_system_id](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`result_info`](../../core-concepts/dpf-types.md#result-info) | +| 4 | [input_name](#input_4) | |[`string`](../../core-concepts/dpf-types.md#standard-types), [`any`](../../core-concepts/dpf-types.md#any) | @@ -111,6 +115,10 @@ Set of even and odd pins to serialize results. Odd pins (4, 6, 8...) are strings ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -126,15 +134,17 @@ data_sources filled with the H5 generated file path. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### evaluate_inputs_before_run +### [evaluate_inputs_before_run](../../core-concepts/operator-configurations.md#evaluate_inputs_before_run) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -145,6 +155,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -159,6 +171,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md index 1d20e80bbb..4de5d705da 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/import_symbolic_workflow.md @@ -14,10 +14,14 @@ Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow wi ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [string_or_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 2| [format](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [string_or_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 2 | [format](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow wi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -54,8 +62,10 @@ Reads a file or string holding a Symbolic Workflow and instantiate a WorkFlow wi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/json_to_data_tree.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/json_to_data_tree.md index dafbc16aad..784216514b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/json_to_data_tree.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/json_to_data_tree.md @@ -14,9 +14,13 @@ Reads a json file or string to a DataTree ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [string_or_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [string_or_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -30,6 +34,10 @@ Reads a json file or string to a DataTree ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_tree](#output_0) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -45,8 +53,10 @@ Reads a json file or string to a DataTree ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/mechanical_csv_to_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/mechanical_csv_to_field.md index 7ba526d79f..a2fca2c192 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/mechanical_csv_to_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/mechanical_csv_to_field.md @@ -14,12 +14,16 @@ Reads mechanical exported csv file ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [unit](#input_0) |`class dataProcessing::unit::CUnit` | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 9 Required| [requested_location](#input_9) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`field_definition`](../../core-concepts/dpf-types.md#field-definition) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [unit](#input_0) | Required|`class dataProcessing::unit::CUnit` | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 9 | [requested_location](#input_9) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`field_definition`](../../core-concepts/dpf-types.md#field-definition) | @@ -57,6 +61,10 @@ Reads mechanical exported csv file ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ Reads mechanical exported csv file ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: csv @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_file_to_vtk.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_file_to_vtk.md index e1bf269d21..0b4f55f2a8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_file_to_vtk.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_file_to_vtk.md @@ -14,11 +14,15 @@ Take an input data sources or streams and convert as much data as possible to vt ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [output_filename](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [output_filename](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -48,6 +52,10 @@ Take an input data sources or streams and convert as much data as possible to vt ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_sources](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -63,8 +71,10 @@ Generated output vtk file ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: vtk @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_to_vtu.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_to_vtu.md index 129e1582d6..a27eb977a3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_to_vtu.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/migrate_to_vtu.md @@ -14,15 +14,19 @@ Extract all results from a datasources and exports them into vtu format. All the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams_container](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 20 Required| [directory](#input_20) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 21| [base_name](#input_21) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 30| [result](#input_30) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 100| [write_mode](#input_100) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_container](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 20 | [directory](#input_20) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 21 | [base_name](#input_21) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 30 | [result](#input_30) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 100 | [write_mode](#input_100) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -84,6 +88,10 @@ Available are rawbinarycompressed, rawbinary, base64appended, base64inline, asci ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [path](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -99,15 +107,17 @@ list of output vtu file path ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -118,6 +128,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: vtk @@ -132,6 +144,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serialize_to_hdf5.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serialize_to_hdf5.md index 4137010387..a86642cb9e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serialize_to_hdf5.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serialize_to_hdf5.md @@ -14,12 +14,16 @@ This operator is deprecated: use 'hdf5dpf_generate_result_file' instead. Seriali ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [file_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [export_floats](#input_1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [export_flat_vectors](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [data](#input_3) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [file_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [export_floats](#input_1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [export_flat_vectors](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [data](#input_3) | Required| | @@ -57,6 +61,10 @@ only the data set explicitly to export is exported ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| @@ -64,8 +72,10 @@ only the data set explicitly to export is exported ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -76,6 +86,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -90,6 +102,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer.md index aaaea846fd..9f1b7c0610 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer.md @@ -14,11 +14,15 @@ Take any input and serialize them in a file. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1 Required| [stream_type](#input_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [file_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [any_input](#input_1) |[`any`](../../core-concepts/dpf-types.md#any) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [stream_type](#input_-1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [file_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [any_input](#input_1) | Required|[`any`](../../core-concepts/dpf-types.md#any) | @@ -48,6 +52,10 @@ any input ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [file_path](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -63,8 +71,10 @@ any input ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer_to_string.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer_to_string.md index 36cfb36193..94eae6e920 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer_to_string.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/serializer_to_string.md @@ -14,10 +14,14 @@ Take any input and serialize them in a string. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1 Required| [stream_type](#input_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [any_input](#input_1) |[`any`](../../core-concepts/dpf-types.md#any) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [stream_type](#input_-1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [any_input](#input_1) | Required|[`any`](../../core-concepts/dpf-types.md#any) | @@ -39,6 +43,10 @@ any input ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **-1**| [nof_chunks](#output_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -62,8 +70,10 @@ Number of chunks when mode passed to input pin(-1) = 2. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -74,6 +84,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -88,6 +100,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/string_deserializer.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/string_deserializer.md index 57ceb13657..78fb7bca17 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/string_deserializer.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/string_deserializer.md @@ -14,10 +14,14 @@ Takes a string generated by the serializer and deserializes it into DPF's entiti ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1 Required| [stream_type](#input_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [serialized_string](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [stream_type](#input_-1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [serialized_string](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Takes a string generated by the serializer and deserializes it into DPF's entiti ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **1**| [any_output](#output_1) |[`any`](../../core-concepts/dpf-types.md#any) | @@ -54,8 +62,10 @@ number and types of outputs corresponding of the inputs used in the serializatio ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/txt_to_data_tree.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/txt_to_data_tree.md index 38692a3ed8..5f3140730b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/txt_to_data_tree.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/txt_to_data_tree.md @@ -14,9 +14,13 @@ Reads a txt file or string to a DataTree ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [string_or_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [string_or_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -30,6 +34,10 @@ Reads a txt file or string to a DataTree ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [data_tree](#output_0) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -45,8 +53,10 @@ Reads a txt file or string to a DataTree ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_export.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_export.md index 39c1f73f98..5e6d92810d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_export.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_export.md @@ -14,12 +14,16 @@ Write the input field and fields container into a given vtk path ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1| [export_type](#input_-1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [file_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [mesh](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 2 Required| [fields](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [export_type](#input_-1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [file_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [mesh](#input_1) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 2 | [fields](#input_2) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -57,6 +61,10 @@ fields exported ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| @@ -64,8 +72,10 @@ fields exported ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -76,6 +86,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: vtk @@ -90,6 +102,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_to_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_to_fields.md index 69047b1d7b..84d0c970a6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_to_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtk_to_fields.md @@ -14,11 +14,15 @@ Write a field based on a vtk file. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [field_name](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4 Required| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_name](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -48,6 +52,10 @@ name of the field in the vtk file ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ fields_container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: vtk @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtu_export.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtu_export.md index c8cb067603..dfd999ef6a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtu_export.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/vtu_export.md @@ -14,16 +14,20 @@ Export DPF data into vtu format. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [directory](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [base_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 3 Required| [fields](#input_3) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | -| 100| [write_mode](#input_100) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 101| [as_point_cloud](#input_101) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 102| [export_faces](#input_102) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 103| [mesh_properties](#input_103) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string_field`](../../core-concepts/dpf-types.md#string-field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [directory](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [base_name](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [mesh](#input_2) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 3 | [fields](#input_3) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field) | +| 100 | [write_mode](#input_100) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 101 | [as_point_cloud](#input_101) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 102 | [export_faces](#input_102) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 103 | [mesh_properties](#input_103) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`string_field`](../../core-concepts/dpf-types.md#string-field) | @@ -93,6 +97,10 @@ List of names of mesh properties to export. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [path](#output_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -108,15 +116,17 @@ list of output vtu file path ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -127,6 +137,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: vtk @@ -141,6 +153,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_pydpf.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_pydpf.md index 2afe5c618e..7b8746ca5a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_pydpf.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_pydpf.md @@ -15,10 +15,14 @@ The script is returned as a string, and can optionally be saved to a specified p ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [workflow](#input_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | -| 1| [output_path](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [workflow](#input_0) | Required|[`workflow`](../../core-concepts/dpf-types.md#workflow) | +| 1 | [output_path](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -40,6 +44,10 @@ The script is returned as a string, and can optionally be saved to a specified p ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [pydpf_code](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -55,8 +63,10 @@ The script is returned as a string, and can optionally be saved to a specified p ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -67,6 +77,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -81,6 +93,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_workflow_topology.md b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_workflow_topology.md index db05930320..aa7504e06a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_workflow_topology.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/serialization/workflow_to_workflow_topology.md @@ -14,9 +14,13 @@ Creates a GenericDataContainer based on WorkflowTopology structure from a Workfl ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [workflow](#input_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [workflow](#input_0) | Required|[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -30,6 +34,10 @@ Creates a GenericDataContainer based on WorkflowTopology structure from a Workfl ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [workflow_topology](#output_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | @@ -45,8 +53,10 @@ Creates a GenericDataContainer based on WorkflowTopology structure from a Workfl ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: serialization **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_shutdown_server.md b/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_shutdown_server.md index 68e602c055..fc7baa0074 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_shutdown_server.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_shutdown_server.md @@ -14,9 +14,13 @@ Shutdowns dpf's grpc server ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [grpc_stream](#input_0) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [grpc_stream](#input_0) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | @@ -30,6 +34,10 @@ dpf streams handling the server ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| @@ -37,8 +45,10 @@ dpf streams handling the server ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -49,6 +59,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: server **Plugin**: grpc @@ -63,6 +75,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_start_server.md b/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_start_server.md index 0d4351e8f2..2d1cb8f6e5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_start_server.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/server/grpc_start_server.md @@ -14,16 +14,20 @@ Starts a dpf's grpc server (if local) or connect to one and keep it waiting for ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [ip](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [port](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [starting_option](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [should_start_server](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5| [dpf_context](#input_5) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 6| [transport_mode](#input_6) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7| [tls_certificates_dir](#input_7) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [ip](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [port](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [starting_option](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [should_start_server](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [dpf_context](#input_5) | |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 6 | [transport_mode](#input_6) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [tls_certificates_dir](#input_7) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -95,6 +99,10 @@ Path to certificates directory when mTLS mode is enabled. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [grpc_streams](#output_0) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | @@ -110,8 +118,10 @@ dpf streams handling the server, if the server is started in this thread, then n ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -122,6 +132,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: server **Plugin**: grpc @@ -136,6 +148,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices.md index 9908a7abce..760d9ba1f3 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices.md @@ -14,18 +14,22 @@ Take nine scalar fields and assemble them as a 3x3 matrix field. If the 'symmetr ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [xx](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [yy](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [zz](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | -| 3| [xy](#input_3) |[`field`](../../core-concepts/dpf-types.md#field) | -| 4| [yz](#input_4) |[`field`](../../core-concepts/dpf-types.md#field) | -| 5| [xz](#input_5) |[`field`](../../core-concepts/dpf-types.md#field) | -| 6| [yx](#input_6) |[`field`](../../core-concepts/dpf-types.md#field) | -| 7| [zy](#input_7) |[`field`](../../core-concepts/dpf-types.md#field) | -| 8| [zx](#input_8) |[`field`](../../core-concepts/dpf-types.md#field) | -| 60| [symmetrical](#input_60) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [xx](#input_0) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [yy](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [zz](#input_2) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 3 | [xy](#input_3) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 4 | [yz](#input_4) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 5 | [xz](#input_5) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 6 | [yx](#input_6) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 7 | [zy](#input_7) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 8 | [zx](#input_8) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 60 | [symmetrical](#input_60) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ Take nine scalar fields and assemble them as a 3x3 matrix field. If the 'symmetr ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -126,8 +134,10 @@ Take nine scalar fields and assemble them as a 3x3 matrix field. If the 'symmetr ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -138,6 +148,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -152,6 +164,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md index f5c95802f6..e5131e7a7b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_matrices_fc.md @@ -14,18 +14,22 @@ Take nine scalar fields container and assemble them as a 3x3 matrix fields. If t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [xx](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [yy](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2| [zz](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 3| [xy](#input_3) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 4| [yz](#input_4) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 5| [xz](#input_5) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 6| [yx](#input_6) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 7| [zy](#input_7) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 8| [zx](#input_8) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 60| [symmetrical](#input_60) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [xx](#input_0) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [yy](#input_1) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [zz](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 3 | [xy](#input_3) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 4 | [yz](#input_4) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 5 | [xz](#input_5) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 6 | [yx](#input_6) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 7 | [zy](#input_7) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 8 | [zx](#input_8) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 60 | [symmetrical](#input_60) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -111,6 +115,10 @@ Take nine scalar fields container and assemble them as a 3x3 matrix fields. If t ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -126,8 +134,10 @@ Take nine scalar fields container and assemble them as a 3x3 matrix fields. If t ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -138,6 +148,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -152,6 +164,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors.md index 1ac5f5e6b9..6f447e275a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors.md @@ -14,11 +14,15 @@ Takes three scalar fields and assembles them as a 3D vector field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [x](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [y](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | -| 2| [z](#input_2) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [x](#input_0) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [y](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 2 | [z](#input_2) | |[`field`](../../core-concepts/dpf-types.md#field) | @@ -48,6 +52,10 @@ Takes three scalar fields and assembles them as a 3D vector field. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Takes three scalar fields and assembles them as a 3D vector field. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md index 2114235ebd..0ed0085497 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/assemble_scalars_to_vectors_fc.md @@ -14,11 +14,15 @@ Takes three scalar fields container and assembles them as a 3D vector fields con ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [x](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [y](#input_1) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 2| [z](#input_2) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [x](#input_0) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [y](#input_1) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 2 | [z](#input_2) | |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -48,6 +52,10 @@ Takes three scalar fields container and assembles them as a 3D vector fields con ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Takes three scalar fields container and assembles them as a 3D vector fields con ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support.md index 75ca94e6a5..4608251fa2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support.md @@ -14,10 +14,14 @@ Ties a support to a field. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [support](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [support](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support` | @@ -39,6 +43,10 @@ Meshed region or a support of the field ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Field with the attached support ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support_fc.md index fb28cedf36..c6b4f442b1 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/bind_support_fc.md @@ -14,10 +14,14 @@ Ties a support to a fields container. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [support](#input_1) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support`, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [support](#input_1) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), `abstract_field_support`, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -39,6 +43,10 @@ Meshed region, support, or time frequency support to attach to the fields contai ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Fields container with the attached support ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_location.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_location.md index e8233ed91b..db247c00d7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_location.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_location.md @@ -14,10 +14,14 @@ Changes the location property of a field without modifying the field data. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [new_location](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [new_location](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ New location string for the field (e.g., 'Nodal', 'ElementalNodal', 'Elemental') ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Field with the updated location property ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_shell_layers.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_shell_layers.md index af51506085..5572e6a4c4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_shell_layers.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/change_shell_layers.md @@ -14,12 +14,16 @@ Extract the requested shell layers from the input fields. If the fields contain ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [e_shell_layer](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | -| 2| [mesh](#input_2) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 26| [merge](#input_26) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [e_shell_layer](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | +| 2 | [mesh](#input_2) | |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 26 | [merge](#input_26) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ For fields with mixed shell layers (solid/shell elements with heterogeneous shel ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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), [`field`](../../core-concepts/dpf-types.md#field) | @@ -72,15 +80,17 @@ For fields with mixed shell layers (solid/shell elements with heterogeneous shel ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -91,6 +101,8 @@ If permissive is set to false, the operator run will ensure the 'change shell la ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -105,6 +117,9 @@ If permissive is set to false, the operator run will ensure the 'change shell la ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/compute_time_scoping.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/compute_time_scoping.md index 287254c1cf..ea36ac4dec 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/compute_time_scoping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/compute_time_scoping.md @@ -14,12 +14,16 @@ Computes the time frequency scoping (made of set IDs) necessary to interpolate o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_values](#input_0) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 2| [step](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [interpolation_type](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 8 Required| [time_freq_support](#input_8) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_values](#input_0) | Required|[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 2 | [step](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [interpolation_type](#input_4) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 8 | [time_freq_support](#input_8) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -57,6 +61,10 @@ List of frequencies or times needed. To specify load steps, put a field (and not ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -80,8 +88,10 @@ time_freq_values ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -92,6 +102,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -106,6 +118,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields.md index 306917006b..e179a9d624 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields.md @@ -19,12 +19,16 @@ Example: ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -3| [rescoping_value](#input_-3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| -2| [reference_scoping_index](#input_-2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| -1| [field_support](#input_-1) |`abstract_field_support` | -| 0 Required| [fields](#input_0) |[`vector`](../../core-concepts/dpf-types.md#vector) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -3 | [rescoping_value](#input_-3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| -2 | [reference_scoping_index](#input_-2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| -1 | [field_support](#input_-1) | |`abstract_field_support` | +| 0 | [fields](#input_0) | Required|[`vector`](../../core-concepts/dpf-types.md#vector) | @@ -63,6 +67,10 @@ A vector of fields to merge from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_fields](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -78,15 +86,17 @@ Field which has as many components as the sum of all the input fields' numbers o ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -97,6 +107,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -111,6 +123,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields_containers.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields_containers.md index 06b663202b..6a471742e4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields_containers.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/concatenate_fields_containers.md @@ -25,12 +25,16 @@ Example: ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -3| [rescoping_value](#input_-3) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| -2| [reference_scoping_index](#input_-2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| -1| [field_support](#input_-1) |`abstract_field_support` | -| 0 Required| [fields_containers](#input_0) |[`vector`](../../core-concepts/dpf-types.md#vector) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -3 | [rescoping_value](#input_-3) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| -2 | [reference_scoping_index](#input_-2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| -1 | [field_support](#input_-1) | |`abstract_field_support` | +| 0 | [fields_containers](#input_0) | Required|[`vector`](../../core-concepts/dpf-types.md#vector) | @@ -69,6 +73,10 @@ A vector of fields containers to merge from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_collections](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -84,15 +92,17 @@ Fields containers with fields which have as many components as the sum of all th ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -103,6 +113,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -117,6 +129,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/customtypefield_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/customtypefield_get_attribute.md index 7a73403f51..8206222eb7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/customtypefield_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/customtypefield_get_attribute.md @@ -14,10 +14,14 @@ Gets a property from an input field/field container. A CustomTypeFieldin pin 0, ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [custom_type_field](#input_0) |[`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [custom_type_field](#input_0) | Required|[`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','tim ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -54,8 +62,10 @@ Property value that is returned. Accepted Outputs are: Field, PropertyField, Cus ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/cyclic_support_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/cyclic_support_get_attribute.md index 6ca4ae1448..c625d964b0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/cyclic_support_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/cyclic_support_get_attribute.md @@ -14,10 +14,14 @@ A CyclicSupport in pin 0 and a property name (string) in pin 1 are expected in i ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [cyclic_support](#input_0) |[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [cyclic_support](#input_0) | Required|[`cyclic_support`](../../core-concepts/dpf-types.md#cyclic-support) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Accepted inputs are: 'element_duplicate_offset' and 'node_duplicate_offset' (ret ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -54,8 +62,10 @@ Property value. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/default_value.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/default_value.md index b568d11cc5..468ef0e44e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/default_value.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/default_value.md @@ -14,10 +14,14 @@ Returns the value from pin 0 if provided, otherwise returns the default value fr ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [forced_value](#input_0) | | -| 1 Required| [default_value](#input_1) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [forced_value](#input_0) | | | +| 1 | [default_value](#input_1) | Required| | @@ -39,6 +43,10 @@ Default value to return if pin 0 is not connected. Must be the same type as pin ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [output](#output_0) | | @@ -54,8 +62,10 @@ Returns primary_value if provided, otherwise default_value ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/delegate_to_operator.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/delegate_to_operator.md index 848d6a628a..6dc5e1da70 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/delegate_to_operator.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/delegate_to_operator.md @@ -14,9 +14,13 @@ Delegate the run to an Operator instantiated by the name in input (forwards all ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1 Required| [operator_name](#input_-1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [operator_name](#input_-1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -30,6 +34,10 @@ Delegate the run to an Operator instantiated by the name in input (forwards all ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [any](#output_0) |[`any`](../../core-concepts/dpf-types.md#any) | @@ -45,8 +53,10 @@ inputs ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/ds_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/ds_get_attribute.md index 8a3d2ec88f..f1e3184967 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/ds_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/ds_get_attribute.md @@ -14,13 +14,17 @@ A DataSources in pin 0 and a property name (string) in pin 1 are expected in inp ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [data_sources](#input_0) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [property_index](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [property_key](#input_3) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [property_result_key](#input_4) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [data_sources](#input_0) | Required|[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property_index](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [property_key](#input_3) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [property_result_key](#input_4) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ Result key to look for. Can be used for 'file_path', 'result_file_name', 'domain ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -81,8 +89,10 @@ Property value. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_field.md index ef33d63adf..788ac02858 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_field.md @@ -14,10 +14,14 @@ Extracts the fields at the indices defined in the vector (in 1) from the fields ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [indices](#input_1) |[`vector`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [indices](#input_1) | |[`vector`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Indices of fields to extract. Default is [0] (first field). Single index returns ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Extracted field(s). Single index produces a field, multiple indices produce a fi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_scoping.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_scoping.md index b9e468e5c0..7f4d0074eb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_scoping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_scoping.md @@ -14,10 +14,14 @@ Takes a field type object, mesh or a collection of them and extracts its scoping ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [field_or_fields_container](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`string_field`](../../core-concepts/dpf-types.md#string-field), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 1| [requested_location](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field_or_fields_container](#input_0) | |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container), [`custom_type_field`](../../core-concepts/dpf-types.md#custom-type-field), [`custom_type_fields_container`](../../core-concepts/dpf-types.md#custom-type-fields-container), [`string_field`](../../core-concepts/dpf-types.md#string-field), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 1 | [requested_location](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ If input 0 is a mesh or a meshes_container, the operator returns the nodes scopi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [mesh_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -54,8 +62,10 @@ If input 0 is a mesh or a meshes_container, the operator returns the nodes scopi ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_fc.md index 6076b7a65e..74a1c2c2f6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_fc.md @@ -14,11 +14,15 @@ Creates a new fields container with all the fields corresponding to the label sp ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1| [label_space](#input_1) |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [collapse_labels](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label_space](#input_1) | |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [collapse_labels](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If set to true (default) the input label space (scoping location) is suppressed ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ fields_container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_mc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_mc.md index 4600040609..f9f053d8da 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_mc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_mc.md @@ -14,11 +14,15 @@ Creates a new meshes container with all the meshed regions corresponding to the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [meshes](#input_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 1| [label_space](#input_1) |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [collapse_labels](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [meshes](#input_0) | Required|[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 1 | [label_space](#input_1) | |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [collapse_labels](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If set to true (default) the input label space (scoping location) is suppressed ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes_container](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -63,8 +71,10 @@ meshes ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_sc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_sc.md index 032a53407d..d0691ed5cc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_sc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_sub_sc.md @@ -14,11 +14,15 @@ Creates a new scopings container with all the scopings corresponding to the labe ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [scopings_container](#input_0) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 1| [label_space](#input_1) |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [collapse_labels](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [scopings_container](#input_0) | Required|[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 1 | [label_space](#input_1) | |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [collapse_labels](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If set to true (default) the input label space (scoping location) is suppressed ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scopings_container](#output_0) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -63,8 +71,10 @@ scopings_container ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_time_freq.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_time_freq.md index ce87e71adc..d2954ed1d8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_time_freq.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/extract_time_freq.md @@ -14,11 +14,15 @@ Extract timefreqs with sets scoping from a time freq support ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1| [time_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 2| [real_or_complex](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [time_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 2 | [real_or_complex](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ False for real only (default). True for complex output. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -63,8 +71,10 @@ False for real only (default). True for complex output. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/fc_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/fc_get_attribute.md index 99fc3bd42a..5528b31083 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/fc_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/fc_get_attribute.md @@ -14,11 +14,15 @@ Uses the FieldsContainer APIs to return a given attribute of the fields containe ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [property_identifier](#input_2) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property_identifier](#input_2) | |[`string`](../../core-concepts/dpf-types.md#standard-types), [`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Additional pin for some property : the label name for "label_scoping" or "label_ ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`label_space`](../../core-concepts/dpf-types.md#label-space), [`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ Returns a Scoping for property: "label_scoping", a vector of int for "label_valu ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field.md index 4dfe562ff1..0170831497 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field.md @@ -14,9 +14,13 @@ Incrementaly merge the input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | @@ -30,6 +34,10 @@ Incrementaly merge the input. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [incremented_result](#output_0) | | @@ -45,8 +53,10 @@ Incrementaly merge the input. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_clone_to_shell_layer.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_clone_to_shell_layer.md index 980f89d560..54726550d4 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_clone_to_shell_layer.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_clone_to_shell_layer.md @@ -14,11 +14,15 @@ Generates a Field from the Field in input 0 that has the same FieldDefinition wi ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [shell_layer](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | -| 2| [duplicate_scoping](#input_2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [shell_layer](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), `enum dataProcessing::EShellLayers` | +| 2 | [duplicate_scoping](#input_2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ If true, a new scoping is computed for the output Field. If false, the input Fie ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,8 +71,10 @@ If true, a new scoping is computed for the output Field. If false, the input Fie ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_get_attribute.md index cfa9be18d7..bfc3029cfa 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_get_attribute.md @@ -14,10 +14,14 @@ Gets a property from an input field/field container. A Fieldin pin 0, a property ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','tim ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -54,8 +62,10 @@ Property value that is returned. Accepted Outputs are: Field, PropertyField, Cus ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_to_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_to_fc.md index f5238300e1..eeaf0cbfbf 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_to_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/field_to_fc.md @@ -14,10 +14,14 @@ Creates a fields container containing the field provided on pin 0. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [label](#input_1) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | Required|[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -39,6 +43,10 @@ Sets a label space. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -54,8 +62,10 @@ Sets a label space. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/fields_container.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/fields_container.md index d2d409a44f..5b692cb52f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/fields_container.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/fields_container.md @@ -14,9 +14,13 @@ Incrementaly merge the input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Incrementaly merge the input. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [incremented_result](#output_0) | | @@ -45,8 +53,10 @@ Incrementaly merge the input. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/for_each.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/for_each.md index 68e05df6ab..1c0e4e1924 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/for_each.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/for_each.md @@ -14,12 +14,16 @@ Allows to write a loop over a chunk of operators. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [iterable](#input_0) | | -| 1| [iterable_values](#input_1) | | -| 2| [pin_index](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [forward](#input_3) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [iterable](#input_0) | Required| | +| 1 | [iterable_values](#input_1) | | | +| 2 | [pin_index](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [forward](#input_3) | Required| | @@ -57,6 +61,10 @@ Either the result of the make_iterable_info operator, or the operator that must ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [empty](#output_0) | | @@ -80,15 +88,17 @@ Either the result of the make_iterable_info operator, or the operator that must ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### evaluate_inputs_before_run +### [evaluate_inputs_before_run](../../core-concepts/operator-configurations.md#evaluate_inputs_before_run) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -99,6 +109,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -113,6 +125,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward.md index d619057e5f..e4442e200f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward.md @@ -14,9 +14,13 @@ Return all the inputs as outputs. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [any](#input_0) |[`any`](../../core-concepts/dpf-types.md#any) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [any](#input_0) | Required|[`any`](../../core-concepts/dpf-types.md#any) | @@ -30,6 +34,10 @@ any type of input ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [any](#output_0) |[`any`](../../core-concepts/dpf-types.md#any) | @@ -45,15 +53,17 @@ same types as inputs ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -64,6 +74,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -78,6 +90,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_field.md index 5362ebce78..bfde9223ff 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_field.md @@ -14,9 +14,13 @@ Returns the input field or fields container. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Forwarded field (passthrough of input) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_fields_container.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_fields_container.md index d1a3d30979..c79aeeef6b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_fields_container.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_fields_container.md @@ -14,9 +14,13 @@ Returns the input field or fields container. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field) | @@ -30,6 +34,10 @@ FieldsContainer or field to forward ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Forwarded fields container (passthrough of input) ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_meshes_container.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_meshes_container.md index 940487d24c..bcb6ac203e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_meshes_container.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/forward_meshes_container.md @@ -14,10 +14,14 @@ Returns the input mesh or meshes container into a meshes container. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [meshes](#input_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 1| [default_label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [meshes](#input_0) | Required|[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container), [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 1 | [default_label](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ this default label is used if a new meshes container needs to be created (defaul ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes_container](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -54,8 +62,10 @@ this default label is used if a new meshes container needs to be created (defaul ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/get_operators.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/get_operators.md index 0ecd79dbf5..1012a5ad04 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/get_operators.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/get_operators.md @@ -14,9 +14,13 @@ Getter on operators inside a workflow. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [workflow](#input_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [workflow](#input_0) | Required|[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -30,6 +34,10 @@ Getter on operators inside a workflow. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [operators](#output_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | @@ -45,8 +53,10 @@ Getter on operators inside a workflow. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md index d6ea73bdeb..353ba0a772 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/hdf5dpf_workglow_provider.md @@ -14,14 +14,18 @@ Extract a custom result from an hdf5dpf file as an executable workflow. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [time_scoping](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [mesh_scoping](#input_1) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 3| [streams](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 24| [meta_data](#input_24) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 60 Required| [result_name](#input_60) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_scoping](#input_0) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [mesh_scoping](#input_1) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 3 | [streams](#input_3) | |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 24 | [meta_data](#input_24) | |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 60 | [result_name](#input_60) | Required| | @@ -75,6 +79,10 @@ Name of the result that must be extracted from the hdf5dpf file ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field_or_fields_container](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -90,8 +98,10 @@ Name of the result that must be extracted from the hdf5dpf file ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/html_doc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/html_doc.md index f4d1844ce1..75842b16b0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/html_doc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/html_doc.md @@ -14,10 +14,14 @@ Create dpf's html documentation. Only on Windows. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [output_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [exposure_level](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [output_path](#input_0) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [exposure_level](#input_1) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Generate the documentation depending on exposure level : 0 (default) for public ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| @@ -46,8 +54,10 @@ Generate the documentation depending on exposure level : 0 (default) for public ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -58,6 +68,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: documentation @@ -72,6 +84,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/incremental_concatenate_as_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/incremental_concatenate_as_fc.md index 1eb0a9097d..1ee419f633 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/incremental_concatenate_as_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/incremental_concatenate_as_fc.md @@ -14,10 +14,14 @@ Assemble fields in a fields container. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [label](#input_1) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [label](#input_1) | |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -39,6 +43,10 @@ Label space value that must be applied to the added field. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [output](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -54,8 +62,10 @@ Label space value that must be applied to the added field. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/ints_to_scoping.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/ints_to_scoping.md index 645b257fca..de7c0af17a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/ints_to_scoping.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/ints_to_scoping.md @@ -14,11 +14,15 @@ Creates a scoping from integer data. Converts single integers, integer vectors, ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [ids](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 1| [location](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [upper_bound](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [ids](#input_0) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 1 | [location](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [upper_bound](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ Upper bound for creating a range scoping. Creates IDs from pin 0 value to this u ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -63,8 +71,10 @@ Generated scoping with the specified IDs and location ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_for_each_range.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_for_each_range.md index c820ca8318..4e726fe6b6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_for_each_range.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_for_each_range.md @@ -14,15 +14,19 @@ Generate a range that can be consumed by the for_each operator ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1| [try_generate_iterable](#input_-1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0| [iterable](#input_0) | | -| 1 Required| [operator_to_iterate](#input_1) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 2 Required| [pin_index](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [valueA](#input_3) | | -| 4 Required| [valueB](#input_4) | | -| 5 Required| [valueC](#input_5) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [try_generate_iterable](#input_-1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [iterable](#input_0) | | | +| 1 | [operator_to_iterate](#input_1) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 2 | [pin_index](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [valueA](#input_3) | Required| | +| 4 | [valueB](#input_4) | Required| | +| 5 | [valueC](#input_5) | Required| | @@ -84,6 +88,10 @@ Operator that must be reconnected with the range values. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [output](#output_0) | | @@ -99,8 +107,10 @@ Operator that must be reconnected with the range values. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -111,6 +121,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -125,6 +137,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_label_space.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_label_space.md index ac6c07642c..65b0d58e60 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_label_space.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_label_space.md @@ -14,11 +14,15 @@ Assemble strings and integers to make a label space. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [base_label](#input_0) |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | -| 1 Required| [label_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [label_value](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [base_label](#input_0) | |[`label_space`](../../core-concepts/dpf-types.md#label-space), [`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +| 1 | [label_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [label_value](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Used as a base label (extracted from Fields/Scoping Container, or directly from ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [label](#output_0) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -63,8 +71,10 @@ Used as a base label (extracted from Fields/Scoping Container, or directly from ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_overall.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_overall.md index e4e81e9909..267bab8f20 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_overall.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_overall.md @@ -14,10 +14,14 @@ Extracts a value from a field and makes a new field containing only this value, ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1 Required| [id](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [id](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Extracts a value from a field and makes a new field containing only this value, ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Extracts a value from a field and makes a new field containing only this value, ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md index b3d134e663..62e713a9a2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/make_producer_consumer_for_each_iterator.md @@ -14,19 +14,23 @@ Generates an iterator that can be consumed by the for_each operator.The chain of ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1| [try_generate_iterable](#input_-1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0| [iterable](#input_0) | | -| 1 Required| [operator_to_iterate](#input_1) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 2 Required| [pin_index](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [valueA](#input_3) | | -| 4 Required| [valueB](#input_4) | | -| 5 Required| [valueC](#input_5) | | -| 1000 Required| [producer_op1](#input_1000) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 1001 Required| [output_pin_of_producer_op1](#input_1001) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1002 Required| [input_pin_of_consumer_op1](#input_1002) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1003 Required| [consumer_op1](#input_1003) |[`operator`](../../core-concepts/dpf-types.md#operator) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [try_generate_iterable](#input_-1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [iterable](#input_0) | | | +| 1 | [operator_to_iterate](#input_1) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 2 | [pin_index](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [valueA](#input_3) | Required| | +| 4 | [valueB](#input_4) | Required| | +| 5 | [valueC](#input_5) | Required| | +| 1000 | [producer_op1](#input_1000) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 1001 | [output_pin_of_producer_op1](#input_1001) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1002 | [input_pin_of_consumer_op1](#input_1002) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1003 | [consumer_op1](#input_1003) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | @@ -120,6 +124,10 @@ Operator that must be reconnected with the range values. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [iterator](#output_0) | | @@ -135,8 +143,10 @@ to connect to producer_consumer_for_each ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -147,6 +157,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -161,6 +173,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md index 7ee30fa00a..ae45d82329 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_chunk_for_each.md @@ -14,17 +14,21 @@ Splits a list of time/freq values into chunks depending on evaluated result prop ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [target_time_freq_values](#input_0) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [operator_to_iterate](#input_1) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 2 Required| [pin_index](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | -| 200 Required| [chunk_config](#input_200) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 1000 Required| [producer_op1](#input_1000) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 1001 Required| [output_pin_of_producer_op1](#input_1001) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1002 Required| [input_pin_of_consumer_op1](#input_1002) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1003 Required| [consumer_op1](#input_1003) |[`operator`](../../core-concepts/dpf-types.md#operator) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [target_time_freq_values](#input_0) | Required|[`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [operator_to_iterate](#input_1) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 2 | [pin_index](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +| 200 | [chunk_config](#input_200) | Required|[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 1000 | [producer_op1](#input_1000) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 1001 | [output_pin_of_producer_op1](#input_1001) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1002 | [input_pin_of_consumer_op1](#input_1002) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1003 | [consumer_op1](#input_1003) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | @@ -102,6 +106,10 @@ a data tree with an int attribute "max_num_bytes", an int attribute "dimensional ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [chunks](#output_0) | | @@ -117,8 +125,10 @@ To connect to "producer_consumer_for_each" Operator on pin 0 ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -129,6 +139,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -143,6 +155,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md index 21b0632df4..2c63b9e020 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mechanical_make_time_freq_support_chunk_for_each.md @@ -14,17 +14,21 @@ Splits a time freq support into chunks depending on evaluated result properties, ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [target_time_freq_support](#input_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | -| 1 Required| [operator_to_iterate](#input_1) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 2 Required| [pin_index](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 7 Required| [abstract_meshed_region](#input_7) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | -| 200 Required| [chunk_config](#input_200) |[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | -| 1000 Required| [producer_op1](#input_1000) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 1001 Required| [output_pin_of_producer_op1](#input_1001) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1002 Required| [input_pin_of_consumer_op1](#input_1002) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1003 Required| [consumer_op1](#input_1003) |[`operator`](../../core-concepts/dpf-types.md#operator) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [target_time_freq_support](#input_0) | Required|[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +| 1 | [operator_to_iterate](#input_1) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 2 | [pin_index](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 7 | [abstract_meshed_region](#input_7) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`field`](../../core-concepts/dpf-types.md#field) | +| 200 | [chunk_config](#input_200) | Required|[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | +| 1000 | [producer_op1](#input_1000) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 1001 | [output_pin_of_producer_op1](#input_1001) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1002 | [input_pin_of_consumer_op1](#input_1002) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1003 | [consumer_op1](#input_1003) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | @@ -102,6 +106,10 @@ a data tree with an int attribute "max_num_bytes", an int attribute "dimensional ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [chunks](#output_0) | | @@ -117,8 +125,10 @@ To connect to "producer_consumer_for_each" Operator on pin 0 ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -129,6 +139,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -143,6 +155,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_any.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_any.md index b4baa7fc3a..33b02ebacc 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_any.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_any.md @@ -14,9 +14,13 @@ Merges a list of objects having the same data types. Once the data type is found ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [any](#input_0) |[`any`](../../core-concepts/dpf-types.md#any) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [any](#input_0) | Required|[`any`](../../core-concepts/dpf-types.md#any) | @@ -30,6 +34,10 @@ Either a vector of objects (sharing the same data types) or objects from pin 0 t ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [any](#output_0) |[`any`](../../core-concepts/dpf-types.md#any) | @@ -45,15 +53,17 @@ Either a vector of objects (sharing the same data types) or objects from pin 0 t ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -64,6 +74,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -78,6 +90,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_collections.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_collections.md index 3064c36510..47bde03c23 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_collections.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_collections.md @@ -14,9 +14,13 @@ Merges a set of collections into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [collections](#input_0) |`vector>`, [`any_collection`](../../core-concepts/dpf-types.md#any-collection) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [collections](#input_0) | Required|`vector>`, [`any_collection`](../../core-concepts/dpf-types.md#any-collection) | @@ -30,6 +34,10 @@ a vector of collections to merge or collections from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_collections](#output_0) |[`any_collection`](../../core-concepts/dpf-types.md#any-collection) | @@ -45,15 +53,17 @@ a vector of collections to merge or collections from pin 0 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -64,6 +74,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -78,6 +90,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_data_tree.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_data_tree.md index 749399a331..de8c64d9c2 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_data_tree.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_data_tree.md @@ -14,9 +14,13 @@ Merges a list of data trees. Attributes names shouldn't be shared accross data t ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [data_tree](#input_0) |[`data_tree`](../../core-concepts/dpf-types.md#data-tree), `vector>` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [data_tree](#input_0) | Required|[`data_tree`](../../core-concepts/dpf-types.md#data-tree), `vector>` | @@ -30,6 +34,10 @@ Either a vector of data trees or data trees from pin 0 to ... to merge. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [any](#output_0) |[`any`](../../core-concepts/dpf-types.md#any) | @@ -45,15 +53,17 @@ Either a vector of data trees or data trees from pin 0 to ... to merge. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### permissive +### [permissive](../../core-concepts/operator-configurations.md#permissive) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -64,6 +74,8 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -78,6 +90,9 @@ If this option is set to true, warning checks (like unit or data sizes) won't be ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields.md index 9a821f4b83..44c0a140f7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields.md @@ -14,11 +14,15 @@ Assembles a set of fields into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -2| [sum_merge](#input_-2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| -1| [merged_support](#input_-1) |`abstract_field_support` | -| 0 Required| [fields](#input_0) |`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -2 | [sum_merge](#input_-2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| -1 | [merged_support](#input_-1) | |`abstract_field_support` | +| 0 | [fields](#input_0) | Required|`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -48,6 +52,10 @@ Either a fields container, a vector of fields to merge, or fields from pin 0 to ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -63,15 +71,17 @@ Either a fields container, a vector of fields to merge, or fields from pin 0 to ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_by_label.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_by_label.md index 71420bff7d..7262c7de2e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_by_label.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_by_label.md @@ -14,12 +14,16 @@ Merges the fields of a fields container that share the same label value. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [merged_field_support](#input_2) |`abstract_field_support` | -| 3| [sum_merge](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [merged_field_support](#input_2) | |`abstract_field_support` | +| 3 | [sum_merge](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Default is false. If true, redundant quantities are summed instead of being igno ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -80,8 +88,10 @@ Default is false. If true, redundant quantities are summed instead of being igno ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -92,6 +102,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -106,6 +118,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_container_matrices_label.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_container_matrices_label.md index 78484f500a..1a9a8a973c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_container_matrices_label.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_container_matrices_label.md @@ -14,11 +14,15 @@ Merge fields of fields container into field matrices. The output is a fields con ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [time_scoping](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [time_scoping](#input_2) | |[`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -48,6 +52,10 @@ if it's specified, fields container of field matrices is constructed only on the ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ fields container of field matrices obtained after merging. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_containers.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_containers.md index c08dc83525..58866b0deb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_containers.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_fields_containers.md @@ -14,13 +14,17 @@ Assembles a set of fields containers into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -200| [should_merge_named_selections](#input_-200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| -3| [sum_merge](#input_-3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| -2| [merged_fields_support](#input_-2) |`abstract_field_support` | -| -1| [merged_fields_containers_support](#input_-1) |`abstract_field_support`, `umap>` | -| 0 Required| [fields_containers](#input_0) |`vector>`, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -200 | [should_merge_named_selections](#input_-200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| -3 | [sum_merge](#input_-3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| -2 | [merged_fields_support](#input_-2) | |`abstract_field_support` | +| -1 | [merged_fields_containers_support](#input_-1) | |`abstract_field_support`, `umap>` | +| 0 | [fields_containers](#input_0) | Required|`vector>`, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -66,6 +70,10 @@ A vector of fields containers to merge or fields containers from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -81,15 +89,17 @@ A vector of fields containers to merge or fields containers from pin 0 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -100,6 +110,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -114,6 +126,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_generic_data_container.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_generic_data_container.md index 4ee3713561..d031bd5660 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_generic_data_container.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_generic_data_container.md @@ -14,9 +14,13 @@ Merges a list of generic data container. For each data entry, the merge operatio ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [generic_data_container](#input_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container), `vector>` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [generic_data_container](#input_0) | Required|[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container), `vector>` | @@ -30,6 +34,10 @@ Either a vector of generic data containers (sharing the same data types) or gene ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [generic_data_container](#output_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | @@ -45,8 +53,10 @@ Either a vector of generic data containers (sharing the same data types) or gene ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_materials.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_materials.md index 9285f2c0cb..a694e5adb7 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_materials.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_materials.md @@ -14,9 +14,13 @@ Assembles a set of materials into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [materials](#input_0) |`vector>`, `materials` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [materials](#input_0) | Required|`vector>`, `materials` | @@ -30,6 +34,10 @@ A vector of materials to merge or materials from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_materials](#output_0) |`materials` | @@ -45,8 +53,10 @@ A vector of materials to merge or materials from pin 0 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes.md index b7cc8db99f..848074b76e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes.md @@ -14,14 +14,18 @@ Take a set of meshes and assemble them in a unique one ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -201| [naive_merge_elements](#input_-201) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| -200| [should_merge_named_selections](#input_-200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [meshes](#input_0) |`vector>`, [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 101| [merge_method](#input_101) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 102| [box_size](#input_102) |[`double`](../../core-concepts/dpf-types.md#standard-types) | -| 103| [remove_duplicate_elements](#input_103) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -201 | [naive_merge_elements](#input_-201) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| -200 | [should_merge_named_selections](#input_-200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [meshes](#input_0) | Required|`vector>`, [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 101 | [merge_method](#input_101) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 102 | [box_size](#input_102) | |[`double`](../../core-concepts/dpf-types.md#standard-types) | +| 103 | [remove_duplicate_elements](#input_103) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -75,6 +79,10 @@ Box size used when merging by distance. Default value is 1e-12. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merges_mesh](#output_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -90,15 +98,17 @@ Box size used when merging by distance. Default value is 1e-12. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -109,6 +119,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -123,6 +135,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes_containers.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes_containers.md index 1ea2914f17..b621d9dde8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes_containers.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_meshes_containers.md @@ -14,9 +14,13 @@ Assembles a set of meshes containers into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [meshes_containers](#input_0) |`vector>`, [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [meshes_containers](#input_0) | Required|`vector>`, [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -30,6 +34,10 @@ a vector of meshes containers to merge or meshes containers from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_meshes_container](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -45,15 +53,17 @@ a vector of meshes containers to merge or meshes containers from pin 0 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -64,6 +74,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -78,6 +90,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_property_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_property_fields.md index f29b04f2d8..21fd31c397 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_property_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_property_fields.md @@ -14,10 +14,14 @@ Assembles a set of property fields into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -201 Required| [naive_merge](#input_-201) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [property_fields](#input_0) |`vector>`, [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -201 | [naive_merge](#input_-201) | Required|[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [property_fields](#input_0) | Required|`vector>`, [`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | @@ -39,6 +43,10 @@ Either a property fields container, a vector of property fields to merge or prop ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property_field](#output_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -54,8 +62,10 @@ Either a property fields container, a vector of property fields to merge or prop ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_result_infos.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_result_infos.md index 0665943d4d..5eeccae2e6 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_result_infos.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_result_infos.md @@ -14,9 +14,13 @@ Assembles a set of result information into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [result_infos](#input_0) |`vector>`, [`result_info`](../../core-concepts/dpf-types.md#result-info) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [result_infos](#input_0) | Required|`vector>`, [`result_info`](../../core-concepts/dpf-types.md#result-info) | @@ -30,6 +34,10 @@ A vector of result info containers to merge or result infos from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_result_infos](#output_0) |[`result_info`](../../core-concepts/dpf-types.md#result-info) | @@ -45,15 +53,17 @@ A vector of result info containers to merge or result infos from pin 0 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -64,6 +74,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -78,6 +90,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings.md index e0be59c0fc..3223cad619 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings.md @@ -14,9 +14,13 @@ Assembles a set of scopings into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [scopings](#input_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), `vector>` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [scopings](#input_0) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping), [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), `vector>` | @@ -30,6 +34,10 @@ Either a scopings container, a vector of scopings to merge, or scopings from pin ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_scoping](#output_0) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -45,8 +53,10 @@ Either a scopings container, a vector of scopings to merge, or scopings from pin ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings_containers.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings_containers.md index 35bba4112f..92ec720c39 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings_containers.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_scopings_containers.md @@ -14,9 +14,13 @@ Assembles a set of scopings containers into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [scopings_containers](#input_0) |`vector>`, [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [scopings_containers](#input_0) | Required|`vector>`, [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -30,6 +34,10 @@ A vector of scopings containers to merge or scopings containers from pin 0 to .. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_scopings_container](#output_0) |[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container) | @@ -45,8 +53,10 @@ A vector of scopings containers to merge or scopings containers from pin 0 to .. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_string_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_string_fields.md index c6502a8ac6..c47971f833 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_string_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_string_fields.md @@ -14,9 +14,13 @@ Assembles a set of string fields into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [string_fields](#input_0) |`vector>`, [`string_field`](../../core-concepts/dpf-types.md#string-field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [string_fields](#input_0) | Required|`vector>`, [`string_field`](../../core-concepts/dpf-types.md#string-field) | @@ -30,6 +34,10 @@ Either a a vector of string fields to merge or string fields from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [string_field](#output_0) |[`string_field`](../../core-concepts/dpf-types.md#string-field) | @@ -45,8 +53,10 @@ Either a a vector of string fields to merge or string fields from pin 0 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_supports.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_supports.md index af6b1a6b0e..0f1ea19fac 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_supports.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_supports.md @@ -14,10 +14,14 @@ Assembles a set of supports into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -200| [should_merge_named_selections](#input_-200) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [supports](#input_0) |`vector>`, `abstract_field_support` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -200 | [should_merge_named_selections](#input_-200) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [supports](#input_0) | Required|`vector>`, `abstract_field_support` | @@ -39,6 +43,10 @@ A vector of supports to merge or supports from pin 0 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_support](#output_0) |`abstract_field_support` | @@ -54,8 +62,10 @@ A vector of supports to merge or supports from pin 0 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_time_freq_supports.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_time_freq_supports.md index 518d9091ce..febf44ff6c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_time_freq_supports.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_time_freq_supports.md @@ -14,9 +14,13 @@ Assembles a set of time/frequency supports into a unique one. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [time_freq_supports](#input_0) |`vector>`, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [time_freq_supports](#input_0) | Required|`vector>`, [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -30,6 +34,10 @@ A vector of time/frequency supports to merge or time/frequency supports from pin ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_support](#output_0) |[`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support) | @@ -45,8 +53,10 @@ A vector of time/frequency supports to merge or time/frequency supports from pin ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_to_field_matrix.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_to_field_matrix.md index c1f42ead0c..7106d1ac22 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_to_field_matrix.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_to_field_matrix.md @@ -14,9 +14,13 @@ Assembles a set of fields into a field matrix. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields](#input_0) |`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields](#input_0) | Required|`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Either a fields container, a vector of fields to merge, or fields from pin 0 to ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_field_matrix](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Either a fields container, a vector of fields to merge, or fields from pin 0 to ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields.md index a9c99ea171..24967ff040 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields.md @@ -14,12 +14,16 @@ Assembles a set of fields into a unique one, applying a weight on the sum of the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -2| [sum_merge](#input_-2) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| -1| [merged_support](#input_-1) |`abstract_field_support` | -| 0 Required| [fields](#input_0) |`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1000 Required| [weights](#input_1000) |`vector>`, [`property_field`](../../core-concepts/dpf-types.md#property-field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -2 | [sum_merge](#input_-2) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| -1 | [merged_support](#input_-1) | |`abstract_field_support` | +| 0 | [fields](#input_0) | Required|`vector>`, [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1000 | [weights](#input_1000) | Required|`vector>`, [`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -57,6 +61,10 @@ Weights to apply to each field from pin 1000 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -72,8 +80,10 @@ Weights to apply to each field from pin 1000 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -84,6 +94,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -98,6 +110,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields_containers.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields_containers.md index 8b7cfaeddf..328d95f05e 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields_containers.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/merge_weighted_fields_containers.md @@ -14,13 +14,17 @@ Assembles a set of fields containers into a unique one, applying a weight on the ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -3| [sum_merge](#input_-3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| -2| [merged_fields_support](#input_-2) |`abstract_field_support` | -| -1| [merged_fields_containers_support](#input_-1) |`abstract_field_support`, `umap>` | -| 0 Required| [fields_containers](#input_0) |`vector>`, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1000 Required| [weights](#input_1000) |`vector>>`, `class dataProcessing::DpfTypeCollection` | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -3 | [sum_merge](#input_-3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| -2 | [merged_fields_support](#input_-2) | |`abstract_field_support` | +| -1 | [merged_fields_containers_support](#input_-1) | |`abstract_field_support`, `umap>` | +| 0 | [fields_containers](#input_0) | Required|`vector>`, [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1000 | [weights](#input_1000) | Required|`vector>>`, `class dataProcessing::DpfTypeCollection` | @@ -66,6 +70,10 @@ Weights to apply to each field from pin 1000 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [merged_fields_container](#output_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -81,15 +89,17 @@ Weights to apply to each field from pin 1000 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -100,6 +110,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -114,6 +126,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh.md index 16d86543e8..20e6215be5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh.md @@ -14,9 +14,13 @@ Incrementaly merge the input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region) | @@ -30,6 +34,10 @@ Incrementaly merge the input. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [incremented_result](#output_0) | | @@ -45,8 +53,10 @@ Incrementaly merge the input. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh_to_mc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh_to_mc.md index 147abf26e0..0b8f32e91c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh_to_mc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/mesh_to_mc.md @@ -14,10 +14,14 @@ Creates a meshes container containing the mesh provided on pin 0. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [mesh](#input_0) |[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | -| 1 Required| [label](#input_1) |[`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [mesh](#input_0) | Required|[`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +| 1 | [label](#input_1) | Required|[`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -39,6 +43,10 @@ Sets a label space. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [meshes_container](#output_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -54,8 +62,10 @@ Sets a label space. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/meshes_container.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/meshes_container.md index 5191f78e04..5c721da77d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/meshes_container.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/meshes_container.md @@ -14,9 +14,13 @@ Incrementaly merge the input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input](#input_0) |[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input](#input_0) | Required|[`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) | @@ -30,6 +34,10 @@ Incrementaly merge the input. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [incremented_result](#output_0) | | @@ -45,8 +53,10 @@ Incrementaly merge the input. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_changelog.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_changelog.md index 1f680adade..27714f812f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_changelog.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_changelog.md @@ -14,9 +14,13 @@ Return a GenericDataContainer used to instantiate the Changelog of an operator b ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [operator_name](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [operator_name](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -30,6 +34,10 @@ Operator internal name. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [changelog_gdc](#output_0) |[`generic_data_container`](../../core-concepts/dpf-types.md#generic-data-container) | @@ -45,8 +53,10 @@ GenericDataContainer used to instantiate a Changelog. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_id.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_id.md index 107fa762ed..feb2f2744b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_id.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/operator_id.md @@ -14,9 +14,13 @@ Return the id of an Operator. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [op](#input_0) |[`operator`](../../core-concepts/dpf-types.md#operator) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [op](#input_0) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | @@ -30,6 +34,10 @@ Return the id of an Operator. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [id](#output_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -45,8 +53,10 @@ Return the id of an Operator. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/overlap_fields.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/overlap_fields.md index 24e30ef485..c90e996ca5 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/overlap_fields.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/overlap_fields.md @@ -14,10 +14,14 @@ Take two fields and superpose them, the overlapping field will override values o ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [base_field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field) | -| 1| [overlapping_field](#input_1) |[`field`](../../core-concepts/dpf-types.md#field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [base_field](#input_0) | |[`field`](../../core-concepts/dpf-types.md#field) | +| 1 | [overlapping_field](#input_1) | |[`field`](../../core-concepts/dpf-types.md#field) | @@ -39,6 +43,10 @@ Take two fields and superpose them, the overlapping field will override values o ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -54,8 +62,10 @@ Take two fields and superpose them, the overlapping field will override values o ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/producer_consumer_for_each.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/producer_consumer_for_each.md index a7d43c2491..f598ad28a8 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/producer_consumer_for_each.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/producer_consumer_for_each.md @@ -14,10 +14,14 @@ Allows to write a loop over operators by connecting data to iterate and by reque ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [producer_consumer_iterableq](#input_0) | | -| 3 Required| [forward](#input_3) | | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [producer_consumer_iterableq](#input_0) | Required| | +| 3 | [forward](#input_3) | Required| | @@ -39,6 +43,10 @@ output of the last operators of the workflow ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [empty](#output_0) | | @@ -62,15 +70,17 @@ output of the last operators of the workflow ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### evaluate_inputs_before_run +### [evaluate_inputs_before_run](../../core-concepts/operator-configurations.md#evaluate_inputs_before_run) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, all input pins of the operator will be evaluated before entering the run method to maintain a correct Operator status. -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -81,6 +91,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -95,6 +107,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/property_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/property_field.md index 6e94c253db..7e1c07ca1d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/property_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/property_field.md @@ -14,9 +14,13 @@ Incrementaly merge the input. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input](#input_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input](#input_0) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -30,6 +34,10 @@ Incrementaly merge the input. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [incremented_result](#output_0) | | @@ -45,8 +53,10 @@ Incrementaly merge the input. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/propertyfield_get_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/propertyfield_get_attribute.md index 555df64733..4601c880bb 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/propertyfield_get_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/propertyfield_get_attribute.md @@ -14,10 +14,14 @@ Gets a property from an input field/field container. A PropertyFieldin pin 0, a ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [property_field](#input_0) |[`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [property_field](#input_0) | Required|[`property_field`](../../core-concepts/dpf-types.md#property-field), [`property_fields_container`](../../core-concepts/dpf-types.md#property-fields-container) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -39,6 +43,10 @@ Property to get. Accepted inputs are specific strings namely: 'unit, 'name','tim ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [property](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree) | @@ -54,8 +62,10 @@ Property value that is returned. Accepted Outputs are: Field, PropertyField, Cus ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -66,6 +76,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -80,6 +92,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/python_generator.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/python_generator.md index a5f6d10dc7..bfe5fa9018 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/python_generator.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/python_generator.md @@ -14,12 +14,16 @@ Generates .py file with specifications for loaded plugin(s). ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [dll_source_path](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [output_path](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [load_symbol](#input_2) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [library_key](#input_3) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [dll_source_path](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [output_path](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [load_symbol](#input_2) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [library_key](#input_3) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -57,6 +61,10 @@ Generates .py file with specifications for loaded plugin(s). ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| @@ -64,8 +72,10 @@ Generates .py file with specifications for loaded plugin(s). ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -76,6 +86,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -90,6 +102,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_operator_instantiate.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_operator_instantiate.md index 8e00bc4174..695968ad6d 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_operator_instantiate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_operator_instantiate.md @@ -14,13 +14,17 @@ Create a local image of an existing remote operator (identified by an id and an ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [operator_to_send](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 1 Required| [output_pin](#input_1) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [streams_to_remote](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources_to_remote](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | -| 5 Required| [output_name](#input_5) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [operator_to_send](#input_0) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [output_pin](#input_1) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_to_remote](#input_3) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources_to_remote](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +| 5 | [output_name](#input_5) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ output's name of the workflow to return ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [remote_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -81,22 +89,24 @@ remote workflow containing an image of the remote workflow and the protocols str ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -107,6 +117,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -121,6 +133,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_workflow_instantiate.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_workflow_instantiate.md index da877f5ca6..82455a2061 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_workflow_instantiate.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/remote_workflow_instantiate.md @@ -14,11 +14,15 @@ Sends a local workflow to a remote process (and keep a local image of it) or cre ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [workflow_to_send](#input_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow), [`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [streams_to_remote](#input_3) |[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | -| 4| [data_sources_to_remote](#input_4) |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [workflow_to_send](#input_0) | Required|[`workflow`](../../core-concepts/dpf-types.md#workflow), [`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [streams_to_remote](#input_3) | Required|[`streams_container`](../../core-concepts/dpf-types.md#streams-container) | +| 4 | [data_sources_to_remote](#input_4) | |[`data_sources`](../../core-concepts/dpf-types.md#data-sources) | @@ -48,6 +52,10 @@ local workflow to push to a remote or id of a remote workflow ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [remote_workflow](#output_0) |[`workflow`](../../core-concepts/dpf-types.md#workflow) | @@ -63,22 +71,24 @@ remote workflow containing an image of the remote workflow and the protocols str ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### num_threads +### [num_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel -### run_in_parallel +### [run_in_parallel](../../core-concepts/operator-configurations.md#run_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** true @@ -89,6 +99,8 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -103,6 +115,9 @@ Loops are allowed to run in parallel if the value of this config is set to true. ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/remove_unnecessary_labels.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/remove_unnecessary_labels.md index 9fa28397da..761cf3009f 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/remove_unnecessary_labels.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/remove_unnecessary_labels.md @@ -14,11 +14,15 @@ Removes the selected label from a fields container. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| -1| [permissive](#input_-1) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [label_to_remove](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| -1 | [permissive](#input_-1) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label_to_remove](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Label to be removed from the fields container. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,15 +71,17 @@ Label to be removed from the fields container. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. -### read_inputs_in_parallel +### [read_inputs_in_parallel](../../core-concepts/operator-configurations.md#read_inputs_in_parallel) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -82,6 +92,8 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -96,6 +108,9 @@ If this option is set to true, the operator's inputs will be evaluated in parall ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/scalars_to_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/scalars_to_field.md index 381db54701..cc93cb5016 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/scalars_to_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/scalars_to_field.md @@ -14,14 +14,18 @@ Creates a scalar or vector field from numeric data. Converts scalar values or ve ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [double_or_vector_double](#input_0) |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | -| 1| [unit](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [location](#input_2) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 3| [num_entities](#input_3) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 4| [num_components](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 5| [scoping](#input_5) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [double_or_vector_double](#input_0) | |[`double`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types) | +| 1 | [unit](#input_1) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [location](#input_2) | |[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [num_entities](#input_3) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 4 | [num_components](#input_4) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 5 | [scoping](#input_5) | |[`scoping`](../../core-concepts/dpf-types.md#scoping) | @@ -75,6 +79,10 @@ Scoping defining entity IDs and locations. If provided, overrides num_entities ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -90,8 +98,10 @@ Generated field with specified data and properties ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -102,6 +112,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -116,6 +128,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/server_path.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/server_path.md index 27ab97bc4f..7fcd3cb065 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/server_path.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/server_path.md @@ -14,9 +14,13 @@ Returns the platform-specific path to a folder in the Dpf server ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [subpath](#input_0) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [subpath](#input_0) | |[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -30,6 +34,10 @@ Subpath of the Dpf server. Supported values: 0 (default): root of the server, 1: ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [path](#output_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -45,8 +53,10 @@ Path to the requested folder in the Dpf server ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_attribute.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_attribute.md index 5443e1b5b3..3bdf160a21 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_attribute.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_attribute.md @@ -14,11 +14,15 @@ Uses the FieldsContainer APIs to modify it. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [property_identifier](#input_2) |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`label_space`](../../core-concepts/dpf-types.md#label-space) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property_identifier](#input_2) | |[`vector`](../../core-concepts/dpf-types.md#standard-types), [`label_space`](../../core-concepts/dpf-types.md#label-space) | @@ -48,6 +52,10 @@ Value of the property to be set : vector of string or LabelSpace for "labels". ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -63,8 +71,10 @@ Returns the modified FieldsContainer. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_property.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_property.md index dae9ab209f..ca44b9aa71 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_property.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/set_property.md @@ -14,11 +14,15 @@ Sets a property to an input field/field container. A Fieldin pin 0, a property n ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [property_name](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2 Required| [property](#input_2) |[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [property_name](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [property](#input_2) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types), [`time_freq_support`](../../core-concepts/dpf-types.md#time-freq-support), [`scoping`](../../core-concepts/dpf-types.md#scoping), [`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types) | @@ -48,6 +52,10 @@ Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScopi ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -63,8 +71,10 @@ Accepted Outputs are: Field, PropertyField, CustomTypeField or their containers. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -75,6 +85,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -89,6 +101,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/split_in_for_each_range.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/split_in_for_each_range.md index 4845ba9e41..02214f0d63 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/split_in_for_each_range.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/split_in_for_each_range.md @@ -14,13 +14,17 @@ Split a scoping into several pieces so you can iterate it with a for_each loop. ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0| [iterable](#input_0) | | -| 1 Required| [operator_to_iterate](#input_1) |[`operator`](../../core-concepts/dpf-types.md#operator) | -| 2 Required| [pin_index](#input_2) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | -| 3 Required| [scoping](#input_3) |[`scoping`](../../core-concepts/dpf-types.md#scoping) | -| 4 Required| [chunk_size](#input_4) |[`int32`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [iterable](#input_0) | | | +| 1 | [operator_to_iterate](#input_1) | Required|[`operator`](../../core-concepts/dpf-types.md#operator) | +| 2 | [pin_index](#input_2) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | +| 3 | [scoping](#input_3) | Required|[`scoping`](../../core-concepts/dpf-types.md#scoping) | +| 4 | [chunk_size](#input_4) | Required|[`int32`](../../core-concepts/dpf-types.md#standard-types) | @@ -66,6 +70,10 @@ Operator that must be reconnected with the range values. ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [output](#output_0) | | @@ -81,8 +89,10 @@ Operator that must be reconnected with the range values. ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt.md index 332c09e02b..723047954b 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt.md @@ -14,9 +14,13 @@ Converts strain field data from Voigt notation (6-component vector) to standard ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [strain_field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [strain_field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field with strain data in Voigt notation, or fields container containing such a ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ Field with strain data converted to standard 3x3 symmetric matrix format ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt_fc.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt_fc.md index 5ae4381120..21ae2ef84c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt_fc.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/strain_from_voigt_fc.md @@ -14,9 +14,13 @@ Converts strain field data from Voigt notation (6-component vector) to standard ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ Field with strain data in Voigt notation, or fields container containing such a ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -45,8 +53,10 @@ Field with strain data converted to standard 3x3 symmetric matrix format ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/txt_file_to_dpf.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/txt_file_to_dpf.md index 2356d10e61..f7a188aba0 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/txt_file_to_dpf.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/txt_file_to_dpf.md @@ -14,9 +14,13 @@ Take an input string and parse it into dataProcessing type ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [input_string](#input_0) |[`string`](../../core-concepts/dpf-types.md#standard-types) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [input_string](#input_0) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | @@ -30,6 +34,10 @@ ex: 'double:1.0', 'int:1', 'vector:1.0;1.0' ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [any_output](#output_0) | | @@ -45,8 +53,10 @@ any output ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/unitary_field.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/unitary_field.md index e3882eafb0..c3aa4ca79c 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/unitary_field.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/unitary_field.md @@ -14,9 +14,13 @@ Takes a field and returns another field of scalars in the same location and scop ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [field](#input_0) |[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [field](#input_0) | Required|[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container) | @@ -30,6 +34,10 @@ field or fields container with only one field is expected ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +Each output is detailed in the sections that follow the table. + | Pin number | Name | Expected type(s) | |-------|------|------------------| | **0**| [field](#output_0) |[`field`](../../core-concepts/dpf-types.md#field) | @@ -45,8 +53,10 @@ field or fields container with only one field is expected ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -57,6 +67,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -71,6 +83,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++ diff --git a/2027R1/dpf-framework-27-r1/operator-specifications/utility/weighted_merge_fields_by_label.md b/2027R1/dpf-framework-27-r1/operator-specifications/utility/weighted_merge_fields_by_label.md index 7c6ee4ee9b..6bafe0a90a 100644 --- a/2027R1/dpf-framework-27-r1/operator-specifications/utility/weighted_merge_fields_by_label.md +++ b/2027R1/dpf-framework-27-r1/operator-specifications/utility/weighted_merge_fields_by_label.md @@ -14,13 +14,17 @@ Performs a weighted merge on fields of a fields container that share the same la ## Inputs -| Pin number | Name | Expected type(s) | -|-------|-------|------------------| -| 0 Required| [fields_container](#input_0) |[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | -| 1 Required| [label](#input_1) |[`string`](../../core-concepts/dpf-types.md#standard-types) | -| 2| [merged_field_support](#input_2) |`abstract_field_support` | -| 3| [sum_merge](#input_3) |[`bool`](../../core-concepts/dpf-types.md#standard-types) | -| 1000 Required| [weights](#input_1000) |`vector>>`, [`property_field`](../../core-concepts/dpf-types.md#property-field) | +This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. +Some inputs are required, while others are optional and provide additional configuration. +Each parameter is detailed in the sections that follow the table. + +| Pin number | Name | Status | Expected type(s) | +|------------|------|--------|------------------| +| 0 | [fields_container](#input_0) | Required|[`fields_container`](../../core-concepts/dpf-types.md#fields-container) | +| 1 | [label](#input_1) | Required|[`string`](../../core-concepts/dpf-types.md#standard-types) | +| 2 | [merged_field_support](#input_2) | |`abstract_field_support` | +| 3 | [sum_merge](#input_3) | |[`bool`](../../core-concepts/dpf-types.md#standard-types) | +| 1000 | [weights](#input_1000) | Required|`vector>>`, [`property_field`](../../core-concepts/dpf-types.md#property-field) | @@ -66,6 +70,10 @@ Weights to apply to each field from pin 1000 to ... ## Outputs +This table lists the output pins for this operator. +Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. +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) | @@ -81,8 +89,10 @@ Weights to apply to each field from pin 1000 to ... ## Configurations +This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. + -### mutex +### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false @@ -93,6 +103,8 @@ If this option is set to true, the shared memory is prevented from being simulta ## Scripting +This operator can be accessed through scripting interfaces using these identifiers. + **Category**: utility **Plugin**: core @@ -107,6 +119,9 @@ If this option is set to true, the shared memory is prevented from being simulta ## Examples +These examples demonstrate how to use this operator in different programming environments. +Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. +
C++