math:modal participation

Version: 0.0.0

Description

Compute the modal participation factor for a given vector field V, defined as sum_i ( V .dot. mode_shape_i * ponderation ).

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.

v_real (Pin 0)

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

real part of field V

v_imag (Pin 1)

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

imag part of field V

mode_shapes (Pin 2)

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

ponderation (Pin 3)

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

force_label_space (Pin 4)

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

If set, will force a label space for output result.

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.

output (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: math

Plugin: core

Scripting name: modal_participation

Full name: math.modal_participation

Internal name: harmonic::modal_participation

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("harmonic::modal_participation"); // operator instantiation
op.connect(0, my_v_real);
op.connect(1, my_v_imag);
op.connect(2, my_mode_shapes);
op.connect(3, my_ponderation);
op.connect(4, my_force_label_space);
ansys::dpf::FieldsContainer my_output = op.getOutput<ansys::dpf::FieldsContainer>(0);

import ansys.dpf.core as dpf

op = dpf.operators.math.modal_participation() # operator instantiation
op.inputs.v_real.connect(my_v_real)
op.inputs.v_imag.connect(my_v_imag)
op.inputs.mode_shapes.connect(my_mode_shapes)
op.inputs.ponderation.connect(my_ponderation)
op.inputs.force_label_space.connect(my_force_label_space)
my_output = op.outputs.output()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.modal_participation() # operator instantiation
op.inputs.v_real.Connect(my_v_real)
op.inputs.v_imag.Connect(my_v_imag)
op.inputs.mode_shapes.Connect(my_mode_shapes)
op.inputs.ponderation.Connect(my_ponderation)
op.inputs.force_label_space.Connect(my_force_label_space)
my_output = op.outputs.output.GetData()

Changelog

• Version 0.0.0: Initial release.