vivyd.excitation.ExcitationGroup

class ExcitationGroup(*excitations)

Bases: TaichiCompatible

A class for representing a group of excitations. More importantly, this class provides a handle comprising all the excitations in the group, which can then be passed to the solver in order to have better control of the model’s excitations.

Parameters:

*excitations (Excitation) – One or more Excitation objects representing the group of excitations.

Attributes

property ExcitationGroup.handle

Get the handle for this excitation group, which can be passed to the solver.

Methods

ExcitationGroup.__call__(t)

Shorthand for interpolate().

Parameters:

t (float)

Return type:

arrf64

ExcitationGroup.interpolate(t)

Interpolate the excitations in the group at a given time t.

Parameters:

t (float) – The time at which to interpolate the excitations.

Returns:

The interpolated excitations at time t. Each element in the array is the interpolated value of the corresponding excitation in the group.

Return type:

arrf64