Thermal-FIST  1.3
Package for hadron resonance gas model applications
Public Member Functions | Protected Attributes | List of all members
thermalfist::BroydenEquations Class Referenceabstract

Abstract class which defines the system of non-linear equations to be solved by the Broyden's method. More...

#include <Broyden.h>

Inheritance diagram for thermalfist::BroydenEquations:
thermalfist::ThermalModelPCE::BroydenEquationsPCE

Public Member Functions

 BroydenEquations (void)
 Default constructor. Does nothing. More...
 
virtual ~BroydenEquations (void)
 Destructor. More...
 
virtual int Dimension () const
 Number of equations. More...
 
void SetDimension (int dim)
 
virtual std::vector< double > Equations (const std::vector< double > &x)=0
 

Protected Attributes

int m_N
 The number of equations. More...
 

Detailed Description

Abstract class which defines the system of non-linear equations to be solved by the Broyden's method.

It is presumed that all equations are of the form 'l.h.s. == 0'. Actual equations are to be specified in a derived class.

Definition at line 31 of file Broyden.h.

Constructor & Destructor Documentation

thermalfist::BroydenEquations::BroydenEquations ( void  )
inline

Default constructor. Does nothing.

Definition at line 35 of file Broyden.h.

virtual thermalfist::BroydenEquations::~BroydenEquations ( void  )
inlinevirtual

Destructor.

Definition at line 38 of file Broyden.h.

Member Function Documentation

virtual int thermalfist::BroydenEquations::Dimension ( ) const
inlinevirtual

Number of equations.

Definition at line 41 of file Broyden.h.

virtual std::vector<double> thermalfist::BroydenEquations::Equations ( const std::vector< double > &  x)
pure virtual

Evaluates the l.h.s. of all the equations being solved for the specified values of the variables. It is presumed that all equations are of the form 'l.h.s. == 0'. Pure virtual function which should be implemented in a derived class.

Parameters
xVector of the variables' values.
Returns
std::vector<double> Vector of l.h.s. computed.

Implemented in thermalfist::ThermalModelPCE::BroydenEquationsPCE.

void thermalfist::BroydenEquations::SetDimension ( int  dim)
inline

Set the number of equations.

Parameters
dimThe number of equations.

Definition at line 48 of file Broyden.h.

Member Data Documentation

int thermalfist::BroydenEquations::m_N
protected

The number of equations.

Definition at line 66 of file Broyden.h.


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