mbsim  4.0.0
MBSim Kernel
Public Member Functions | Private Attributes | List of all members
MBSim::MultiDimensionalNewtonMethod Class Reference

Newton method for multidimensional root finding. More...

#include <multi_dimensional_newton_method.h>

Inheritance diagram for MBSim::MultiDimensionalNewtonMethod:
[legend]

Public Member Functions

 MultiDimensionalNewtonMethod ()
 plain constructor
 
int getNumberOfIterations () const
 
int getNumberOfMaximalIterations () const
 
int getInfo () const
 
void setMaximumNumberOfIterations (int itmax_)
 
void setFunction (Function< fmatvec::Vec(fmatvec::Vec)> *function_)
 
void setJacobianFunction (NewtonJacobianFunction *jacobian_)
 
void setDampingFunction (MBSim::DampingFunction *damping_)
 
void setCriteriaFunction (CriteriaFunction *criteria_)
 
CriteriaFunction * getCriteriaFunction ()
 
void setLinearAlgebra (int linAlg_)
 
void setJacobianUpdateFreq (int JacobianUpdateFreq_)
 
fmatvec::Vec solve (const fmatvec::Vec &initialValue)
 solve nonlinear root function More...
 
- Public Member Functions inherited from fmatvec::Atom
Atom & operator= (const Atom &)
 
void setMessageStreamActive (MsgType type, bool activeFlag)
 
void getMessageStream (MsgType type, std::shared_ptr< bool > &a, std::shared_ptr< std::ostream > &s) const
 
void adoptMessageStreams (const Atom *src=nullptr)
 
std::ostream & msg (MsgType type) const
 
bool msgAct (MsgType type) const
 

Private Attributes

Function< fmatvec::Vec(fmatvec::Vec)> * function
 root function
 
NewtonJacobianFunction * jacobian
 Jacobian matrix.
 
DampingFunction * damping
 
CriteriaFunction * criteria
 
int itermax
 maximum number of iterations, actual number of iterations, maximum number of damping steps, information about success
 
int iter
 
int info
 
int linAlg
 flag which linear algebra solution should be taken 0 = solve with LU-decomposition 1 = solve with LS (least squares) for underdetermined systems
 
int jacobianUpdateFreq
 the frequency of updating Jacobian during iteration
 

Additional Inherited Members

- Public Types inherited from fmatvec::Atom
enum  MsgType
 
- Static Public Member Functions inherited from fmatvec::Atom
static void setCurrentMessageStream (MsgType type, const std::shared_ptr< bool > &a=std::make_shared< bool >(true), const std::shared_ptr< std::ostream > &s=std::make_shared< std::ostream >(std::cout.rdbuf()))
 
static std::ostream & msgStatic (MsgType type)
 
static bool msgActStatic (MsgType type)
 
- Protected Member Functions inherited from fmatvec::Atom
 Atom (const Atom &src)
 

Detailed Description

Newton method for multidimensional root finding.

Author
Kilian Grundl (3.2.2012)

Member Function Documentation

◆ solve()

Vec MBSim::MultiDimensionalNewtonMethod::solve ( const fmatvec::Vec &  initialValue)

solve nonlinear root function

Parameters
initialValueinitial value

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