Template Class Bus

Inheritance Relationships

Base Type

Class Documentation

template<typename scalar_type, typename index_type>
class Bus : public GridKit::PhasorDynamics::BusBase<scalar_type, index_type>

Implementation of a PQ bus.

Voltage V and phase theta are variables in PQ bus model. Active and reactive power, P and Q, are residual components.

Public Functions

Bus()

Constructor for a phasor dynamics bus.

The model is using current balance in Cartesian coordinates.

Todo:

Arguments that should be passed to ModelEvaluatorImpl constructor:

  • Number of equations = 2 (size_)

  • Number of variables = 2 (size_)

  • Number of quadratures = 0

  • Number of optimization parameters = 0

Bus(ScalarT Vr, ScalarT Vi)

Bus constructor.

This constructor sets initial values for active and reactive voltage.

Todo:

Arguments that should be passed to ModelEvaluatorImpl constructor:

  • Number of equations = 2 (size_)

  • Number of variables = 2 (size_)

  • Number of quadratures = 0

  • Number of optimization parameters = 0

Bus(const ModelDataT &data)

Construct a new Bus.

Parameters:

data – [in] - structure with bus data

virtual int setBusID(IdxT) final override

Set the bus ID.

virtual int allocate() final override

allocate method resizes local solution and residual vectors.

virtual int tagDifferentiable() final override

Bus variables are algebraic.

virtual int initialize() final override

initialize method sets bus variables to stored initial values.

virtual int evaluateResidual() final override

PQ bus does not compute residuals, so here we just reset residual values.

Warning

This implementation assumes bus residuals are always evaluated before component model residuals.

virtual int evaluateJacobian() final override

Jacobian evaluation not implemented.

Jacobian evaluation experimental. This sets values to 0, for other components to add their contributions.

Warning

This implementation assumes bus Jacobians are always evaluated before component model Jacobians.

Returns:

int - error code

Returns:

int - error code

inline virtual BusTypeT BusType() const final override

Pure virtual function, returns bus type (DEFAULT or SLACK).