Skip to content

Commit

Permalink
Allow to set CVODE parameters for ME FMUs (OpenModelica#1277)
Browse files Browse the repository at this point in the history
  • Loading branch information
@gabibbo97
gabibbo97 committed Dec 6, 2023
1 parent f7c50c9 commit c66d712
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 8 deletions.
28 changes: 28 additions & 0 deletions src/OMSimulatorLib/Flags.cpp
View file
Expand Up @@ -65,6 +65,10 @@ void oms::Flags::setDefaults()
{
addParametersToCSV = false;
algLoopSolver = oms_alg_solver_kinsol;
cvodeMaxErrTestFails = 100;
cvodeMaxNLSFails = 100;
cvodeMaxNLSIterations = 5;
cvodeMaxSteps = 1000;
defaultModeIsCS = false;
deleteTempFiles = true;
directionalDerivatives = true;
Expand Down Expand Up @@ -203,6 +207,30 @@ oms_status_enu_t oms::Flags::ClearAllOptions(const std::string& value)
return oms_status_ok;
}

oms_status_enu_t oms::Flags::CVODEMaxErrTestFails(const std::string& value)
{
GetInstance().cvodeMaxErrTestFails = atoi(value.c_str());
return oms_status_ok;
}

oms_status_enu_t oms::Flags::CVODEMaxNLSFailures(const std::string& value)
{
GetInstance().cvodeMaxNLSFails = atoi(value.c_str());
return oms_status_ok;
}

oms_status_enu_t oms::Flags::CVODEMaxNLSIterations(const std::string& value)
{
GetInstance().cvodeMaxNLSIterations = atoi(value.c_str());
return oms_status_ok;
}

oms_status_enu_t oms::Flags::CVODEMaxSteps(const std::string& value)
{
GetInstance().cvodeMaxSteps = atoi(value.c_str());
return oms_status_ok;
}

oms_status_enu_t oms::Flags::DeleteTempFiles(const std::string& value)
{
GetInstance().deleteTempFiles = (value == "true");
Expand Down
16 changes: 16 additions & 0 deletions src/OMSimulatorLib/Flags.h
View file
Expand Up @@ -56,6 +56,10 @@ namespace oms
static oms_status_enu_t SetCommandLineOption(const std::string& cmd);

static bool AddParametersToCSV() {return GetInstance().addParametersToCSV;}
static int CVODEMaxErrTestFails() {return GetInstance().cvodeMaxErrTestFails;}
static int CVODEMaxNLSFailures() {return GetInstance().cvodeMaxNLSFails;}
static int CVODEMaxNLSIterations() {return GetInstance().cvodeMaxNLSIterations;}
static int CVODEMaxSteps() {return GetInstance().cvodeMaxSteps;}
static bool DefaultModeIsCS() {return GetInstance().defaultModeIsCS;}
static bool DeleteTempFiles() {return GetInstance().deleteTempFiles;}
static bool DirectionalDerivatives() {return GetInstance().directionalDerivatives;}
Expand Down Expand Up @@ -89,6 +93,10 @@ namespace oms

private:
bool addParametersToCSV;
int cvodeMaxErrTestFails;
int cvodeMaxNLSFails;
int cvodeMaxNLSIterations;
int cvodeMaxSteps;
bool defaultModeIsCS;
bool deleteTempFiles;
bool directionalDerivatives;
Expand Down Expand Up @@ -148,6 +156,10 @@ namespace oms
{"--addParametersToCSV", "", "Export parameters to .csv file (true, [false])", re_default, Flags::AddParametersToCSV, false},
{"--algLoopSolver", "", "Specifies the alg. loop solver method (fixedpoint, [kinsol]) used for algebraic loops spanning over multiple components.", re_default, Flags::AlgLoopSolver, false},
{"--clearAllOptions", "", "Reset all flags to default values", re_void, Flags::ClearAllOptions, false},
{"--CVODEMaxErrTestFails", "", "Maximum number of error test failures for CVODE", re_number, Flags::CVODEMaxErrTestFails, false},
{"--CVODEMaxNLSFailures", "", "Maximum number of nonlinear convergence failures for CVODE", re_number, Flags::CVODEMaxNLSFailures, false},
{"--CVODEMaxNLSIterations", "", "Maximum number of nonlinear solver iterations for CVODE", re_number, Flags::CVODEMaxNLSIterations, false},
{"--CVODEMaxSteps", "", "Maximum number of steps for CVODE", re_number, Flags::CVODEMaxSteps, false},
{"--deleteTempFiles", "", "Deletes temp files as soon as they are no longer needed ([true], false)", re_bool, Flags::DeleteTempFiles, false},
{"--directionalDerivatives", "", "Specifies whether directional derivatives should be used to calculate the Jacobian for alg. loops or if a numerical approximation should be used instead ([true], false)", re_bool, Flags::DirectionalDerivatives, false},
{"--dumpAlgLoops", "", "Dump information for alg loops (true, [false])", re_bool, Flags::DumpAlgLoops, false},
Expand Down Expand Up @@ -186,6 +198,10 @@ namespace oms
static oms_status_enu_t AddParametersToCSV(const std::string& value);
static oms_status_enu_t AlgLoopSolver(const std::string& value);
static oms_status_enu_t ClearAllOptions(const std::string& value);
static oms_status_enu_t CVODEMaxErrTestFails(const std::string& value);
static oms_status_enu_t CVODEMaxNLSFailures(const std::string& value);
static oms_status_enu_t CVODEMaxNLSIterations(const std::string& value);
static oms_status_enu_t CVODEMaxSteps(const std::string& value);
static oms_status_enu_t DeleteTempFiles(const std::string& value);
static oms_status_enu_t DirectionalDerivatives(const std::string& value);
static oms_status_enu_t DumpAlgLoops(const std::string& value);
Expand Down
16 changes: 8 additions & 8 deletions src/OMSimulatorLib/SystemSC.cpp
View file
Expand Up @@ -348,21 +348,21 @@ oms_status_enu_t oms::SystemSC::initialize()
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetMaxStep() failed with flag = " + std::to_string(flag));

// further settings from cpp runtime
flag = CVodeSetInitStep(solverData.cvode.mem, initialStepSize); // INITIAL STEPSIZE
flag = CVodeSetInitStep(solverData.cvode.mem, initialStepSize); // INITIAL STEPSIZE
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetInitStep() failed with flag = " + std::to_string(flag));
flag = CVodeSetMaxOrd(solverData.cvode.mem, 5); // MAXIMUM ORDER
flag = CVodeSetMaxOrd(solverData.cvode.mem, 5); // MAXIMUM ORDER
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetMaxOrd() failed with flag = " + std::to_string(flag));
flag = CVodeSetMaxConvFails(solverData.cvode.mem, 100); // MAXIMUM NUMBER OF NONLINEAR CONVERGENCE FAILURES
flag = CVodeSetMaxConvFails(solverData.cvode.mem, Flags::CVODEMaxNLSFailures()); // MAXIMUM NUMBER OF NONLINEAR CONVERGENCE FAILURES
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetMaxConvFails() failed with flag = " + std::to_string(flag));
flag = CVodeSetStabLimDet(solverData.cvode.mem, true); // STABILITY DETECTION
flag = CVodeSetStabLimDet(solverData.cvode.mem, true); // STABILITY DETECTION
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetStabLimDet() failed with flag = " + std::to_string(flag));
flag = CVodeSetMinStep(solverData.cvode.mem, minimumStepSize); // MINIMUM STEPSIZE
flag = CVodeSetMinStep(solverData.cvode.mem, minimumStepSize); // MINIMUM STEPSIZE
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetMinStep() failed with flag = " + std::to_string(flag));
flag = CVodeSetMaxNonlinIters(solverData.cvode.mem, 5); // MAXIMUM NUMBER OF ITERATIONS
flag = CVodeSetMaxNonlinIters(solverData.cvode.mem, Flags::CVODEMaxNLSIterations()); // MAXIMUM NUMBER OF ITERATIONS
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetMaxNonlinIters() failed with flag = " + std::to_string(flag));
flag = CVodeSetMaxErrTestFails(solverData.cvode.mem, 100); // MAXIMUM NUMBER OF ERROR TEST FAILURES
flag = CVodeSetMaxErrTestFails(solverData.cvode.mem, Flags::CVODEMaxErrTestFails()); // MAXIMUM NUMBER OF ERROR TEST FAILURES
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetMaxErrTestFails() failed with flag = " + std::to_string(flag));
flag = CVodeSetMaxNumSteps(solverData.cvode.mem, 1000); // MAXIMUM NUMBER OF STEPS
flag = CVodeSetMaxNumSteps(solverData.cvode.mem, Flags::CVODEMaxSteps()); // MAXIMUM NUMBER OF STEPS
if (flag < 0) logError("SUNDIALS_ERROR: CVodeSetMaxNumSteps() failed with flag = " + std::to_string(flag));
}

Expand Down

0 comments on commit c66d712

Please sign in to comment.