Package pypower :: Module scale_load
[hide private]
[frames] | no frames]

Module scale_load

source code

Scales fixed and/or dispatchable loads.

Classes [hide private]
  ScalingError
Functions [hide private]
 
scale_load(load, bus, gen=None, load_zone=None, opt=None)
Scales fixed and/or dispatchable loads.
source code
Variables [hide private]
  __package__ = 'pypower'
Function Details [hide private]

scale_load(load, bus, gen=None, load_zone=None, opt=None)

source code 

Scales fixed and/or dispatchable loads.

Assumes consecutive bus numbering when dealing with dispatchable loads.

Parameters:
  • load - Each element specifies the amount of scaling for the corresponding load zone, either as a direct scale factor or as a target quantity. If there are nz load zones this vector has nz elements.
  • bus - Standard bus matrix with nb rows, where the fixed active and reactive loads available for scaling are specified in columns PD and QD
  • gen - (optional) standard gen matrix with ng rows, where the dispatchable loads available for scaling are specified by columns PG, QG, PMIN, QMIN and QMAX (in rows for which isload(gen) returns true). If gen is empty, it assumes there are no dispatchable loads.
  • load_zone - (optional) nb element vector where the value of each element is either zero or the index of the load zone to which the corresponding bus belongs. If load_zone[b] = k then the loads at bus b will be scaled according to the value of load[k]. If load_zone[b] = 0, the loads at bus b will not be modified. If load_zone is empty, the default is determined by the dimensions of the load vector. If load is a scalar, a single system-wide zone including all buses is used, i.e. load_zone = ones(nb). If load is a vector, the default load_zone is defined as the areas specified in the bus matrix, i.e. load_zone = bus[:, BUS_AREA], and load should have dimension = max(bus[:, BUS_AREA]).
  • opt - (optional) dict with three possible fields, 'scale', 'pq' and 'which' that determine the behavior as follows:
    • scale (default is 'FACTOR')
      • 'FACTOR' : load consists of direct scale factors, where load[k] = scale factor R[k] for zone k
      • 'QUANTITY' : load consists of target quantities, where load[k] = desired total active load in MW for zone k after scaling by an appropriate R(k)
    • pq (default is 'PQ')
      • 'PQ' : scale both active and reactive loads
      • 'P' : scale only active loads
    • which (default is 'BOTH' if GEN is provided, else 'FIXED')
      • 'FIXED' : scale only fixed loads
      • 'DISPATCHABLE' : scale only dispatchable loads
      • 'BOTH' : scale both fixed and dispatchable loads

See Also: total_load

Authors:
Ray Zimmerman (PSERC Cornell), Richard Lincoln