Skip to main content

DPF Framework 2026 R1

math:modal damping ratio

Last update: 31.07.2026

Version: 0.0.0

Description

Computes damping ratio for each mode shape as X_i = const + ratio_i + m_coefficient / (2*omega_i) + k_coefficient * omega_i/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.

Pin number Name Status Expected type(s)
0 natural_freq Required vector<double>
1 const_ratio double
2 ratio_by_modes vector<double>
3 m_coefficient Required double
4 k_coefficient Required double

natural_freq (Pin 0)

input vector expects natural frequencies.

const_ratio (Pin 1)

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

constant modal damping ratio

ratio_by_modes (Pin 2)

modal damping ratio for each mode shape

m_coefficient (Pin 3)

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

global mass matrix multiplier

k_coefficient (Pin 4)

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

global stiffness matrix multiplier

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.

Pin number Name Expected type(s)
0 field field

field (Pin 0)

  • Expected type(s): field

field of modal damping ratio.

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_damping_ratio

Full name: math.modal_damping_ratio

Internal name: modal_damping_ratio

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.

C++
#include "dpf_api.h"

ansys::dpf::Operator op("modal_damping_ratio"); // operator instantiation
op.connect(0, my_natural_freq);
op.connect(1, my_const_ratio);
op.connect(2, my_ratio_by_modes);
op.connect(3, my_m_coefficient);
op.connect(4, my_k_coefficient);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);
CPython
import ansys.dpf.core as dpf

op = dpf.operators.math.modal_damping_ratio() # operator instantiation
op.inputs.natural_freq.connect(my_natural_freq)
op.inputs.const_ratio.connect(my_const_ratio)
op.inputs.ratio_by_modes.connect(my_ratio_by_modes)
op.inputs.m_coefficient.connect(my_m_coefficient)
op.inputs.k_coefficient.connect(my_k_coefficient)
my_field = op.outputs.field()
IPython
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.modal_damping_ratio() # operator instantiation
op.inputs.natural_freq.Connect(my_natural_freq)
op.inputs.const_ratio.Connect(my_const_ratio)
op.inputs.ratio_by_modes.Connect(my_ratio_by_modes)
op.inputs.m_coefficient.Connect(my_m_coefficient)
op.inputs.k_coefficient.Connect(my_k_coefficient)
my_field = op.outputs.field.GetData()

Changelog

  • Version 0.0.0: Initial release.

Connect with Ansys