Fault calculation implemented

1 files changed, 110 insertions, 15 deletions

diff --git a/Project/ElectricCalculation.h b/Project/ElectricCalculation.h
index e4e4ef7..3eea5dd 100644
--- a/Project/ElectricCalculation.h
+++ b/Project/ElectricCalculation.h
@@ -18,14 +18,16 @@
 enum BusType { BUS_SLACK = 0, BUS_PV, BUS_PQ };
 
 enum ReactiveLimitsType {
-    RL_UNLIMITED = 0,     // The bus can generate any ammount of reactive power.
-    RL_LIMITED,           // The bus reactive power generation is limited.
-    RL_UNLIMITED_SOURCE,  // The bus have at least one source of infinite reative power.
-    RL_MAX_REACHED,       // Max limit reached
-    RL_MIN_REACHED,       // Min limit reached
-    RL_NONE_REACHED       // No limits reached
+    RL_UNLIMITED = 0,    // The bus can generate any ammount of reactive power.
+    RL_LIMITED,          // The bus reactive power generation is limited.
+    RL_UNLIMITED_SOURCE, // The bus have at least one source of infinite reative power.
+    RL_MAX_REACHED,      // Max limit reached
+    RL_MIN_REACHED,      // Min limit reached
+    RL_NONE_REACHED      // No limits reached
 };
 
+enum YBusSequence { POSITIVE_SEQ = 0, NEGATIVE_SEQ, ZERO_SEQ };
+
 struct ReactiveLimits {
     double maxLimit = 0.0;
     double minLimit = 0.0;
@@ -34,30 +36,123 @@ struct ReactiveLimits {
     ReactiveLimitsType limitReached = RL_NONE_REACHED;
 };
 
+/**
+ * @class ElectricCalculation
+ * @author Thales Lima Oliveira
+ * @date 09/01/2017
+ * @file ElectricCalculation.h
+ * @brief Base class of electric calculations, with general methods.
+ */
 class ElectricCalculation
 {
-   public:
+public:
+    /**
+     * @brief Constructor.
+     */
     ElectricCalculation();
+
+    /**
+     * @brief Destructor.
+     */
     ~ElectricCalculation();
+
+    /**
+     * @brief Separate the elements from a generic list.
+     * @param elementList List of generic elements.
+     */
     virtual void GetElementsFromList(std::vector<Element*> elementList);
-    virtual bool GetYBus(std::vector<std::vector<std::complex<double> > >& yBus, double systemPowerBase);
+
+    /**
+     * @brief Get the admittance matrix from the list of elements (use GetElementsFromList first).
+     * @param yBus Admittance matrix. The previous content will be erased.
+     * @param systemPowerBase Base power of the system.
+     * @param sequence Sequence of admittance matrix (positive, negative and zero).
+     * @param includeSyncMachines Include the synchronous machines on calculation.
+     * @return Return true if was possible to build the admittance matrix.
+     */
+    virtual bool GetYBus(std::vector<std::vector<std::complex<double> > >& yBus,
+        double systemPowerBase,
+        YBusSequence sequence = POSITIVE_SEQ,
+        bool includeSyncMachines = false);
+
+    /**
+     * @brief Invert a matrix.
+     * @param matrix Matrix to invert.
+     * @param inverse Inverted matrix. The previous content will be erased.
+     * @return Return true if was possible to invert the matrix.
+     */
+    virtual bool InvertMatrix(std::vector<std::vector<std::complex<double> > > matrix,
+        std::vector<std::vector<std::complex<double> > >& inverse);
+
+    /**
+     * @brief Update the elements after the power flow calculation.
+     * @param voltage Array with the buses voltages.
+     * @param power Array with the buses injected power.
+     * @param busType Array with the buses type.
+     * @param reactiveLimit Array with the reactive limit data.
+     * @param systemPowerBase Base power of the system.
+     */
     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);
+        std::vector<std::complex<double> > power,
+        std::vector<BusType> busType,
+        std::vector<ReactiveLimits> reactiveLimit,
+        double systemPowerBase);
 
+    /**
+     * @brief Get the buses of the system (use GetElementsFromList first).
+     * @return A list of bus elements.
+     */
     const std::vector<Bus*> GetBusList() const { return m_busList; }
+
+    /**
+     * @brief Get the capacitors of the system (use GetElementsFromList first).
+     * @return A list of capacitor elements.
+     */
     const std::vector<Capacitor*> GetCapacitorList() const { return m_capacitorList; }
+    
+    /**
+     * @brief Get the induction motors of the system (use GetElementsFromList first).
+     * @return A list of induction motor elements.
+     */
     const std::vector<IndMotor*> GetIndMotorList() const { return m_indMotorList; }
+    
+    /**
+     * @brief Get the inductors of the system (use GetElementsFromList first).
+     * @return A list of inductor elements.
+     */
     const std::vector<Inductor*> GetInductorList() const { return m_inductorList; }
+    
+    /**
+     * @brief Get the lines of the system (use GetElementsFromList first).
+     * @return A list of line elements.
+     */
     const std::vector<Line*> GetLineList() const { return m_lineList; }
+    
+    /**
+     * @brief Get the loads of the system (use GetElementsFromList first).
+     * @return A list of load elements.
+     */
     const std::vector<Load*> GetLoadList() const { return m_loadList; }
+    
+    /**
+     * @brief Get the synchronous generators of the system (use GetElementsFromList first).
+     * @return A list of synchronous generator elements.
+     */
     const std::vector<SyncGenerator*> GetSyncGeneratorList() const { return m_syncGeneratorList; }
+    
+    /**
+     * @brief Get the synchronous motors of the system (use GetElementsFromList first).
+     * @return A list of synchronous motor elements.
+     */
     const std::vector<SyncMotor*> GetSyncMotorList() const { return m_syncMotorList; }
-    const std::vector<Transformer*> GetTransformerList() const { return m_transformerList; }
     
-   protected:
+    /**
+     * @brief Get the transformers of the system (use GetElementsFromList first).
+     * @return A list of transformer elements.
+     */
+    const std::vector<Transformer*> GetTransformerList() const { return m_transformerList; }
+
+protected:
     std::vector<Bus*> m_busList;
     std::vector<Capacitor*> m_capacitorList;
     std::vector<IndMotor*> m_indMotorList;
@@ -69,4 +164,4 @@ class ElectricCalculation
     std::vector<Transformer*> m_transformerList;
 };
 
-#endif  // ELECTRICCALCULATION_H
+#endif // ELECTRICCALCULATION_H