Skip to content

Refine IDATest::consistentICType test for steady-state initialization #543

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
nkoukpaizan merged 9 commits into from
Aug 19, 2026
Merged

Refine IDATest::consistentICType test for steady-state initialization #543

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
72b4340
std::abs--> isEqual
nkoukpaizan Aug 19, 2026
a2925e2
Make all checks explicity in IDATest::consistentICType, including unc…
nkoukpaizan Aug 19, 2026
86c2c52
Add test for IDATest::consistentICType with initially consistent deri…
nkoukpaizan Aug 19, 2026
9682912
Change IDATest::consistentICType model to something that admits a ste…
nkoukpaizan Aug 19, 2026
d7c7a88
Apply pre-commit fixes
nkoukpaizan Aug 19, 2026
0c854bb
Increasing consistentICType tolerances.
nkoukpaizan Aug 19, 2026
4f3391f
Increasing consistentICType tolerances.
nkoukpaizan Aug 19, 2026
bedb2af
Update tolerance comment.
nkoukpaizan Aug 19, 2026
02c74dc
Apply pre-commit fixes
nkoukpaizan Aug 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
44 changes: 35 additions & 9 deletions tests/UnitTests/Solver/Dynamic/IdaTests.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,8 +384,8 @@ namespace GridKit
public:
ConsistentICTypeEvaluator() = default;

explicit ConsistentICTypeEvaluator(bool consistent_derivative)
: consistent_derivative_(consistent_derivative)
explicit ConsistentICTypeEvaluator(bool steady_state)
: steady_state_(steady_state)
{
}

Expand All @@ -403,7 +403,7 @@ namespace GridKit

y[0] = 0.0;
y[1] = 10.0;
yp[0] = consistent_derivative_ ? 1.0 : 0.0;
yp[0] = steady_state_ ? 0.0 : 2.0; // Purposefully inconsistent guess for non-steady-state case.
yp[1] = 0.0;
tag_ = {true, false};
abs_tol[0] = 0.0;
Expand All @@ -428,14 +428,14 @@ namespace GridKit
const auto* y = y_.getData();
const auto* yp = yp_.getData();

f[0] = yp[0] - 1.0;
f[0] = yp[0] + y[0] + y[1] - 1.0;
f[1] = y[1] - y[0];
f_.setDataUpdated();
return 0;
}

private:
bool consistent_derivative_{false};
bool steady_state_{false};
};
} // namespace Model

Expand Down Expand Up @@ -576,16 +576,42 @@ namespace GridKit
{
TestStatus success = true;

using RealT = typename ScalarTraits<ScalarT>::RealT;

// If the tolerances are too tight, a finite difference approximation to the Jacobian
// cannot be generated, and initialization will fail with bad initial guesses.
static constexpr auto tol = 100.0 * std::numeric_limits<RealT>::epsilon();

// IdaConsistentICType::YA_YDP with non-steady-state initial guess for the derivatives
{
Model::ConsistentICTypeEvaluator<ScalarT, IdxT> model;
Model::ConsistentICTypeEvaluator<ScalarT, IdxT> model(false);

Ida<ScalarT, IdxT> ida(&model);
ida.setConsistentICType(AnalysisManager::Sundials::IdaConsistentICType::YA_YDP);
ida.setTolerance(tol);
ida.configureSimulation();
ida.initializeSimulation(0.0);

success *= isEqual(model.yp().getData()[0], 1.0, tol);
success *= isEqual(model.yp().getData()[1], 0.0, tol);
success *= isEqual(model.y().getData()[0], 0.0, tol);
success *= isEqual(model.y().getData()[1], 0.0, tol);
}

// IdaConsistentICType::Y with steady-state initial guess for the derivatives
{
Model::ConsistentICTypeEvaluator<ScalarT, IdxT> model(true);

Ida<ScalarT, IdxT> ida(&model);
ida.setConsistentICType(AnalysisManager::Sundials::IdaConsistentICType::Y);
ida.setTolerance(tol);
ida.configureSimulation();
ida.initializeSimulation(0.0);

success *= (std::abs(model.yp().getData()[0] - 1.0) < 1.0e-10);
success *= (std::abs(model.y().getData()[1]) < 1.0e-10);
success *= isEqual(model.yp().getData()[0], 0.0, tol);
success *= isEqual(model.yp().getData()[1], 0.0, tol);
success *= isEqual(model.y().getData()[0], 0.5, tol);
success *= isEqual(model.y().getData()[1], 0.5, tol);
}

{
Expand All @@ -596,7 +622,7 @@ namespace GridKit
ida.configureSimulation();
ida.initializeSimulation(0.0);

success *= (std::abs(model.y().getData()[0]) < 1.0e-10);
success *= isEqual(model.y().getData()[0], 0.0);
}

return success.report(__func__);
Expand Down
Loading