tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(engine_multiscale): improved error message when Eigen failes to converge to a solution for QSE solver

Browse Source
This commit is contained in:
Emily Boudreaux
2025-10-12 07:52:30 -04:00
parent 2f1077c02d
commit bc666ff783
1 changed files with 29 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/lib/engine/views/engine_multiscale.cpp
View File

@@ -151,6 +151,21 @@ namespace {
return reactantSample != productSample; return reactantSample != productSample;
} }
const std::unordered_map<Eigen::LevenbergMarquardtSpace::Status, std::string> lm_status_map = {
{Eigen::LevenbergMarquardtSpace::Status::NotStarted, "NotStarted"},
{Eigen::LevenbergMarquardtSpace::Status::Running, "Running"},
{Eigen::LevenbergMarquardtSpace::Status::ImproperInputParameters, "ImproperInputParameters"},
{Eigen::LevenbergMarquardtSpace::Status::RelativeReductionTooSmall, "RelativeReductionTooSmall"},
{Eigen::LevenbergMarquardtSpace::Status::RelativeErrorTooSmall, "RelativeErrorTooSmall"},
{Eigen::LevenbergMarquardtSpace::Status::RelativeErrorAndReductionTooSmall, "RelativeErrorAndReductionTooSmall"},
{Eigen::LevenbergMarquardtSpace::Status::CosinusTooSmall, "CosinusTooSmall"},
{Eigen::LevenbergMarquardtSpace::Status::TooManyFunctionEvaluation, "TooManyFunctionEvaluation"},
{Eigen::LevenbergMarquardtSpace::Status::FtolTooSmall, "FtolTooSmall"},
{Eigen::LevenbergMarquardtSpace::Status::XtolTooSmall, "XtolTooSmall"},
{Eigen::LevenbergMarquardtSpace::Status::GtolTooSmall, "GtolTooSmall"},
{Eigen::LevenbergMarquardtSpace::Status::UserAsked, "UserAsked"}
};
} }
namespace gridfire { namespace gridfire {
@@ -1119,11 +1134,22 @@ namespace gridfire {
if (status <= 0 || status >= 4) { if (status <= 0 || status >= 4) {
std::stringstream msg; std::stringstream msg;
//TODO: Add a better error message here and quill logging msg << "While working on QSE group with algebraic species: ";
msg << "QSE solver failed with status: " << status; int count = 0;
for (const auto& species: algebraic_species) {
msg << species;
if (count < algebraic_species.size() - 1) {
msg << ", ";
}
count++;
}
msg << " the QSE solver failed to converge with status: " << lm_status_map.at(status);
msg << ". This likely indicates that the QSE groups were not properly partitioned";
msg << " (for example if the algebraic set here contains species which should be dynamic like He-4 or H-1).";
LOG_ERROR(m_logger, "{}", msg.str());
throw std::runtime_error(msg.str()); throw std::runtime_error(msg.str());
} }
LOG_TRACE_L1(m_logger, "Minimization succeeded!"); LOG_TRACE_L1(m_logger, "QSE Group minimization succeeded with status: {}", lm_status_map.at(status));
Eigen::VectorXd Y_final_qse = Y_scale.array() * v_initial.array().sinh(); // Convert back to physical abundances using asinh scaling Eigen::VectorXd Y_final_qse = Y_scale.array() * v_initial.array().sinh(); // Convert back to physical abundances using asinh scaling
i = 0; i = 0;
for (const auto& species: algebraic_species) { for (const auto& species: algebraic_species) {