result:poynting vector

Version: 0.0.0

Description

Compute the Poynting Vector

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

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

fields_containerB (Pin 1)

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

fields_containerC (Pin 2)

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

fields_containerD (Pin 3)

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

abstract_meshed_region (Pin 4)

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

the mesh region in this pin have to be boundary or skin mesh

int32 (Pin 5)

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

load step number, if it's specified, the Poynting Vector is computed only on the substeps of this step

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

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

Plugin: core

Scripting name: poynting_vector

Full name: result.poynting_vector

Internal name: PoyntingVector

License: any_dpf_supported_increments

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("PoyntingVector"); // operator instantiation
op.connect(0, my_fields_containerA);
op.connect(1, my_fields_containerB);
op.connect(2, my_fields_containerC);
op.connect(3, my_fields_containerD);
op.connect(4, my_abstract_meshed_region);
op.connect(5, my_int32);
ansys::dpf::FieldsContainer my_fields_container = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.result.poynting_vector() # operator instantiation
op.inputs.fields_containerA.connect(my_fields_containerA)
op.inputs.fields_containerB.connect(my_fields_containerB)
op.inputs.fields_containerC.connect(my_fields_containerC)
op.inputs.fields_containerD.connect(my_fields_containerD)
op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
op.inputs.int32.connect(my_int32)
my_fields_container = op.outputs.fields_container()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.poynting_vector() # operator instantiation
op.inputs.fields_containerA.Connect(my_fields_containerA)
op.inputs.fields_containerB.Connect(my_fields_containerB)
op.inputs.fields_containerC.Connect(my_fields_containerC)
op.inputs.fields_containerD.Connect(my_fields_containerD)
op.inputs.abstract_meshed_region.Connect(my_abstract_meshed_region)
op.inputs.int32.Connect(my_int32)
my_fields_container = op.outputs.fields_container.GetData()

Changelog

• Version 0.0.0: Initial release.