Windows compatibility (new PR)

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release Changelog
 
+## v0.3
+
+- Added Windows compatibility (G++, Clang, MSVC).
+
 ## v0.2
 
 - Added 3, 10, 37, and 39 bus test cases.
@@ -77,7 +81,6 @@
 - Added `REGCA` converter model implementation for PhasorDynamics.
 - Remove unnecessary data copying while evaluating `PowerElectronics` models, speeding up large simulations by up to 3x
 - Added `HYGOV` governor model implementation for PhasorDynamics.
-- Added `REPCA` controller model implementation for PhasorDynamics.
 
 ## v0.1
 

CMakeLists.txt

@@ -17,11 +17,19 @@ set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 if(MSVC)
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Wall")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")
 else()
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wconversion -Wpedantic")
 endif()
 
+if(CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+  add_compile_definitions(FORCE_INLINE=[[gnu::always_inline]]\ inline)
+elseif(MSVC)
+  add_compile_definitions(FORCE_INLINE=[[msvc::forceinline]]\ inline)
+else()
+  add_compile_definitions(FORCE_INLINE=inline)
+endif()
+
 set(GRIDKIT_THIRD_PARTY_DIR ${PROJECT_SOURCE_DIR}/third-party)
 
 # Ipopt support is disabled by default
@@ -119,7 +127,11 @@ if("${isSystemDir}" STREQUAL "-1")
   set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
 endif("${isSystemDir}" STREQUAL "-1")
 
-option(BUILD_SHARED_LIBS "Build shared libraries" ON)
+if(WIN32)
+  option(BUILD_SHARED_LIBS "Build shared libraries" OFF)
+else()
+  option(BUILD_SHARED_LIBS "Build shared libraries" ON)
+endif()
 
 if(GRIDKIT_ENABLE_IPOPT)
   include(FindIpopt)

GridKit/AutomaticDifferentiation/Enzyme/LowerSparseStorage.hpp

@@ -206,7 +206,7 @@ namespace GridKit
        * @param[in,out] nnz - number of nonzeros
        */
       template <typename ScalarT, typename IdxT>
-      __attribute__((always_inline)) static void sparse_store(
+      FORCE_INLINE static void sparse_store(
           ScalarT     val,
           IdxT        row,
           IdxT        col,
@@ -251,7 +251,7 @@ namespace GridKit
        * @tparam IdxT - matrix index data type
        */
       template <typename ScalarT, typename IdxT>
-      __attribute__((always_inline)) static ScalarT sparse_load(IdxT, IdxT, IdxT*, IdxT*, ScalarT*)
+      FORCE_INLINE static ScalarT sparse_load(IdxT, IdxT, IdxT*, IdxT*, ScalarT*)
       {
         return 0.0;
       }
@@ -263,7 +263,7 @@ namespace GridKit
        * @tparam IdxT - matrix index data type
        */
       template <typename ScalarT, typename IdxT>
-      __attribute__((always_inline)) static void ident_store(ScalarT, IdxT, IdxT)
+      FORCE_INLINE static void ident_store(ScalarT, IdxT, IdxT)
       {
         assert(0 && "should never store");
       }
@@ -275,7 +275,7 @@ namespace GridKit
        * @tparam IdxT - matrix index data type
        */
       template <typename ScalarT, typename IdxT>
-      __attribute__((always_inline)) static ScalarT ident_load(IdxT row, IdxT col)
+      FORCE_INLINE static ScalarT ident_load(IdxT row, IdxT col)
       {
         row /= sizeof(ScalarT);
         return (ScalarT) (row == col);

GridKit/CommonMath.hpp

@@ -4,6 +4,7 @@
 #include <cmath>
 
 #include <GridKit/Constants.hpp>
+#include <GridKit/Definitions.hpp>
 #include <GridKit/ScalarTraits.hpp>
 
 namespace GridKit
@@ -34,7 +35,7 @@ namespace GridKit
      * @return value of the sigmoid function
      */
     template <class ScalarT>
-    __attribute__((always_inline)) inline ScalarT sigmoid(const ScalarT x)
+    FORCE_INLINE ScalarT sigmoid(const ScalarT x)
     {
       using RealT = typename GridKit::ScalarTraits<ScalarT>::RealT;
       return HALF<RealT> * (ONE<RealT> + std::tanh(HALF<RealT> * MU<RealT> * x));
@@ -52,7 +53,7 @@ namespace GridKit
      * @return value of the smooth ramp function
      */
     template <class ScalarT>
-    __attribute__((always_inline)) inline ScalarT ramp(const ScalarT x)
+    FORCE_INLINE ScalarT ramp(const ScalarT x)
     {
       using RealT = typename GridKit::ScalarTraits<ScalarT>::RealT;
 
@@ -76,7 +77,7 @@ namespace GridKit
      * @return value of the quadratic ramp
      */
     template <class ScalarT>
-    __attribute__((always_inline)) inline ScalarT qramp(const ScalarT x)
+    FORCE_INLINE ScalarT qramp(const ScalarT x)
     {
       return x * x * sigmoid(x);
     }
@@ -101,7 +102,7 @@ namespace GridKit
      * forcing callers to cast every parameter.
      */
     template <class LeftT, class RightT>
-    __attribute__((always_inline)) inline auto max(
+    FORCE_INLINE auto max(
         const LeftT  x,
         const RightT y)
     {
@@ -128,7 +129,7 @@ namespace GridKit
      * forcing callers to cast every parameter.
      */
     template <class LeftT, class RightT>
-    __attribute__((always_inline)) inline auto min(
+    FORCE_INLINE auto min(
         const LeftT  x,
         const RightT y)
     {
@@ -152,7 +153,7 @@ namespace GridKit
      * @return value of the smooth clamp function
      */
     template <class ScalarT, typename LowerT, typename UpperT>
-    __attribute__((always_inline)) inline auto clamp(
+    FORCE_INLINE auto clamp(
         const ScalarT x,
         const LowerT  lower,
         const UpperT  upper)
@@ -176,7 +177,7 @@ namespace GridKit
      * @return Smooth no-offset deadbanded value
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT deadband1(
+    FORCE_INLINE ScalarT deadband1(
         const ScalarT x,
         const RealT   lower,
         const RealT   upper)
@@ -200,7 +201,7 @@ namespace GridKit
      * @return Smooth offset deadbanded value
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT deadband2(
+    FORCE_INLINE ScalarT deadband2(
         const ScalarT x,
         const RealT   lower,
         const RealT   upper)
@@ -222,7 +223,7 @@ namespace GridKit
      * @return Slew-rate-limited value of f
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT slew(
+    FORCE_INLINE ScalarT slew(
         const ScalarT f,
         const RealT   rate)
     {
@@ -247,7 +248,7 @@ namespace GridKit
      * @return Smooth linear segment contribution
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT linseg(
+    FORCE_INLINE ScalarT linseg(
         const ScalarT x,
         const RealT   lower,
         const RealT   upper,
@@ -268,7 +269,7 @@ namespace GridKit
      * @return Smooth indicator that x is above limit_min
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT above(
+    FORCE_INLINE ScalarT above(
         const ScalarT x,
         const RealT   limit_min)
     {
@@ -286,7 +287,7 @@ namespace GridKit
      * @return Smooth indicator that x is below limit_max
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT below(
+    FORCE_INLINE ScalarT below(
         const ScalarT x,
         const RealT   limit_max)
     {
@@ -305,7 +306,7 @@ namespace GridKit
      * @return Smooth indicator that x is inside [limit_min, limit_max]
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT inside(
+    FORCE_INLINE ScalarT inside(
         const ScalarT x,
         const RealT   limit_min,
         const RealT   limit_max)
@@ -326,7 +327,7 @@ namespace GridKit
      * @return Smooth indicator that x is outside [limit_min, limit_max]
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT outside(
+    FORCE_INLINE ScalarT outside(
         const ScalarT x,
         const RealT   limit_min,
         const RealT   limit_max)
@@ -349,7 +350,7 @@ namespace GridKit
      *         0 when integration should be blocked.
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT indicator(
+    FORCE_INLINE ScalarT indicator(
         const ScalarT x,
         const ScalarT f,
         const RealT   limit_min,
@@ -383,7 +384,7 @@ namespace GridKit
      * @return Smooth anti-windup limited derivative
      */
     template <class ScalarT, typename RealT>
-    __attribute__((always_inline)) inline ScalarT antiwindup(
+    FORCE_INLINE ScalarT antiwindup(
         const ScalarT x,
         const ScalarT f,
         const RealT   limit_min,

GridKit/Model/PhasorDynamics/Branch/Branch.hpp

@@ -8,6 +8,7 @@
  */
 #pragma once
 
+#include <GridKit/Definitions.hpp>
 #include <GridKit/Model/PhasorDynamics/Branch/BranchData.hpp>
 #include <GridKit/Model/PhasorDynamics/Component.hpp>
 #include <GridKit/Model/PhasorDynamics/ComponentSignals.hpp>
@@ -135,17 +136,17 @@ namespace GridKit
                              typename ModelDataT::Parameters parameter,
                              RealT&                          target);
 
-      static __attribute__((always_inline)) inline void addAdmittanceContribution(const RealT   G,
-                                                                                  const RealT   B,
-                                                                                  const ScalarT Vr,
-                                                                                  const ScalarT Vi,
-                                                                                  ScalarT&      Ir,
-                                                                                  ScalarT&      Ii);
+      FORCE_INLINE static void addAdmittanceContribution(const RealT   G,
+                                                         const RealT   B,
+                                                         const ScalarT Vr,
+                                                         const ScalarT Vi,
+                                                         ScalarT&      Ir,
+                                                         ScalarT&      Ii);
 
-      static __attribute__((always_inline)) inline void evaluateAdmittanceBlock(const RealT    G,
-                                                                                const RealT    B,
-                                                                                const ScalarT* wb,
-                                                                                ScalarT*       h);
+      FORCE_INLINE static void evaluateAdmittanceBlock(const RealT    G,
+                                                       const RealT    B,
+                                                       const ScalarT* wb,
+                                                       ScalarT*       h);
 
       ScalarT& Vr1()
       {
@@ -188,13 +189,13 @@ namespace GridKit
       }
 
     public:
-      __attribute__((always_inline)) inline int evaluateBusResidual11(
+      FORCE_INLINE int evaluateBusResidual11(
           const ScalarT*, const ScalarT*, const ScalarT*, ScalarT*);
-      __attribute__((always_inline)) inline int evaluateBusResidual12(
+      FORCE_INLINE int evaluateBusResidual12(
           const ScalarT*, const ScalarT*, const ScalarT*, ScalarT*);
-      __attribute__((always_inline)) inline int evaluateBusResidual21(
+      FORCE_INLINE int evaluateBusResidual21(
           const ScalarT*, const ScalarT*, const ScalarT*, ScalarT*);
-      __attribute__((always_inline)) inline int evaluateBusResidual22(
+      FORCE_INLINE int evaluateBusResidual22(
           const ScalarT*, const ScalarT*, const ScalarT*, ScalarT*);
 
     private:

GridKit/Model/PhasorDynamics/Branch/BranchImpl.hpp

@@ -185,7 +185,7 @@ namespace GridKit
     }
 
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) inline void Branch<scalar_type, index_type>::addAdmittanceContribution(
+    FORCE_INLINE void Branch<scalar_type, index_type>::addAdmittanceContribution(
         const RealT   G,
         const RealT   B,
         const ScalarT Vr,
@@ -198,7 +198,7 @@ namespace GridKit
     }
 
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) inline void Branch<scalar_type, index_type>::evaluateAdmittanceBlock(
+    FORCE_INLINE void Branch<scalar_type, index_type>::evaluateAdmittanceBlock(
         const RealT    G,
         const RealT    B,
         const ScalarT* wb,
@@ -234,7 +234,7 @@ namespace GridKit
      *
      */
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) inline int Branch<scalar_type, index_type>::evaluateBusResidual11(
+    FORCE_INLINE int Branch<scalar_type, index_type>::evaluateBusResidual11(
         [[maybe_unused]] const ScalarT* y,
         [[maybe_unused]] const ScalarT* yp,
         const ScalarT*                  wb,
@@ -250,7 +250,7 @@ namespace GridKit
      *
      */
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) inline int Branch<scalar_type, index_type>::evaluateBusResidual12(
+    FORCE_INLINE int Branch<scalar_type, index_type>::evaluateBusResidual12(
         [[maybe_unused]] const ScalarT* y,
         [[maybe_unused]] const ScalarT* yp,
         const ScalarT*                  wb,
@@ -266,7 +266,7 @@ namespace GridKit
      *
      */
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) int Branch<scalar_type, index_type>::evaluateBusResidual21(
+    FORCE_INLINE int Branch<scalar_type, index_type>::evaluateBusResidual21(
         [[maybe_unused]] const ScalarT* y,
         [[maybe_unused]] const ScalarT* yp,
         const ScalarT*                  wb,
@@ -282,7 +282,7 @@ namespace GridKit
      *
      */
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) int Branch<scalar_type, index_type>::evaluateBusResidual22(
+    FORCE_INLINE int Branch<scalar_type, index_type>::evaluateBusResidual22(
         [[maybe_unused]] const ScalarT* y,
         [[maybe_unused]] const ScalarT* yp,
         const ScalarT*                  wb,

GridKit/Model/PhasorDynamics/BusFault/BusFault.hpp

@@ -1,6 +1,7 @@
 /* Bus Fault Component - Adam Birchfield */
 #pragma once
 
+#include <GridKit/Definitions.hpp>
 #include <GridKit/Model/PhasorDynamics/BusBase.hpp>
 #include <GridKit/Model/PhasorDynamics/Component.hpp>
 #include <GridKit/Model/PhasorDynamics/ComponentSignals.hpp>
@@ -116,9 +117,9 @@ namespace GridKit
       }
 
     public:
-      __attribute__((always_inline)) inline int evaluateBusResidual(
+      FORCE_INLINE int evaluateBusResidual(
           const ScalarT*, const ScalarT*, const ScalarT*, ScalarT*);
-      __attribute__((always_inline)) inline int evaluateInternalResidual(
+      FORCE_INLINE int evaluateInternalResidual(
           const ScalarT*, const ScalarT*, const ScalarT*, ScalarT*);
 
     private:

GridKit/Model/PhasorDynamics/BusFault/BusFaultImpl.hpp

@@ -209,7 +209,7 @@ namespace GridKit
      *
      */
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) int BusFault<scalar_type, index_type>::evaluateBusResidual(
+    FORCE_INLINE int BusFault<scalar_type, index_type>::evaluateBusResidual(
         const ScalarT*                  y,
         [[maybe_unused]] const ScalarT* yp,
         [[maybe_unused]] const ScalarT* wb,
@@ -228,7 +228,7 @@ namespace GridKit
      *
      */
     template <typename scalar_type, typename index_type>
-    __attribute__((always_inline)) int BusFault<scalar_type, index_type>::evaluateInternalResidual(
+    FORCE_INLINE int BusFault<scalar_type, index_type>::evaluateInternalResidual(
         const ScalarT*                  y,
         [[maybe_unused]] const ScalarT* yp,
         const ScalarT*                  wb,