Inductor.cpp

/*
 *  Copyright (C) 2017  Thales Lima Oliveira <thales@ufu.br>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#include "Inductor.h"
#include "../../forms/ReactiveShuntElementForm.h"
 
Inductor::Inductor() : Shunt()
{
    m_elementType = TYPE_INDUCTOR;
}
 
Inductor::Inductor(wxString name) : Shunt()
{
    m_elementType = TYPE_INDUCTOR;
    m_electricalData.name = name;
}
 
Inductor::~Inductor() {}
 
bool Inductor::AddParent(Element* parent, wxPoint2DDouble position)
{
    if (parent) {
        m_parentList.push_back(parent);
        parent->AddChild(this);
        wxPoint2DDouble parentPt =
            parent->RotateAtPosition(position, -parent->GetAngle());        // Rotate click to horizontal position.
        parentPt.m_y = parent->GetPosition().m_y;                           // Centralize on bus.
        parentPt = parent->RotateAtPosition(parentPt, parent->GetAngle());  // Rotate back.
 
        m_position = parentPt + wxPoint2DDouble(0.0, 100.0);  // Shifts the position to the down of the bus.
        m_width = 20.0;
        m_height = 70.0;
        m_rect = wxRect2DDouble(m_position.m_x - m_width / 2.0, m_position.m_y - m_height / 2.0, m_width, m_height);
 
        m_pointList.push_back(parentPt);
        m_pointList.push_back(GetSwitchPoint(parent, parentPt, m_position));
        m_pointList.push_back(m_position + wxPoint2DDouble(0.0, -m_height / 2.0 - 10.0));
        m_pointList.push_back(m_position + wxPoint2DDouble(0.0, -m_height / 2.0));
 
        m_inserted = true;
 
        wxRect2DDouble genRect(0, 0, 0, 0);
        m_switchRect.push_back(genRect);  // Push a general rectangle.
        UpdateSwitches();
 
        return true;
    }
    return false;
}
 
//void Inductor::Draw(wxPoint2DDouble translation, double scale) const
//{
//  OpenGLColour elementColour;
//  if (m_online) {
//      if (m_dynEvent)
//          elementColour = m_dynamicEventColour;
//      else
//          elementColour = m_onlineElementColour;
//  }
//  else
//      elementColour = m_offlineElementColour;
//
//  if (m_inserted) {
//      if (m_selected) {
//          glLineWidth(1.5 + m_borderSize * 2.0);
//          glColor4dv(m_selectionColour.GetRGBA());
//
//          DrawLine(m_pointList);
//
//          glPushMatrix();
//          glTranslated(m_position.m_x, m_position.m_y, 0.0);
//          glRotated(m_angle, 0.0, 0.0, 1.0);
//          glTranslated(-m_position.m_x, -m_position.m_y, 0.0);
//
//          DrawArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 10.0), 10, 45, 270, 30, GL_LINE_STRIP);
//          DrawArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 25.0), 10, 45, 315, 30, GL_LINE_STRIP);
//          DrawArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 40.0), 10, 90, 315, 30, GL_LINE_STRIP);
//
//          DrawGround(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 50.0));
//
//          glPopMatrix();
//
//          // Draw node selection.
//          DrawCircle(m_pointList[0], 5.0 + m_borderSize / scale, 10, GL_POLYGON);
//      }
//      // Draw Load (layer 2).
//      glLineWidth(1.5);
//      glColor4dv(elementColour.GetRGBA());
//      DrawCircle(m_pointList[0], 5.0, 10, GL_POLYGON);
//      DrawLine(m_pointList);
//
//      DrawSwitches();
//
//      glPushMatrix();
//      glTranslated(m_position.m_x, m_position.m_y, 0.0);
//      glRotated(m_angle, 0.0, 0.0, 1.0);
//      glTranslated(-m_position.m_x, -m_position.m_y, 0.0);
//
//      glColor4dv(elementColour.GetRGBA());
//      DrawArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 10.0), 10, 45, 270, 10, GL_LINE_STRIP);
//      DrawArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 25.0), 10, 45, 315, 10, GL_LINE_STRIP);
//      DrawArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 40.0), 10, 90, 315, 10, GL_LINE_STRIP);
//
//      DrawGround(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 50.0));
//
//      glPopMatrix();
//  }
//}
 
void Inductor::DrawDC(wxPoint2DDouble translation, double scale, wxGraphicsContext* gc) const
{
    wxColour elementColour;
    if (m_online) {
        if (m_dynEvent)
            elementColour = m_dynamicEventColour;
        else
            elementColour = m_onlineElementColour;
    }
    else
        elementColour = m_offlineElementColour;
 
    if (m_inserted) {
        if (m_selected) {
            gc->SetPen(wxPen(wxColour(m_selectionColour), 2 + m_borderSize * 2.0));
            gc->SetBrush(*wxTRANSPARENT_BRUSH);
 
            gc->StrokeLines(m_pointList.size(), &m_pointList[0]);
 
            // Push the current matrix on stack.
            gc->PushState();
            // Rotate the matrix around the object position.
            gc->Translate(m_position.m_x, m_position.m_y);
            gc->Rotate(wxDegToRad(m_angle));
            gc->Translate(-m_position.m_x, -m_position.m_y);
 
            DrawDCArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 10.0), 10, 45, 270, 30, gc);
            DrawDCArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 25.0), 10, 45, 315, 30, gc);
            DrawDCArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 40.0), 10, 90, 315, 30, gc);
 
            DrawDCGround(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 50.0), gc);
 
            gc->PopState();
 
            // Draw node selection.
            gc->SetPen(*wxTRANSPARENT_PEN);
            gc->SetBrush(wxBrush(wxColour(m_selectionColour)));
            DrawDCCircle(m_pointList[0], 5.0 + m_borderSize / scale, 10, gc);
        }
        // Draw Inductor (layer 2).
        gc->SetPen(*wxTRANSPARENT_PEN);
        gc->SetBrush(wxBrush(wxColour(elementColour)));
        DrawDCCircle(m_pointList[0], 5.0, 10, gc);
 
        gc->SetPen(wxPen(wxColour(elementColour), 2));
        gc->SetBrush(*wxTRANSPARENT_BRUSH);
        gc->StrokeLines(m_pointList.size(), &m_pointList[0]);
 
        DrawDCSwitches(gc);
 
        // Push the current matrix on stack.
        gc->PushState();
        // Rotate the matrix around the object position.
        gc->Translate(m_position.m_x, m_position.m_y);
        gc->Rotate(wxDegToRad(m_angle));
        gc->Translate(-m_position.m_x, -m_position.m_y);
 
        gc->SetPen(wxPen(wxColour(elementColour), 2));
        gc->SetBrush(*wxTRANSPARENT_BRUSH);
        DrawDCArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 10.0), 10, 45, 270, 10, gc);
        DrawDCArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 25.0), 10, 45, 315, 10, gc);
        DrawDCArc(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 40.0), 10, 90, 315, 10, gc);
 
        DrawDCGround(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 50.0), gc);
 
        gc->PopState();
    }
}
 
void Inductor::DrawDC(wxPoint2DDouble translation, double scale, wxDC& dc) const
{
    wxColour elementColour;
    if (m_online) {
        if (m_dynEvent)
            elementColour = m_dynamicEventColour;
        else
            elementColour = m_onlineElementColour;
    }
    else
        elementColour = m_offlineElementColour;
 
    std::vector<wxPoint> pointListInt;
    for (auto& pt : m_pointList) {
        pointListInt.emplace_back(static_cast<int>(pt.m_x), static_cast<int>(pt.m_y));
    }
 
    if (m_inserted) {
        wxPoint arcPts[3];
        wxPoint2DDouble p;
        p = m_position + wxPoint2DDouble(0, -m_height / 2.0 + 10.0);
        arcPts[0] = RotateAround(p, m_position, m_angle);
        p = m_position + wxPoint2DDouble(0, -m_height / 2.0 + 25.0);
        arcPts[1] = RotateAround(p, m_position, m_angle);
        p = m_position + wxPoint2DDouble(0, -m_height / 2.0 + 40.0);
        arcPts[2] = RotateAround(p, m_position, m_angle);
 
        if (m_selected) {
            dc.SetPen(wxPen(wxColour(m_selectionColour), 2 + m_borderSize * 2.0));
            dc.SetBrush(*wxTRANSPARENT_BRUSH);
 
            dc.DrawLines(pointListInt.size(), &pointListInt[0]);
 
            DrawDCArc(arcPts[0], 10, 90 - m_angle, 315 - m_angle, dc);
            DrawDCArc(arcPts[1], 10, 45 - m_angle, 315 - m_angle, dc);
            DrawDCArc(arcPts[2], 10, 45 - m_angle, 270 - m_angle, dc);
 
            DrawDCGround(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 50.0), dc);
 
            // Draw node selection.
            dc.SetPen(*wxTRANSPARENT_PEN);
            dc.SetBrush(wxBrush(wxColour(m_selectionColour)));
            DrawDCCircle(m_pointList[0], 5.0 + m_borderSize / scale, dc);
        }
        // Draw Inductor (layer 2).
        dc.SetPen(*wxTRANSPARENT_PEN);
        dc.SetBrush(wxBrush(wxColour(elementColour)));
        DrawDCCircle(m_pointList[0], 5.0, dc);
 
        dc.SetPen(wxPen(wxColour(elementColour), 2));
        dc.SetBrush(*wxTRANSPARENT_BRUSH);
        dc.DrawLines(pointListInt.size(), &pointListInt[0]);
 
        DrawDCSwitches(dc);
 
        dc.SetPen(wxPen(wxColour(elementColour), 2));
        dc.SetBrush(*wxTRANSPARENT_BRUSH);
        DrawDCArc(arcPts[0], 10, 90 - m_angle, 315 - m_angle, dc);
        DrawDCArc(arcPts[1], 10, 45 - m_angle, 315 - m_angle, dc);
        DrawDCArc(arcPts[2], 10, 45 - m_angle, 270 - m_angle, dc);
 
        DrawDCGround(m_position + wxPoint2DDouble(0, -m_height / 2.0 + 50.0), dc);
    }
}
 
void Inductor::Rotate(bool clockwise)
{
    double rotAngle = m_rotationAngle;
    if (!clockwise) rotAngle = -m_rotationAngle;
 
    m_angle += rotAngle;
    if (m_angle >= 360 || m_angle <= -360) m_angle = 0.0;
    m_pointList[2] = RotateAtPosition(m_pointList[2], rotAngle);
    m_pointList[3] = RotateAtPosition(m_pointList[3], rotAngle);
    UpdateSwitchesPosition();
}
 
bool Inductor::GetContextMenu(wxMenu& menu)
{
    menu.Append(ID_EDIT_ELEMENT, _("Edit Inductor"));
 
    wxMenu* textMenu = new wxMenu();
 
    textMenu->Append(ID_TXT_NAME, _("Name"));
    textMenu->Append(ID_TXT_REACTIVE_POWER, _("Reactive power"));
    textMenu->SetClientData(menu.GetClientData());
    menu.AppendSubMenu(textMenu, _("Add text"));
 
    GeneralMenuItens(menu);
    return true;
}
 
bool Inductor::Contains(wxPoint2DDouble position) const
{
    wxPoint2DDouble ptR = RotateAtPosition(position, -m_angle);
    return m_rect.Contains(ptR);
}
 
bool Inductor::Intersects(wxRect2DDouble rect) const { return RotatedRectanglesIntersects(m_rect, rect, m_angle, 0.0); }
bool Inductor::ShowForm(wxWindow* parent, Element* element)
{
    ReactiveShuntElementForm inductorForm(parent, this);
    inductorForm.SetTitle(_("Inductor"));
    inductorForm.CenterOnParent();
    if (inductorForm.ShowModal() == wxID_OK) {
        return true;
    }
    return false;
}
 
InductorElectricalData Inductor::GetPUElectricalData(double systemPowerBase)
{
    InductorElectricalData data = m_electricalData;
    switch (data.reactivePowerUnit) {
    case ElectricalUnit::UNIT_var: {
        data.reactivePower = data.reactivePower / systemPowerBase;
        data.reactivePowerUnit = ElectricalUnit::UNIT_PU;
    } break;
    case ElectricalUnit::UNIT_kvar: {
        data.reactivePower = (data.reactivePower * 1e3) / systemPowerBase;
        data.reactivePowerUnit = ElectricalUnit::UNIT_PU;
    } break;
    case ElectricalUnit::UNIT_Mvar: {
        data.reactivePower = (data.reactivePower * 1e6) / systemPowerBase;
        data.reactivePowerUnit = ElectricalUnit::UNIT_PU;
    } break;
    default:
        break;
    }
 
    return data;
}
 
Element* Inductor::GetCopy()
{
    Inductor* copy = new Inductor();
    *copy = *this;
    return copy;
}
 
wxString Inductor::GetTipText() const
{
    wxString tipText = m_electricalData.name;
 
    // TODO: Avoid reactive power calculation.
    double reactivePower = m_electricalData.reactivePower;
    if (!m_online)
        reactivePower = 0.0;
    else {
        std::complex<double> v = static_cast<Bus*>(m_parentList[0])->GetElectricalData().voltage;
        reactivePower *= std::pow(std::abs(v), 2);
    }
    tipText += "\n";
    tipText += _("\nQ = ") + wxString::FromDouble(reactivePower, 5);
    switch (m_electricalData.reactivePowerUnit) {
    case ElectricalUnit::UNIT_PU: {
        tipText += _(" p.u.");
    } break;
    case ElectricalUnit::UNIT_var: {
        tipText += _(" var");
    } break;
    case ElectricalUnit::UNIT_kvar: {
        tipText += _(" kvar");
    } break;
    case ElectricalUnit::UNIT_Mvar: {
        tipText += _(" Mvar");
    } break;
    default:
        break;
    }
 
    return tipText;
}
 
rapidxml::xml_node<>* Inductor::SaveElement(rapidxml::xml_document<>& doc, rapidxml::xml_node<>* elementListNode)
{
    auto elementNode = XMLParser::AppendNode(doc, elementListNode, "Inductor");
    XMLParser::SetNodeAttribute(doc, elementNode, "ID", m_elementID);
 
    SaveCADProperties(doc, elementNode);
 
    auto electricalProp = XMLParser::AppendNode(doc, elementNode, "ElectricalProperties");
    auto isOnline = XMLParser::AppendNode(doc, electricalProp, "IsOnline");
    XMLParser::SetNodeValue(doc, isOnline, m_online);
    auto name = XMLParser::AppendNode(doc, electricalProp, "Name");
    XMLParser::SetNodeValue(doc, name, m_electricalData.name);
    auto reactivePower = XMLParser::AppendNode(doc, electricalProp, "ReactivePower");
    XMLParser::SetNodeValue(doc, reactivePower, m_electricalData.reactivePower);
    XMLParser::SetNodeAttribute(doc, reactivePower, "UnitID", static_cast<int>(m_electricalData.reactivePowerUnit));
 
    SaveSwitchingData(doc, electricalProp);
 
    return elementNode;
}
 
bool Inductor::OpenElement(rapidxml::xml_node<>* elementNode, std::vector<Element*> parentList)
{
    if (!OpenCADProperties(elementNode, parentList)) return false;
 
    auto electricalProp = elementNode->first_node("ElectricalProperties");
    if (!electricalProp) return false;
 
    SetOnline(XMLParser::GetNodeValueInt(electricalProp, "IsOnline"));
    m_electricalData.name = electricalProp->first_node("Name")->value();
    m_electricalData.reactivePower = XMLParser::GetNodeValueDouble(electricalProp, "ReactivePower");
    m_electricalData.reactivePowerUnit =
        static_cast<ElectricalUnit>(XMLParser::GetAttributeValueInt(electricalProp, "ReactivePower", "UnitID"));
 
    if (!OpenSwitchingData(electricalProp)) return false;
    if (m_swData.swTime.size() != 0) SetDynamicEvent(true);
 
    m_inserted = true;
    return true;
}