A class to handle the Hamiltonian of the central region in Keldysh formalism. More...

Inheritance diagram for CreateHamiltonians_Keldysh:

[legend]

Public Member Functions
function	ApplyOverlapMatrices (E)
	Applies the overlap matrices to the Hamiltonians: K = H-ES. More...

function	Clear (MemberName)
	Clears the value of an attribute in the class. More...

function	CreateClone (varargin)
	Creates a clone of the present class. More...

function	CreateHamiltonians_Keldysh (Opt, param, varargin)
	Constructor of the class. More...

function	CreateScatterH (varargin)
	Creates a Hamiltonian of a rectangle shaped area. More...

function	display (message, nosilent)
	Displays output messages on the screen. More...

function	getOpt ()
	Retrives the structure containing the calculation parameters. More...

function	loadScatter (filename)
	Loads the Hamiltonian and other data of the scattering region from a file. More...

function	projectHamiltonian2Spin (s)
	Projects the Hamiltonian to a spin states of $s=\pm1$. More...

function	Read (MemberName)
	Query for the value of an attribute in the class. More...

function	RemoveSites (indexes)
	Removes specific sites from the model of the scattering region. More...

function	Reset ()
	Resets all elements in the class. More...

function	saveScatter (filename)
	Saves the Hamiltonian and other data of the scattering region. More...

function	shiftFermiEnergy (Energy)
	Shifts the on-site energies in the Scattering region by a given energy. More...

function	Write (MemberName, input)
	Sets the value of an attribute in the class. 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 Attributes
Property	coordinates
	An instance of the structure coordinates. More...

Property	fazis_mtx_scatter
	The matrix of the Peierls phases. More...

Property	fazis_mtx_scatter_t
	The matrix of the Peierls phases for the transverse coupling. More...

Property	GaugeTransformationApplied
	A logical value. True if a gauge transformation was applied on the Hamiltonians, or false otherwise. More...

Property	HamiltoniansCreated
	A logical value. True if the Hamiltonian was created, false otherwise. More...

Property	HamiltoniansDecimated
	A logical value. True if the Hamiltonian was decimated, or false otherwise. More...

Property	height
	The length of the scattering region in units of the lattice contant. More...

Property	Hscatter
	The matrix of the Hamiltonian. More...

Property	Hscatter_transverse
	The matrix of the Hamiltonian corresponding to the transverse coupling. More...

Property	Kscatter
	Hscatter - E*Sscatter. More...

Property	Kscatter_transverse
	Hscatter_transverse - E*Sscatter_transverse. More...

Property	kulso_szabfokok
	A list of the sites to be kept after decimation. More...

Property	M
	The number of sites in one unit cell. More...

Property	MagneticFieldApplied
	A logical value. True if the vector potential was incorporated into the Hamiltonian or false otherwise. More...

Property	Opt
	An instance of structure Opt. More...

Property	OverlapApplied
	A logical value. True if the overlap integrals were applied, false otherwise. More...

Property	param
	An instance of structure param. More...

Property	q
	A transverse momentum. More...

Property	Sscatter
	The matrix of the overlap integrals in the Hamiltonian. More...

Property	Sscatter_transverse
	The matrix of the overlap integrals for the transverse coupling. More...

Property	varargin
	list of optional parameters (see http://www.mathworks.com/help/matlab/ref/varargin.html for details) More...

Property	width
	The number of sites in the cross section. More...

Detailed Description

A class to handle the Hamiltonian of the central region in Keldysh formalism.

Available

EQuUs v4.9 or later

Definition at line 26 of file CreateHamiltonians_Keldysh.m.

Constructor & Destructor Documentation

◆ CreateHamiltonians_Keldysh()

function CreateHamiltonians_Keldysh::CreateHamiltonians_Keldysh	(	Opt	,
		param	,
		varargin
	)

Constructor of the class.

Parameters

Opt	An instance of the structure Opt.
param	An instance of structure param.
varargin	Cell array of optional parameters. For details see InputParsing.

Returns: An instance of the class

Member Function Documentation

◆ ApplyOverlapMatrices()

function CreateHamiltonians::ApplyOverlapMatrices ( E )

inherited

Applies the overlap matrices to the Hamiltonians: K = H-ES.

Parameters

E	The energy value.

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

◆ Clear()

function CreateHamiltonians::Clear ( MemberName )

inherited

Clears the value of an attribute in the class.

Parameters

MemberName The name of the attribute to be cleared.

◆ CreateClone()

function CreateHamiltonians::CreateClone ( varargin )

inherited

Creates a clone of the present class.

Parameters

varargin	Cell array of optional parameters (https://www.mathworks.com/help/matlab/ref/varargin.html):
'empty'	Set true to create an empty clone, or false (default) to clone all atributes.

Returns: Returns with the cloned object.

◆ CreateScatterH()

function CreateHamiltonians::CreateScatterH ( varargin )

inherited

Creates a Hamiltonian of a rectangle shaped area.

The created Hamiltonian and coordinates are stored within the object.

Parameters

varargin	Cell array of optional parameters:
'Scatter_UC'	An instance of class CreateLeadHamiltonians or its subclass
'CustomHamiltonian'	An instance of class Custom_Hamiltonians for external Hamiltonian source.

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

◆ getOpt()

function Messages::getOpt ( )

inherited

Retrives the structure containing the calculation parameters.

Returns: Return an instance of structure Opt.

◆ loadScatter()

function CreateHamiltonians::loadScatter ( filename )

inherited

Loads the Hamiltonian and other data of the scattering region from a file.

Parameters

filename The string containing the path to the file. (In octave use absolute paths only)

◆ projectHamiltonian2Spin()

function CreateHamiltonians::projectHamiltonian2Spin ( s )

inherited

Projects the Hamiltonian to a spin states of $s=\pm1$.

Parameters

s	The quantum index of the spin (\pm1)

◆ Read()

function CreateHamiltonians::Read ( MemberName )

inherited

Query for the value of an attribute in the class.

Parameters

MemberName The name of the attribute to be set.

Returns: Returns with the value of the attribute.

◆ RemoveSites()

function CreateHamiltonians::RemoveSites ( indexes )

inherited

Removes specific sites from the model of the scattering region.

For example see function ScatterPotQD.

Parameters

indexes Logical array. Sites with true values will be removed from the system.

◆ Reset()

function CreateHamiltonians::Reset ( )

inherited

Resets all elements in the class.

◆ saveScatter()

function CreateHamiltonians::saveScatter ( filename )

inherited

Saves the Hamiltonian and other data of the scattering region.

Parameters

filename The string containing the path to the file. (In octave use absolute paths only)

◆ shiftFermiEnergy()

function CreateHamiltonians::shiftFermiEnergy ( Energy )

inherited

Shifts the on-site energies in the Scattering region by a given energy.

Parameters

Energy The energy value to be used.

◆ Write()

function CreateHamiltonians::Write	(	MemberName	,
		input
	)

inherited

Sets the value of an attribute in the class.

Parameters

MemberName	The name of the attribute to be set.
input	The value to be set.

Member Data Documentation

◆ coordinates

Property CreateHamiltonians::coordinates

protectedinherited

An instance of the structure coordinates.

Definition at line 61 of file CreateHamiltonians.m.

◆ fazis_mtx_scatter

Property CreateHamiltonians::fazis_mtx_scatter

protectedinherited

The matrix of the Peierls phases.

Definition at line 55 of file CreateHamiltonians.m.

◆ fazis_mtx_scatter_t

Property CreateHamiltonians::fazis_mtx_scatter_t

protectedinherited

The matrix of the Peierls phases for the transverse coupling.

Definition at line 58 of file CreateHamiltonians.m.

◆ GaugeTransformationApplied

Property CreateHamiltonians::GaugeTransformationApplied

protectedinherited

A logical value. True if a gauge transformation was applied on the Hamiltonians, or false otherwise.

Definition at line 85 of file CreateHamiltonians.m.

◆ HamiltoniansCreated

Property CreateHamiltonians::HamiltoniansCreated

protectedinherited

A logical value. True if the Hamiltonian was created, false otherwise.

Definition at line 73 of file CreateHamiltonians.m.

◆ HamiltoniansDecimated

Property CreateHamiltonians::HamiltoniansDecimated

protectedinherited

A logical value. True if the Hamiltonian was decimated, or false otherwise.

Definition at line 76 of file CreateHamiltonians.m.

◆ height

Property CreateHamiltonians::height

protectedinherited

The length of the scattering region in units of the lattice contant.

Definition at line 64 of file CreateHamiltonians.m.

◆ Hscatter

Property CreateHamiltonians::Hscatter

protectedinherited

The matrix of the Hamiltonian.

Definition at line 43 of file CreateHamiltonians.m.

◆ Hscatter_transverse

Property CreateHamiltonians::Hscatter_transverse

protectedinherited

The matrix of the Hamiltonian corresponding to the transverse coupling.

Definition at line 46 of file CreateHamiltonians.m.

◆ Kscatter

Property CreateHamiltonians::Kscatter

protectedinherited

Hscatter - E*Sscatter.

Definition at line 37 of file CreateHamiltonians.m.

◆ Kscatter_transverse

Property CreateHamiltonians::Kscatter_transverse

protectedinherited

Hscatter_transverse - E*Sscatter_transverse.

Definition at line 40 of file CreateHamiltonians.m.

◆ kulso_szabfokok

Property CreateHamiltonians::kulso_szabfokok

protectedinherited

A list of the sites to be kept after decimation.

Definition at line 34 of file CreateHamiltonians.m.

◆ M

Property CreateHamiltonians::M

protectedinherited

The number of sites in one unit cell.

Definition at line 70 of file CreateHamiltonians.m.

◆ MagneticFieldApplied

Property CreateHamiltonians::MagneticFieldApplied

protectedinherited

A logical value. True if the vector potential was incorporated into the Hamiltonian or false otherwise.

Definition at line 82 of file CreateHamiltonians.m.

◆ Opt

Property Messages::Opt

protectedinherited

An instance of structure Opt.

Definition at line 31 of file Messages.m.

◆ OverlapApplied

Property CreateHamiltonians::OverlapApplied

protectedinherited

A logical value. True if the overlap integrals were applied, false otherwise.

Definition at line 79 of file CreateHamiltonians.m.

◆ param

Property CreateHamiltonians::param

protectedinherited

An instance of structure param.

Definition at line 31 of file CreateHamiltonians.m.

◆ q

Property CreateHamiltonians::q

protectedinherited

A transverse momentum.

Definition at line 88 of file CreateHamiltonians.m.

◆ Sscatter

Property CreateHamiltonians::Sscatter

protectedinherited

The matrix of the overlap integrals in the Hamiltonian.

Definition at line 49 of file CreateHamiltonians.m.

◆ Sscatter_transverse

Property CreateHamiltonians::Sscatter_transverse

protectedinherited

The matrix of the overlap integrals for the transverse coupling.

Definition at line 52 of file CreateHamiltonians.m.

◆ varargin

Property CreateHamiltonians::varargin

protectedinherited

list of optional parameters (see http://www.mathworks.com/help/matlab/ref/varargin.html for details)

Definition at line 91 of file CreateHamiltonians.m.

◆ width

Property CreateHamiltonians::width

protectedinherited

The number of sites in the cross section.

Definition at line 67 of file CreateHamiltonians.m.

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

CreateHamiltonians_Keldysh.m

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Available

Constructor & Destructor Documentation

◆ CreateHamiltonians_Keldysh()

Member Function Documentation

◆ ApplyOverlapMatrices()

◆ BadInputType()

◆ BadInputTypeNoDefault()

◆ Clear()

◆ CreateClone()

◆ CreateScatterH()

◆ display()

◆ ExceedIteration()

◆ getOpt()

◆ loadScatter()

◆ projectHamiltonian2Spin()

◆ Read()

◆ RemoveSites()

◆ Reset()

◆ saveScatter()

◆ shiftFermiEnergy()

◆ Write()

Member Data Documentation

◆ coordinates

◆ fazis_mtx_scatter

◆ fazis_mtx_scatter_t

◆ GaugeTransformationApplied

◆ HamiltoniansCreated

◆ HamiltoniansDecimated

◆ height

◆ Hscatter

◆ Hscatter_transverse

◆ Kscatter

◆ Kscatter_transverse

◆ kulso_szabfokok

◆ M

◆ MagneticFieldApplied

◆ Opt

◆ OverlapApplied

◆ param

◆ q

◆ Sscatter

◆ Sscatter_transverse

◆ varargin

◆ width