serialization:migrate to vtk

Version: 0.0.0

Description

Take an input data sources or streams and convert as much data as possible to vtk.

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.

output_filename (Pin 0)

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

streams_container (Pin 3)

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

data_sources (Pin 4)

• Required: No
• 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.

data_sources (Pin 0)

• Expected type(s): data_sources

Generated output vtk file

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

Full name: serialization.migrate_file_to_vtk

Internal name: vtk::migrate_file

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::migrate_file"); // operator instantiation
op.connect(0, my_output_filename);
op.connect(3, my_streams_container);
op.connect(4, my_data_sources);
ansys::dpf::DataSources my_data_sources = op.getOutput<ansys::dpf::DataSources>(0);

import ansys.dpf.core as dpf

op = dpf.operators.serialization.migrate_file_to_vtk() # operator instantiation
op.inputs.output_filename.connect(my_output_filename)
op.inputs.streams_container.connect(my_streams_container)
op.inputs.data_sources.connect(my_data_sources)
my_data_sources = op.outputs.data_sources()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.serialization.migrate_file_to_vtk() # operator instantiation
op.inputs.output_filename.Connect(my_output_filename)
op.inputs.streams_container.Connect(my_streams_container)
op.inputs.data_sources.Connect(my_data_sources)
my_data_sources = op.outputs.data_sources.GetData()

Changelog

• Version 0.0.0: Initial release.