MechSys  1.0
Computing library for simulations in continuum and discrete mechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Public Attributes
Numerical::Root< Instance > Class Template Reference

#include <root.h>

List of all members.

Public Types

typedef double(Instance::* pF )(double x, void *UserData)
 Callback function.
typedef double(Instance::* pdFdx )(double x, void *UserData)
 Callback derivative of function w.r.t x.

Public Member Functions

 Root (Instance *Inst, pF F, pdFdx dFdx=NULL)
double Solve (double xa, double xb, double *x_guess=NULL, void *UserData=NULL)
 Find root.

Public Attributes

double Tol
int It
int MaxIt
String Scheme
bool Verbose

template<typename Instance>
class Numerical::Root< Instance >


Member Typedef Documentation

template<typename Instance>
typedef double(Instance::* Numerical::Root< Instance >::pdFdx)(double x, void *UserData)

Callback derivative of function w.r.t x.

template<typename Instance>
typedef double(Instance::* Numerical::Root< Instance >::pF)(double x, void *UserData)

Callback function.


Constructor & Destructor Documentation

template<typename Instance >
Numerical::Root< Instance >::Root ( Instance *  Inst,
pF  F,
pdFdx  dFdx = NULL 
) [inline]

Constructor.


Member Function Documentation

template<typename Instance >
double Numerical::Root< Instance >::Solve ( double  xa,
double  xb,
double *  x_guess = NULL,
void *  UserData = NULL 
) [inline]

Find root.


Member Data Documentation

template<typename Instance>
int Numerical::Root< Instance >::It
template<typename Instance>
int Numerical::Root< Instance >::MaxIt
template<typename Instance>
String Numerical::Root< Instance >::Scheme
template<typename Instance>
double Numerical::Root< Instance >::Tol
template<typename Instance>
bool Numerical::Root< Instance >::Verbose

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines