[MaL] renamed and moved FunctionHandles

MathLib/ODE/CVodeSolver.cpp

@@ -90,7 +90,7 @@ public:
 	~CVodeSolverImpl();
 
 private:
-	void setFunction(std::unique_ptr<FunctionHandles>&& f);
+	void setFunction(std::unique_ptr<detail::FunctionHandles>&& f);
 
 	void preSolve();
 	void solve(const double t_end);
@@ -113,7 +113,7 @@ private:
 	unsigned _num_equations;
 	void* _cvode_mem;
 
-	std::unique_ptr<FunctionHandles> _f;
+	std::unique_ptr<detail::FunctionHandles> _f;
 
 	int _linear_multistep_method = CV_ADAMS;
 	int _nonlinear_solver_iteration = CV_FUNCTIONAL;
@@ -178,8 +178,9 @@ CVodeSolverImpl::CVodeSolverImpl(const BaseLib::ConfigTree& config,
 	auto f_wrapped = [](const realtype t, const N_Vector y, N_Vector ydot,
 	                    void* function_handles) -> int
 	{
-		bool successful = static_cast<FunctionHandles*>(function_handles)
-		                      ->call(t, NV_DATA_S(y), NV_DATA_S(ydot));
+		bool successful =
+		    static_cast<detail::FunctionHandles*>(function_handles)
+		        ->call(t, NV_DATA_S(y), NV_DATA_S(ydot));
 		return successful ? 0 : 1;
 	};
 
@@ -206,7 +207,7 @@ void CVodeSolverImpl::setTolerance(const double abstol, const double reltol)
 	_reltol = reltol;
 }
 
-void CVodeSolverImpl::setFunction(std::unique_ptr<FunctionHandles>&& f)
+void CVodeSolverImpl::setFunction(std::unique_ptr<detail::FunctionHandles>&& f)
 {
 	_f = std::move(f);
 	assert(_num_equations == _f->getNumEquations());
@@ -251,7 +252,7 @@ void CVodeSolverImpl::preSolve()
 			// Caution: by calling the DENSE_COL() macro we assume that matrices
 			//          are stored contiguously in memory!
 			bool successful =
-			    static_cast<FunctionHandles*>(function_handles)
+			    static_cast<detail::FunctionHandles*>(function_handles)
 			        ->callJacobian(t, NV_DATA_S(y), NV_DATA_S(ydot),
 			                       DENSE_COL(jac, 0));
 			return successful ? 0 : 1;
@@ -309,7 +310,7 @@ void CVodeSolver::setTolerance(const double abstol, const double reltol)
 	_impl->setTolerance(abstol, reltol);
 }
 
-void CVodeSolver::setFunction(std::unique_ptr<FunctionHandles>&& f)
+void CVodeSolver::setFunction(std::unique_ptr<detail::FunctionHandles>&& f)
 {
 	_impl->setFunction(std::move(f));
 }

MathLib/ODE/CVodeSolver.h

@@ -13,6 +13,7 @@
 #include "BaseLib/ConfigTree.h"
 
 #include "OdeSolverTypes.h"
+#include "FunctionHandles.h"
 
 namespace MathLib
 {
@@ -33,7 +34,7 @@ protected:
 	void setTolerance(double const* const abstol, const double reltol);
 	void setTolerance(const double abstol, const double reltol);
 
-	void setFunction(std::unique_ptr<FunctionHandles>&& f);
+	void setFunction(std::unique_ptr<detail::FunctionHandles>&& f);
 
 	void setIC(const double t0, double const* const y0);
 

MathLib/ODE/ConcreteOdeSolver.h

@@ -15,7 +15,7 @@
 #include "BaseLib/ConfigTree.h"
 
 #include "OdeSolver.h"
-#include "Handles.h"
+#include "FunctionHandles.h"
 
 #ifdef CVODE_FOUND
 #include "CVodeSolver.h"
@@ -53,9 +53,8 @@ public:
 	void setFunction(Function f, JacobianFunction df) override
 	{
 		Implementation::setFunction(
-		    std::unique_ptr<  // TODO unique_ptr not needed
-		        detail::Handles<NumEquations>>{
-		        new detail::Handles<NumEquations>{f, df}});
+		    std::unique_ptr<detail::FunctionHandlesImpl<NumEquations>>{
+		        new detail::FunctionHandlesImpl<NumEquations>{f, df}});
 	}
 
 	void setTolerance(const std::array<double, NumEquations>& abstol,

MathLib/ODE/Handles.h → MathLib/ODE/FunctionHandles.h

@@ -16,14 +16,31 @@ namespace MathLib
 {
 namespace detail
 {
+class FunctionHandles
+{
+public:
+	virtual bool call(const double t, double const* const y,
+	                  double* const ydot) = 0;
+	virtual bool callJacobian(const double t,
+	                          double const* const y,
+	                          double* const ydot,
+	                          double* const jac) = 0;
+
+	virtual bool hasJacobian() const = 0;
+
+	virtual unsigned getNumEquations() const = 0;
+
+	virtual ~FunctionHandles() = default;
+};
+
 /// Function handles for N equations.
 template <unsigned N>
-struct Handles : public MathLib::FunctionHandles
+struct FunctionHandlesImpl : FunctionHandles
 {
 	using Function = MathLib::Function<N>;
 	using JacobianFunction = MathLib::JacobianFunction<N>;
 
-	Handles(Function& f, JacobianFunction& df) : f(f), df(df) {}
+	FunctionHandlesImpl(Function& f, JacobianFunction& df) : f(f), df(df) {}
 	bool call(const double t, const double* const y,
 	          double* const ydot) override
 	{

MathLib/ODE/OdeSolverTypes.h

@@ -38,23 +38,6 @@ using JacobianFunction = std::function<bool(const double t,
                                             MappedConstVector<N> ydot,
                                             MappedMatrix<N, N> jac)>;
 
-// This is an internal detail
-class FunctionHandles
-{
-public:
-	virtual bool call(const double t, double const* const y,
-	                  double* const ydot) = 0;
-	virtual bool callJacobian(const double t,
-	                          double const* const y,
-	                          double* const ydot,
-	                          double* const jac) = 0;
-
-	virtual bool hasJacobian() const = 0;
-
-	virtual unsigned getNumEquations() const = 0;
-
-	virtual ~FunctionHandles() = default;
-};
-}
+}  // namespace MathLib
 
 #endif  // MATHLIB_ODE_ODESOLVERTYPES_H