Ikarus::NonLinearSolverLogger Class Reference

Implementation of an observer for logging non-linear solvers.This class inherits from the IObserver class and provides specific implementations for updating based on NonLinearSolverMessages.

#include <ikarus/utils/listener/nonlinearsolverlogger.hh>

Inheritance diagram for Ikarus::NonLinearSolverLogger:

Public Types
using	Token = std::shared_ptr< void >

Public Member Functions
template<typename BC >
NonLinearSolverLogger &	subscribeTo (BC &bc)
void	updateImpl (NonLinearSolverMessages message)
	Handles the update when a NonLinearSolverMessages is received. More...
void	updateImpl (NonLinearSolverMessages message, double val)
	Handles the update when a NonLinearSolverMessages with a double value is received. More...
void	updateImpl (NonLinearSolverMessages message, int intVal)
	Handles the update when a NonLinearSolverMessages with an integer value is received. More...
template<typename Broadcaster , typename F >
auto	subscribe (Broadcaster &broadcaster, F &&f)
	Function to subscribe to a broadcaster with a given function (either a lambda, std::function or function pointer). More...
template<typename Broadcaster , typename Signature , typename F > requires (not Concepts::PointerOrSmartPointer<Broadcaster>)
auto	subscribe (Broadcaster &broadcaster, F &&f)
	Function to subscribe to a broadcaster with a given function (either a lambda, std::function or function pointer). More...
void	unSubscribeAll ()
	Unsubscribe from all listeners. At the moment unsubscribing can't be done more granularly. More...
void	unSubscribeLast ()
	Unsubscribe from the last subscribed listener. More...
void	unSubscribe (Token &&ts)

Member Typedef Documentation

Token

using Ikarus::Listener::Token = std::shared_ptr<void>

inherited

Member Function Documentation

subscribe() [1/2]

template<typename Broadcaster , typename F >

auto Ikarus::Listener::subscribe ( Broadcaster &  broadcaster, F &&  f  )

inlineinherited

This function deducts the types of the arguments itself and then forwards it. If there are problems with type deduction use the function below and specify the types of the arguments manually.

Template Parameters

Broadcaster	the type of the Broadcaster (for example a NonlinearSolver or ControlRoutine), can either be a pointer or value.
F	the type of the function

Parameters

broadcaster	the broadcaster
f	the function

Here is the caller graph for this function:

subscribe() [2/2]

template<typename Broadcaster , typename Signature , typename F >
requires (not Concepts::PointerOrSmartPointer<Broadcaster>)

auto Ikarus::Listener::subscribe ( Broadcaster &  broadcaster, F &&  f  )

inlineinherited

Template Parameters

Broadcaster	the type of the Broadcaster (for example a NonlinearSolver or ControlRoutine), can either be a pointer or value.
Signature	the exact signature of the function F
F	the type of the function

Parameters

broadcaster	the broadcaster
f	the function

subscribeTo()

template<typename BC >

NonLinearSolverLogger & Ikarus::NonLinearSolverLogger::subscribeTo ( BC &  bc )

inline

unSubscribe()

void Ikarus::Listener::unSubscribe ( Token &&  ts )

inlineinherited

unSubscribeAll()

void Ikarus::Listener::unSubscribeAll ( )

inlineinherited

unSubscribeLast()

void Ikarus::Listener::unSubscribeLast ( )

inlineinherited

updateImpl() [1/3]

void Ikarus::NonLinearSolverLogger::updateImpl

(

NonLinearSolverMessages

message

)

Parameters

message

The NonLinearSolverMessages received.

Here is the caller graph for this function:

updateImpl() [2/3]

void Ikarus::NonLinearSolverLogger::updateImpl	(	NonLinearSolverMessages	message,
		double	val
	)

Parameters

message	The NonLinearSolverMessages received.
val	The double value associated with the message.

updateImpl() [3/3]

void Ikarus::NonLinearSolverLogger::updateImpl	(	NonLinearSolverMessages	message,
		int	intVal
	)

Parameters

message	The NonLinearSolverMessages received.
intVal	The integer value associated with numberOfIterations.

---

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

• nonlinearsolverlogger.hh