A class responsible for the Peierls and gauge transformations.
More...
|
Property | eta |
| The strength of the magnetic field for the built-in vector potentials. More...
|
|
Property | gauge |
| String containing the name of the built-in gauge ('LandauX', 'LandauY'). More...
|
|
Property | Opt |
| An instance of structure Opt. More...
|
|
Property | Vectorpotential |
| Function handle A = f( x,y) of the vector potential to be used in the calculations (A is a N x 2 vector, where N is the number of the points given by the x and y coordinates.) More...
|
|
A class responsible for the Peierls and gauge transformations.
Definition at line 24 of file Peierls.m.
◆ Peierls()
Constructor of the class.
- Parameters
-
Opt | An instance of the structure Opt. |
varargin | Cell array of optional parameters. For details see InputParsing. |
- Returns
- An instance of the class
◆ BadInputType()
static function Messages::BadInputType |
( |
variable |
, |
|
|
type |
|
|
) |
| |
|
staticinherited |
Throws a "bad input type" warning, with using the default value.
- Parameters
-
variable | A string conatining the name of the variable. |
type | A string describing the desired type. |
◆ BadInputTypeNoDefault()
static function Messages::BadInputTypeNoDefault |
( |
variable |
, |
|
|
type |
|
|
) |
| |
|
staticinherited |
Throws a "bad input type" warning without setting it to default.
- Parameters
-
variable | A string conatining the name of the variable. |
type | A string describing the desired type. |
◆ CreateClone()
Creates a clone of the present object.
- Returns
- Returns with the cloned object.
◆ CreateHandleForVectorpotential()
function Peierls::CreateHandleForVectorpotential |
( |
| ) |
|
|
protected |
Creates function handles for in-built Vector potentials in a gauge given by attribute Opt.gauge.
- Returns
- Returns A function handle
◆ display()
function Messages::display |
( |
message |
, |
|
|
nosilent |
|
|
) |
| |
|
inherited |
Displays output messages on the screen.
- Parameters
-
message | String containing the message to be displayed |
nosilent | Set true to override the silent option given in Opt.Silent. |
◆ ExceedIteration()
static function Messages::ExceedIteration |
( |
| ) |
|
|
staticinherited |
Throws an "iteration exceeded" warning.
◆ gaugeTransformation()
Algorithm to perform gauge transformation on Green's function and/or on Hamiltonian.
- Parameters
-
mtx | The matrix of the Green's function or the Hamiltonian. |
coordinates | An instance of structure #coordinates containing the site coordinates |
gauge_field | Function handle S = f( x,y) of the gauge transformation. (S is a N x 1 vector, where N is the number of the points given by the x and y coordinates.) |
- Returns
- Returns with the transformaed matrix.
◆ gaugeTransformationOnLead()
Algorithm to perform gauge transformation in the Hamiltonians of a lead.
The transformed matrices are stored within the input class.
- Parameters
-
Lead | An instance of class CreateLeadHamiltonians (or a derived class) |
gauge_field | Function handle S = f( x,y) of the gauge transformation. (S is a N x 1 vector, where N is the number of the points given by the x and y coordinates.) |
◆ getOpt()
Retrives the structure containing the calculation parameters.
- Returns
- Return an instance of structure Opt.
◆ InputParsing()
function Peierls::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): |
'Vectorpotential' | Function handle A = f( x,y) of the vector potential to be used in the calculations (A is a N x 2 vector, where N is the number of the points given by the x and y coordinates.) |
◆ Peierls_phase()
function Peierls::Peierls_phase |
( |
startpoint |
, |
|
|
endpoint |
|
|
) |
| |
|
protected |
Calculates the Peierls phase along bonds.
- Parameters
-
- Returns
- Returns with the peierls phases
◆ PeierlsTransform()
function Peierls::PeierlsTransform |
( |
CreateH |
| ) |
|
◆ PeierlsTransformLeads()
Algorithm to perform Peierls transformation in the Hamiltonians of the leads.
- Parameters
-
◆ setVectorPotential()
function Peierls::setVectorPotential |
( |
vectorpot |
| ) |
|
Use to set the handle for the vector potential.
- Parameters
-
vectorpot | Function handle A = f( x,y) of the vector potential to be used in the calculations (A is a N x 2 vector, where N is the number of the points given by the x and y coordinates.) |
◆ x_temp()
function Peierls::x_temp |
( |
y |
, |
|
|
startpoint |
, |
|
|
endpoint |
|
|
) |
| |
|
protected |
◆ y_temp()
function Peierls::y_temp |
( |
x |
, |
|
|
startpoint |
, |
|
|
endpoint |
|
|
) |
| |
|
protected |
◆ eta
The strength of the magnetic field for the built-in vector potentials.
Definition at line 34 of file Peierls.m.
◆ gauge
String containing the name of the built-in gauge ('LandauX', 'LandauY').
Definition at line 31 of file Peierls.m.
◆ Opt
◆ Vectorpotential
Property Peierls::Vectorpotential |
|
protected |
Function handle A = f( x,y) of the vector potential to be used in the calculations (A is a N x 2 vector, where N is the number of the points given by the x and y coordinates.)
Definition at line 37 of file Peierls.m.
The documentation for this class was generated from the following file: