Thermal-FIST 1.5
Package for hadron resonance gas model applications
Loading...
Searching...
No Matches
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::CosmicEoS::BroydenEquationsCosmology thermalfist::EffectiveMassModel::BroydenEquationsEMMMeff thermalfist::EffectiveMassModel::BroydenEquationsEMMMeffConstrained thermalfist::EffectiveMassModel::BroydenEquationsEMMTBEC thermalfist::ExcludedVolumeModelMultiBase::BroydenEquationsEVMulti thermalfist::ThermalModelPCE::BroydenEquationsPCE

Public Member Functions

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

Protected Attributes

int m_N
 The number of equations.
 

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

◆ BroydenEquations()

thermalfist::BroydenEquations::BroydenEquations ( )
default

Default constructor. Does nothing.

◆ ~BroydenEquations()

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

Destructor.

Member Function Documentation

◆ Dimension()

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

Number of equations.

Definition at line 41 of file Broyden.h.

◆ Equations()

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::CosmicEoS::BroydenEquationsCosmology, thermalfist::EffectiveMassModel::BroydenEquationsEMMMeff, thermalfist::EffectiveMassModel::BroydenEquationsEMMMeffConstrained, thermalfist::EffectiveMassModel::BroydenEquationsEMMTBEC, thermalfist::ExcludedVolumeModelMultiBase::BroydenEquationsEVMulti, and thermalfist::ThermalModelPCE::BroydenEquationsPCE.

◆ SetDimension()

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

Set the number of equations.

Parameters
dimThe number of equations.

Definition at line 27 of file Broyden.cpp.

Member Data Documentation

◆ m_N

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 files: