utility:change shell layers

Version: 0.0.0

Description

Extract the requested shell layers from the input fields. If the fields contain only one layer and the permissive configuration input is set to true then it returns the input fields. If permissive configuration input is set to false, any change which should not be permitted won't be achieved and the corresponding field in the output will be empty. If permissive configuration input is set to true (default), carefully check the result.

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.

fields_container (Pin 0)

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

e_shell_layer (Pin 1)

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

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

mesh (Pin 2)

• Required: No
• Expected type(s): abstract_meshed_region, meshes_container

Mesh support of the input fields_container, in case it does not have one defined. If the fields_container contains mixed shell/solid results, the mesh is required (either by connecting this pin or in the support).

merge (Pin 26)

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

For fields with mixed shell layers (solid/shell elements with heterogeneous shell layers), group all of them in the same field (false by default).

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, 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.

permissive

• Expected type(s): bool
• Default value: true

If permissive is set to false, the operator run will ensure the 'change shell layers' operation is allowed (for example, if asking mid layer for a field defined on top and bottom layers, the computed field will be empty). If permissive is set to true, the operator run will be done in a permissive way (no check). Default is true.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: utility

Plugin: core

Scripting name: change_shell_layers

Full name: utility.change_shell_layers

Internal name: change_shellLayers

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("change_shellLayers"); // operator instantiation
op.connect(0, my_fields_container);
op.connect(1, my_e_shell_layer);
op.connect(2, my_mesh);
op.connect(26, my_merge);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.change_shell_layers() # operator instantiation
op.inputs.fields_container.connect(my_fields_container)
op.inputs.e_shell_layer.connect(my_e_shell_layer)
op.inputs.mesh.connect(my_mesh)
op.inputs.merge.connect(my_merge)
my_fields_container_as_fields_container = op.outputs.fields_container_as_fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.change_shell_layers() # operator instantiation
op.inputs.fields_container.Connect(my_fields_container)
op.inputs.e_shell_layer.Connect(my_e_shell_layer)
op.inputs.mesh.Connect(my_mesh)
op.inputs.merge.Connect(my_merge)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.