utility:clone field to shell layer

Version: 0.0.0

Description

Generates a Field from the Field in input 0 that has the same FieldDefinition with the exception of the shellLayers enum that is specified in input 1. The DataPointer is recomputed to the appropriate value. The Data of the output Field is 0.0 for all entities. Scoping can be shared or not based on the optional pin 2.

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

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

shell_layer (Pin 1)

• Required: Yes
• Expected type(s): int32, enum dataProcessing::EShellLayers

0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.

duplicate_scoping (Pin 2)

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

If true, a new scoping is computed for the output Field. If false, the input Field scoping is used. Default is false.

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

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

Full name: utility.field_clone_to_shell_layer

Internal name: field::clone_to_shell_layer

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("field::clone_to_shell_layer"); // operator instantiation
op.connect(0, my_field);
op.connect(1, my_shell_layer);
op.connect(2, my_duplicate_scoping);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.field_clone_to_shell_layer() # operator instantiation
op.inputs.field.connect(my_field)
op.inputs.shell_layer.connect(my_shell_layer)
op.inputs.duplicate_scoping.connect(my_duplicate_scoping)
my_field = op.outputs.field()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.field_clone_to_shell_layer() # operator instantiation
op.inputs.field.Connect(my_field)
op.inputs.shell_layer.Connect(my_shell_layer)
op.inputs.duplicate_scoping.Connect(my_duplicate_scoping)
my_field = op.outputs.field.GetData()

Changelog

• Version 0.0.0: Initial release.