serialization:vtk to fields

Version: 0.0.0

Description

Write a field based on a vtk file.

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.

field_name (Pin 0)

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

name of the field in the vtk file

streams (Pin 3)

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

data_sources (Pin 4)

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

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

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

Plugin: vtk

Scripting name: vtk_to_fields

Full name: serialization.vtk_to_fields

Internal name: vtk::vtk::FieldProvider

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("vtk::vtk::FieldProvider"); // operator instantiation
op.connect(0, my_field_name);
op.connect(3, my_streams);
op.connect(4, my_data_sources);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.serialization.vtk_to_fields() # operator instantiation
op.inputs.field_name.connect(my_field_name)
op.inputs.streams.connect(my_streams)
op.inputs.data_sources.connect(my_data_sources)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.serialization.vtk_to_fields() # operator instantiation
op.inputs.field_name.Connect(my_field_name)
op.inputs.streams.Connect(my_streams)
op.inputs.data_sources.Connect(my_data_sources)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.