metadata:boundary condition provider

Version: 0.0.0

Description

Reads boundary conditions from the results files contained in the streams or data sources.

Supported file types

This operator supports the following keys (file formats) for each listed namespace (plugin/solver):

• mapdl: cms, mode, rdsp, rfrq, rst, rstp, rth

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

Time/freq set ids (use ints or scoping) or time/freq step ids (use scoping with TimeFreq_steps location) required in output.

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.

property (Pin 13)

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

Type of boundary condition to get.

Available boundary conditions are :

• Applied Force : 1
• Fixed Displacement : 2
• Applied Pressure : 3
• Fixed Temperature : 4
• Applied Heat Flux : 5
• Fluid Temperature : 6
• Film Coefficient Convection : 7
• Ambient Temperature : 8
• Spatial Integrand : 9
• Fixed Rotation : 10
• Fixed Acceleration : 11
• Fixed Velocity : 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.

field_or_fields_container (Pin 0)

• Expected type(s): field, fields_container

Value of the boundary condition at each node (0 if there is not). It is a field if there is only one time step, and a fields container otherwise.

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

Plugin: core

Scripting name: boundary_condition_provider

Full name: metadata.boundary_condition_provider

Internal name: boundary_conditions

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("boundary_conditions"); // operator instantiation
op.connect(0, my_time_scoping);
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
op.connect(13, my_property);
ansys::dpf::Field my_field_or_fields_container = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.metadata.boundary_condition_provider() # operator instantiation
op.inputs.time_scoping.connect(my_time_scoping)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.property.connect(my_property)
my_field_or_fields_container_as_field = op.outputs.field_or_fields_container_as_field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.metadata.boundary_condition_provider() # operator instantiation
op.inputs.time_scoping.Connect(my_time_scoping)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.property.Connect(my_property)
my_field_or_fields_container = op.outputs.field_or_fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.