loadcontrol.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021-2025 The Ikarus Developers ikarus@ibb.uni-stuttgart.de
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
 
#include <memory>
 
#include <dune/common/hybridutilities.hh>
 
#include <ikarus/controlroutines/controlinfos.hh>
#include <ikarus/controlroutines/controlroutinebase.hh>
#include <ikarus/controlroutines/controlroutinefactory.hh>
#include <ikarus/utils/broadcaster/broadcaster.hh>
 
namespace Ikarus {
 
template <typename NLS>
class LoadControl;
 
struct LoadControlConfig
{
  int loadSteps{};
  double tbegin{};
  double tEnd{};
};
 
template <typename NLS>
auto createControlRoutine(const LoadControlConfig& config, NLS&& nonlinearSolver) {
  return LoadControl(std::forward<NLS>(nonlinearSolver), config.loadSteps, std::array{config.tbegin, config.tEnd});
}
 
template <typename NLS>
class LoadControl : public ControlRoutineBase<typename NLS::DifferentiableFunction>
{
public:
  constexpr std::string name() const { return "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_} {
    if (loadSteps_ <= 0)
      DUNE_THROW(Dune::InvalidStateException, "Number of load steps should be greater than zero.");
  }
 
  ControlInformation run(typename NLS::Domain& x);
 
  void predictor(typename NLS::Domain& x) const;
 
  /* \brief returns the nonlinear solver */
  NLS& nonLinearSolver() { return *nonLinearSolver_; }
 
private:
  std::shared_ptr<NLS> nonLinearSolver_;
  int loadSteps_;
  double parameterBegin_;
  double parameterEnd_;
  double stepSize_;
 
  void updateAndNotifyControlInfo(ControlInformation& info, const NonLinearSolverInformation& solverInfo,
                                  const typename LoadControl::State& state) {
    info.solverInfos.push_back(solverInfo);
    info.totalIterations += solverInfo.iterations;
    this->notify(ControlMessages::SOLUTION_CHANGED, state);
    this->notify(ControlMessages::STEP_ENDED, state);
  }
};
 
} // namespace Ikarus
 
#include <ikarus/controlroutines/loadcontrol.inl>