From 3dc2e158dde6f297c0d5538222804321a2323e23 Mon Sep 17 00:00:00 2001 From: Thales Lima Oliveira Date: Fri, 15 Sep 2017 12:50:09 -0300 Subject: Add doxygen documentation On docs folder --- docs/doxygen/html/class_fault.html | 428 +++++++++++++++++++++++++++++++++++++ 1 file changed, 428 insertions(+) create mode 100644 docs/doxygen/html/class_fault.html (limited to 'docs/doxygen/html/class_fault.html') diff --git a/docs/doxygen/html/class_fault.html b/docs/doxygen/html/class_fault.html new file mode 100644 index 0000000..569270f --- /dev/null +++ b/docs/doxygen/html/class_fault.html @@ -0,0 +1,428 @@ + + + + + + + +PSP-UFU: Fault Class Reference + + + + + + + + + +
+
+ + + + + + + +
+
PSP-UFU +  2017w37a +
+
Power System Platform (UFU)
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
Fault Class Reference
+
+
+ +

#include <Fault.h>

+
+Inheritance diagram for Fault:
+
+
+ + +ElectricCalculation + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Fault (std::vector< Element *> elementList)
 Contructor. More...
 
+ Fault ()
 Default contructor. Use GetElementsFromList(std::vector<Element*> elementList).
 
+ ~Fault ()
 Destructor.
 
virtual bool RunFaultCalculation (double systemPowerBase)
 Calculate the fault of the system. Return true if was possible the calculation. More...
 
virtual bool RunSCPowerCalcutation (double systemPowerBase)
 Calculate the short-circuit power of the system. Return true if was possible the calculation. More...
 
virtual void UpdateElementsFault (double systemPowerBase)
 Update the data of the elements. More...
 
virtual wxString GetErrorMessage ()
 Get the error message generated in RunFaultCalculation(double systemPowerBase). More...
 
- Public Member Functions inherited from ElectricCalculation
+ ElectricCalculation ()
 Constructor.
 
+ ~ElectricCalculation ()
 Destructor.
 
virtual void GetElementsFromList (std::vector< Element *> elementList)
 Separate the power elements from a generic list. More...
 
virtual bool GetYBus (std::vector< std::vector< std::complex< double > > > &yBus, double systemPowerBase, YBusSequence sequence=POSITIVE_SEQ, bool includeSyncMachines=false, bool allLoadsAsImpedances=false)
 Get the admittance matrix from the list of elements (use GetElementsFromList first). More...
 
virtual bool InvertMatrix (std::vector< std::vector< std::complex< double > > > matrix, std::vector< std::vector< std::complex< double > > > &inverse)
 Invert a matrix. More...
 
virtual void UpdateElementsPowerFlow (std::vector< std::complex< double > > voltage, std::vector< std::complex< double > > power, std::vector< BusType > busType, std::vector< ReactiveLimits > reactiveLimit, double systemPowerBase)
 Update the elements after the power flow calculation. More...
 
+void ABCtoDQ0 (std::complex< double > complexValue, double angle, double &dValue, double &qValue)
 
+void DQ0toABC (double dValue, double qValue, double angle, std::complex< double > &complexValue)
 
+std::vector< std::complex< double > > GaussianElimination (std::vector< std::vector< std::complex< double > > > matrix, std::vector< std::complex< double > > array)
 
+Machines::SyncMachineModel GetMachineModel (SyncGenerator *generator)
 
+std::vector< std::complex< double > > ComplexMatrixTimesVector (std::vector< std::vector< std::complex< double > > > matrix, std::vector< std::complex< double > > vector)
 
+void GetLUDecomposition (std::vector< std::vector< std::complex< double > > > matrix, std::vector< std::vector< std::complex< double > > > &matrixL, std::vector< std::vector< std::complex< double > > > &matrixU)
 
+std::vector< std::complex< double > > LUEvaluate (std::vector< std::vector< std::complex< double > > > u, std::vector< std::vector< std::complex< double > > > l, std::vector< std::complex< double > > b)
 
const std::vector< Bus * > GetBusList () const
 Get the buses of the system (use GetElementsFromList first). More...
 
const std::vector< Capacitor * > GetCapacitorList () const
 Get the capacitors of the system (use GetElementsFromList first). More...
 
const std::vector< IndMotor * > GetIndMotorList () const
 Get the induction motors of the system (use GetElementsFromList first). More...
 
const std::vector< Inductor * > GetInductorList () const
 Get the inductors of the system (use GetElementsFromList first). More...
 
const std::vector< Line * > GetLineList () const
 Get the lines of the system (use GetElementsFromList first). More...
 
const std::vector< Load * > GetLoadList () const
 Get the loads of the system (use GetElementsFromList first). More...
 
const std::vector< SyncGenerator * > GetSyncGeneratorList () const
 Get the synchronous generators of the system (use GetElementsFromList first). More...
 
const std::vector< SyncMotor * > GetSyncMotorList () const
 Get the synchronous motors of the system (use GetElementsFromList first). More...
 
const std::vector< Transformer * > GetTransformerList () const
 Get the transformers of the system (use GetElementsFromList first). More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+wxString m_errorMsg = ""
 
+double m_systemPowerBase
 
+std::vector< std::vector< std::complex< double > > > m_zBusPos
 
+std::vector< std::vector< std::complex< double > > > m_zBusNeg
 
+std::vector< std::vector< std::complex< double > > > m_zBusZero
 
+std::vector< std::complex< double > > m_posFaultVoltagePos
 
+std::vector< std::complex< double > > m_posFaultVoltageNeg
 
+std::vector< std::complex< double > > m_posFaultVoltageZero
 
+std::complex< double > m_fCurrentA
 
+std::complex< double > m_fCurrentB
 
+std::complex< double > m_fCurrentC
 
+std::vector< std::complex< double > > m_posFaultVoltageA
 
+std::vector< std::complex< double > > m_posFaultVoltageB
 
+std::vector< std::complex< double > > m_posFaultVoltageC
 
- Protected Attributes inherited from ElectricCalculation
+std::vector< PowerElement * > m_powerElementList
 
+std::vector< Bus * > m_busList
 
+std::vector< Capacitor * > m_capacitorList
 
+std::vector< IndMotor * > m_indMotorList
 
+std::vector< Inductor * > m_inductorList
 
+std::vector< Line * > m_lineList
 
+std::vector< Load * > m_loadList
 
+std::vector< SyncGenerator * > m_syncGeneratorList
 
+std::vector< SyncMotor * > m_syncMotorList
 
+std::vector< Transformer * > m_transformerList
 
+

Detailed Description

+
Author
Thales Lima Oliveira
+
Date
10/01/2017
+

Constructor & Destructor Documentation

+ +

◆ Fault()

+ +
+
+ + + + + + + + +
Fault::Fault (std::vector< Element *> elementList)
+
+ +

Contructor.

+
Parameters
+ + +
elementListList of elements in workspace
+
+
+ +
+
+

Member Function Documentation

+ +

◆ GetErrorMessage()

+ +
+
+ + + + + +
+ + + + + + + +
virtual wxString Fault::GetErrorMessage ()
+ 		+inlinevirtual
+
+ +

Get the error message generated in RunFaultCalculation(double systemPowerBase).

+
Returns
Error message.
+ +
+
+ +

◆ RunFaultCalculation()

+ +
+
+ + + + + +
+ + + + + + + + +
bool Fault::RunFaultCalculation (double systemPowerBase)
+ 		+virtual
+
+ +

Calculate the fault of the system. Return true if was possible the calculation.

+
Parameters
+ + +
systemPowerBaseSystem base of power.
+
+
+ +
+
+ +

◆ RunSCPowerCalcutation()

+ +
+
+ + + + + +
+ + + + + + + + +
bool Fault::RunSCPowerCalcutation (double systemPowerBase)
+ 		+virtual
+
+ +

Calculate the short-circuit power of the system. Return true if was possible the calculation.

+
Parameters
+ + +
systemPowerBaseSystem base of power.
+
+
+ +
+
+ +

◆ UpdateElementsFault()

+ +
+
+ + + + + +
+ + + + + + + + +
void Fault::UpdateElementsFault (double systemPowerBase)
+ 		+virtual
+
+ +

Update the data of the elements.

+
Parameters
+ + +
systemPowerBaseSystem base of power.
+
+
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+Generated by   +doxygen + 1.8.13 +
+ + -- cgit