Add branch component model.

ComponentLib/Branch/Branch.cpp

@@ -0,0 +1,182 @@
+/*
+ *
+ * Copyright (c) 2017, Lawrence Livermore National Security, LLC.
+ * Produced at the Lawrence Livermore National Laboratory.
+ * Written by Slaven Peles <[email protected]> and Duan Nan <[email protected]>.
+ * LLNL-CODE-718378.
+ * All rights reserved.
+ *
+ * This file is part of GridKit. For details, see github.com/LLNL/GridKit
+ * Please also read the LICENSE file.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * - Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the disclaimer below.
+ * - Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the disclaimer (as noted below) in the
+ *   documentation and/or other materials provided with the distribution.
+ * - Neither the name of the LLNS/LLNL nor the names of its contributors may
+ *   be used to endorse or promote products derived from this software without
+ *   specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL LAWRENCE LIVERMORE NATIONAL
+ * SECURITY, LLC, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISINGIN ANY
+ * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Lawrence Livermore National Laboratory is operated by Lawrence Livermore
+ * National Security, LLC, for the U.S. Department of Energy, National
+ * Nuclear Security Administration under Contract DE-AC52-07NA27344.
+ *
+ * This document was prepared as an account of work sponsored by an agency
+ * of the United States government. Neither the United States government nor
+ * Lawrence Livermore National Security, LLC, nor any of their employees
+ * makes any warranty, expressed or implied, or assumes any legal liability
+ * or responsibility for the accuracy, completeness, or usefulness of any
+ * information, apparatus, product, or process disclosed, or represents that
+ * its use would not infringe privately owned rights. Reference herein to
+ * any specific commercial product, process, or service by trade name,
+ * trademark, manufacturer, or otherwise does not necessarily constitute or
+ * imply its endorsement, recommendation, or favoring by the United States
+ * government or Lawrence Livermore National Security, LLC. The views and
+ * opinions of authors expressed herein do not necessarily state or reflect
+ * those of the United States government or Lawrence Livermore National
+ * Security, LLC, and shall not be used for advertising or product
+ * endorsement purposes.
+ *
+ */
+
+#include <iostream>
+#include <cmath>
+#include <ComponentLib/Bus/BaseBus.hpp>
+
+#include "Branch.hpp"
+
+namespace ModelLib {
+
+/*!
+ * @brief Constructor for a pi-model branch
+ *
+ * Arguments passed to ModelEvaluatorImpl:
+ * - Number of equations = 0
+ * - Number of independent variables = 0
+ * - Number of quadratures = 0
+ * - Number of optimization parameters = 0
+ */
+
+template <class ScalarT, typename IdxT>
+Branch<ScalarT, IdxT>::Branch(bus_type* bus1, bus_type* bus2)
+  : gL_( 100.0),
+    bL_(-100.0),
+    gL1_(0.0),
+    bL1_(0.01),
+    gL2_(0.0),
+    bL2_(0.01),
+    bus1_(bus1),
+    bus2_(bus2)
+{
+}
+
+template <class ScalarT, typename IdxT>
+Branch<ScalarT, IdxT>::~Branch()
+{
+    //std::cout << "Destroy Branch..." << std::endl;
+}
+
+/*!
+ * @brief allocate method computes sparsity pattern of the Jacobian.
+ */
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::allocate()
+{
+    //std::cout << "Allocate Branch..." << std::endl;
+    return 0;
+}
+
+/**
+ * Initialization of the branch model
+ *
+ */
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::initialize()
+{
+    return 0;
+}
+
+/**
+ * \brief Identify differential variables.
+ */
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::tagDifferentiable()
+{
+    return 0;
+}
+
+/**
+ * \brief Residual contribution of the branch is pushed to the
+ * two terminal buses.
+ */
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::evaluateResidual()
+{
+    ScalarT dtheta = theta1() - theta2();
+    P1() +=  V1()*V1()*(gL_ + gL1_) - V1()*V2()*(gL_*cos(dtheta) + bL_*sin(dtheta));
+    Q1() += -V1()*V1()*(bL_ + bL1_) - V1()*V2()*(gL_*sin(dtheta) - bL_*cos(dtheta));
+    P2() +=  V2()*V2()*(gL_ + gL2_) - V1()*V2()*(gL_*cos(dtheta) - bL_*sin(dtheta));
+    Q2() += -V2()*V2()*(bL_ + bL2_) + V1()*V2()*(gL_*sin(dtheta) + bL_*cos(dtheta));
+
+    return 0;
+}
+
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::evaluateJacobian()
+{
+    std::cout << "Evaluate Jacobian for Branch..." << std::endl;
+    std::cout << "Jacobian evaluation not implemented!" << std::endl;
+    return 0;
+}
+
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::evaluateIntegrand()
+{
+    // std::cout << "Evaluate Integrand for Branch..." << std::endl;
+    return 0;
+}
+
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::initializeAdjoint()
+{
+    //std::cout << "Initialize adjoint for Branch..." << std::endl;
+    return 0;
+}
+
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::evaluateAdjointResidual()
+{
+    // std::cout << "Evaluate adjoint residual for Branch..." << std::endl;
+    return 0;
+}
+
+template <class ScalarT, typename IdxT>
+int Branch<ScalarT, IdxT>::evaluateAdjointIntegrand()
+{
+    // std::cout << "Evaluate adjoint Integrand for Branch..." << std::endl;
+    return 0;
+}
+
+// Available template instantiations
+template class Branch<double, long int>;
+template class Branch<double, size_t>;
+
+} //namespace ModelLib

ComponentLib/Branch/Branch.hpp

@@ -0,0 +1,197 @@
+/*
+ *
+ * Copyright (c) 2017, Lawrence Livermore National Security, LLC.
+ * Produced at the Lawrence Livermore National Laboratory.
+ * Written by Slaven Peles <[email protected]> and Duan Nan <[email protected]>.
+ * LLNL-CODE-718378.
+ * All rights reserved.
+ *
+ * This file is part of GridKit. For details, see github.com/LLNL/GridKit
+ * Please also read the LICENSE file.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * - Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the disclaimer below.
+ * - Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the disclaimer (as noted below) in the
+ *   documentation and/or other materials provided with the distribution.
+ * - Neither the name of the LLNS/LLNL nor the names of its contributors may
+ *   be used to endorse or promote products derived from this software without
+ *   specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL LAWRENCE LIVERMORE NATIONAL
+ * SECURITY, LLC, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISINGIN ANY
+ * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Lawrence Livermore National Laboratory is operated by Lawrence Livermore
+ * National Security, LLC, for the U.S. Department of Energy, National
+ * Nuclear Security Administration under Contract DE-AC52-07NA27344.
+ *
+ * This document was prepared as an account of work sponsored by an agency
+ * of the United States government. Neither the United States government nor
+ * Lawrence Livermore National Security, LLC, nor any of their employees
+ * makes any warranty, expressed or implied, or assumes any legal liability
+ * or responsibility for the accuracy, completeness, or usefulness of any
+ * information, apparatus, product, or process disclosed, or represents that
+ * its use would not infringe privately owned rights. Reference herein to
+ * any specific commercial product, process, or service by trade name,
+ * trademark, manufacturer, or otherwise does not necessarily constitute or
+ * imply its endorsement, recommendation, or favoring by the United States
+ * government or Lawrence Livermore National Security, LLC. The views and
+ * opinions of authors expressed herein do not necessarily state or reflect
+ * those of the United States government or Lawrence Livermore National
+ * Security, LLC, and shall not be used for advertising or product
+ * endorsement purposes.
+ *
+ */
+
+#ifndef _BRANCH_H_
+#define _BRANCH_H_
+
+#include <ModelEvaluatorImpl.hpp>
+
+namespace ModelLib
+{
+    template <class ScalarT, typename IdxT> class BaseBus;
+}
+
+namespace ModelLib
+{
+    /*!
+     * @brief Implementation of a pi-model branch between two buses.
+     *
+     */
+    template  <class ScalarT, typename IdxT>
+    class Branch : public ModelEvaluatorImpl<ScalarT, IdxT>
+    {
+        using ModelEvaluatorImpl<ScalarT, IdxT>::size_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::nnz_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::time_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::alpha_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::y_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::yp_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::tag_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::f_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::g_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::yB_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::ypB_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::fB_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::gB_;
+        using ModelEvaluatorImpl<ScalarT, IdxT>::param_;
+
+        typedef typename ModelEvaluatorImpl<ScalarT, IdxT>::real_type real_type;
+        typedef BaseBus<ScalarT, IdxT> bus_type;
+
+    public:
+        Branch(bus_type* bus1, bus_type* bus2);
+        virtual ~Branch();
+
+        int allocate();
+        int initialize();
+        int tagDifferentiable();
+        int evaluateResidual();
+        int evaluateJacobian();
+        int evaluateIntegrand();
+
+        int initializeAdjoint();
+        int evaluateAdjointResidual();
+        //int evaluateAdjointJacobian();
+        int evaluateAdjointIntegrand();
+
+    public:
+        void setGl(real_type gL)
+        {
+            gL_ = gL;
+        }
+
+        void setGl1(real_type gL1)
+        {
+            gL1_ = gL1;
+        }
+
+        void setGl2(real_type gL2)
+        {
+            gL2_ = gL2;
+        }
+
+        void setBl(real_type bL)
+        {
+            bL_ = bL;
+        }
+
+        void setBl1(real_type bL1)
+        {
+            bL1_ = bL1;
+        }
+
+        void setBl2(real_type bL2)
+        {
+            bL2_ = bL2;
+        }
+
+    private:
+        ScalarT& V1()
+        {
+            return bus1_->V();
+        }
+
+        ScalarT& theta1()
+        {
+            return bus1_->theta();
+        }
+
+        ScalarT& P1()
+        {
+            return bus1_->P();
+        }
+
+        ScalarT& Q1()
+        {
+            return bus1_->Q();
+        }
+
+        ScalarT& V2()
+        {
+            return bus2_->V();
+        }
+
+        ScalarT& theta2()
+        {
+            return bus2_->theta();
+        }
+
+        ScalarT& P2()
+        {
+            return bus2_->P();
+        }
+
+        ScalarT& Q2()
+        {
+            return bus2_->Q();
+        }
+
+    private:
+        real_type gL_;
+        real_type bL_;
+        real_type gL1_;
+        real_type bL1_;
+        real_type gL2_;
+        real_type bL2_;
+        bus_type* bus1_;
+        bus_type* bus2_;
+    };
+}
+
+#endif // _BRANCH_H