Skip to content
Snippets Groups Projects
Commit 8cf0f3a0 authored by Christoph Lehmann's avatar Christoph Lehmann Committed by Dmitri Naumov
Browse files

[MaL] changed spelling ode -> ODE

parent 75ae4de0
No related branches found
No related tags found
No related merge requests found
......@@ -61,11 +61,11 @@ namespace MathLib
/**
* This class provides concrete access to Sundials' CVode solver.
*
* OdeSolver (implicitly bounds checked, agnostic to concrete ODE solver)
* ODESolver (implicitly bounds checked, agnostic to concrete ODE solver)
* |
* | Dynamic polymorphism
* v
* ConcreteOdeSolver (implicitly bounds checked, interfaces with a specific
* ConcreteODESolver (implicitly bounds checked, interfaces with a specific
* library)
* |
* | Forward calls, disable bounds checking, no need for templates anymore
......
......@@ -12,7 +12,7 @@
#include "BaseLib/ConfigTree.h"
#include "OdeSolverTypes.h"
#include "ODESolverTypes.h"
#include "FunctionHandles.h"
namespace MathLib
......
......@@ -14,7 +14,7 @@
#include "BaseLib/ConfigTree.h"
#include "OdeSolver.h"
#include "ODESolver.h"
#include "FunctionHandles.h"
#ifdef CVODE_FOUND
......@@ -24,17 +24,17 @@
namespace MathLib
{
template <unsigned NumEquations>
std::unique_ptr<OdeSolver<NumEquations>> createOdeSolver(
std::unique_ptr<ODESolver<NumEquations>> createODESolver(
BaseLib::ConfigTree const& config);
/**
* ODE solver with a bounds-safe interface.
*
* This class makes contact between the abstract \c OdeSolver interface and a
* This class makes contact between the abstract \c ODESolver interface and a
* certain solver \c Implementation.
*
* The interface of this class inherits the array bounds checking from \c
* OdeSolver.
* ODESolver.
* Its methods forward calls to the \c Implementation erasing array bounds info
* by
* passing \c std::array as raw pointer.
......@@ -42,11 +42,11 @@ std::unique_ptr<OdeSolver<NumEquations>> createOdeSolver(
* This way the \c Implementation does not need to be templated.
*/
template <typename Implementation, unsigned NumEquations>
class ConcreteOdeSolver final : public OdeSolver<NumEquations>,
class ConcreteODESolver final : public ODESolver<NumEquations>,
private Implementation
{
public:
using Interface = OdeSolver<NumEquations>;
using Interface = ODESolver<NumEquations>;
using Function = typename Interface::Function;
using JacobianFunction = typename Interface::JacobianFunction;
......@@ -101,22 +101,22 @@ public:
private:
/// instances of this class shall only be constructed by
/// the friend function listed below
ConcreteOdeSolver(BaseLib::ConfigTree const& config)
ConcreteODESolver(BaseLib::ConfigTree const& config)
: Implementation{config, NumEquations}
{
}
friend std::unique_ptr<OdeSolver<NumEquations>>
createOdeSolver<NumEquations>(BaseLib::ConfigTree const& config);
friend std::unique_ptr<ODESolver<NumEquations>>
createODESolver<NumEquations>(BaseLib::ConfigTree const& config);
};
template <unsigned NumEquations>
std::unique_ptr<OdeSolver<NumEquations>> createOdeSolver(
std::unique_ptr<ODESolver<NumEquations>> createODESolver(
BaseLib::ConfigTree const& config)
{
#ifdef CVODE_FOUND
return std::unique_ptr<OdeSolver<NumEquations>>(
new ConcreteOdeSolver<CVodeSolver, NumEquations>(config));
return std::unique_ptr<ODESolver<NumEquations>>(
new ConcreteODESolver<CVodeSolver, NumEquations>(config));
#else
return nullptr;
#endif // CVODE_FOUND
......
......@@ -10,7 +10,7 @@
#ifndef MATHLIB_ODE_HANDLES_H
#define MATHLIB_ODE_HANDLES_H
#include "OdeSolverTypes.h"
#include "ODESolverTypes.h"
namespace MathLib
{
......
......@@ -12,7 +12,7 @@
#include <array>
#include "OdeSolverTypes.h"
#include "ODESolverTypes.h"
namespace MathLib
{
......@@ -24,7 +24,7 @@ namespace MathLib
* ODE solver libraries. However, it is agnostic to the specific solver used.
*/
template <unsigned NumEquations>
class OdeSolver
class ODESolver
{
public:
using Function = MathLib::Function<NumEquations>;
......@@ -51,7 +51,7 @@ public:
virtual Eigen::Matrix<double, NumEquations, 1, Eigen::ColMajor> getYDot(
const double t, const MappedConstVector<NumEquations>& y) const = 0;
virtual ~OdeSolver() = default;
virtual ~ODESolver() = default;
};
} // namespace MathLib
......
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment