Copyright (C) 2016 Peter Rakyta, Ph.D.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.
Description
A class describing the Fermi Dirac distribution of fermionic particles.
Syntax
object = FermiDirac( varargin )
Parameters |
varargin
|
Optional parameters given by a sequence ...'name', value,... . Possible parameters are:
T The temperature in Kelvin (scalar or an array of temperature values).
|
Attributes (protected)
k_B
Boltzmann constant in eV/K.
T
The temperature in Kelvin.
beta
1/(k_B*T).
Methods (public)
Methods (private)
FermiDirac::Fermi
Description
Calculates the Fermi distribution.
Syntax
ret = object.Fermi( E )
Parameters |
E
|
The energy value in eV (scalar or an array of energy values).
|
Return |
ret
|
The calculated Fermi distribution values.
|
FermiDirac::setTemperature
Description
Set the temperature for the calculations.
Syntax
ret = object.setTemperature( T )
Parameters |
T
|
The temperature in Kelvin (scalar or an array)
|
FermiDirac::InputParsing
Description
Parses the optional parameters for the class constructor.
Syntax
object.InputParsing(varargin)
Parameters |
varargin
|
Optional parameters given by a sequence ...'name', value,... . Possible parameters are:
T The temperature in Kelvin (scalar or an array of temperature values).
|