Template Class Gensal

• Defined in File Gensal.hpp

Inheritance Relationships

Base Type

• public GridKit::PhasorDynamics::Component< scalar_type, index_type > (Template Class Component)

Class Documentation

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

Public Functions

Gensal(BusT *bus, const ModelDataT &data)

Constructor for a GENSAL generator model with saturation.

virtual int setGridKitComponentID(IdxT) final override

Set the component ID.

virtual int allocate() final override

allocate method computes sparsity pattern of the Jacobian.

virtual int verify() const final override

verify method checks that attached signals are also linked

virtual int initialize() final override

Initialization of the generator model

virtual int tagDifferentiable() final override

Identify differential variables.

virtual int evaluateResidual() final override

Residual evaluation and contribution to the connected bus.

virtual int evaluateJacobian() final override

Jacobian evaluation not implemented yet.

Jacobian evaluation experimental.

Returns:

int - error code, 0 = success

ScalarT getSpeed()

Access generator relative speed.

Returns:

int - error code, 0 = success

inline auto getSignals() -> ComponentSignals<ScalarT, IdxT, GensalInternalVariables, GensalExternalVariables>&

Get the ComponentSignals from this Gensal

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

Get non-owning reference to monitor.