Skip to content

IEEEST Stabilizer Improvements/Corrections #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lukelowry wants to merge 9 commits into
base: develop
Choose a base branch
from
Draft

IEEEST Stabilizer Improvements/Corrections #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
866a258
IEEEST Stabilizer Improvements/Corrections
lukelowry Aug 8, 2026
5ee050f
remove param names from signature
lukelowry Aug 10, 2026
8e91ad7
no ternary operators
lukelowry Aug 10, 2026
392abed
remove operatorname maybe fix gh render
lukelowry Aug 10, 2026
65a4bf0
test verbosity
lukelowry Aug 10, 2026
1c13225
remove single use method
lukelowry Aug 10, 2026
022e22f
Apply pre-commit fixes
lukelowry Sep 3, 2026
1d7b880
Apply pre-commit fixes
lukelowry Sep 11, 2026
258187d
Apply pre-commit fixes
lukelowry Sep 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions GridKit/Model/PhasorDynamics/Stabilizer/IEEEST/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ if(GRIDKIT_ENABLE_ENZYME)
ClangEnzymeFlags
COMPILE_OPTIONS
PRIVATE
-mllvm
-enzyme-auto-sparsity=1
"SHELL:-mllvm -enzyme-auto-sparsity=1"
# Preserve runtime-order stores for Enzyme sparsification.
"SHELL:-mllvm -simplifycfg-sink-common=false"
-fno-math-errno)
else()
gridkit_add_library(
Expand Down
80 changes: 39 additions & 41 deletions GridKit/Model/PhasorDynamics/Stabilizer/IEEEST/Ieeest.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@

#pragma once

#include <cstddef>
#include <memory>
#include <vector>
Comment thread
nkoukpaizan marked this conversation as resolved.

#include <GridKit/Definitions.hpp>
#include <GridKit/Model/PhasorDynamics/Component.hpp>
#include <GridKit/Model/PhasorDynamics/SignalNode/SignalNodeSet.hpp>
#include <GridKit/Model/PhasorDynamics/SignalPorts.hpp>
Expand All @@ -16,6 +21,9 @@ namespace GridKit
{
namespace PhasorDynamics
{
template <typename scalar_type, typename index_type>
class SignalNode;

Comment on lines +24 to +26

@superwhiskers superwhiskers Sep 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are we forward declaring this here?

namespace Stabilizer
{
/// Internal variables of `Ieeest`
Expand Down Expand Up @@ -44,41 +52,42 @@ namespace GridKit
template <typename scalar_type, typename index_type>
class Ieeest : public Component<scalar_type, index_type>
{
using Component<scalar_type, index_type>::gridkit_component_id_;
using Component<scalar_type, index_type>::abs_tol_;
using Component<scalar_type, index_type>::allocated_;
using Component<scalar_type, index_type>::alpha_;
using Component<scalar_type, index_type>::f_;
using Component<scalar_type, index_type>::gridkit_component_id_;
using Component<scalar_type, index_type>::J_cols_buffer_;
using Component<scalar_type, index_type>::J_rows_buffer_;
using Component<scalar_type, index_type>::J_vals_buffer_;
using Component<scalar_type, index_type>::nnz_;
using Component<scalar_type, index_type>::residual_indices_;
using Component<scalar_type, index_type>::size_;
using Component<scalar_type, index_type>::tag_;
using Component<scalar_type, index_type>::abs_tol_;
using Component<scalar_type, index_type>::time_;
using Component<scalar_type, index_type>::variable_indices_;
using Component<scalar_type, index_type>::wb_;
using Component<scalar_type, index_type>::y_;
using Component<scalar_type, index_type>::yp_;
using Component<scalar_type, index_type>::wb_;
using Component<scalar_type, index_type>::ws_;
using Component<scalar_type, index_type>::ws_indices_;
using Component<scalar_type, index_type>::h_;
using Component<scalar_type, index_type>::J_rows_buffer_;
using Component<scalar_type, index_type>::J_cols_buffer_;
using Component<scalar_type, index_type>::J_vals_buffer_;
using Component<scalar_type, index_type>::variable_indices_;
using Component<scalar_type, index_type>::residual_indices_;
using Component<scalar_type, index_type>::allocated_;

public:
using ScalarT = scalar_type;
using IdxT = index_type;
using RealT = typename Component<ScalarT, IdxT>::RealT;
using ModelDataT = IeeestData<RealT, IdxT>;
using SignalNodeSetT = SignalNodeSet<ScalarT, IdxT>;
using SignalPortsT = SignalPorts<ScalarT, ModelDataT>;
using MonitorT = Model::VariableMonitor<Ieeest, IeeestData>;
using ScalarT = scalar_type;
using IdxT = index_type;
using RealT = typename Component<ScalarT, IdxT>::RealT;
using SignalT = SignalNode<ScalarT, IdxT>;
using ModelDataT = IeeestData<RealT, IdxT>;
using SignalNodeSetT = SignalNodeSet<ScalarT, IdxT>;
using SignalPortsT = SignalPorts<ScalarT, ModelDataT>;
using MonitorT = Model::VariableMonitor<Ieeest, IeeestData>;
using InternalVariablesT = IeeestInternalVariables;
using ExternalVariablesT = IeeestExternalVariables;

Ieeest();
Ieeest(const ModelDataT& data);
explicit Ieeest(const ModelDataT& data);

@superwhiskers superwhiskers Sep 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just curious what motivated this adjustment here

~Ieeest();

int setGridKitComponentID(IdxT) override final;
int setGridKitComponentID(IdxT component_id) override final;
int allocate() override final;
int verify() const override final;
int initialize() override final;
Expand All @@ -102,6 +111,12 @@ namespace GridKit
ScalarT*);

private:
void initializeParameters(const ModelDataT& data);
void initializeMonitor();
void setDerivedParameters();

static constexpr RealT TIME_CONSTANT_MINIMUM = static_cast<RealT>(1.0e-3);

@superwhiskers superwhiskers Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it looks like this same constant is duplicated across many header files. is there any reason it cannot be placed in a more "global" place so we aren't copy-pasting it all over?

@nkoukpaizan nkoukpaizan Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consolidating is desirable and possible. But at this point, it's still not clear that we want to maintain this minimum time constant.


RealT A1_{0};
RealT A2_{0};
RealT A3_{0};
Expand All @@ -121,34 +136,17 @@ namespace GridKit
RealT Vcu_{0};
RealT Tdelay_{0};

RealT a0_{1};
IdxT order_{0};

RealT a1_{0};
RealT a2_{0};
RealT a3_{0};
RealT a4_{0};

// Precomputed masks and safe inverse coefficients for branch-free degenerate paths.
RealT use_notch_{0};
RealT bypass_notch_{1};
RealT use_4th_order_{0};
RealT use_3rd_order_{0};
RealT use_2nd_order_{0};
RealT safe_inv_a4_{0};
RealT safe_inv_a3_{0};
RealT safe_inv_a2_{0};
RealT use_T2_block_{1};
RealT bypass_T2_block_{0};
RealT use_T4_block_{1};
RealT bypass_T4_block_{0};
RealT use_T6_block_{1};
RealT bypass_T6_block_{0};

SignalPortsT ports_;
IdxT parameter_error_count_{0};

SignalPortsT ports_;
std::unique_ptr<MonitorT> monitor_;

void initializeParameters(const ModelDataT& data);
void initializeMonitor();
};

} // namespace Stabilizer
Expand Down
98 changes: 43 additions & 55 deletions GridKit/Model/PhasorDynamics/Stabilizer/IEEEST/IeeestEnzyme.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ namespace GridKit
{
namespace Stabilizer
{
/**
* @brief Jacobian evaluation experimental
*
* @tparam ScalarT - Scalar data type
* @tparam IdxT - Index data type
* @return int - error code, 0 = success
*/
template <typename scalar_type, typename index_type>
int Ieeest<scalar_type, index_type>::evaluateJacobian()
{
Expand All @@ -29,9 +22,6 @@ namespace GridKit

if (J_rows_buffer_ == nullptr)
{
// Reserve space for the dense blocks.
// The size of the buffer is the sum of maximum capacities of the blocks.
// Enyme will compute the appropriate nnz from sparsification.
auto size = static_cast<size_t>(size_);
auto signal_size = static_cast<size_t>(ws_.getSize());
auto buffer_size = 2 * size * size + size * signal_size;
Expand All @@ -40,63 +30,61 @@ namespace GridKit
J_vals_buffer_ = new RealT[buffer_size];
}

using ModelT = GridKit::PhasorDynamics::Stabilizer::Ieeest<scalar_type, index_type>;
using Fn = GridKit::Enzyme::Sparse::MemberFunctions;

nnz_ = 0;

GridKit::Enzyme::Sparse::DfDy<GridKit::PhasorDynamics::Stabilizer::Ieeest<ScalarT, IdxT>,
GridKit::Enzyme::Sparse::MemberFunctions::InternalResidualWithSignal>::eval(this,
static_cast<size_t>(f_.getSize()),
static_cast<size_t>(y_.getSize()),
(this->getResidualIndices()).data(),
(this->getVariableIndices()).data(),
y_.getData(),
yp_.getData(),
nullptr,
ws_.getData(),
J_rows_buffer_,
J_cols_buffer_,
J_vals_buffer_,
nnz_);
GridKit::Enzyme::Sparse::DfDy<ModelT, Fn::InternalResidualWithSignal>::eval(this,
static_cast<size_t>(f_.getSize()),
static_cast<size_t>(y_.getSize()),
(this->getResidualIndices()).data(),
(this->getVariableIndices()).data(),
y_.getData(),
yp_.getData(),
nullptr,
ws_.getData(),
J_rows_buffer_,
J_cols_buffer_,
J_vals_buffer_,
nnz_);

GridKit::Enzyme::Sparse::DfDyp<GridKit::PhasorDynamics::Stabilizer::Ieeest<ScalarT, IdxT>,
GridKit::Enzyme::Sparse::MemberFunctions::InternalResidualWithSignal>::eval(this,
static_cast<size_t>(f_.getSize()),
static_cast<size_t>(y_.getSize()),
(this->getResidualIndices()).data(),
(this->getVariableIndices()).data(),
y_.getData(),
yp_.getData(),
nullptr,
ws_.getData(),
alpha_,
J_rows_buffer_,
J_cols_buffer_,
J_vals_buffer_,
nnz_);
GridKit::Enzyme::Sparse::DfDyp<ModelT, Fn::InternalResidualWithSignal>::eval(this,
static_cast<size_t>(f_.getSize()),
static_cast<size_t>(y_.getSize()),
(this->getResidualIndices()).data(),
(this->getVariableIndices()).data(),
y_.getData(),
yp_.getData(),
nullptr,
ws_.getData(),
alpha_,
J_rows_buffer_,
J_cols_buffer_,
J_vals_buffer_,
nnz_);

GridKit::Enzyme::Sparse::DfDws<GridKit::PhasorDynamics::Stabilizer::Ieeest<ScalarT, IdxT>,
GridKit::Enzyme::Sparse::MemberFunctions::InternalResidualWithSignal>::eval(this,
static_cast<size_t>(f_.getSize()),
static_cast<size_t>(ws_.getSize()),
(this->getResidualIndices()).data(),
ws_indices_.data(),
y_.getData(),
yp_.getData(),
nullptr,
ws_.getData(),
J_rows_buffer_,
J_cols_buffer_,
J_vals_buffer_,
nnz_);
GridKit::Enzyme::Sparse::DfDws<ModelT, Fn::InternalResidualWithSignal>::eval(this,
static_cast<size_t>(f_.getSize()),
static_cast<size_t>(ws_.getSize()),
(this->getResidualIndices()).data(),
ws_indices_.data(),
y_.getData(),
yp_.getData(),
nullptr,
ws_.getData(),
J_rows_buffer_,
J_cols_buffer_,
J_vals_buffer_,
nnz_);

this->constructCoo();

return 0;
}

// Available template instantiations
template class Ieeest<double, long int>;
template class Ieeest<double, size_t>;

} // namespace Stabilizer
} // namespace PhasorDynamics
} // namespace GridKit
Loading
Loading