Template Class BusFault

Inheritance Relationships

Base Type

Class Documentation

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

Public Functions

BusFault(BusT *bus)

Constructor for a bus fault.

Model sizes:

  • Number of equations = 0

  • Number of independent variables = 0

BusFault(BusT *bus, RealT R, RealT X, int status)

Construct a new BusFault.

Parameters:

  • bus1 – - pointer to bus-1

  • bus2 – - pointer to bus-2

  • R – - line series resistance

  • X – - line series reactance

  • G – - line shunt conductance

  • B – - line shunt charging

BusFault(BusT *bus, const ModelDataT &data)

Construct a new BusFault.

Parameters:

  • bus1 – - pointer to bus-1

  • bus2 – - pointer to bus-2

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 initialize() final override

Initialization of the branch model

virtual int tagDifferentiable() final override

Identify differential variables.

virtual int evaluateResidual() final override

Residual contribution of the branch is pushed to the two terminal buses.

virtual int evaluateJacobian() final override

Jacobian evaluation not implemented yet.

Jacobian evaluation experimental.

Returns:

int - error code, 0 = success

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

Get non-owning reference to monitor.