FrequencyRayleighDamping

FrequencyRayleighDamping

FrequencyRayleighDamping(damping_factor: float, f1: float = 0.2, f2: float = 20.0, user_name: Optional[str] = None)

Bases: RayleighDamping

Frequency-based Rayleigh damping generator.

FrequencyRayleighDamping automatically calculates Rayleigh alphaM and betaK factors given a target damping ratio and two control frequencies (such as first and second modes).

Tcl form

Renders inside region definitions as: -rayleigh <alphaM> <betaK> 0.0 0.0

Example

from femora.core.model import Model

model = Model()
damping = model.damping.frequency_rayleigh(
    damping_factor=0.05,
    f1=0.2,
    f2=20.0,
)
print(damping.tag)

Create a frequency-based Rayleigh damping model.

Parameters:

Name	Type	Description	Default
damping_factor	float	Target damping ratio (between 0.0 and 1.0).	required
f1	float	First control frequency in Hz.	0.2
f2	float	Second control frequency in Hz.	20.0
user_name	Optional[str]	Optional unique name for the damping object.	None

Raises:

Type	Description
ValueError	If frequencies are non-positive or if damping_factor is outside [0.0, 1.0].

Methods:

get_type staticmethod

get_type() -> str

Get the damping type name.

Returns:

Type	Description
str	The string "Frequency Rayleigh".