result:turbulent kinetic energy (k)

Version: 0.0.0

Description

Read Turbulent Kinetic Energy (k) 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):

• cff: cas, flprj

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.

time_scoping (Pin 0)

• Required: No
• Expected type(s): scoping, int32, vector<int32>, double, field, vector<double>

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, 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

streams_container (Pin 3)

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

result file container allowed to be kept open to cache data

data_sources (Pin 4)

• Required: Yes
• Expected type(s): data_sources

result file path container, used if no streams are set

mesh (Pin 7)

• Required: No
• Expected type(s): abstract_meshed_region, meshes_container

prevents from reading the mesh in the result files

region_scoping (Pin 25)

• Required: No
• Expected type(s): scoping, int32, vector<int32>

region id (integer) or vector of region ids (vector) or region scoping (scoping) of the model (region corresponds to zone for Fluid results or part for LSDyna results).

qualifiers (Pin 1000)

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

(for Fluid results only) LabelSpace with combination of zone, phases or species ids

Outputs

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

fields_container (Pin 0)

• Expected type(s): fields_container

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: turbulent_kinetic_energy

Full name: result.turbulent_kinetic_energy

Internal name: K

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.

#include "dpf_api.h"

ansys::dpf::Operator op("K"); // operator instantiation
op.connect(0, my_time_scoping);
op.connect(1, my_mesh_scoping);
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(7, my_mesh);
op.connect(25, my_region_scoping);
op.connect(1000, my_qualifiers);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::fieldscontainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.result.turbulent_kinetic_energy() # operator instantiation
op.inputs.time_scoping.connect(my_time_scoping)
op.inputs.mesh_scoping.connect(my_mesh_scoping)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.mesh.connect(my_mesh)
op.inputs.region_scoping.connect(my_region_scoping)
op.inputs.qualifiers1.connect(my_qualifiers1)
op.inputs.qualifiers2.connect(my_qualifiers2)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.turbulent_kinetic_energy() # operator instantiation
op.inputs.time_scoping.Connect(my_time_scoping)
op.inputs.mesh_scoping.Connect(my_mesh_scoping)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.mesh.Connect(my_mesh)
op.inputs.region_scoping.Connect(my_region_scoping)
op.inputs.qualifiers.Connect(my_qualifiers)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.