pathfollowing.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/adaptivestepsizing.hh>
#include <ikarus/controlroutines/controlinfos.hh>
#include <ikarus/controlroutines/pathfollowingfunctions.hh>
#include <ikarus/solver/nonlinearsolver/newtonraphsonwithscalarsubsidiaryfunction.hh>
#include <ikarus/utils/observer/observer.hh>
#include <ikarus/utils/observer/observermessages.hh>
 
namespace Ikarus {
 
  namespace Impl {
 
    template <typename NonLinearSolver, typename PathFollowingType = ArcLength, typename AdaptiveStepSizing>
    consteval bool checkPathFollowingTemplates() {
      return ((Concepts::PathFollowingStrategy<
                  PathFollowingType, typename NonLinearSolver::NonLinearOperator,
                  SubsidiaryArgs>)and(Concepts::
                                          AdaptiveStepSizingStrategy<
                                              AdaptiveStepSizing, NonLinearSolverInformation, SubsidiaryArgs,
                                              std::remove_cvref_t<typename NonLinearSolver::NonLinearOperator>>)
              and (Concepts::NonLinearSolverCheckForPathFollowing<NonLinearSolver>));
    }
 
  }  // namespace Impl
 
  template <typename NonLinearSolver, typename PathFollowingType = ArcLength,
            typename AdaptiveStepSizing = AdaptiveStepSizing::NoOp>
  requires(
      Impl::checkPathFollowingTemplates<NonLinearSolver, PathFollowingType, AdaptiveStepSizing>()) class PathFollowing
      : public IObservable<ControlMessages> {
  public:
    constexpr auto name() const { return std::string("Path following with " + pathFollowingType_.name()); }
 
    PathFollowing(const std::shared_ptr<NonLinearSolver>& p_nonLinearSolver, int steps, double stepSize,
                  PathFollowingType p_pathFollowingType = ArcLength{}, AdaptiveStepSizing p_adaptiveStepSizing = {})
        : nonLinearSolver{p_nonLinearSolver},
          steps_{steps},
          stepSize_{stepSize},
          pathFollowingType_{p_pathFollowingType},
          adaptiveStepSizing{p_adaptiveStepSizing} {}
 
    ControlInformation run();
 
  private:
    std::shared_ptr<NonLinearSolver> nonLinearSolver;
    int steps_;
    double stepSize_;
    PathFollowingType pathFollowingType_;
    AdaptiveStepSizing adaptiveStepSizing;
  };
 
}  // namespace Ikarus
 
#include <ikarus/controlroutines/pathfollowing.inl>