G4Solver< Function > Class Template Reference

#include <G4Solver.hh>

Public Types
enum	{ DefaultMaxIter = 100 }

Public Member Functions
	G4Solver ()
	G4Solver (const G4int iterations, const G4double tol)
	G4Solver (const G4Solver &right)
	~G4Solver ()
G4Solver &	operator= (const G4Solver &right)
G4bool	operator== (const G4Solver &right) const
G4bool	operator!= (const G4Solver &right) const
G4int	GetMaxIterations (void) const
void	SetMaxIterations (const G4int iterations)
G4double	GetTolerance (void) const
void	SetTolerance (const G4double epsilon)
G4double	GetIntervalLowerLimit (void) const
G4double	GetIntervalUpperLimit (void) const
void	SetIntervalLimits (const G4double Limit1, const G4double Limit2)
G4double	GetRoot (void) const
G4bool	Bisection (Function &theFunction)
G4bool	RegulaFalsi (Function &theFunction)
G4bool	Brent (Function &theFunction)
G4bool	Crenshaw (Function &theFunction)

Detailed Description

template<class Function>
class G4Solver< Function >

Definition at line 40 of file G4Solver.hh.

Member Enumeration Documentation

anonymous enum

template<class Function >

anonymous enum

Enumerator
DefaultMaxIter

Definition at line 43 of file G4Solver.hh.

{DefaultMaxIter = 100};

Constructor & Destructor Documentation

G4Solver() [1/3]

template<class Function >

G4Solver< Function >::G4Solver ( )

inline

Definition at line 46 of file G4Solver.hh.

               : MaxIter(DefaultMaxIter), tolerance(DefaultTolerance),
         a(0.0), b(0.0), root(0.0) {};

G4Solver() [2/3]

template<class Function >

G4Solver< Function >::G4Solver ( const G4int  iterations, const G4double  tol  )

inline

Definition at line 49 of file G4Solver.hh.

                                                         :
    MaxIter(iterations), tolerance(tol),
    a(0.0), b(0.0), root(0.0) {};

G4Solver() [3/3]

template<class Function >

G4Solver< Function >::G4Solver

(

const G4Solver< Function > &

right

)

Definition at line 35 of file G4Solver.cc.

{
    MaxIter = right.MaxIter;
    tolerance = right.tolerance;
    a = right.a;
    b = right.b;
    root = right.root;
}

~G4Solver()

template<class Function >

G4Solver< Function >::~G4Solver ( )

inline

Definition at line 57 of file G4Solver.hh.

{};

Member Function Documentation

Bisection()

template<class Function >

G4bool G4Solver< Function >::Bisection

(

Function &

theFunction

)

Brent()

template<class Function >

G4bool G4Solver< Function >::Brent

(

Function &

theFunction

)

Referenced by G4StatMFMacroMultiplicity::CalcChemicalPotentialMu(), G4StatMFMacroChemicalPotential::CalcChemicalPotentialNu(), and G4StatMFMacroTemperature::CalcTemperature().

Crenshaw()

template<class Function >

G4bool G4Solver< Function >::Crenshaw

(

Function &

theFunction

)

Referenced by G4StatMFMacroTemperature::CalcTemperature().

GetIntervalLowerLimit()

template<class Function >

G4double G4Solver< Function >::GetIntervalLowerLimit ( void  ) const

inline

Definition at line 71 of file G4Solver.hh.

{return a;}

GetIntervalUpperLimit()

template<class Function >

G4double G4Solver< Function >::GetIntervalUpperLimit ( void  ) const

inline

Definition at line 72 of file G4Solver.hh.

{return b;}

GetMaxIterations()

template<class Function >

G4int G4Solver< Function >::GetMaxIterations ( void  ) const

inline

Definition at line 64 of file G4Solver.hh.

{return MaxIter;}

GetRoot()

template<class Function >

G4double G4Solver< Function >::GetRoot ( void  ) const

inline

Definition at line 76 of file G4Solver.hh.

{return root;}

Referenced by G4StatMFMacroMultiplicity::CalcChemicalPotentialMu(), G4StatMFMacroChemicalPotential::CalcChemicalPotentialNu(), and G4StatMFMacroTemperature::CalcTemperature().

GetTolerance()

template<class Function >

G4double G4Solver< Function >::GetTolerance ( void  ) const

inline

Definition at line 67 of file G4Solver.hh.

{return tolerance;}

operator!=()

template<class Function >

G4bool G4Solver< Function >::operator!=

(

const G4Solver< Function > &

right

)

const

Definition at line 64 of file G4Solver.cc.

{
    return !operator==(right);
}

operator=()

template<class Function >

G4Solver< Function > & G4Solver< Function >::operator=

(

const G4Solver< Function > &

right

)

Definition at line 46 of file G4Solver.cc.

{
    MaxIter = right.MaxIter;
    tolerance = right.tolerance;
    a = right.a;
    b = right.b;
    root = right.root;  
    return *this;
}

operator==()

template<class Function >

G4bool G4Solver< Function >::operator==

(

const G4Solver< Function > &

right

)

const

Definition at line 57 of file G4Solver.cc.

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

RegulaFalsi()

template<class Function >

G4bool G4Solver< Function >::RegulaFalsi

(

Function &

theFunction

)

SetIntervalLimits()

template<class Function >

void G4Solver< Function >::SetIntervalLimits	(	const G4double	Limit1,
		const G4double	Limit2
	)

Referenced by G4StatMFMacroMultiplicity::CalcChemicalPotentialMu(), G4StatMFMacroChemicalPotential::CalcChemicalPotentialNu(), and G4StatMFMacroTemperature::CalcTemperature().

SetMaxIterations()

template<class Function >

void G4Solver< Function >::SetMaxIterations ( const G4int  iterations )

inline

Definition at line 65 of file G4Solver.hh.

{MaxIter=iterations;}

SetTolerance()

template<class Function >

void G4Solver< Function >::SetTolerance ( const G4double  epsilon )

inline

Definition at line 68 of file G4Solver.hh.

{tolerance = epsilon;}

---

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

• G4Solver.hh
• G4Solver.cc