snl.ccss.jpowerflow.ac
Interface ACPFBus

All Known Implementing Classes:
AbstractACPFBus, AbstractPFBus

public interface ACPFBus

This interface defines all the methods needed by the AC power flow simulators for a bus object.

Author:
Bryan T. Richardson - Sandia National Laboratories

Method Summary
 boolean checkGenMvarOutput(double busMvar, boolean adjust)
          This method should return true if all generators available for Automatic Voltage Regulation (AVR) are within the reactive power output limits of the generator.
 double getAngle()
          This method should return the bus voltage angle in radians.
 double getBusMvar()
          This method should return the total amount of reactive power at the bus in per unit.
 double getBusMw()
          This method should return the total amount of real power at the bus in per unit.
 int getNumber()
          This method should return the bus ID as it's represented in the system.
 double getSusceptance()
          This method should return the amount of susceptance present at the bus in per unit.
 double getVoltage()
          This method should return the bus voltage magnitude in per unit.
 boolean isAVR()
          This method should return true if at least one generator connected to the bus is available for Automatic Voltage Regulation (AVR), and false otherwise.
 boolean isGenerationBus()
          This method should return true if the bus has generation attached to it, and false otherwise.
 boolean isSlackBus()
          This method should return true if the bus is the system slack bus, and false otherwise.
 void setAngle(double angle)
          This method should update the voltage angle for the bus
 void setBusMvar(double busMvar)
          This method should update the total amount of reactive power at the bus.
 void setBusMw(double busMw)
          This method should update the total amount of real power at the bus.
 void setVoltage(double voltage)
          This method should update the voltage magnitude for the bus
 

Method Detail

getNumber

int getNumber()
This method should return the bus ID as it's represented in the system.

Returns:
bus ID number

getVoltage

double getVoltage()
This method should return the bus voltage magnitude in per unit.

Returns:
per unit voltage magnitude

getAngle

double getAngle()
This method should return the bus voltage angle in radians.

Returns:
voltage angle in radians

getBusMw

double getBusMw()
This method should return the total amount of real power at the bus in per unit. This is represented by real generated power minus real load power.

Returns:
per unit total real power

getBusMvar

double getBusMvar()
This method should return the total amount of reactive power at the bus in per unit. This is represented by reactive generated power minus reactive load power.

Returns:
per unit total reactive power

getSusceptance

double getSusceptance()
This method should return the amount of susceptance present at the bus in per unit.

Returns:
per unit amount of susceptance

isGenerationBus

boolean isGenerationBus()
This method should return true if the bus has generation attached to it, and false otherwise.

Returns:
true if generation is present

isSlackBus

boolean isSlackBus()
This method should return true if the bus is the system slack bus, and false otherwise.

Returns:
true if system slack bus

isAVR

boolean isAVR()
This method should return true if at least one generator connected to the bus is available for Automatic Voltage Regulation (AVR), and false otherwise.

Returns:
true if at least one generator available for AVR is present

checkGenMvarOutput

boolean checkGenMvarOutput(double busMvar,
                           boolean adjust)
This method should return true if all generators available for Automatic Voltage Regulation (AVR) are within the reactive power output limits of the generator. This is used by the mismatch check method in FullNewton to determine if the power system is suitable for convergence. The adjust flag should be set to true if the user would like to make generator reactive power output adjustments when this method returns false.

Parameters:
busMvar - Total amount of reactive power at the bus
adjust - Set to true of generators outside their limits should be adjusted
Returns:
true if all generators available for AVR are within reactive power output limits

setVoltage

void setVoltage(double voltage)
This method should update the voltage magnitude for the bus

Parameters:
voltage - Voltage magnitude in per unit

setAngle

void setAngle(double angle)
This method should update the voltage angle for the bus

Parameters:
angle - Voltage angle in radians

setBusMw

void setBusMw(double busMw)
This method should update the total amount of real power at the bus. New generation output values can be calculated from this by adding the total amount of load present at the bus.

Parameters:
busMw - Total amount of real power at the bus in per unit

setBusMvar

void setBusMvar(double busMvar)
This method should update the total amount of reactive power at the bus. New generation output values can be calculated from this by adding the total amount of load present at the bus.

Parameters:
busMvar - Total amount of reactive power at the bus in per unit