NAEquationSolver< Function > Class Template Reference

#include <EquationSolver.h>

Public Types
enum	{ DefaultMaxIter = 100 }

Public Member Functions
bool	Brent (Function &theFunction)
double	GetIntervalLowerLimit (void) const
double	GetIntervalUpperLimit (void) const
int	GetMaxIterations (void) const
double	GetRoot (void) const
double	GetTolerance (void) const
	NAEquationSolver ()
	NAEquationSolver (const int iterations, const double tol)
	NAEquationSolver (const NAEquationSolver &right)
bool	operator!= (const NAEquationSolver &right) const
NAEquationSolver &	operator= (const NAEquationSolver &right)
bool	operator== (const NAEquationSolver &right) const
void	SetIntervalLimits (const double Limit1, const double Limit2)
void	SetMaxIterations (const int iterations)
void	SetTolerance (const double epsilon)
	~NAEquationSolver ()

Private Attributes
double	fA
double	fB
int	fMaxIter
double	fRoot
double	fTolerance

Detailed Description

template<class Function>
class NAEquationSolver< Function >

Definition at line 18 of file EquationSolver.h.

Member Enumeration Documentation

template<class Function>

anonymous enum

Enumerator
DefaultMaxIter

Definition at line 21 of file EquationSolver.h.

{DefaultMaxIter = 100};

Constructor & Destructor Documentation

template<class Function>

NAEquationSolver< Function >::NAEquationSolver ( )

inline

Definition at line 35 of file EquationSolver.h.

Referenced by NAEquationSolver< Function >::NAEquationSolver().

                     : fMaxIter(DefaultMaxIter), fTolerance(DefaultTolerance),
    fA(0.0), fB(0.0), fRoot(0.0) {};

template<class Function>

NAEquationSolver< Function >::NAEquationSolver ( const int  iterations, const double  tol  )

inline

Definition at line 38 of file EquationSolver.h.

References NAEquationSolver< Function >::NAEquationSolver().

                                                             :
      fMaxIter(iterations), fTolerance(tol),
      fA(0.0), fB(0.0), fRoot(0.0) {};

template<class Function >

NAEquationSolver< Function >::NAEquationSolver

(

const NAEquationSolver< Function > &

right

)

Definition at line 14 of file EquationSolver.cc.

References NAEquationSolver< Function >::GetIntervalLowerLimit(), NAEquationSolver< Function >::GetIntervalUpperLimit(), NAEquationSolver< Function >::GetMaxIterations(), NAEquationSolver< Function >::GetRoot(), and NAEquationSolver< Function >::GetTolerance().

                                                                           {
  fMaxIter = right.GetMaxIterations();
  fTolerance = right.GetTolerance();
  fA = right.GetIntervalLowerLimit();
  fB = right.GetIntervalUpperLimit();
  fRoot = right.GetRoot();
}

template<class Function>

NAEquationSolver< Function >::~NAEquationSolver ( )

inline

Definition at line 46 of file EquationSolver.h.

References NAEquationSolver< Function >::operator!=(), NAEquationSolver< Function >::operator=(), and NAEquationSolver< Function >::operator==().

{};

Member Function Documentation

template<class Function>

bool NAEquationSolver< Function >::Brent

(

Function &

theFunction

)

Referenced by NAStrangePotential::CalculateStrangePotential(), and NAEquationSolver< Function >::GetRoot().

template<class Function>

double NAEquationSolver< Function >::GetIntervalLowerLimit ( void  ) const

inline

Definition at line 59 of file EquationSolver.h.

References NAEquationSolver< Function >::fA.

Referenced by NAEquationSolver< Function >::NAEquationSolver(), and NAEquationSolver< Function >::operator=().

{return fA;}

template<class Function>

double NAEquationSolver< Function >::GetIntervalUpperLimit ( void  ) const

inline

Definition at line 60 of file EquationSolver.h.

References NAEquationSolver< Function >::fB, and NAEquationSolver< Function >::SetIntervalLimits().

Referenced by NAEquationSolver< Function >::NAEquationSolver(), and NAEquationSolver< Function >::operator=().

{return fB;}

template<class Function>

int NAEquationSolver< Function >::GetMaxIterations ( void  ) const

inline

Definition at line 53 of file EquationSolver.h.

References NAEquationSolver< Function >::fMaxIter.

Referenced by NAEquationSolver< Function >::NAEquationSolver(), and NAEquationSolver< Function >::operator=().

{return fMaxIter;}

template<class Function>

double NAEquationSolver< Function >::GetRoot ( void  ) const

inline

Definition at line 64 of file EquationSolver.h.

References NAEquationSolver< Function >::Brent(), and NAEquationSolver< Function >::fRoot.

Referenced by NAStrangePotential::CalculateStrangePotential(), NAEquationSolver< Function >::NAEquationSolver(), and NAEquationSolver< Function >::operator=().

{return fRoot;} 

template<class Function>

double NAEquationSolver< Function >::GetTolerance ( void  ) const

inline

Definition at line 56 of file EquationSolver.h.

References NAEquationSolver< Function >::fTolerance.

Referenced by NAEquationSolver< Function >::NAEquationSolver(), and NAEquationSolver< Function >::operator=().

{return fTolerance;}

template<class Function >

bool NAEquationSolver< Function >::operator!=

(

const NAEquationSolver< Function > &

right

)

const

Definition at line 40 of file EquationSolver.cc.

References operator==().

Referenced by NAEquationSolver< Function >::~NAEquationSolver().

                                                                                {
  return !operator==(right);
}

template<class Function >

NAEquationSolver< Function > & NAEquationSolver< Function >::operator=

(

const NAEquationSolver< Function > &

right

)

Definition at line 24 of file EquationSolver.cc.

References NAEquationSolver< Function >::GetIntervalLowerLimit(), NAEquationSolver< Function >::GetIntervalUpperLimit(), NAEquationSolver< Function >::GetMaxIterations(), NAEquationSolver< Function >::GetRoot(), and NAEquationSolver< Function >::GetTolerance().

Referenced by NAEquationSolver< Function >::~NAEquationSolver().

                                                                                                 {
  fMaxIter = right.GetMaxIterations();
  fTolerance = right.GetTolerance();
  fA = right.GetIntervalLowerLimit();
  fB = right.GetIntervalUpperLimit();
  fRoot = right.GetRoot();
  return *this;
}

template<class Function >

bool NAEquationSolver< Function >::operator==

(

const NAEquationSolver< Function > &

right

)

const

Definition at line 34 of file EquationSolver.cc.

Referenced by NAEquationSolver< Function >::~NAEquationSolver().

                                                                                {
  if (this == &right) return true;
  else return false;
}

template<class Function>

void NAEquationSolver< Function >::SetIntervalLimits	(	const double	Limit1,
		const double	Limit2
	)

Referenced by NAStrangePotential::CalculateStrangePotential(), and NAEquationSolver< Function >::GetIntervalUpperLimit().

template<class Function>

void NAEquationSolver< Function >::SetMaxIterations ( const int  iterations )

inline

Definition at line 54 of file EquationSolver.h.

{fMaxIter=iterations;}

template<class Function>

void NAEquationSolver< Function >::SetTolerance ( const double  epsilon )

inline

Definition at line 57 of file EquationSolver.h.

References geometryDiff::epsilon.

{fTolerance = epsilon;}

Member Data Documentation

template<class Function>

double NAEquationSolver< Function >::fA

private

Definition at line 28 of file EquationSolver.h.

Referenced by NAEquationSolver< Function >::GetIntervalLowerLimit().

template<class Function>

double NAEquationSolver< Function >::fB

private

Definition at line 29 of file EquationSolver.h.

Referenced by NAEquationSolver< Function >::GetIntervalUpperLimit().

template<class Function>

int NAEquationSolver< Function >::fMaxIter

private

Definition at line 25 of file EquationSolver.h.

Referenced by NAEquationSolver< Function >::GetMaxIterations().

template<class Function>

double NAEquationSolver< Function >::fRoot

private

Definition at line 31 of file EquationSolver.h.

Referenced by NAEquationSolver< Function >::GetRoot().

template<class Function>

double NAEquationSolver< Function >::fTolerance

private

Definition at line 26 of file EquationSolver.h.

Referenced by NAEquationSolver< Function >::GetTolerance().