Base class for Solvers. More...

#include <Solver.h>

Inheritance diagram for TBTK::Solver::Solver:

Public Member Functions
	Solver ()

virtual	~Solver ()

virtual void	setModel (Model &model)

Model &	getModel ()

const Model &	getModel () const

Detailed Description

Base class for Solvers.

The Solver is a base class for other Solvers. See therefore the documentation for the Diagonalizer, BlockDiagonalizer, ArnoldiIterator, and ChebyshevExpander examples of specific production ready Solvers.

Example

#include "TBTK/Model.h"
#include "TBTK/Solver/Solver.h"
#include "TBTK/Streams.h"
#include "TBTK/TBTK.h"
 
using namespace TBTK;
 
int main(){
    Initialize();
 
    Model model;
    model.setChemicalPotential(10);
    model.setTemperature(300);
 
    Solver::Solver solver;
    solver.setModel(model);
 
    Streams::out << solver.getModel() << "\n";
}

Output

Model
    Temperature: 300K (300 n.u.)
    Chemical potential: 10eV (10 n.u.)
    Statistics: Fermi-Dirac
    Basis size: Not yet constructed.

Constructor & Destructor Documentation

◆ Solver()

TBTK::Solver::Solver::Solver ( )

Constructs a Solver::Solver.

◆ ~Solver()

virtual TBTK::Solver::Solver::~Solver ( )

virtual

Destructor.

Member Function Documentation

◆ getModel() [1/2]

const Model & TBTK::Solver::Solver::getModel ( )

inline

Get model.

Returns: The Model that the Solver is solving.

◆ getModel() [2/2]

const Model& TBTK::Solver::Solver::getModel ( ) const

Get model.

Returns: The Model that the Solver is solving.

◆ setModel()

void TBTK::Solver::Solver::setModel ( Model & model )

inlinevirtual

Set model to solve.

Parameters

model The Model that is to be solved.

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

/TBTK/Lib/include/TBTK/Solver/Solver.h

Public Member Functions