Skip to content

improve the approach we use for parsing and storing component data #169

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

Merged
pelesh merged 16 commits into from
Jul 9, 2025
Merged

improve the approach we use for parsing and storing component data #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ae05633
initial progress on the new data structure parsing approach
superwhiskers Jul 2, 2025
6109ddf
Apply pre-commmit fixes
superwhiskers Jul 2, 2025
e20c243
move the case format tests and require floating point parameters to b…
superwhiskers Jul 3, 2025
914199b
add some documentation to the modified bus fault data structure
superwhiskers Jul 3, 2025
4e2710c
break out the component data json parser into a separate file
superwhiskers Jul 3, 2025
8f30068
finish reworking the remainder of the applicable `*Data` structures t…
superwhiskers Jul 8, 2025
6208376
finish the data structure reworking started in the previous commit
superwhiskers Jul 8, 2025
7f2f902
Apply pre-commmit fixes
superwhiskers Jul 8, 2025
26a6df4
fix documentation comment in `LoadImpl.hpp`
superwhiskers Jul 8, 2025
4a4d72c
remove extraneous parens in `SystemModelData.hpp`
superwhiskers Jul 8, 2025
4270567
fix the `ThreeBusClassical` example
superwhiskers Jul 9, 2025
5fea53d
Apply pre-commmit fixes
superwhiskers Jul 9, 2025
4ac3862
minor fixes to the documentation comments, remove unnecessary no-ops
superwhiskers Jul 9, 2025
d86ff3d
Apply pre-commmit fixes
superwhiskers Jul 9, 2025
ee3d37e
address all review comments
superwhiskers Jul 9, 2025
b7461eb
Apply pre-commmit fixes
superwhiskers Jul 9, 2025
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
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@
[submodule "third-party/nlohmann-json"]
path = third-party/nlohmann-json
url = https://github.com/nlohmann/json
[submodule "third-party/magic-enum"]
path = third-party/magic-enum
url = https://github.com/Neargye/magic_enum
10 changes: 8 additions & 2 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ set(PACKAGE_VERSION_PATCH "0")

set(PACKAGE_VERSION "${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}.${PACKAGE_VERSION_PATCH}")

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD 20)

if (MSVC)
set(CMAKE_CXX_FLAGS "/Wall")
Expand Down Expand Up @@ -83,7 +83,6 @@ endif("${isSystemDir}" STREQUAL "-1")


include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
include_directories(${CMAKE_CURRENT_SOURCE_DIR}/third-party/nlohmann-json/single_include)

option(GRIDKIT_BUILD_SHARED "Build shared libraries" ON)
option(GRIDKIT_BUILD_STATIC "Build static libraries" OFF)
Expand All @@ -108,6 +107,13 @@ if(${GRIDKIT_ENABLE_ENZYME})
add_definitions(-DGRIDKIT_ENABLE_ENZYME)
endif()

# add third-party libraries

set(JSON_BuildTests OFF CACHE INTERNAL "")

add_subdirectory(third-party/nlohmann-json)
add_subdirectory(third-party/magic-enum)

# Macro that adds libraries
include(GridkitAddLibrary)

Expand Down
133 changes: 67 additions & 66 deletions examples/PhasorDynamics/Tiny/ThreeBus/Basic/ThreeBusBasic.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ int main()
{
using namespace GridKit::PhasorDynamics;
using namespace AnalysisManager::Sundials;
using BusType = BusData<scalar_type, index_type>::BusType;

auto error_allowed = static_cast<real_type>(1e-4);

Expand All @@ -99,109 +100,109 @@ int main()

// Bus 0
data.bus[0].bus_id = 0;
data.bus[0].bus_type = BusData<scalar_type, index_type>::BusType::SLACK;
data.bus[0].bus_type = BusType::SLACK;
data.bus[0].Vr0 = 1.06;
data.bus[0].Vi0 = 0.0;

// Bus 1
data.bus[1].bus_id = 1;
data.bus[1].bus_type = BusData<scalar_type, index_type>::BusType::DEFAULT;
data.bus[1].bus_type = BusType::DEFAULT;
data.bus[1].Vr0 = 1.0599558398065716;
data.bus[1].Vi0 = -0.009675621941024773;

// Bus 2
data.bus[2].bus_id = 2;
data.bus[2].bus_type = BusData<scalar_type, index_type>::BusType::DEFAULT;
data.bus[2].bus_type = BusType::DEFAULT;
data.bus[2].Vr0 = 0.9610827543495831;
data.bus[2].Vi0 = -0.13122476630506485;

// Set branch data
data.branch.resize(3);

// Branch 0-1
data.branch[0].bus1_id = data.bus[0].bus_id;
data.branch[0].bus2_id = data.bus[1].bus_id;
data.branch[0].R = 0.05;
data.branch[0].X = 0.21;
data.branch[0].G = 0;
data.branch[0].B = 0.1;
data.branch[0].ports[BranchPorts::bus1] = data.bus[0].bus_id;
data.branch[0].ports[BranchPorts::bus2] = data.bus[1].bus_id;
data.branch[0].parameters[BranchParameters::R] = 0.05;
data.branch[0].parameters[BranchParameters::X] = 0.21;
data.branch[0].parameters[BranchParameters::G] = 0.;
data.branch[0].parameters[BranchParameters::B] = 0.1;

// Branch 0-2
data.branch[1].bus1_id = data.bus[0].bus_id;
data.branch[1].bus2_id = data.bus[2].bus_id;
data.branch[1].R = 0.06;
data.branch[1].X = 0.15;
data.branch[1].G = 0;
data.branch[1].B = 0.12;
data.branch[1].ports[BranchPorts::bus1] = data.bus[0].bus_id;
data.branch[1].ports[BranchPorts::bus2] = data.bus[2].bus_id;
data.branch[1].parameters[BranchParameters::R] = 0.06;
data.branch[1].parameters[BranchParameters::X] = 0.15;
data.branch[1].parameters[BranchParameters::G] = 0.;
data.branch[1].parameters[BranchParameters::B] = 0.12;

// Branch 1-2
data.branch[2].bus1_id = data.bus[1].bus_id;
data.branch[2].bus2_id = data.bus[2].bus_id;
data.branch[2].R = 0.08;
data.branch[2].X = 0.27;
data.branch[2].G = 0;
data.branch[2].B = 0.45;
data.branch[2].ports[BranchPorts::bus1] = data.bus[1].bus_id;
data.branch[2].ports[BranchPorts::bus2] = data.bus[2].bus_id;
data.branch[2].parameters[BranchParameters::R] = 0.08;
data.branch[2].parameters[BranchParameters::X] = 0.27;
data.branch[2].parameters[BranchParameters::G] = 0.;
data.branch[2].parameters[BranchParameters::B] = 0.45;

// Set generator data
data.genrou.resize(2);

// Generator on bus 1
data.genrou[0].bus_id = 1;
data.genrou[0].p0 = 0.5;
data.genrou[0].q0 = -0.07588;
data.genrou[0].H = 2.7;
data.genrou[0].D = 0.;
data.genrou[0].Ra = 0.;
data.genrou[0].Tdop = 7.;
data.genrou[0].Tdopp = .04;
data.genrou[0].Tqopp = .05;
data.genrou[0].Tqop = .75;
data.genrou[0].Xd = 1.9;
data.genrou[0].Xdp = 0.17;
data.genrou[0].Xdpp = 0.15;
data.genrou[0].Xq = 0.4;
data.genrou[0].Xqp = 0.35;
data.genrou[0].Xqpp = 0.15;
data.genrou[0].Xl = 0.14999;
data.genrou[0].S10 = 0.;
data.genrou[0].S12 = 0.;
data.genrou[0].ports[GenrouPorts::bus] = 1;
data.genrou[0].parameters[GenrouParameters::p0] = 0.5;
data.genrou[0].parameters[GenrouParameters::q0] = -0.07588;
data.genrou[0].parameters[GenrouParameters::H] = 2.7;
data.genrou[0].parameters[GenrouParameters::D] = 0.;
data.genrou[0].parameters[GenrouParameters::Ra] = 0.;
data.genrou[0].parameters[GenrouParameters::Tdop] = 7.;
data.genrou[0].parameters[GenrouParameters::Tdopp] = .04;
data.genrou[0].parameters[GenrouParameters::Tqopp] = .05;
data.genrou[0].parameters[GenrouParameters::Tqop] = .75;
data.genrou[0].parameters[GenrouParameters::Xd] = 1.9;
data.genrou[0].parameters[GenrouParameters::Xdp] = 0.17;
data.genrou[0].parameters[GenrouParameters::Xdpp] = 0.15;
data.genrou[0].parameters[GenrouParameters::Xq] = 0.4;
data.genrou[0].parameters[GenrouParameters::Xqp] = 0.35;
data.genrou[0].parameters[GenrouParameters::Xqpp] = 0.15;
data.genrou[0].parameters[GenrouParameters::Xl] = 0.14999;
data.genrou[0].parameters[GenrouParameters::S10] = 0.;
data.genrou[0].parameters[GenrouParameters::S12] = 0.;

// Generator on bus 2
data.genrou[1].bus_id = 2;
data.genrou[1].p0 = 0.25;
data.genrou[1].q0 = 0.26587;
data.genrou[1].H = 1.6;
data.genrou[1].D = 0.;
data.genrou[1].Ra = 0.;
data.genrou[1].Tdop = 7.5;
data.genrou[1].Tdopp = .04;
data.genrou[1].Tqopp = .05;
data.genrou[1].Tqop = .75;
data.genrou[1].Xd = 2.3;
data.genrou[1].Xdp = 0.2;
data.genrou[1].Xdpp = 0.18;
data.genrou[1].Xq = 0.5;
data.genrou[1].Xqp = 0.5;
data.genrou[1].Xqpp = 0.18;
data.genrou[1].Xl = 0.15;
data.genrou[1].S10 = 0.;
data.genrou[1].S12 = 0.;
data.genrou[1].ports[GenrouPorts::bus] = 2;
data.genrou[1].parameters[GenrouParameters::p0] = 0.25;
data.genrou[1].parameters[GenrouParameters::q0] = 0.26587;
data.genrou[1].parameters[GenrouParameters::H] = 1.6;
data.genrou[1].parameters[GenrouParameters::D] = 0.;
data.genrou[1].parameters[GenrouParameters::Ra] = 0.;
data.genrou[1].parameters[GenrouParameters::Tdop] = 7.5;
data.genrou[1].parameters[GenrouParameters::Tdopp] = .04;
data.genrou[1].parameters[GenrouParameters::Tqopp] = .05;
data.genrou[1].parameters[GenrouParameters::Tqop] = .75;
data.genrou[1].parameters[GenrouParameters::Xd] = 2.3;
data.genrou[1].parameters[GenrouParameters::Xdp] = 0.2;
data.genrou[1].parameters[GenrouParameters::Xdpp] = 0.18;
data.genrou[1].parameters[GenrouParameters::Xq] = 0.5;
data.genrou[1].parameters[GenrouParameters::Xqp] = 0.5;
data.genrou[1].parameters[GenrouParameters::Xqpp] = 0.18;
data.genrou[1].parameters[GenrouParameters::Xl] = 0.15;
data.genrou[1].parameters[GenrouParameters::S10] = 0.;
data.genrou[1].parameters[GenrouParameters::S12] = 0.;

// Set load data
data.load.resize(1);

// Load on bus 2
data.load[0].bus_id = 2;
data.load[0].R = 0.4447197839297772;
data.load[0].X = 0.20330047265361242;
data.load[0].ports[LoadPorts::bus] = 2;
data.load[0].parameters[LoadParameters::R] = 0.4447197839297772;
data.load[0].parameters[LoadParameters::X] = 0.20330047265361242;

// Set fault data
data.bus_fault.resize(1);

data.bus_fault[0].bus_id = 2;
data.bus_fault[0].R = 0.0;
data.bus_fault[0].X = 1e-5;
data.bus_fault[0].status = false;
data.bus_fault[0].ports[BusFaultPorts::bus] = 2;
data.bus_fault[0].parameters[BusFaultParameters::R] = 0.0;
data.bus_fault[0].parameters[BusFaultParameters::X] = 1e-5;
data.bus_fault[0].parameters[BusFaultParameters::state0] = false;

//
// Instantiate system
Expand Down
84 changes: 43 additions & 41 deletions examples/PhasorDynamics/Tiny/ThreeBus/Classical/ThreeBusClassical.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ using scalar_type = double;
using real_type = double;
using index_type = size_t;

using BusType = GridKit::PhasorDynamics::BusData<scalar_type, index_type>::BusType;

struct OutputData
{
real_type t;
Expand Down Expand Up @@ -99,13 +101,13 @@ int main()

// Bus 0
data.bus[0].bus_id = 0;
data.bus[0].bus_type = BusData<scalar_type, index_type>::BusType::SLACK;
data.bus[0].bus_type = BusType::SLACK;
data.bus[0].Vr0 = 1.06;
data.bus[0].Vi0 = 0.0;

// Bus 1
data.bus[1].bus_id = 1;
data.bus[1].bus_type = BusData<scalar_type, index_type>::BusType::DEFAULT;
data.bus[1].bus_type = BusType::DEFAULT;
data.bus[1].Vr0 = 1.0599558398065716;
data.bus[1].Vi0 = -0.009675621941024773;

Expand All @@ -119,65 +121,65 @@ int main()
data.branch.resize(3);

// Branch 0-1
data.branch[0].bus1_id = data.bus[0].bus_id;
data.branch[0].bus2_id = data.bus[1].bus_id;
data.branch[0].R = 0.05;
data.branch[0].X = 0.21;
data.branch[0].G = 0;
data.branch[0].B = 0.1;
data.branch[0].ports[BranchPorts::bus1] = data.bus[0].bus_id;
data.branch[0].ports[BranchPorts::bus2] = data.bus[1].bus_id;
data.branch[0].parameters[BranchParameters::R] = 0.05;
data.branch[0].parameters[BranchParameters::X] = 0.21;
data.branch[0].parameters[BranchParameters::G] = 0.0;
data.branch[0].parameters[BranchParameters::B] = 0.1;

// Branch 0-2
data.branch[1].bus1_id = data.bus[0].bus_id;
data.branch[1].bus2_id = data.bus[2].bus_id;
data.branch[1].R = 0.06;
data.branch[1].X = 0.15;
data.branch[1].G = 0;
data.branch[1].B = 0.12;
data.branch[1].ports[BranchPorts::bus1] = data.bus[0].bus_id;
data.branch[1].ports[BranchPorts::bus2] = data.bus[2].bus_id;
data.branch[1].parameters[BranchParameters::R] = 0.06;
data.branch[1].parameters[BranchParameters::X] = 0.15;
data.branch[1].parameters[BranchParameters::G] = 0.0;
data.branch[1].parameters[BranchParameters::B] = 0.12;

// Branch 1-2
data.branch[2].bus1_id = data.bus[1].bus_id;
data.branch[2].bus2_id = data.bus[2].bus_id;
data.branch[2].R = 0.08;
data.branch[2].X = 0.27;
data.branch[2].G = 0;
data.branch[2].B = 0.45;
data.branch[2].ports[BranchPorts::bus1] = data.bus[1].bus_id;
data.branch[2].ports[BranchPorts::bus2] = data.bus[2].bus_id;
data.branch[2].parameters[BranchParameters::R] = 0.08;
data.branch[2].parameters[BranchParameters::X] = 0.27;
data.branch[2].parameters[BranchParameters::G] = 0.0;
data.branch[2].parameters[BranchParameters::B] = 0.45;

// Set generator data
data.genclassical.resize(2);

// Generator on bus 1
data.genclassical[0].bus_id = data.bus[1].bus_id;
data.genclassical[0].p0 = 0.5;
data.genclassical[0].q0 = -0.07588;
data.genclassical[0].H = 2.7;
data.genclassical[0].D = 0.;
data.genclassical[0].Ra = 0.;
data.genclassical[0].Xdp = 0.17;
data.genclassical[0].ports[GenClassicalPorts::bus] = data.bus[1].bus_id;
data.genclassical[0].parameters[GenClassicalParameters::p0] = 0.5;
data.genclassical[0].parameters[GenClassicalParameters::q0] = -0.07588;
data.genclassical[0].parameters[GenClassicalParameters::H] = 2.7;
data.genclassical[0].parameters[GenClassicalParameters::D] = 0.;
data.genclassical[0].parameters[GenClassicalParameters::Ra] = 0.;
data.genclassical[0].parameters[GenClassicalParameters::Xdp] = 0.17;

// Generator on bus 2
data.genclassical[1].bus_id = data.bus[2].bus_id;
data.genclassical[1].p0 = 0.25;
data.genclassical[1].q0 = 0.26587;
data.genclassical[1].H = 1.6;
data.genclassical[1].D = 0.;
data.genclassical[1].Ra = 0.;
data.genclassical[1].Xdp = 0.2;
data.genclassical[1].ports[GenClassicalPorts::bus] = data.bus[2].bus_id;
data.genclassical[1].parameters[GenClassicalParameters::p0] = 0.25;
data.genclassical[1].parameters[GenClassicalParameters::q0] = 0.26587;
data.genclassical[1].parameters[GenClassicalParameters::H] = 1.6;
data.genclassical[1].parameters[GenClassicalParameters::D] = 0.;
data.genclassical[1].parameters[GenClassicalParameters::Ra] = 0.;
data.genclassical[1].parameters[GenClassicalParameters::Xdp] = 0.2;

// Set load data
data.load.resize(1);

// Load on bus 2
data.load[0].bus_id = 2;
data.load[0].R = 0.4447197839297772;
data.load[0].X = 0.20330047265361242;
data.load[0].ports[LoadPorts::bus] = 2;
data.load[0].parameters[LoadParameters::R] = 0.4447197839297772;
data.load[0].parameters[LoadParameters::X] = 0.20330047265361242;

// Set fault data
data.bus_fault.resize(1);

data.bus_fault[0].bus_id = 2;
data.bus_fault[0].R = 0.0;
data.bus_fault[0].X = 1e-5;
data.bus_fault[0].status = false;
data.bus_fault[0].ports[BusFaultPorts::bus] = 2;
data.bus_fault[0].parameters[BusFaultParameters::R] = 0.0;
data.bus_fault[0].parameters[BusFaultParameters::X] = 1e-5;
data.bus_fault[0].parameters[BusFaultParameters::state0] = false;

//
// Instantiate system
Expand Down
Loading