Template Class Ieeet1

Inheritance Relationships

Base Type

Class Documentation

template<typename scalar_type, typename index_type>
class Ieeet1 : public GridKit::PhasorDynamics::Component<scalar_type, index_type>

Public Functions

Ieeet1(BusT *bus)

Constructor for IEEET1 Exciter.

Ieeet1(SignalT *efd_signal, SignalT *speed_signal, BusT *bus, const ModelDataT &data)

Constructor for IEEET1 Exciter.

Parameters:

  • data – Data object to store parameters

  • bus – Signal used for terminal reference vmag

  • speed – Signal used for machine relative speed

  • efd – Signal used for E field

Ieeet1(BusT *bus, const ModelDataT &data)

Constructor for IEEET1 Exciter.

Parameters:

  • bus – Signal used for terminal reference vmag

  • data – Data object to store parameters

virtual int setGridKitComponentID(IdxT) final override

Set the component ID.

virtual int allocate() final override

Allocate memory for model.

virtual int verify() const final override

verify method checks that attached signals are also linked

virtual int initialize() final override

Initialization of the Exciter.

Solves for a steady-state initial condition that satisfies F(y, yp=0, t=0) = 0 exactly for every residual equation.

Inputs:

  • EFD assigned by the generator (read from y_[7]).

  • Bus voltage, used to form the sensed terminal voltage Ec.

  • Attached external signals (omega, V_S)

Saturation is included via ksat computed from efdp and SA, SB.

virtual int tagDifferentiable() final override

Identify differential variables.

Returns:

int 0

virtual int evaluateResidual() final override

Residual evaluation.

virtual int evaluateJacobian() final override

Jacobian evaluation not implemented yet.

Returns:

int - error code, 0 = success

inline auto getSignals() -> ComponentSignals<ScalarT, IdxT, Ieeet1InternalVariables, Ieeet1ExternalVariables>&

Get the ComponentSignals from this Ieeet1

virtual const Model::VariableMonitorBase *getMonitor() const override

Get non-owning reference to monitor.