# getLoadInfo

Gets the information for all loads in the circuit

## Contents

- Syntax
- Description
- Inputs
- Outputs
- Example

## Syntax

    Loads = getLoadInfo(DSSCircObj)
    Loads = getLoadInfo(DSSCircObj, loadNames)

## Description

Function to get the information about the loads in the circuit and return a structure with the information. If the optional input of loadNames is filled, the function returns information for the specified subset of loads, excluding the miscellaneous parameters mentioned in the outputs below.

## Inputs

- `DSSCircObj` - link to OpenDSS active circuit and command text (from DSSStartup)
- `loadNames` - optional cell array of line names to get information for

## Outputs

`Loads` is a structure with all the parameters for the loads in the active circuit. Fields are:

- name - Name of the load.
- busName - Name of the associated bus.
- numPhases - Number of phases associated with the load.
- enabled - {1|0} indicates whether this element is enabled in the simulation.
- coordinates - Coordinates for the load's bus, obtained from getBusInfo.
- distance - Line distance from the load's bus to the substation, obtained from getBusInfo.
- current - average phase current
- phaseVoltages - Value of voltage magnitudes calculated from the complex voltage returned by OpenDSS. Length is always 3, returning 0 for phases not on the bus
- phaseVoltagesPU - Per-unit value of voltage magnitudes calculated from the complex per-unit voltage returned by OpenDSS. Length is always 3, returning 0 for phases not on the bus.
- voltage, voltagePU, voltagePhasorPU, phaseVoltages, phaseVoltagePhasors, ... phaseVoltagePhasorsPU, phaseVoltagesLL, phaseVoltagesLLPU, voltageLL, voltageLLPU - voltages and voltage phasors
- seqVoltages, cplxVoltages, seqCurrents, cplxSeqCurrents - zero, positive, and negative sequence voltages and currents magnitude or complex phasors
- phasePowerReal - 3-element array of the real components of each phase's complex power injected by generator. Phases that are not present will return 0.
- phasePowerReactive - 3-element array of the imaginary components of each phase's complex power injected by generator. Phases that are not present will return 0.
- powerReal - Total phasePowerReal.
- powerReactive - Total phasePowerReactive.
- losses - total real and imaginary power losses
- phaseLosses - real and imaginary power losses
- xfkVA - The kVA rating of the associated transformer.
- kW, kvar, kva - Rated power of the load.
- kV - Rated voltage.
- PF - Rate power factor of the load.
- Idx, pctMean, pctStdDev, allocationFactor, Cfactor, class, isDelta, CVRcurve, CVRwatts_, CVRvars, daily, duty, kwhdays, model, numCust, Rneut, spectrum, VmaxPU, VminEmerg, VminNorm, VminPU, Xneut, yearly, status, growth - OpenDSS load object properties

## Example

Returns load information in the circuit

    [DSSCircObj, DSSText, gridpvPath] = DSSStartup;
    DSSText.command = ['Compile "' gridpvPath 'ExampleCircuit\master_Ckt24.dss"'];
    DSSText.command = 'solve';
    Loads = getLoadInfo(DSSCircObj) %Get information for all loads
    Loads = getLoadInfo(DSSCircObj,DSSCircObj.ActiveCircuit.Loads.AllNames) %Get information for all loads
    Loads = getLoadInfo(DSSCircObj, {'360667000'}) %Get information for one load
    Loads = getLoadInfo(DSSCircObj, [{'530877691_1'};{'331431200'}]); %Get information for two loads
    %

    Loads =

    3891x1 struct array with fields:

        name
        busName
        numPhases
        enabled
        current
        coordinates
        distance
        voltage
        voltagePU
        voltagePhasorPU
        phaseVoltages
        phaseVoltagesPU
        phaseVoltagePhasors
        phaseVoltagePhasorsPU
        phaseVoltagesLL
        phaseVoltagesLLPU
        voltageLL
        voltageLLPU
        seqVoltages
        cplxSeqVoltages
        seqCurrents
        cplxSeqCurrents
        phasePowerReal
        phasePowerReactive
        powerReal
        powerReactive
        losses
        phaseLosses
        xfkVA
        kW
        kvar
        kva
        kV
        PF
        Idx
        pctMean
        pctStdDev
        allocationFactor
        Cfactor
        class
        isDelta
        CVRcurve
        CVRwatts
        CVRvars
        daily
        duty
        kwhdays
        model
        numCust
        Rneut
        spectrum
        VmaxPU
        VminEmerg
        VminNorm
        VminPU
        Xneut
        yearly
        status
        growth

    Loads =

    3891x1 struct array with fields:

        name
        busName
        numPhases
        enabled
        current
        coordinates
        distance
        voltage
        voltagePU
        voltagePhasorPU
        phaseVoltages
        phaseVoltagesPU
        phaseVoltagePhasors
        phaseVoltagePhasorsPU
        phaseVoltagesLL
        phaseVoltagesLLPU
        voltageLL
        voltageLLPU
        seqVoltages
        cplxSeqVoltages
        seqCurrents
        cplxSeqCurrents
        phasePowerReal
        phasePowerReactive
        powerReal
        powerReactive
        losses
        phaseLosses
        xfkVA
        kW
        kvar
        kva
        kV
        PF
        Idx
        pctMean
        pctStdDev
        allocationFactor
        Cfactor
        class
        isDelta
        CVRcurve
        CVRwatts
        CVRvars
        daily
        duty
        kwhdays
        model
        numCust
        Rneut
        spectrum
        VmaxPU
        VminEmerg
        VminNorm
        VminPU
        Xneut
        yearly
        status
        growth

    Loads =

                         name: '360667000'
                      busName: 'g2101ra0900_n300678_sec_2.1'
                    numPhases: 1
                      enabled: 1
                      current: 0.0489
                  coordinates: [0 0]
                     distance: 6.9739
                      voltage: 240.1923
                    voltagePU: 1.0025
              voltagePhasorPU: 0.7660 - 0.6467i
                phaseVoltages: [240.1923 0 0]
              phaseVoltagesPU: [1.0025 0 0]
          phaseVoltagePhasors: [1x3 double]
        phaseVoltagePhasorsPU: [1x3 double]
              phaseVoltagesLL: [240.1923 0 0]
            phaseVoltagesLLPU: [1.0025 0 0]
                    voltageLL: 240.1923
                  voltageLLPU: 1.0025
                  seqVoltages: [1 1 1]
              cplxSeqVoltages: [-1 0 -1 0 -1 0]
                  seqCurrents: [1 1 1]
              cplxSeqCurrents: [-1 0 -1 0 -1 0]
               phasePowerReal: 0.0115
           phasePowerReactive: 0.0023
                    powerReal: 0.0115
                powerReactive: 0.0023
                       losses: 0.0115 + 0.0023i
                  phaseLosses: 0.0115 + 0.0023i
                        xfkVA: 0.0106
                           kW: 0.0115
                         kvar: 0.0023
                          kva: 0.0048
                           kV: 0.2400
                           PF: 0.9800
                          Idx: 3723
                      pctMean: 50
                    pctStdDev: 10
             allocationFactor: 1.1102
                      Cfactor: 4
                        class: 1
                      isDelta: 0
                     CVRcurve: ''
                     CVRwatts: 0.8000
                      CVRvars: 3
                        daily: ''
                         duty: ''
                      kwhdays: 30
                        model: 'dssLoadCVR'
                      numCust: 1
                        Rneut: -1
                     spectrum: 'defaultload'
                       VmaxPU: 1.0500
                    VminEmerg: 0
                     VminNorm: 0
                       VminPU: 0.7000
                        Xneut: 0
                       yearly: ''
                       status: 'dssLoadVariable'
                       growth: ''