The PathFollowing control routine for path-following analysis. More...

#include <ikarus/controlroutines/pathfollowing.hh>

Inheritance diagram for Ikarus::PathFollowing< NLS, PF, ASS >:

Public Member Functions
constexpr auto	name () const
	The name of the PathFollowing method. More...

	PathFollowing (const std::shared_ptr< NLS > &nls, int steps, double stepSize, PF pathFollowingType=ArcLength{}, ASS adaptiveStepSizing={})
	Constructor for PathFollowing. More...

ControlInformation	run ()
	Executes the PathFollowing routine. More...

NLS &	nonlinearSolver ()

void	subscribe (ControlMessages message, std::shared_ptr< IObserver< ControlMessages > > observer)
	Subscribe an observer to receive notifications for a specific message type. More...

void	subscribeAll (std::shared_ptr< IObserver< ControlMessages > > observer)
	Subscribe an observer to receive notifications for all message types. More...

void	subscribeAll (std::initializer_list< std::shared_ptr< IObserver< ControlMessages > > > observers)
	Subscribe multiple observers to receive notifications for all message types. More...

void	unSubscribe (ControlMessages message, std::shared_ptr< IObserver< ControlMessages > > observer)
	Unsubscribe an observer from receiving notifications for a specific message type. More...

void	unSubscribeAll (std::shared_ptr< IObserver< ControlMessages > > observer)
	Unsubscribe an observer from receiving notifications for all message types. More...

void	notify (ControlMessages message)
	Notify observers about a specific message type. More...

void	notify (ControlMessages message, ScalarType val)
	Notify observers about a specific message type with a floating-point value. More...

void	notify (ControlMessages message, int val)
	Notify observers about a specific message type with an integer value. More...

void	notify (ControlMessages message, const std::string &val)
	Notify observers about a specific message type with a string value. More...

void	notify (ControlMessages message, int val1, double val2)
	Notify observers about a specific message type with an integer and a double value. More...

void	notify (ControlMessages message, int val1, const std::string &val2)
	Notify observers about a specific message type with an integer value and a string value. More...

void	notify (ControlMessages message, Eigen::VectorX< ScalarType > vec)
	Notify observers about a specific message type with an Eigen::VectorX. More...

void	notify (MT message)

void	notify (MT message, ScalarType val)

void	notify (MT message, int val)

void	notify (MT message, const std::string &val)

void	notify (MT message, int val1, double val2)

void	notify (MT message, int val1, const std::string &val2)

void	notify (MT message, Eigen::VectorX< ScalarType > vec)

Detailed Description

template<typename NLS, typename PF = ArcLength, typename ASS = AdaptiveStepSizing::NoOp>
requires (Impl::checkPathFollowingTemplates<NLS, PF, ASS>())
class Ikarus::PathFollowing< NLS, PF, ASS >

This class represents the PathFollowing control routine, which utilizes a nonlinear solver, such as Newton's method with scalar subsidiary function, which has to be fulfilled for solving the system along a predefined path.

Consider a non-linear system of equations

\[\mathbf{R}: \require{cases}\begin{cases}\mathbb{R}^n \times \mathbb{R} &\rightarrow \mathbb{R}^n \\ (\mathbf{D},\lambda) &\mapsto \mathbf{R}(\mathbf{D},\lambda) \end{cases}.\]

Then in each step \(k+1\) of the path following algorithm, the following problem is solved

\[ \begin{align} \mathbf{R}(\mathbf{D}_k+ \mathrm{D}\mathbf{D}, \lambda_k+ \mathrm{D} \lambda) &= \mathbf{0} \\ f(\mathrm{D}\mathbf{D}, \mathrm{D} \lambda) &= 0 \end{align} \]

where \(\mathrm{D}\mathbf{D}\) is the increment of the solution vector and \(\mathrm{D} \lambda\) is the load factor increment. The subsidiary function \(f\) is provided by the user and needs to fulfill the concept Concepts::PathFollowingStrategy. This subsidiary function makes the given problem well-posed.

Currently the following subsidiary functions are implemented LoadControlSubsidiaryFunction, ArcLength and DisplacementControl

Template Parameters

NLS	Type of the nonlinear solver used in the control routine.
PF	Type of the path-following strategy.
ASS	Type of the adaptive step sizing strategy.

Constructor & Destructor Documentation

◆ PathFollowing()

template<typename NLS , typename PF = ArcLength, typename ASS = AdaptiveStepSizing::NoOp>

Ikarus::PathFollowing< NLS, PF, ASS >::PathFollowing	(	const std::shared_ptr< NLS > &	nls,
		int	steps,
		double	stepSize,
		PF	pathFollowingType = `ArcLength{}`,
		ASS	adaptiveStepSizing = `{}`
	)

inline

Parameters

nls	The non linear solver.
steps	Number of steps in the control routine.
stepSize	Size of each step.
pathFollowingType	Type of the path-following function.
adaptiveStepSizing	Type of the adaptive step sizing strategy.

Member Function Documentation

◆ name()

template<typename NLS , typename PF = ArcLength, typename ASS = AdaptiveStepSizing::NoOp>

constexpr auto Ikarus::PathFollowing< NLS, PF, ASS >::name ( ) const

inlineconstexpr

◆ nonlinearSolver()

template<typename NLS , typename PF = ArcLength, typename ASS = AdaptiveStepSizing::NoOp>

NLS & Ikarus::PathFollowing< NLS, PF, ASS >::nonlinearSolver ( )

inline

◆ notify() [1/14]

void Ikarus::IObservable< ControlMessages >::notify ( ControlMessages message )

inherited

Parameters

message The message type to notify about.

◆ notify() [2/14]

void Ikarus::IObservable< ControlMessages >::notify	(	ControlMessages	message,
		const std::string &	val
	)

inherited

Parameters

message	The message type to notify about.
val	The string value to be sent with the notification.

◆ notify() [3/14]

void Ikarus::IObservable< ControlMessages >::notify	(	ControlMessages	message,
		Eigen::VectorX< ScalarType >	vec
	)

inherited

Template Parameters

ScalarType The type of the elements in the Eigen::VectorX.

Parameters

message	The message type to notify about.
vec	The Eigen::VectorX to be sent with the notification.

◆ notify() [4/14]

void Ikarus::IObservable< ControlMessages >::notify	(	ControlMessages	message,
		int	val
	)

inherited

Parameters

message	The message type to notify about.
val	The integer value to be sent with the notification.

◆ notify() [5/14]

void Ikarus::IObservable< ControlMessages >::notify	(	ControlMessages	message,
		int	val1,
		const std::string &	val2
	)

inherited

Parameters

message	The message type to notify about.
val1	The integer value to be sent with the notification.
val2	The string value to be sent with the notification.

◆ notify() [6/14]

void Ikarus::IObservable< ControlMessages >::notify	(	ControlMessages	message,
		int	val1,
		double	val2
	)

inherited

Parameters

message	The message type to notify about.
val1	The integer value to be sent with the notification.
val2	The double value to be sent with the notification.

◆ notify() [7/14]

void Ikarus::IObservable< ControlMessages >::notify	(	ControlMessages	message,
		ScalarType	val
	)

inherited

Template Parameters

ScalarType The type of the floating-point value.

Parameters

message	The message type to notify about.
val	The floating-point value to be sent with the notification.

◆ notify() [8/14]

void Ikarus::IObservable< ControlMessages >::notify ( MT message )

inherited

◆ notify() [9/14]

void Ikarus::IObservable< ControlMessages >::notify	(	MT	message,
		const std::string &	val
	)

inherited

◆ notify() [10/14]

void Ikarus::IObservable< ControlMessages >::notify	(	MT	message,
		Eigen::VectorX< ScalarType >	vec
	)

inherited

◆ notify() [11/14]

void Ikarus::IObservable< ControlMessages >::notify	(	MT	message,
		int	val
	)

inherited

◆ notify() [12/14]

void Ikarus::IObservable< ControlMessages >::notify	(	MT	message,
		int	val1,
		const std::string &	val2
	)

inherited

◆ notify() [13/14]

void Ikarus::IObservable< ControlMessages >::notify	(	MT	message,
		int	val1,
		double	val2
	)

inherited

◆ notify() [14/14]

void Ikarus::IObservable< ControlMessages >::notify	(	MT	message,
		ScalarType	val
	)

inherited

◆ run()

template<typename NLS , typename PF , typename ASS >
requires (Impl::checkPathFollowingTemplates<NLS, PF, ASS>())

ControlInformation Ikarus::PathFollowing< NLS, PF, ASS >::run

Returns: ControlInformation structure containing information about the control results.

Initializing solver

Calculate predictor for a particular step

◆ subscribe()

void Ikarus::IObservable< MT >::subscribe	(	ControlMessages	message,
		std::shared_ptr< IObserver< ControlMessages > >	observer
	)

inherited

Parameters

message	The message type to subscribe to.
observer	The observer to be subscribed.

◆ subscribeAll() [1/2]

void Ikarus::IObservable< ControlMessages >::subscribeAll ( std::initializer_list< std::shared_ptr< IObserver< ControlMessages > > > observers )

inherited

Parameters

observers List of observers to be subscribed.

◆ subscribeAll() [2/2]

void Ikarus::IObservable< ControlMessages >::subscribeAll ( std::shared_ptr< IObserver< ControlMessages > > observer )

inherited

Parameters

observer The observer to be subscribed.

◆ unSubscribe()

void Ikarus::IObservable< MT >::unSubscribe	(	ControlMessages	message,
		std::shared_ptr< IObserver< ControlMessages > >	observer
	)

inherited

Parameters

message	The message type to unsubscribe from.
observer	The observer to be unsubscribed.

◆ unSubscribeAll()

void Ikarus::IObservable< MT >::unSubscribeAll ( std::shared_ptr< IObserver< ControlMessages > > observer )

inherited

Parameters

observer The observer to be unsubscribed.

The documentation for this class was generated from the following files:

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PathFollowing()

Member Function Documentation

◆ name()

◆ nonlinearSolver()

◆ notify() [1/14]

◆ notify() [2/14]

◆ notify() [3/14]

◆ notify() [4/14]

◆ notify() [5/14]

◆ notify() [6/14]

◆ notify() [7/14]

◆ notify() [8/14]

◆ notify() [9/14]

◆ notify() [10/14]

◆ notify() [11/14]

◆ notify() [12/14]

◆ notify() [13/14]

◆ notify() [14/14]

◆ run()

◆ subscribe()

◆ subscribeAll() [1/2]

◆ subscribeAll() [2/2]

◆ unSubscribe()

◆ unSubscribeAll()