All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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< EquationsJacobi
 
- Public Types inherited from extends1< GaudiTool, IEqSolver >
typedef extends1 base_class
 Typedef to this class. More...
 
typedef extend_interfaces1
< IEqSolver
extend_interfaces_base
 Typedef to the base of this class. More...
 
typedef
extend_interfaces_base::ext_iids 
interfaces
 MPL set of all the implemented interfaces. More...
 
- Public Types inherited from AlgTool
typedef
Gaudi::PluginService::Factory3
< IAlgTool *, const
std::string &, const
std::string &, const
IInterface * > 
Factory
 
- Public Types inherited from implements3< IAlgTool, IProperty, IStateful >
typedef implements3 base_class
 Typedef to this class. More...
 
typedef extend_interfaces3
< IAlgTool, IProperty,
IStateful
extend_interfaces_base
 Typedef to the base of this class. More...
 
typedef
extend_interfaces_base::ext_iids 
interfaces
 MPL set of all the implemented interfaces. More...
 
- Public Types inherited from extend_interfaces3< IAlgTool, IProperty, IStateful >
typedef mpl::fold< typename
IAlgTool::iid::iids::type,
typename mpl::fold< typename
IProperty::iid::iids::type,
typename
IStateful::iid::iids::type,
mpl::insert< mpl::_1, mpl::_2 >
>::type, mpl::insert< mpl::_1,
mpl::_2 > >::type 
ext_iids
 MPL set of interfaces extended by this one. More...
 
- Public Types inherited from IInterface
enum  Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
 Return status. More...
 
typedef Gaudi::InterfaceId
< IInterface, 0, 0 > 
iid
 Interface ID. More...
 
typedef mpl::set1< iidext_iids
 Extra interfaces. More...
 
- Public Types inherited from extend_interfaces1< IEqSolver >
typedef IEqSolver::iid::iids::type ext_iids
 MPL set of interfaces extended by this one. More...
 
- Public Types inherited from IEqSolver
typedef Genfun::AbsFunction GenFunc
 Function (. More...
 
typedef std::vector< const
GenFunc * > 
Equations
 Vector of the function "GenFunc" which we solver. More...
 
typedef Genfun::Argument Arg
 Argument of function "GenFunc" (. More...
 

Public Member Functions

virtual StatusCode solver (const Equations &funcs, Arg &arg) const
 Solving nonlinear system with N equations in N unknowns of the function "GenFunc". More...
 
virtual StatusCode initialize ()
 Overriding initialize. More...
 
virtual StatusCode finalize ()
 standard finalization method More...
 
virtual ~EqSolver ()
 Destructor. More...
 
 EqSolver (const std::string &type, const std::string &name, const IInterface *parent)
 Standard constructor. More...
 
- Public Member Functions inherited from extends1< GaudiTool, IEqSolver >
 extends1 (A1 a1, A2 a2, A3 a3)
 Templated constructor with 3 arguments. More...
 
 extends1 (A1 a1, A2 a2)
 Templated constructor with 2 arguments. More...
 
 extends1 (A1 a1)
 Templated constructor with 1 argument. More...
 
 extends1 ()
 Default constructor. More...
 
virtual void * i_cast (const InterfaceID &tid) const
 Implementation of IInterface::i_cast. More...
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)
 Implementation of IInterface::queryInterface. More...
 
virtual std::vector< std::string > getInterfaceNames () const
 Implementation of IInterface::getInterfaceNames. More...
 
virtual ~extends1 ()
 Virtual destructor. More...
 
- Public Member Functions inherited from GaudiTool
INTupleSvcntupleSvc () const
 Access the standard N-Tuple. More...
 
INTupleSvcevtColSvc () const
 Access the standard event collection service. More...
 
IDataProviderSvcdetSvc () const
 accessor to detector service More...
 
IDataProviderSvcevtSvc () const
 accessor to event service service More...
 
IIncidentSvcincSvc () const
 accessor to Incident Service More...
 
IChronoStatSvcchronoSvc () const
 accessor to Chrono & Stat Service More...
 
IHistogramSvchistoSvc () const
 acessor to the histogram service More...
 
IAlgContextSvccontextSvc () const
 acessor to the Algorithm Context Service More...
 
DataObjectput (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...
 
DataObjectput (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...
 
- 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...
 
DataObjectput (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...
 
IUpdateManagerSvcupdMgrSvc () 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...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream ( MSG::ALWAYS ) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream ( MSG::FATAL ) More...
 
MsgStreamerr () const
 shortcut for the method msgStream ( MSG::ERROR ) More...
 
MsgStreamerror () const
 shortcut for the method msgStream ( MSG::ERROR ) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream ( MSG::WARNING ) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream ( MSG::INFO ) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream ( MSG::DEBUG ) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream ( MSG::VERBOSE ) More...
 
MsgStreammsg () const
 shortcut for the method msgStream ( MSG::INFO ) More...
 
const Statisticscounters () const
 accessor to all counters More...
 
StatEntitycounter (const std::string &tag) const
 accessor to certain counter by name More...
 
MSG::Level msgLevel () const
 The current message service output level. More...
 
bool msgLevel (const MSG::Level level) const
 Test the output level. More...
 
void resetMsgStream () const
 Reset (delete) the current message stream object. 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)()=NULL)
 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. More...
 
 GaudiCommon (const std::string &type, const std::string &name, const IInterface *parent)
 Tool constructor. More...
 
StatusCode release (const IInterface *interface) const
 Manual forced (and 'safe') release of the active tool or service. More...
 
virtual unsigned long release ()
 Un-hide IInterface::release (ICC warning #1125) More...
 
const AlgToolstools () const
 get the list of aquired tools More...
 
const Servicesservices () 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...
 
double globalTimeOffset () const
 Returns the "globalTimeOffset" double. 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
virtual const std::string & name () const
 Retrieve full identifying name of the concrete tool object. More...
 
virtual const std::string & type () const
 Retrieve type (concrete class) of the sub-algtool. More...
 
virtual const IInterfaceparent () const
 Retrieve parent of the sub-algtool. More...
 
virtual StatusCode configure ()
 Configuration (from OFFLINE to CONFIGURED). More...
 
virtual StatusCode start ()
 Start (from INITIALIZED to RUNNING). More...
 
virtual StatusCode stop ()
 Stop (from RUNNING to INITIALIZED). More...
 
virtual StatusCode terminate ()
 Initialization (from CONFIGURED to OFFLINE). More...
 
virtual StatusCode reinitialize ()
 Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
 
virtual StatusCode restart ()
 Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
 
virtual Gaudi::StateMachine::State FSMState () const
 Get the current state. More...
 
virtual Gaudi::StateMachine::State targetFSMState () const
 When we are in the middle of a transition, get the state where the transition is leading us. More...
 
virtual StatusCode sysInitialize ()
 Initialize AlgTool. More...
 
virtual StatusCode sysStart ()
 Start AlgTool. More...
 
virtual StatusCode sysStop ()
 Stop AlgTool. More...
 
virtual StatusCode sysFinalize ()
 Finalize AlgTool. More...
 
virtual StatusCode sysReinitialize ()
 Initialize AlgTool. More...
 
virtual StatusCode sysRestart ()
 Start AlgTool. More...
 
virtual StatusCode setProperty (const Property &p)
 Default implementations for IProperty interface. More...
 
virtual StatusCode setProperty (const std::string &s)
 Set the property by string. More...
 
virtual StatusCode setProperty (const std::string &n, const std::string &v)
 Set the property by std::string. More...
 
virtual StatusCode getProperty (Property *p) const
 Get the property by property. More...
 
virtual const PropertygetProperty (const std::string &name) const
 Get the property by name. More...
 
virtual StatusCode getProperty (const std::string &n, std::string &v) const
 Get the property by std::string. More...
 
virtual const std::vector
< Property * > & 
getProperties () const
 Get list of properties. More...
 
PropertyMgrgetPropertyMgr ()
 
template<class TYPE >
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
 AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
 Standard Constructor. More...
 
ISvcLocatorserviceLocator () const
 Retrieve pointer to service locator. More...
 
ISvcLocatorsvcLoc () const
 shortcut for the method service locator More...
 
IMessageSvcmsgSvc () const
 Retrieve pointer to message service. More...
 
IToolSvctoolSvc () 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< IServiceservice (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...
 
void declInterface (const InterfaceID &, void *)
 declare interface More...
 
template<class T >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property. More...
 
PropertydeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
 Declare remote named properties. More...
 
IAuditorSvcauditorSvc () const
 Access the auditor service. More...
 
IMonitorSvcmonitorSvc () 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...
 
- Public Member Functions inherited from extend_interfaces3< IAlgTool, IProperty, IStateful >
virtual ~extend_interfaces3 ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IAlgTool
 DeclareInterfaceID (IAlgTool, 3, 0)
 InterfaceID. More...
 
virtual ~IAlgTool ()
 Virtual destructor. More...
 
virtual unsigned long refCount () const =0
 Current number of reference counts. More...
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID. More...
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes). More...
 
- Public Member Functions inherited from IInterface
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance. More...
 
virtual ~IInterface ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IProperty
 DeclareInterfaceID (IProperty, 2, 0)
 InterfaceID. More...
 
- Public Member Functions inherited from IStateful
 DeclareInterfaceID (IStateful, 1, 0)
 InterfaceID. More...
 
virtual ~IStateful ()
 
- Public Member Functions inherited from extend_interfaces1< IEqSolver >
virtual ~extend_interfaces1 ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IEqSolver
 DeclareInterfaceID (IEqSolver, 2, 0)
 InterfaceID. More...
 

Private Member Functions

 EqSolver ()
 default constructor is private More...
 
 EqSolver (const EqSolver &)
 copy constructor is private More...
 
EqSolveroperator= (const EqSolver &)
 assignment operator is More...
 

Private Attributes

std::string m_algType
 
double m_max_iter
 
double m_norm_residual
 
const
gsl_multiroot_fdfsolver_type * 
m_type
 

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...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 
- Protected Types inherited from GaudiCommon< 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 GaudiUtils::HashMap
< std::string, SmartIF
< IService > > 
Services
 storage for active services More...
 
- Protected Member Functions inherited from GaudiTool
 GaudiTool (const std::string &type, const std::string &name, const IInterface *parent)
 Standard constructor. More...
 
virtual ~GaudiTool ()
 destructor, virtual and protected More...
 
- Protected Member Functions inherited from GaudiCommon< AlgTool >
virtual ~GaudiCommon ()
 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
int outputLevel () const
 get tool's output level More...
 
IntegerPropertyoutputLevelProperty ()
 Accessor for the Message level property. More...
 
void initOutputLevel (Property &prop)
 callback for output level property More...
 
virtual ~AlgTool ()
 
- Protected Attributes inherited from GaudiCommon< AlgTool >
ICounterSummarySvcm_counterSummarySvc
 a pointer to the CounterSummarySvc More...
 
std::vector< std::string > m_counterList
 list of counters to declare. Set by property CounterList. This can be a regular expression. More...
 
std::vector< std::string > m_statEntityList
 
- 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 25 of file EqSolver.h.

Member Typedef Documentation

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

Definition at line 27 of file EqSolver.h.

Constructor & Destructor Documentation

EqSolver::~EqSolver ( )
virtual

Destructor.

Definition at line 341 of file EqSolver.cpp.

342 {}
EqSolver::EqSolver ( const std::string &  type,
const std::string &  name,
const IInterface parent 
)

Standard constructor.

See also
GaudiTool
Parameters
typetool type
nametool name
parentparent of the tool

declare type of the algorithm for root finding

declare maximum of iteration

declare the absolute error bound for the residual value

Definition at line 75 of file EqSolver.cpp.

78  : base_class ( type, name , parent )
79  , m_algType ( "fdfsolver_hybridsj" )
80  , m_max_iter ( 1000 )
81  , m_norm_residual ( 1.0e-7 )
82  , m_type ( 0 )
83 
84 {
86  declareProperty ( "Algorithm", m_algType );
88  declareProperty ( "Iteration", m_max_iter );
90  declareProperty ( "Residual" , m_norm_residual );
91 }
virtual const std::string & type() const
Retrieve type (concrete class) of the sub-algtool.
Definition: AlgTool.cpp:58
extends1 base_class
Typedef to this class.
Definition: extends.h:12
std::string m_algType
Definition: EqSolver.h:94
Property * declareProperty(const std::string &name, T &property, const std::string &doc="none") const
Declare the named property.
Definition: AlgTool.h:232
double m_norm_residual
Definition: EqSolver.h:96
double m_max_iter
Definition: EqSolver.h:95
const gsl_multiroot_fdfsolver_type * m_type
Definition: EqSolver.h:97
virtual const std::string & name() const
Retrieve full identifying name of the concrete tool object.
Definition: AlgTool.cpp:51
EqSolver::EqSolver ( )
private

default constructor is private

EqSolver::EqSolver ( const EqSolver )
private

copy constructor is private

Member Function Documentation

StatusCode EqSolver::finalize ( )
virtual

standard finalization method

See also
AlgTool
IAlgTool
Returns
status code

Reimplemented from GaudiTool.

Definition at line 328 of file EqSolver.cpp.

329 {
331 
332  MsgStream log( msgSvc() , name() ) ;
333 
334  if ( sc.isFailure() )
335  {
336  return Error("Could not finaliaze base class GaudiTool", sc);
337  }
338  return StatusCode::SUCCESS;
339 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
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.
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:72
IMessageSvc * msgSvc() const
Retrieve pointer to message service.
Definition: AlgTool.cpp:79
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:30
virtual StatusCode finalize()
standard finalization method
Definition: GaudiTool.cpp:189
virtual const std::string & name() const
Retrieve full identifying name of the concrete tool object.
Definition: AlgTool.cpp:51
StatusCode EqSolver::initialize ( )
virtual

Overriding initialize.

Reimplemented from GaudiTool.

Definition at line 273 of file EqSolver.cpp.

275 {
277 
278  MsgStream log( msgSvc() , name() ) ;
279 
280  if( sc.isFailure() )
281  {
282  return Error ("Could not initiliaze base class GaudiTool", sc);
283  }
284  /* The algorithm for multiional root-finding
285  (solving nonlinear systems with n equations in n unknowns)*/
286 
287  if( "fdfsolver_hybridsj" == m_algType )
288  {
289  m_type = gsl_multiroot_fdfsolver_hybridsj ;
290  log << MSG::DEBUG
291  << "Root findind algoritms to be used: "
292  << "'gsl_multiroot_fdfsolver_hybridsj'"
293  << endmsg;
294  }
295  else if ( "fdfsolver_hybridj" == m_algType )
296  {
297  m_type = gsl_multiroot_fdfsolver_hybridj ;
298  log << MSG::DEBUG
299  << "Root findind algoritms to be used: "
300  << "'gsl_multiroot_fdfsolver_hybridj'"
301  << endmsg;
302  }
303  else if ( "fdfsolver_newton" == m_algType )
304  {
305  m_type = gsl_multiroot_fdfsolver_newton ;
306  log << MSG::DEBUG
307  << "Root findind algoritms to be used: "
308  << "'gsl_multiroot_fdfsolver_newton'"
309  << endmsg;
310  }
311  else if ( "fdfsolver_gnewton" == m_algType )
312  {
313  m_type = gsl_multiroot_fdfsolver_gnewton ;
314  log << MSG::DEBUG
315  << "Root findind algoritms to be used: "
316  << "'gsl_multiroot_fdfsolver_gnewton'"
317  << endmsg;
318  }
319  else
320  {
321  return Error(" Unknown algorith type '"
322  + std::string(m_algType) + "'");
323  }
324 
325  return StatusCode::SUCCESS;
326 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
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.
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:72
virtual StatusCode initialize()
standard initialization method
Definition: GaudiTool.cpp:174
std::string m_algType
Definition: EqSolver.h:94
IMessageSvc * msgSvc() const
Retrieve pointer to message service.
Definition: AlgTool.cpp:79
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:30
const gsl_multiroot_fdfsolver_type * m_type
Definition: EqSolver.h:97
virtual const std::string & name() const
Retrieve full identifying name of the concrete tool object.
Definition: AlgTool.cpp:51
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:243
EqSolver& EqSolver::operator= ( const EqSolver )
private

assignment operator is

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

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

Implements IEqSolver.

Definition at line 191 of file EqSolver.cpp.

194 {
195  using namespace Genfun;
196 
197  gsl_vector_view vect = gsl_vector_view_array ( &arg[0] ,
198  arg.dimension() );
199  MsgStream log( msgSvc(), name() );
200 
201  EqSolverMisc local (funcs, arg);
202 
203  const gsl_multiroot_fdfsolver_type *T = m_type;
204  gsl_multiroot_fdfsolver *s;
205  int status = 0 ;
206  size_t iter = 0 ;
207 
208  gsl_multiroot_function_fdf function;
209 
210  function.f = &fun_gsl;
211  function.df = &dfun_gsl;
212  function.fdf = &fdfun_gsl;
213  function.n = vect.vector.size;
214  function.params = (void*) &local;
215 
216  s = gsl_multiroot_fdfsolver_alloc(T, vect.vector.size);
217  gsl_multiroot_fdfsolver_set (s, &function, &vect.vector);
218 
219  for (iter = 0; iter < m_max_iter; ++iter)
220  {
221  status = gsl_multiroot_fdfsolver_iterate (s);
222  if (status)
223  {
224  return Error
225  ("Error from gsl_gsl_multiroot_fdfsolver_iterate '"
226  + std::string(gsl_strerror(status)) + "'") ;
227  }
228 
229  status = gsl_multiroot_test_residual (s->f,
231 
232  if ( status != GSL_CONTINUE ) { break; }
233  }
234 
235  for (unsigned int i = 0; i < vect.vector.size; ++i)
236  {
237  gsl_vector_set (&vect.vector, i, gsl_vector_get (s->x, i));
238  }
239 
240  if (status == GSL_SUCCESS)
241  {
242  log << MSG::DEBUG
243  << "We stopped in the method on the " << iter
244  << " iteration (we have maximum " << m_max_iter
245  << " iterations)" << endmsg;
246  }
247  else if (status == GSL_CONTINUE && iter <= m_max_iter )
248  {
249  return Error ( "Method finished with '"
250  + std::string(gsl_strerror(status))
251  + "' error" );
252  }
253  else
254  {
255  return Error ( "Method finished with '" +
256  std::string(gsl_strerror(status))
257  + "' error" );
258  }
259 
260  gsl_multiroot_fdfsolver_free (s);
261 
262  if (status)
263  {
264  return Error ( "Method finished with '"
265  + std::string(gsl_strerror(status))
266  + "' error" );
267  }
268 
269  return GSL_SUCCESS;
270 }
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
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.
IMessageSvc * msgSvc() const
Retrieve pointer to message service.
Definition: AlgTool.cpp:79
double m_norm_residual
Definition: EqSolver.h:96
double m_max_iter
Definition: EqSolver.h:95
string s
Definition: gaudirun.py:210
const gsl_multiroot_fdfsolver_type * m_type
Definition: EqSolver.h:97
virtual const std::string & name() const
Retrieve full identifying name of the concrete tool object.
Definition: AlgTool.cpp:51
list i
Definition: ana.py:128
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:243

Member Data Documentation

std::string EqSolver::m_algType
private

Definition at line 94 of file EqSolver.h.

double EqSolver::m_max_iter
private

Definition at line 95 of file EqSolver.h.

double EqSolver::m_norm_residual
private

Definition at line 96 of file EqSolver.h.

const gsl_multiroot_fdfsolver_type* EqSolver::m_type
private

Definition at line 97 of file EqSolver.h.


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