## On this page # result:temperature gradient X Last update: 31.07.2026 **Version: 0.0.0** ## Description Read/compute Temperature Gradient X component of the vector (1st component) by calling the readers defined by the datasources. Regarding the requested location and the input mesh scoping, the result location can be Nodal/ElementalNodal/Elemental. ## Supported file types This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver): - hdf5: h5dpf ## Inputs This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table. Pin numberNameStatusExpected type(s)0[time\_scoping](#input_0)[`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types)**1**[mesh\_scoping](#input_1)[`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping)**2**[fields\_container](#input_2)[`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) ### time\_scoping (Pin 0) - **Required:** No - **Expected type(s):** [`scoping`](../../core-concepts/dpf-types.md#scoping), [`int32`](../../core-concepts/dpf-types.md#standard-types), [`vector`](../../core-concepts/dpf-types.md#standard-types), [`double`](../../core-concepts/dpf-types.md#standard-types), [`field`](../../core-concepts/dpf-types.md#field), [`vector`](../../core-concepts/dpf-types.md#standard-types) time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq\_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq\_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs are higher than available time/freqs in result files. To get all data for all time/freq sets, connect an int with value -1. ### mesh\_scoping (Pin 1) - **Required:** No - **Expected type(s):** [`scopings_container`](../../core-concepts/dpf-types.md#scopings-container), [`scoping`](../../core-concepts/dpf-types.md#scoping) nodes or elements scoping required in output. The output fields will be scoped on these node or element IDs. To figure out the ordering of the fields data, look at their scoping IDs as they might not be ordered as the input scoping was. The scoping's location indicates whether nodes or elements are asked for. Using scopings container allows you to split the result fields container into domains ### fields\_container (Pin 2) - **Required:** No - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) FieldsContainer already allocated modified inplace ### streams\_container (Pin 3) - **Required:** No - **Expected type(s):** [`streams_container`](../../core-concepts/dpf-types.md#streams-container) result file container allowed to be kept open to cache data ### data\_sources (Pin 4) - **Required:** Yes - **Expected type(s):** [`data_sources`](../../core-concepts/dpf-types.md#data-sources) result file path container, used if no streams are set ### bool\_rotate\_to\_global (Pin 5) - **Required:** No - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) if true the field is rotated to global coordinate system (default true) ### mesh (Pin 7) - **Required:** No - **Expected type(s):** [`abstract_meshed_region`](../../core-concepts/dpf-types.md#meshed-region), [`meshes_container`](../../core-concepts/dpf-types.md#meshes-container) prevents from reading the mesh in the result files ### requested\_location (Pin 9) - **Required:** No - **Expected type(s):** [`string`](../../core-concepts/dpf-types.md#standard-types) requested location, default is Nodal ### read\_cyclic (Pin 14) - **Required:** No - **Expected type(s):** `enum dataProcessing::ECyclicReading`, [`int32`](../../core-concepts/dpf-types.md#standard-types) if 0 cyclic symmetry is ignored, if 1 cyclic sector is read, if 2 cyclic expansion is done, if 3 cyclic expansion is done and stages are merged (default is 1) ### read\_beams (Pin 22) - **Required:** No - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) elemental nodal beam results are read if this pin is set to true (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 numberNameExpected type(s)0[fields\_container](#output_0)[`fields_container`](../../core-concepts/dpf-types.md#fields-container) ### fields\_container (Pin 0) - **Expected type(s):** [`fields_container`](../../core-concepts/dpf-types.md#fields-container) ## Configurations This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior. ### [mutex](../../core-concepts/operator-configurations.md#mutex) - **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** false If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. ### [num\_threads](../../core-concepts/operator-configurations.md#num_threads) - **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types) - **Default value:** 0 Number of threads to use to run in parallel ### [run\_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. ## Scripting This operator can be accessed through scripting interfaces using these identifiers. **Category**: result **Plugin**: core **Scripting name**: temperature\_grad\_X **Full name**: result.temperature\_grad\_X **Internal name**: TGX **License**: None ## Examples These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output. C++```cpp #include "dpf_api.h" ansys::dpf::Operator op("TGX"); // operator instantiation op.connect(0, my_time_scoping); op.connect(1, my_mesh_scoping); op.connect(2, my_fields_container); op.connect(3, my_streams_container); op.connect(4, my_data_sources); op.connect(5, my_bool_rotate_to_global); op.connect(7, my_mesh); op.connect(9, my_requested_location); op.connect(14, my_read_cyclic); op.connect(22, my_read_beams); ansys::dpf::FieldsContainer my_fields_container = op.getOutput(0); ``` CPython```python import ansys.dpf.core as dpf op = dpf.operators.result.temperature_grad_X() # operator instantiation op.inputs.time_scoping.connect(my_time_scoping) op.inputs.mesh_scoping.connect(my_mesh_scoping) op.inputs.fields_container.connect(my_fields_container) op.inputs.streams_container.connect(my_streams_container) op.inputs.data_sources.connect(my_data_sources) op.inputs.bool_rotate_to_global.connect(my_bool_rotate_to_global) op.inputs.mesh.connect(my_mesh) op.inputs.requested_location.connect(my_requested_location) op.inputs.read_cyclic.connect(my_read_cyclic) op.inputs.read_beams.connect(my_read_beams) my_fields_container = op.outputs.fields_container() ``` IPython```python import mech_dpf import Ans.DataProcessing as dpf op = dpf.operators.result.temperature_grad_X() # operator instantiation op.inputs.time_scoping.Connect(my_time_scoping) op.inputs.mesh_scoping.Connect(my_mesh_scoping) op.inputs.fields_container.Connect(my_fields_container) op.inputs.streams_container.Connect(my_streams_container) op.inputs.data_sources.Connect(my_data_sources) op.inputs.bool_rotate_to_global.Connect(my_bool_rotate_to_global) op.inputs.mesh.Connect(my_mesh) op.inputs.requested_location.Connect(my_requested_location) op.inputs.read_cyclic.Connect(my_read_cyclic) op.inputs.read_beams.Connect(my_read_beams) my_fields_container = op.outputs.fields_container.GetData() ``` ## Changelog - Version 0.0.0: Initial release.