Skip to main content

DPF Framework 2025 R2

result:reaction force Y

Last update: 03.06.2026

Version: 0.0.0

Description

Read/compute nodal reaction forces Y component of the vector (2nd component) by calling the readers defined by the datasources.

Supported file types

This operator supports the following keys (file formats) 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 number Name Status Expected type(s)
0 time_scoping scoping, int32, vector<int32>, double, field, vector<double>
1 mesh_scoping scopings_container, scoping
2 fields_container fields_container
3 streams_container streams_container
4 data_sources Required data_sources
5 bool_rotate_to_global bool
7 mesh abstract_meshed_region, meshes_container
14 read_cyclic enum dataProcessing::ECyclicReading, int32

time_scoping (Pin 0)

time/freq values (use doubles or field), time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output. To specify time/freq values at specific load steps, put a Field (and not a list) in input with a scoping located on "TimeFreq_steps". Linear time freq intrapolation is performed if the values are not in the result files and the data at the max time or freq is taken when time/freqs 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)

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)

FieldsContainer already allocated modified inplace

streams_container (Pin 3)

result file container allowed to be kept open to cache data

data_sources (Pin 4)

result file path container, used if no streams are set

bool_rotate_to_global (Pin 5)

  • Required: No
  • Expected type(s): bool

if true the field is rotated to global coordinate system (default true)

mesh (Pin 7)

prevents from reading the mesh in the result files

read_cyclic (Pin 14)

  • Required: No
  • Expected type(s): enum dataProcessing::ECyclicReading, int32

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)

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

Pin number Name Expected type(s)
0 fields_container fields_container

fields_container (Pin 0)

Configurations

This operator supports configuration options that modify its behavior.

mutex

  • Expected type(s): bool
  • Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

num_threads

  • Expected type(s): int32
  • Default value: 0

Number of threads to use to run in parallel

run_in_parallel

  • Expected type(s): bool
  • 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: reaction_force_Y

Full name: result.reaction_force_Y

Internal name: RFY

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++
#include "dpf_api.h"

ansys::dpf::Operator op("RFY"); // 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(14, my_read_cyclic);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::fieldscontainer>(0);

</ansys::dpf::fieldscontainer>

CPython
import ansys.dpf.core as dpf

op = dpf.operators.result.reaction_force_Y() # 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.read_cyclic.connect(my_read_cyclic)
my_fields_container = op.outputs.fields_container()
IPython
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.reaction_force_Y() # 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.read_cyclic.Connect(my_read_cyclic)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys