utility:convert to field

Version: 0.0.0

Description

Creates a scalar or vector field from numeric data. Converts scalar values or vectors into a DPF field with specified properties.

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.

double_or_vector_double (Pin 0)

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

Data of the field. Default is 0-field. Specify a double to create a field with uniform values, or a vector for explicit data per entity

unit (Pin 1)

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

Unit symbol (m, Hz, kg, ...). Default is dimensionless

location (Pin 2)

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

Location of the field: 'Nodal', 'ElementalNodal', 'Elemental', etc. Default is 'numeric'

num_entities (Pin 3)

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

Number of field entities. Default is 1, or the size of the scoping if provided

num_components (Pin 4)

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

Number of field components per entity. Default is 1 for scalar, >1 for vector

scoping (Pin 5)

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

Scoping defining entity IDs and locations. If provided, overrides num_entities

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 (Pin 0)

• Expected type(s): field

Generated field with specified data and properties

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

Plugin: core

Scripting name: scalars_to_field

Full name: utility.scalars_to_field

Internal name: fieldify

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("fieldify"); // operator instantiation
op.connect(0, my_double_or_vector_double);
op.connect(1, my_unit);
op.connect(2, my_location);
op.connect(3, my_num_entities);
op.connect(4, my_num_components);
op.connect(5, my_scoping);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.scalars_to_field() # operator instantiation
op.inputs.double_or_vector_double.connect(my_double_or_vector_double)
op.inputs.unit.connect(my_unit)
op.inputs.location.connect(my_location)
op.inputs.num_entities.connect(my_num_entities)
op.inputs.num_components.connect(my_num_components)
op.inputs.scoping.connect(my_scoping)
my_field = op.outputs.field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.scalars_to_field() # operator instantiation
op.inputs.double_or_vector_double.Connect(my_double_or_vector_double)
op.inputs.unit.Connect(my_unit)
op.inputs.location.Connect(my_location)
op.inputs.num_entities.Connect(my_num_entities)
op.inputs.num_components.Connect(my_num_components)
op.inputs.scoping.Connect(my_scoping)
my_field = op.outputs.field.GetData()

Changelog

• Version 0.0.0: Initial release.