Skip to main content

DPF Framework 2025 R2

result:part kinetic energy (LSDyna)

Last update: 03.06.2026

Version: 0.0.0

Description

Read Part Kinetic Energy (LSDyna) 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
  • lsdyna: binout

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)
3 streams_container streams_container
4 data_sources Required data_sources
6 entity_scoping scoping
50 unit_system int32, string, class dataProcessing::unit::CUnitSystem

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

entity_scoping (Pin 6)

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

entity (part for matsum, interface for rcforc) where the result will be scoped

unit_system (Pin 50)

  • Required: No
  • Expected type(s): int32, string, class dataProcessing::unit::CUnitSystem

Unit System ID (int), semicolon-separated list of base unit strings (str) or UnitSystem instance

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or 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.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: result

Plugin: core

Scripting name: part_kinetic_energy

Full name: result.part_kinetic_energy

Internal name: M_KE

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("M_KE"); // operator instantiation
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(6, my_entity_scoping);
op.connect(50, my_unit_system);
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.part_kinetic_energy() # operator instantiation
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.entity_scoping.connect(my_entity_scoping)
op.inputs.unit_system.connect(my_unit_system)
my_fields_container = op.outputs.fields_container()
IPython
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.part_kinetic_energy() # operator instantiation
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.entity_scoping.Connect(my_entity_scoping)
op.inputs.unit_system.Connect(my_unit_system)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys