GetVoltageSensitivityToComplexPower Method

VoltageSensitivityToComplexPowerGenerator GetVoltageSensitivityToComplexPower Method

ElecNetKit Documentation

Generates Voltage Sensitivities to changes in P and Q at each load bus on the network.

Namespace: ElecNetKit.Sensitivities
Assembly: ElecNetKit.Sensitivities (in ElecNetKit.Sensitivities.dll) Version: 1.1.4771.27372 (1.1.0.0)

Syntax

C++

Copy to Clipboard Print

public static TwinKeyDictionary<string, string, VoltageSensitivityToPQDataSet> GetVoltageSensitivityToComplexPower(
	ISimulator Simulator,
	string NetworkMasterFile,
	string CommandString,
	double PerturbationFrac
)

public static TwinKeyDictionary<string, string, VoltageSensitivityToPQDataSet> GetVoltageSensitivityToComplexPower(
	ISimulator Simulator,
	string NetworkMasterFile,
	string CommandString,
	double PerturbationFrac
)

Public Shared Function GetVoltageSensitivityToComplexPower ( _
	Simulator As ISimulator, _
	NetworkMasterFile As String, _
	CommandString As String, _
	PerturbationFrac As Double _
) As TwinKeyDictionary(Of String, String, VoltageSensitivityToPQDataSet)

Public Shared Function GetVoltageSensitivityToComplexPower ( _
	Simulator As ISimulator, _
	NetworkMasterFile As String, _
	CommandString As String, _
	PerturbationFrac As Double _
) As TwinKeyDictionary(Of String, String, VoltageSensitivityToPQDataSet)

public:
static TwinKeyDictionary<String^, String^, VoltageSensitivityToPQDataSet^>^ GetVoltageSensitivityToComplexPower(
	ISimulator^ Simulator, 
	String^ NetworkMasterFile, 
	String^ CommandString, 
	double PerturbationFrac
)

public:
static TwinKeyDictionary<String^, String^, VoltageSensitivityToPQDataSet^>^ GetVoltageSensitivityToComplexPower(
	ISimulator^ Simulator, 
	String^ NetworkMasterFile, 
	String^ CommandString, 
	double PerturbationFrac
)

Parameters

Simulator: Type: ElecNetKit.Simulator ISimulator
The simulator to use for the generation of sensitivities.

NetworkMasterFile: Type: System String
The file path of the Network to calculate sensitivities for.

CommandString

Type:

System String
A command for issuing perturbations. The command should be compatible with Online

Format(String, Object )-style format strings, and should use {0} to represent a random ID, {1} to represent the bus that perturbation should occur on, {2} to represent a kW quantity to perturb by and {3} to represent a kVAr quantity to perturb by.

Examples

As an example, the following string specifies a new generator for perturbation in OpenDSS syntax:

Copy to Clipboard Print

"new Generator.{0} bus1={1} phases=3 model=1 status=fixed kV=11 Vminpu=0.9 Vmaxpu=1.1 kW={2} kvAR={3}"

"new Generator.{0} bus1={1} phases=3 model=1 status=fixed kV=11 Vminpu=0.9 Vmaxpu=1.1 kW={2} kvAR={3}"

PerturbationFrac: Type: System Double
The fraction of average load size to perturb by.

Return Value

A 2-axis dictionary, in which the X-axis represents the source bus, the Y-axis represents the affected bus, and the values are an index of sensitivity information.

Remarks

This is a convenience class that uses the functionality supplied by SensitivityGenerator T and PerturbAndObserveRunner TObserve . For other kinds of sensitivities, you may wish to use these classes directly.