Skip to content

Commit 9c73129

Browse files
committed
add documentation for unused force_step_size in euler integrator
1 parent 782d81c commit 9c73129

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

cpp/memilio/math/euler.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
#include "memilio/config.h"
2424
#include "memilio/math/integrator.h"
25+
#include "memilio/utils/compiler_diagnostics.h"
2526

2627
namespace mio
2728
{
@@ -41,10 +42,12 @@ class EulerIntegratorCore : public IntegratorCore<FP>
4142
* @param[in,out] t current time step h=dt
4243
* @param[in,out] dt current time step h=dt
4344
* @param[out] ytp1 approximated value y(t+1)
45+
* @param[in] force_step_size This argument is unused, as the step width is always fixed.
4446
*/
4547
bool step(const DerivFunction<FP>& f, Eigen::Ref<const Vector<FP>> yt, FP& t, FP& dt, Eigen::Ref<Vector<FP>> ytp1,
46-
const bool = false) const override
48+
const bool force_step_size = false) const override
4749
{
50+
mio::unused(force_step_size);
4851
// we are misusing the next step y as temporary space to store the derivative
4952
f(yt, t, ytp1);
5053
ytp1 = yt + dt * ytp1;

0 commit comments

Comments
 (0)