Eötvös Quantum Utilities  v4.9.146
Providing the Horsepowers in the Quantum Realm
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
Peierls Class Reference

A class responsible for the Peierls and gauge transformations. More...

Inheritance diagram for Peierls:
Inheritance graph
[legend]

Public Member Functions

function CreateClone ()
 Creates a clone of the present object. More...
 
function display (message, nosilent)
 Displays output messages on the screen. More...
 
function gaugeTransformation (mtx, coordinates, gauge_field)
 Algorithm to perform gauge transformation on Green's function and/or on Hamiltonian. More...
 
function gaugeTransformationOnLead (Lead, gauge_field)
 Algorithm to perform gauge transformation in the Hamiltonians of a lead. More...
 
function getOpt ()
 Retrives the structure containing the calculation parameters. More...
 
function Peierls (Opt, varargin)
 Constructor of the class. More...
 
function PeierlsTransform (CreateH)
 Algorithm to perform Peierls transformation in Hamiltonian stored in the CreateHamiltonians object. More...
 
function PeierlsTransformLeads (Lead)
 Algorithm to perform Peierls transformation in the Hamiltonians of the leads. More...
 
function setVectorPotential (vectorpot)
 Use to set the handle for the vector potential. More...
 

Static Public Member Functions

static function BadInputType (variable, type)
 Throws a "bad input type" warning, with using the default value. More...
 
static function BadInputTypeNoDefault (variable, type)
 Throws a "bad input type" warning without setting it to default. More...
 
static function ExceedIteration ()
 Throws an "iteration exceeded" warning. More...
 

Protected Member Functions

function CreateHandleForVectorpotential ()
 Creates function handles for in-built Vector potentials in a gauge given by attribute Opt.gauge. More...
 
function InputParsing (varargin)
 Parses the optional parameters for the class constructor. More...
 
function Peierls_phase (startpoint, endpoint)
 Calculates the Peierls phase along bonds. More...
 
function x_temp (y, startpoint, endpoint)
 
function y_temp (x, startpoint, endpoint)
 

Protected Attributes

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...
 

Detailed Description

A class responsible for the Peierls and gauge transformations.

Definition at line 24 of file Peierls.m.

Constructor & Destructor Documentation

◆ Peierls()

function Peierls::Peierls ( Opt  ,
varargin   
)

Constructor of the class.

Parameters
OptAn instance of the structure Opt.
vararginCell array of optional parameters. For details see InputParsing.
Returns
An instance of the class

Member Function Documentation

◆ BadInputType()

static function Messages::BadInputType ( variable  ,
type   
)
staticinherited

Throws a "bad input type" warning, with using the default value.

Parameters
variableA string conatining the name of the variable.
typeA 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
variableA string conatining the name of the variable.
typeA string describing the desired type.

◆ CreateClone()

function Peierls::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
messageString containing the message to be displayed
nosilentSet true to override the silent option given in Opt.Silent.

◆ ExceedIteration()

static function Messages::ExceedIteration ( )
staticinherited

Throws an "iteration exceeded" warning.

◆ gaugeTransformation()

function Peierls::gaugeTransformation ( mtx  ,
coordinates  ,
gauge_field   
)

Algorithm to perform gauge transformation on Green's function and/or on Hamiltonian.

Parameters
mtxThe matrix of the Green's function or the Hamiltonian.
coordinatesAn instance of structure #coordinates containing the site coordinates
gauge_fieldFunction 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()

function Peierls::gaugeTransformationOnLead ( Lead  ,
gauge_field   
)

Algorithm to perform gauge transformation in the Hamiltonians of a lead.

The transformed matrices are stored within the input class.

Parameters
LeadAn instance of class CreateLeadHamiltonians (or a derived class)
gauge_fieldFunction 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()

function Messages::getOpt ( )
inherited

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
vararginCell 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
startpointCoordinates ([x,y]) of the starting points.
endpointCoordinates ([x,y]) of the end points.
Returns
Returns with the peierls phases

◆ PeierlsTransform()

function Peierls::PeierlsTransform ( CreateH  )

Algorithm to perform Peierls transformation in Hamiltonian stored in the CreateHamiltonians object.

Parameters
CreateHAn instance of class CreateHamiltonians (or a derived class).

◆ PeierlsTransformLeads()

function Peierls::PeierlsTransformLeads ( Lead  )

Algorithm to perform Peierls transformation in the Hamiltonians of the leads.

Parameters
LeadAn instance of class CreateLeadHamiltonians (or a derived class)

◆ setVectorPotential()

function Peierls::setVectorPotential ( vectorpot  )

Use to set the handle for the vector potential.

Parameters
vectorpotFunction 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 ( ,
startpoint  ,
endpoint   
)
protected

◆ y_temp()

function Peierls::y_temp ( ,
startpoint  ,
endpoint   
)
protected

Member Data Documentation

◆ eta

Property Peierls::eta
protected

The strength of the magnetic field for the built-in vector potentials.

Definition at line 34 of file Peierls.m.

◆ gauge

Property Peierls::gauge
protected

String containing the name of the built-in gauge ('LandauX', 'LandauY').

Definition at line 31 of file Peierls.m.

◆ Opt

Property Messages::Opt
protectedinherited

An instance of structure Opt.

Definition at line 31 of file Messages.m.

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