EqSolver Class Reference

The simplest concrete implementation of IEqSolver interface. More...

#include <src/Components/EqSolver.h>

Inheritance diagram for EqSolver:

Collaboration diagram for EqSolver:

Classes
class	EqSolverMisc

Public Types
typedef std::vector< Equations >	Jacobi
Public Types inherited from extends< GaudiTool, IEqSolver >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from AlgTool
typedef Gaudi::PluginService::Factory< IAlgTool *, const std::string &, const std::string &, const IInterface * >	Factory
Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...
Public Types inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
using	base_class = CommonMessaging
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Public Member Functions
StatusCode	solver (const Equations &funcs, Arg &arg) const override
	Solving nonlinear system with N equations in N unknowns of the function "GenFunc". More...
StatusCode	initialize () override
	Overriding initialize. More...
StatusCode	finalize () override
	~EqSolver () override
	Destructor. More...
Public Member Functions inherited from extends< GaudiTool, IEqSolver >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from GaudiTool
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
INTupleSvc *	ntupleSvc () const
	Access the standard N-Tuple. More...
INTupleSvc *	evtColSvc () const
	Access the standard event collection service. More...
IDataProviderSvc *	detSvc () const
	accessor to detector service More...
IIncidentSvc *	incSvc () const
	accessor to Incident Service More...
IChronoStatSvc *	chronoSvc () const
	accessor to Chrono & Stat Service More...
IHistogramSvc *	histoSvc () const
	acessor to the histogram service More...
IAlgContextSvc *	contextSvc () const
	acessor to the Algorithm Context Service More...
DataObject *	put (IDataProviderSvc *svc, DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
DataObject *	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data from Gaudi Event Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
TYPE *	getDet (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
template<class TYPE >
bool	exist (const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
template<class TYPE >
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...
template<class TYPE >
bool	existDet (const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...
StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...
StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...
	GaudiTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
	~GaudiTool () override
	destructor, virtual and protected More...
Public Member Functions inherited from GaudiCommon< AlgTool >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Quicker version of the get function which bypasses the check on the retrieved data. More...
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
DataObject *	put (IDataProviderSvc *svc, DataObject *object, const std::string &location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
TOOL *	tool (const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools. More...
TOOL *	tool (const std::string &type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...
SmartIF< SERVICE >	svc (const std::string &name, const bool create=true) const
	A useful method for the easy location of services. More...
IUpdateManagerSvc *	updMgrSvc () const
	Short-cut to locate the Update Manager Service. More...
StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...
StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...
StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...
StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
	Print the message and return with the given StatusCode. More...
void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...
void	Assert (const bool ok, const char *message, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...
void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException. More...
void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception. More...
void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message. More...
const Statistics &	counters () const
	accessor to all counters More...
StatEntity &	counter (const std::string &tag) const
	accessor to certain counter by name More...
bool	typePrint () const
	Insert the actual C++ type of the algorithm/tool in the messages ? More...
bool	propsPrint () const
	Print properties at initialization ? More...
bool	statPrint () const
	Print statistical counters at finalization ? More...
bool	errorsPrint () const
	Print error counters at finalization ? More...
long	printStat (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of statistical counters More...
long	printErrors (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of error counters More...
long	printProps (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of properties More...
void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=nullptr)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
void	registerCondition (const std::string &condition, CondType *&condPtrDest, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
void	registerCondition (char *condition, StatusCode(CallerClass::*mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class. More...
void	registerCondition (TargetClass *condition, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
StatusCode	runUpdate ()
	asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident. More...
	GaudiCommon (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from Algorithm. More...
	GaudiCommon (const std::string &type, const std::string &name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
StatusCode	release (const IInterface *interface) const
	Manual forced (and 'safe') release of the active tool or service. More...
const Services &	services () const
	get the list of aquired services More...
const std::string &	context () const
	Returns the "context" string. Used to identify different processing states. More...
const std::string &	rootInTES () const
	Returns the "rootInTES" string. More...
const std::string	fullTESLocation (const std::string &location, const bool useRootInTES) const
	Returns the full correct event location given the rootInTes settings. More...
Public Member Functions inherited from AlgTool
StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown) override
	Query for a given interface. More...
const std::string &	name () const override
	Retrieve full identifying name of the concrete tool object. More...
const std::string &	type () const override
	Retrieve type (concrete class) of the sub-algtool. More...
const IInterface *	parent () const override
	Retrieve parent of the sub-algtool. More...
StatusCode	configure () override
StatusCode	initialize () override
StatusCode	start () override
StatusCode	stop () override
StatusCode	finalize () override
StatusCode	terminate () override
StatusCode	reinitialize () override
StatusCode	restart () override
Gaudi::StateMachine::State	FSMState () const override
Gaudi::StateMachine::State	targetFSMState () const override
StatusCode	sysInitialize () override
	Initialize AlgTool. More...
StatusCode	sysStart () override
	Start AlgTool. More...
StatusCode	sysStop () override
	Stop AlgTool. More...
StatusCode	sysFinalize () override
	Finalize AlgTool. More...
StatusCode	sysReinitialize () override
	Initialize AlgTool. More...
StatusCode	sysRestart () override
	Start AlgTool. More...
	AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...
ISvcLocator *	svcLoc () const
	shortcut for the method service locator More...
IDataProviderSvc *	evtSvc () const
	accessor to event service service More...
IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service. More...
template<class T >
StatusCode	service (const std::string &name, T *&svc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&svc) const
	Access a service by name, type creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...
template<typename T >
SmartIF< T >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
virtual void	acceptDHVisitor (IDataHandleVisitor *) const override
void	commitHandles () override
const DataObjIDColl &	inputDataObjs () const override
const DataObjIDColl &	outputDataObjs () const override
void	registerTool (IAlgTool *tool) const
void	deregisterTool (IAlgTool *tool) const
template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used public tool. More...
template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used private tool. More...
const std::vector< IAlgTool * > &	tools () const
IAuditorSvc *	auditorSvc () const
	Access the auditor service. More...
IMonitorSvc *	monitorSvc () const
	Access the monitor service. More...
template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...
void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...
	~AlgTool () override
Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * >	inputHandles () const override
std::vector< Gaudi::DataHandle * >	outputHandles () const override
virtual const DataObjIDColl &	extraInputDeps () const override
virtual const DataObjIDColl &	extraOutputDeps () const override
void	declare (Gaudi::DataHandle &handle) override
void	renounce (Gaudi::DataHandle &handle) override
Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
	PropertyHolder ()=default
	~PropertyHolder () override=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none") const
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...
StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...
const Gaudi::Details::PropertyBase &	getProperty (const std::string &name) const override
	get the property by name More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	convert the property to the string More...
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...
bool	hasProperty (const std::string &name) const override
	Return true if we have a property with the given name. More...
	PropertyHolder (const PropertyHolder &)=delete
PropertyHolder &	operator= (const PropertyHolder &)=delete
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
	Specializations for various GaudiHandles. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...
MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces< Interfaces... >
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
	EqSolver ()=delete
	default constructor is private More...
	EqSolver (const EqSolver &)=delete
	copy constructor is private More...
EqSolver &	operator= (const EqSolver &)=delete
	assignment operator is More...

Private Attributes
Gaudi::Property< std::string >	m_algType
Gaudi::Property< double >	m_max_iter {this, "Iteration", 1000, "maximum of iteration"}
Gaudi::Property< double >	m_norm_residual {this, "Residual", 1.0e-7, "absolute error bound for the residual value"}
const gsl_multiroot_fdfsolver_type *	m_type = nullptr

Additional Inherited Members
Static Public Member Functions inherited from GaudiTool
static bool	enableSummary (bool)
	enable/disable summary More...
static bool	summaryEnabled ()
	is summary enabled? More...
Protected Types inherited from GaudiCommon< AlgTool >
using	base_class = AlgTool
typedef std::map< std::string, StatEntity >	Statistics
	the actual type of general counters More...
typedef std::map< std::string, unsigned int >	Counter
	the actual type error/warning counter More...
typedef std::vector< IAlgTool * >	AlgTools
	storage for active tools More...
typedef std::vector< SmartIF< IService > >	Services
	storage for active services More...
Protected Member Functions inherited from GaudiCommon< AlgTool >
	~GaudiCommon () override=default
	Destructor. More...
StatusCode	releaseTool (const IAlgTool *tool) const
	manual forced (and 'safe') release of the tool More...
StatusCode	releaseSvc (const IInterface *svc) const
	manual forced (and 'safe') release of the service More...
Protected Member Functions inherited from AlgTool
template<typename I >
void	declareInterface (I *i)
std::vector< IAlgTool * > &	tools ()
Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > > >
void	initDataHandleHolder ()
	initializes all handles - called by the sysInitialize method of any descendant of this More...
Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const
Protected Member Functions inherited from CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...
Protected Attributes inherited from GaudiCommon< AlgTool >
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...
Protected Attributes inherited from AlgTool
std::unique_ptr< IDataHandleVisitor >	m_updateDataHandles
	Hook for for derived classes to provide a custom visitor for data handles. More...
Static Protected Attributes inherited from GaudiCommon< AlgTool >
static const bool	IgnoreRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...
static const bool	UseRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

Detailed Description

The simplest concrete implementation of IEqSolver interface.

See also

GaudiGSL/IEqSolver.h

Author

Kirill Miklyaev kiril.nosp@m.lm@i.nosp@m.ris1..nosp@m.itep.nosp@m..ru

Date

2003-07-07

Definition at line 23 of file EqSolver.h.

Member Typedef Documentation

typedef std::vector<Equations> EqSolver::Jacobi

Definition at line 26 of file EqSolver.h.

Constructor & Destructor Documentation

EqSolver::~EqSolver ( )

override

Destructor.

Definition at line 317 of file EqSolver.cpp.

{}

EqSolver::EqSolver ( )

privatedelete

default constructor is private

EqSolver::EqSolver ( const EqSolver &  )

privatedelete

copy constructor is private

Member Function Documentation

StatusCode EqSolver::finalize ( )

override

Definition at line 304 of file EqSolver.cpp.

{
  StatusCode sc = GaudiTool::finalize() ;

  MsgStream log( msgSvc() , name() ) ;

  if ( sc.isFailure() )
    {
      return Error("Could not finaliaze base class GaudiTool", sc);
    }
  return StatusCode::SUCCESS;
}

StatusCode EqSolver::initialize ( )

override

Overriding initialize.

Definition at line 249 of file EqSolver.cpp.

{
  StatusCode sc = GaudiTool::initialize() ;

  MsgStream log( msgSvc() , name() ) ;

  if( sc.isFailure() )
    {
      return Error ("Could not initiliaze base class GaudiTool", sc);
    }
  /* The algorithm for multiional root-finding
     (solving nonlinear systems with n equations in n unknowns)*/

  if(       "fdfsolver_hybridsj" == m_algType )
    {
      m_type = gsl_multiroot_fdfsolver_hybridsj  ;
      log << MSG::DEBUG
          << "Root findind algoritms to be used: "
          << "'gsl_multiroot_fdfsolver_hybridsj'"
          << endmsg;
    }
  else if ( "fdfsolver_hybridj" == m_algType )
    {
      m_type = gsl_multiroot_fdfsolver_hybridj   ;
      log << MSG::DEBUG
          << "Root findind algoritms to be used: "
          << "'gsl_multiroot_fdfsolver_hybridj'"
          << endmsg;
    }
  else if ( "fdfsolver_newton" == m_algType )
    {
      m_type = gsl_multiroot_fdfsolver_newton    ;
      log << MSG::DEBUG
          << "Root findind algoritms to be used: "
          << "'gsl_multiroot_fdfsolver_newton'"
          << endmsg;
    }
  else if ( "fdfsolver_gnewton" == m_algType )
    {
      m_type = gsl_multiroot_fdfsolver_gnewton   ;
      log << MSG::DEBUG
          << "Root findind algoritms to be used: "
          << "'gsl_multiroot_fdfsolver_gnewton'"
          << endmsg;
    }
  else
    {
      return Error(" Unknown algorith type '"
                   + std::string(m_algType) + "'");
     }

  return StatusCode::SUCCESS;
}

EqSolver& EqSolver::operator= ( const EqSolver &  )

privatedelete

assignment operator is

StatusCode EqSolver::solver ( const Equations &  funcs, Arg &  arg  ) const

override

Solving nonlinear system with N equations in N unknowns of the function "GenFunc".

Solving nonlinear system of the function "GenFunc".

See also

IEqSolver.h

Returns

StatusCode

Definition at line 167 of file EqSolver.cpp.

{
  using namespace Genfun;

  gsl_vector_view vect = gsl_vector_view_array ( &arg[0] ,
                                                 arg.dimension() );
  MsgStream log( msgSvc(), name() );

  EqSolverMisc local (funcs, arg);

  const gsl_multiroot_fdfsolver_type *T = m_type;
  gsl_multiroot_fdfsolver *s;
  int    status = 0 ;
  size_t iter   = 0 ;

  gsl_multiroot_function_fdf function;

  function.f = &fun_gsl;
  function.df = &dfun_gsl;
  function.fdf = &fdfun_gsl;
  function.n = vect.vector.size;
  function.params = (void*) &local;

  s = gsl_multiroot_fdfsolver_alloc(T, vect.vector.size);
  gsl_multiroot_fdfsolver_set (s, &function, &vect.vector);

  for (iter = 0; iter < m_max_iter; ++iter)
    {
      status = gsl_multiroot_fdfsolver_iterate (s);
      if (status)
        {
          return Error
            ("Error from gsl_gsl_multiroot_fdfsolver_iterate '"
             + std::string(gsl_strerror(status)) + "'") ;
        }

      status = gsl_multiroot_test_residual (s->f,
                                            m_norm_residual);

      if ( status != GSL_CONTINUE ) { break; }
    }

  for (unsigned int i = 0; i < vect.vector.size; ++i)
    {
      gsl_vector_set (&vect.vector, i, gsl_vector_get (s->x, i));
    }

  if (status == GSL_SUCCESS)
    {
      log << MSG::DEBUG
          << "We stopped in the method on the " << iter
          << " iteration (we have maximum "     << m_max_iter
          << " iterations)"                     << endmsg;
    }
  else if (status == GSL_CONTINUE && iter <= m_max_iter )
    {
      return Error ( "Method finished with '"
                     + std::string(gsl_strerror(status))
                     +  "' error" );
    }
  else
    {
      return Error ( "Method finished with '" +
                     std::string(gsl_strerror(status))
                     +  "' error" );
    }

  gsl_multiroot_fdfsolver_free (s);

  if (status)
    {
      return Error ( "Method finished with '"
                     + std::string(gsl_strerror(status))
                     +  "' error" );
    }

  return GSL_SUCCESS;
}

Member Data Documentation

Gaudi::Property<std::string> EqSolver::m_algType

private

Initial value:

{this, "Algorithm", "fdfsolver_hybridsj",
                                         "type of the algorithm for root finding"}

Definition at line 83 of file EqSolver.h.

Gaudi::Property<double> EqSolver::m_max_iter {this, "Iteration", 1000, "maximum of iteration"}

private

Definition at line 85 of file EqSolver.h.

Gaudi::Property<double> EqSolver::m_norm_residual {this, "Residual", 1.0e-7, "absolute error bound for the residual value"}

private

Definition at line 86 of file EqSolver.h.

const gsl_multiroot_fdfsolver_type* EqSolver::m_type = nullptr

private

Definition at line 88 of file EqSolver.h.

---

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

• GaudiGSL/src/Components/EqSolver.h
• GaudiGSL/src/Components/EqSolver.cpp