loadcontrol.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021-2024 The Ikarus Developers mueller@ibb.uni-stuttgart.de
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
 
#include <memory>
 
#include <ikarus/controlroutines/controlinfos.hh>
#include <ikarus/utils/observer/observer.hh>
#include <ikarus/utils/observer/observermessages.hh>
 
namespace Ikarus {
 
template <typename NLS>
class LoadControl : public IObservable<ControlMessages>
{
public:
  constexpr auto name() const { return std::string("Load Control Method"); }
 
  LoadControl(const std::shared_ptr<NLS>& nonLinearSolver, int loadSteps, const std::array<double, 2>& tbeginEnd)
      : nonLinearSolver_{nonLinearSolver},
        loadSteps_{loadSteps},
        parameterBegin_{tbeginEnd[0]},
        parameterEnd_{tbeginEnd[1]},
        stepSize_{(parameterEnd_ - parameterBegin_) / loadSteps_} {
    static_assert(
        requires {
          nonLinearSolver_->nonLinearOperator().lastParameter() = 0.0;
          nonLinearSolver_->nonLinearOperator().lastParameter() += 0.0;
        }, "The last parameter (load factor) must be assignable and incrementable with a double!");
  }
 
  ControlInformation run();
 
  /* \brief returns the nonlinear solver */
  NLS& nonlinearSolver() { return *nonLinearSolver_; }
 
private:
  std::shared_ptr<NLS> nonLinearSolver_;
  int loadSteps_;
  double parameterBegin_;
  double parameterEnd_;
  double stepSize_;
};
 
} // namespace Ikarus
 
#include <ikarus/controlroutines/loadcontrol.inl>