FermiDirac Class Reference

A class describing the Fermi Dirac distribution of fermionic particles. More...

Inheritance diagram for FermiDirac:

Public Member Functions
function	Fermi (E)
	A function of the Fermi-Dirac statistics. More...
function	FermiDirac (varargin)
	A constructor of the class. More...
function	setTemperature (T)
	Sets the temperature for the calculations. More...

Protected Member Functions
function	InputParsing (varargin)
	Parses the optional parameters for the class constructor. More...

Protected Attributes
Property	beta
	More...
Property	k_B
	Boltzmann constant in eV/K. More...
Property	mu
	The Chemical potential in the same unit as other energy scales in the Hamiltonians. More...
Property	T
	The temperature in Kelvin. More...
Property	T_treshold
	treshold temperature (makes difference between T=0 and T>0) More...

Detailed Description

A class describing the Fermi Dirac distribution of fermionic particles.

Definition at line 25 of file FermiDirac.m.

Constructor & Destructor Documentation

FermiDirac()

function FermiDirac::FermiDirac

(

varargin

)

A constructor of the class.

Parameters

varargin

Cell array of optional parameters (https://www.mathworks.com/help/matlab/ref/varargin.html), for details see InputParsing.

Returns

Returns with an instance of the class.

Member Function Documentation

Fermi()

function FermiDirac::Fermi

(

E

)

A function of the Fermi-Dirac statistics.

Parameters

E	The energy value in eV (scalar or an array of energy values).

Returns

Returns with the occupation number (numbers).

InputParsing()

function FermiDirac::InputParsing ( varargin  )

protected

Parses the optional parameters for the class constructor.

Parameters

varargin	Cell array of optional parameters (https://www.mathworks.com/help/matlab/ref/varargin.html):
'T'	The absolute temperature in Kelvins.
'mu'	The Chemical potential in the same unit as other energy scales in the Hamiltonians.

setTemperature()

function FermiDirac::setTemperature

(

T

)

Sets the temperature for the calculations.

Parameters

T	The temperature in Kelvin (scalar or an array)

Member Data Documentation

beta

Property FermiDirac::beta

protected

Definition at line 38 of file FermiDirac.m.

k_B

Property FermiDirac::k_B

protected

Boltzmann constant in eV/K.

Definition at line 32 of file FermiDirac.m.

mu

Property FermiDirac::mu

protected

The Chemical potential in the same unit as other energy scales in the Hamiltonians.

Definition at line 44 of file FermiDirac.m.

T

Property FermiDirac::T

protected

The temperature in Kelvin.

Definition at line 35 of file FermiDirac.m.

T_treshold

Property FermiDirac::T_treshold

protected

treshold temperature (makes difference between T=0 and T>0)

Definition at line 41 of file FermiDirac.m.

---

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

• FermiDirac.m