Skip to content

align sundials interfaces to the style guide #175

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
phlptp merged 5 commits into from
May 28, 2026
Merged

align sundials interfaces to the style guide #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
79fd321
align sundials interfaces to the style guide
phlptp May 28, 2026
a1713ba
clang-tidy fixes
phlptp May 28, 2026
6ce334c
more clang-tidy fixes
phlptp May 28, 2026
6f63434
more renaming
phlptp May 28, 2026
2354208
clang-tidy fixes
phlptp May 28, 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
2 changes: 1 addition & 1 deletion src/extraModels/txLifeSpan.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ void txLifeSpan::updateA(coreTime time)
prevTime = time;
}

void txLifeSpan::timestep(coreTime time, const IOdata& /*inputs*/, const solverMode& /*sMode*/)
void txLifeSpan::timestep(coreTime time, const IOdata& /*inputs*/, const SolverMode& /*sMode*/)
{
updateA(time);
}
Expand Down
2 changes: 1 addition & 1 deletion src/extraModels/txLifeSpan.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class txLifeSpan: public sensor {
const IOdata& desiredOutput,
IOdata& fieldSet) override;

virtual void timestep(coreTime time, const IOdata& inputs, const solverMode& sMode) override;
virtual void timestep(coreTime time, const IOdata& inputs, const SolverMode& sMode) override;
virtual void updateA(coreTime time) override;

void actionTaken(index_t actionNumber,
Expand Down
2 changes: 1 addition & 1 deletion src/extraModels/txThermalModel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ void txThermalModel::updateA(coreTime time)
prevTime = time;
}

void txThermalModel::timestep(coreTime time, const IOdata& /*inputs*/, const solverMode& /*sMode*/)
void txThermalModel::timestep(coreTime time, const IOdata& /*inputs*/, const SolverMode& /*sMode*/)
{
updateA(time);
}
Expand Down
2 changes: 1 addition & 1 deletion src/extraModels/txThermalModel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class txThermalModel: public sensor {
const IOdata& desiredOutput,
IOdata& fieldSet) override;

virtual void timestep(coreTime time, const IOdata& inputs, const solverMode& sMode) override;
virtual void timestep(coreTime time, const IOdata& inputs, const SolverMode& sMode) override;
virtual void updateA(coreTime time) override;
};

Expand Down
4 changes: 2 additions & 2 deletions src/extraSolvers/braid/braidInterface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ class braidSolver: public SolverInterface {
explicit braidSolver(const std::string& objName = "braid");
/** alternate constructor to feed to solverInterface
@param[in] gds the GridDynSimulation to link to
@param[in] sMode the solverMode to solve with
@param[in] sMode the SolverMode to solve with
*/
braidSolver(GridDynSimulation* gds, const solverMode& sMode);
braidSolver(GridDynSimulation* gds, const SolverMode& sMode);

Equation* equation = nullptr;

Expand Down
12 changes: 6 additions & 6 deletions src/extraSolvers/braid/braidSolver.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ braidSolver::braidSolver(const std::string& objName): SolverInterface(objName)
mode.dynamic = true;
mode.differential = true;
mode.algebraic = true;
flags[block_mode_only] = true;
flags[BLOCK_MODE_ONLY] = true;
}
braidSolver::braidSolver(GridDynSimulation* gds, const solverMode& sMode):
braidSolver::braidSolver(GridDynSimulation* gds, const SolverMode& sMode):
SolverInterface(gds, sMode)
{
}
Expand Down Expand Up @@ -186,19 +186,19 @@ void braidSolver::allocate(count_t stateCount, count_t numRoots)
deriv.resize(stateCount);
state2.resize(stateCount);
svsize = stateCount;
flags.reset(initialized_flag);
flags.set(allocated_flag);
flags.reset(INITIALIZED_FLAG);
flags.set(ALLOCATED_FLAG);
}
rootCount = numRoots;
rootsfound.resize(numRoots);
}

void braidSolver::initialize(coreTime t0)
{
if (!flags[allocated_flag]) {
if (!flags[ALLOCATED_FLAG]) {
throw(InvalidSolverOperation(-2));
}
flags.set(initialized_flag);
flags.set(INITIALIZED_FLAG);
solverCallCount = 0;
solveTime = t0;

Expand Down
2 changes: 1 addition & 1 deletion src/extraSolvers/paradae/equations/EqGridDyn.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ EquationGridDyn::EquationGridDyn(Real t0_,
int N_unistep_,
GridDynSimulation* gds_,
const Vector& y0_,
solverMode* mode_,
SolverMode* mode_,
vector<double>& discontinuities,
vector<int>& rootsfound)
{
Expand Down
6 changes: 3 additions & 3 deletions src/extraSolvers/paradae/equations/EqGridDyn.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#include <vector>
namespace griddyn {
class GridDynSimulation;
class solverMode;
class SolverMode;
} // namespace griddyn

using namespace std;
Expand All @@ -29,11 +29,11 @@ class EquationGridDyn: public Equation_DAE_full {
int N_unistep_,
griddyn::GridDynSimulation* gds_,
const Vector& y0_,
griddyn::solverMode* mode_,
griddyn::SolverMode* mode_,
vector<double>& discontinuities,
vector<int>& rootsfound);
static EquationGridDyn Default(const MapParam& param);
griddyn::solverMode* mode; //!< to the solverMode
griddyn::SolverMode* mode; //!< to the SolverMode

// Redefinition of inherited virtual methods
virtual void function(const Real t,
Expand Down
8 changes: 4 additions & 4 deletions src/fileInput/readSolverElement.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace {
} // namespace

void loadSolverElement(std::shared_ptr<ReaderElement>& element,
ReaderInfo& ReaderInformation,
ReaderInfo& readerInformation,
GridDynSimulation* parentObject)
{
std::shared_ptr<SolverInterface> solverDefinition;
Expand Down Expand Up @@ -53,7 +53,7 @@ void loadSolverElement(std::shared_ptr<ReaderElement>& element,
if (!solverIdentifier.empty()) {
if (solverDefinition) {
if (solverDefinition->getSolverMode().offsetIndex >
1) // don't allow overriding the names on solvermode index 0 and 1
1) // don't allow overriding the names on SolverMode index 0 and 1
{
solverDefinition->setName(solverIdentifier);
}
Expand Down Expand Up @@ -90,8 +90,8 @@ void loadSolverElement(std::shared_ptr<ReaderElement>& element,
}

setAttributes(
solverDefinition.get(), element, "solver", ReaderInformation, solverIgnoreFields());
setParams(solverDefinition.get(), element, "solver", ReaderInformation, solverIgnoreFields());
solverDefinition.get(), element, "solver", readerInformation, solverIgnoreFields());
setParams(solverDefinition.get(), element, "solver", readerInformation, solverIgnoreFields());
// add the solver
parentObject->add(solverDefinition);
}
Expand Down
2 changes: 1 addition & 1 deletion src/fmi/fmi_models/fmiCoSimLoad.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ void FmiCoSimLoad::dynObjectInitializeB(const IOdata& inputs,
void FmiCoSimLoad::setState(coreTime time,
const double state[],
const double dstateDt[],
const solverMode& sMode)
const SolverMode& sMode)
{
fmisub->setState(time, state, dstateDt, sMode);
auto out = fmisub->getOutputs(noInputs, emptyStateData, cLocalSolverMode);
Expand Down
2 changes: 1 addition & 1 deletion src/fmi/fmi_models/fmiCoSimLoad.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class FmiCoSimLoad: public FmiCoSimWrapper<GridLoad> {
virtual void setState(coreTime time,
const double state[],
const double dstateDt[],
const solverMode& sMode) override;
const SolverMode& sMode) override;
};

} // namespace griddyn::fmi
2 changes: 1 addition & 1 deletion src/fmi/fmi_models/fmiCoSimLoad3phase.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ void FmiCoSimLoad3phase::set(std::string_view param, double val, units::unit uni
void FmiCoSimLoad3phase::setState(coreTime time,
const double state[],
const double dstateDt[],
const solverMode& sMode)
const SolverMode& sMode)
{
fmisub->setState(time, state, dstateDt, sMode);
auto out = fmisub->getOutputs(noInputs, emptyStateData, cLocalSolverMode);
Expand Down
2 changes: 1 addition & 1 deletion src/fmi/fmi_models/fmiCoSimLoad3phase.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class FmiCoSimLoad3phase: public FmiCoSimWrapper<loads::ThreePhaseLoad> {
virtual void setState(coreTime time,
const double state[],
const double dstateDt[],
const solverMode& sMode) override;
const SolverMode& sMode) override;

virtual const std::vector<stringVec>& getFmiInputNames() const override;

Expand Down
12 changes: 6 additions & 6 deletions src/fmi/fmi_models/fmiCoSimSubModel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ double FmiCoSimSubModel::getPartial(int depIndex, int refIndex, RefMode /*mode*/

void FmiCoSimSubModel::timestep(coreTime /*time*/,
const IOdata& /*inputs*/,
const solverMode& /*sMode*/)
const SolverMode& /*sMode*/)
{
assert(unimplemented);
/*
Expand Down Expand Up @@ -472,7 +472,7 @@ void FmiCoSimSubModel::ioPartialDerivatives(const IOdata& /*inputs*/,
const stateData& /*sD*/,
matrixData<double>& /* md*/,
const IOlocs& /*inputLocs*/,
const solverMode& /*sMode*/)
const SolverMode& /*sMode*/)
{
assert(unimplemented);
/*
Expand Down Expand Up @@ -515,7 +515,7 @@ for (kk = 0; kk < m_outputSize; ++kk)

IOdata FmiCoSimSubModel::getOutputs(const IOdata& /*inputs*/,
const stateData& sD,
const solverMode& sMode) const
const SolverMode& sMode) const
{
IOdata out(m_outputSize, 0);
if (cs->getCurrentMode() >= FmuMode::INITIALIZATION_MODE) {
Expand Down Expand Up @@ -544,15 +544,15 @@ IOdata FmiCoSimSubModel::getOutputs(const IOdata& /*inputs*/,

double FmiCoSimSubModel::getDoutdt(const IOdata& /*inputs*/,
const stateData& /*sD*/,
const solverMode& /*sMode*/,
const SolverMode& /*sMode*/,
index_t /*outputNum*/) const
{
return 0;
}

double FmiCoSimSubModel::getOutput(const IOdata& /*inputs*/,
const stateData& sD,
const solverMode& sMode,
const SolverMode& sMode,
index_t outputNum) const
{
double out = kNullVal;
Expand Down Expand Up @@ -585,7 +585,7 @@ double FmiCoSimSubModel::getOutput(index_t outputNum) const

void FmiCoSimSubModel::updateLocalCache([[maybe_unused]] const IOdata& inputs,
[[maybe_unused]] const stateData& sD,
[[maybe_unused]] const solverMode& sMode)
[[maybe_unused]] const SolverMode& sMode)
{
static_cast<void>(inputs);
static_cast<void>(sD);
Expand Down
12 changes: 6 additions & 6 deletions src/fmi/fmi_models/fmiCoSimSubModel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,30 +57,30 @@ class FmiCoSimSubModel: public GridSubModel {
virtual double get(std::string_view param,
units::unit unitType = units::defunit) const override;

virtual void timestep(coreTime time, const IOdata& inputs, const solverMode& sMode) override;
virtual void timestep(coreTime time, const IOdata& inputs, const SolverMode& sMode) override;
virtual void ioPartialDerivatives(const IOdata& inputs,
const stateData& sD,
matrixData<double>& md,
const IOlocs& inputLocs,
const solverMode& sMode) override;
const SolverMode& sMode) override;

IOdata getOutputs(const IOdata& inputs,
const stateData& sD,
const solverMode& sMode) const override;
const SolverMode& sMode) const override;
virtual double getDoutdt(const IOdata& inputs,
const stateData& sD,
const solverMode& sMode,
const SolverMode& sMode,
index_t outputNum = 0) const override;
virtual double getOutput(const IOdata& inputs,
const stateData& sD,
const solverMode& sMode,
const SolverMode& sMode,
index_t outputNum = 0) const override;

virtual double getOutput(index_t outputNum = 0) const override;

virtual void updateLocalCache([[maybe_unused]] const IOdata& inputs,
[[maybe_unused]] const stateData& sD,
[[maybe_unused]] const solverMode& sMode) override;
[[maybe_unused]] const SolverMode& sMode) override;
bool isLoaded() const;

protected:
Expand Down
20 changes: 10 additions & 10 deletions src/fmi/fmi_models/fmiCoSimWrapper.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,23 +41,23 @@ class FmiCoSimWrapper: public FmiWrapper<FmiCoSimSubModel, BaseObj> {
void residual(const IOdata& inputs,
const stateData& sD,
double resid[],
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->residual(inputs, sD, resid, sMode);
}

void derivative(const IOdata& inputs,
const stateData& sD,
double deriv[],
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->derivative(inputs, sD, deriv, sMode);
}

void outputPartialDerivatives(const IOdata& inputs,
const stateData& sD,
matrixData<double>& md,
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->outputPartialDerivatives(inputs,
sD,
Expand All @@ -68,7 +68,7 @@ class FmiCoSimWrapper: public FmiWrapper<FmiCoSimSubModel, BaseObj> {
const stateData& sD,
matrixData<double>& md,
const IOlocs& inputLocs,
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->ioPartialDerivatives(
inputs, sD, md, inputLocs, sMode);
Expand All @@ -77,7 +77,7 @@ class FmiCoSimWrapper: public FmiWrapper<FmiCoSimSubModel, BaseObj> {
const stateData& sD,
matrixData<double>& md,
const IOlocs& inputLocs,
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->jacobianElements(
inputs, sD, md, inputLocs, sMode);
Expand All @@ -86,32 +86,32 @@ class FmiCoSimWrapper: public FmiWrapper<FmiCoSimSubModel, BaseObj> {
void rootTest(const IOdata& inputs,
const stateData& sD,
double roots[],
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->rootTest(inputs, sD, roots, sMode);
}
void rootTrigger(coreTime time,
const IOdata& inputs,
const std::vector<int>& rootMask,
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->rootTrigger(time, inputs, rootMask, sMode);
}

void setState(coreTime time,
const double state[],
const double dstateDt[],
const solverMode& sMode) override
const SolverMode& sMode) override
{
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->setState(time, state, dstateDt, sMode);
}

index_t findIndex(std::string_view field, const solverMode& sMode) const override
index_t findIndex(std::string_view field, const SolverMode& sMode) const override
{
return FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->findIndex(field, sMode);
}

void timestep(coreTime time, const IOdata& inputs, const solverMode& sMode) override
void timestep(coreTime time, const IOdata& inputs, const SolverMode& sMode) override
{
BaseObj::prevTime = time;
FmiWrapper<FmiCoSimSubModel, BaseObj>::fmisub->timestep(time, inputs, sMode);
Expand Down
4 changes: 2 additions & 2 deletions src/fmi/fmi_models/fmiMELoad.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ CoreObject* FmiMELoad::clone(CoreObject* obj) const

void FmiMELoad::updateLocalCache(const IOdata& inputs,
const stateData& stateDataRef,
const solverMode& sMode)
const SolverMode& sMode)
{
auto inputVector = inputs;
const auto voltageComplex = std::polar(inputs[voltageInLocation], inputs[angleInLocation]);
Expand Down Expand Up @@ -67,7 +67,7 @@ void FmiMELoad::set(std::string_view param, double val, units::unit unitType)
void FmiMELoad::setState(coreTime time,
const double state[],
const double dstateDt[],
const solverMode& sMode)
const SolverMode& sMode)
{
FmiMEWrapper<GridLoad>::setState(time, state, dstateDt, sMode);
auto out = fmisub->getOutputs(noInputs, emptyStateData, cLocalSolverMode);
Expand Down
4 changes: 2 additions & 2 deletions src/fmi/fmi_models/fmiMELoad.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ class FmiMELoad: public FmiMEWrapper<GridLoad> {

virtual void updateLocalCache(const IOdata& inputs,
const stateData& stateDataRef,
const solverMode& sMode) override;
const SolverMode& sMode) override;
virtual void setState(coreTime time,
const double state[],
const double dstateDt[],
const solverMode& sMode) override;
const SolverMode& sMode) override;

protected:
IOdata translateOutput(const IOdata& fmiOutput, const IOdata& busV);
Expand Down
Loading