A class to import custom Hamiltonians provided by other codes or created manually More...

Inheritance diagram for Custom_Hamiltonians:

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

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

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

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

function	LoadHamiltonians (varargin)
	Obtain the Hamiltonians from the external source. More...

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

function	Reset ()
	Resets all elements in the object. 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
	Cell array of coordinates of the leads. More...

Property	coordinates_scatter
	coordinates of the scattering region More...

Property	CustomHamiltoniansHandle
	Function Handle for the custom Hamiltonians with identical input values as LoadHamiltonians, and output values described in the example Hamiltonians. More...

Property	EF
	The Fermi energy. More...

Property	H0
	Cell array of Hamiltonians of one slab in the leads. More...

Property	H1
	Cell array of couplings between the slabs of the leads. More...

Property	H1_transverse
	Cell array of transverse coupling between the unit cells of the lead. More...

Property	Hamiltonians_loaded
	logical value: true if Hamiltonians are loaded, false otherwise. More...

Property	Hcoupling
	Cell array of couplings between the scattering region and the leads. More...

Property	Hscatter
	Hamiltonian of the scattering region. More...

Property	Hscatter_transverse
	transverse coupling for the scattering region More...

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

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

Property	S0
	Cell array of overlap integrals of one slab in the leads. More...

Property	S1
	Cell array of overlap integrals between the slabs of the leads. More...

Property	S1_transverse
	overlap integrals for the transverse coupling between the unit cells of the lead More...

Property	Scoupling
	Cell array of overlap integrals between the scattering region and the leads. More...

Property	Sscatter
	Overlap integrals of the scattering region. More...

Property	Sscatter_transverse
	overlap integrals for the transverse coupling in the scattering region More...

Property	varargin
	list of optional parameters (see InputParsing for details) More...

Private Member Functions
function	Initialize ()
	Initializes object properties. More...

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

Detailed Description

A class to import custom Hamiltonians provided by other codes or created manually

Available

EQuUs v4.8 or later

Definition at line 26 of file Custom_Hamiltonians.m.

Constructor & Destructor Documentation

◆ Custom_Hamiltonians()

function Custom_Hamiltonians::Custom_Hamiltonians	(	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

◆ 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 Custom_Hamiltonians::Clear ( MemberName )

Clears the value of an attribute in the class.

Parameters

MemberName The name of the attribute to be cleared.

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

◆ Initialize()

function Custom_Hamiltonians::Initialize ( )

private

Initializes object properties.

◆ InputParsing()

function Custom_Hamiltonians::InputParsing ( varargin )

private

Parses the optional parameters for the class constructor.

Parameters

varargin	Optional parameters, see the web documantation.
'EF'	The Fermi energy.
'CustomHamiltoniansHandle'	A function handle for the custom Hamiltonians with identical input values as LoadHamiltonians, and output values described in the example Hamiltonians.

◆ LoadHamiltonians()

function Custom_Hamiltonians::LoadHamiltonians ( varargin )

Obtain the Hamiltonians from the external source.

Parameters

varargin	Cell array of optional parameters (https://www.mathworks.com/help/matlab/ref/varargin.html):
'q'	The transverse momentum quantum number.

◆ Read()

function Custom_Hamiltonians::Read ( MemberName )

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.

◆ Reset()

function Custom_Hamiltonians::Reset ( )

Resets all elements in the object.

◆ Write()

function Custom_Hamiltonians::Write	(	MemberName	,
		input
	)

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 Custom_Hamiltonians::coordinates

protected

Cell array of coordinates of the leads.

Definition at line 72 of file Custom_Hamiltonians.m.

◆ coordinates_scatter

Property Custom_Hamiltonians::coordinates_scatter

protected

coordinates of the scattering region

Definition at line 75 of file Custom_Hamiltonians.m.

◆ CustomHamiltoniansHandle

Property Custom_Hamiltonians::CustomHamiltoniansHandle

protected

Function Handle for the custom Hamiltonians with identical input values as LoadHamiltonians, and output values described in the example Hamiltonians.

Definition at line 84 of file Custom_Hamiltonians.m.

◆ EF

Property Custom_Hamiltonians::EF

protected

The Fermi energy.

Definition at line 81 of file Custom_Hamiltonians.m.

◆ H0

Property Custom_Hamiltonians::H0

protected

Cell array of Hamiltonians of one slab in the leads.

Definition at line 36 of file Custom_Hamiltonians.m.

◆ H1

Property Custom_Hamiltonians::H1

protected

Cell array of couplings between the slabs of the leads.

Definition at line 39 of file Custom_Hamiltonians.m.

◆ H1_transverse

Property Custom_Hamiltonians::H1_transverse

protected

Cell array of transverse coupling between the unit cells of the lead.

Definition at line 42 of file Custom_Hamiltonians.m.

◆ Hamiltonians_loaded

Property Custom_Hamiltonians::Hamiltonians_loaded

protected

logical value: true if Hamiltonians are loaded, false otherwise.

Definition at line 78 of file Custom_Hamiltonians.m.

◆ Hcoupling

Property Custom_Hamiltonians::Hcoupling

protected

Cell array of couplings between the scattering region and the leads.

Definition at line 51 of file Custom_Hamiltonians.m.

◆ Hscatter

Property Custom_Hamiltonians::Hscatter

protected

Hamiltonian of the scattering region.

Definition at line 45 of file Custom_Hamiltonians.m.

◆ Hscatter_transverse

Property Custom_Hamiltonians::Hscatter_transverse

protected

transverse coupling for the scattering region

Definition at line 48 of file Custom_Hamiltonians.m.

◆ Opt

Property Messages::Opt

protectedinherited

An instance of structure Opt.

Definition at line 31 of file Messages.m.

◆ param

Property Custom_Hamiltonians::param

protected

An instance of structure param.

Definition at line 33 of file Custom_Hamiltonians.m.

◆ S0

Property Custom_Hamiltonians::S0

protected

Cell array of overlap integrals of one slab in the leads.

Definition at line 54 of file Custom_Hamiltonians.m.

◆ S1

Property Custom_Hamiltonians::S1

protected

Cell array of overlap integrals between the slabs of the leads.

Definition at line 57 of file Custom_Hamiltonians.m.

◆ S1_transverse

Property Custom_Hamiltonians::S1_transverse

protected

overlap integrals for the transverse coupling between the unit cells of the lead

Definition at line 60 of file Custom_Hamiltonians.m.

◆ Scoupling

Property Custom_Hamiltonians::Scoupling

protected

Cell array of overlap integrals between the scattering region and the leads.

Definition at line 69 of file Custom_Hamiltonians.m.

◆ Sscatter

Property Custom_Hamiltonians::Sscatter

protected

Overlap integrals of the scattering region.

Definition at line 63 of file Custom_Hamiltonians.m.

◆ Sscatter_transverse

Property Custom_Hamiltonians::Sscatter_transverse

protected

overlap integrals for the transverse coupling in the scattering region

Definition at line 66 of file Custom_Hamiltonians.m.

◆ varargin

Property Custom_Hamiltonians::varargin

protected

list of optional parameters (see InputParsing for details)

Definition at line 87 of file Custom_Hamiltonians.m.

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

Custom_Hamiltonians.m

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Available

Constructor & Destructor Documentation

◆ Custom_Hamiltonians()

Member Function Documentation

◆ BadInputType()

◆ BadInputTypeNoDefault()

◆ Clear()

◆ display()

◆ ExceedIteration()

◆ getOpt()

◆ Initialize()

◆ InputParsing()

◆ LoadHamiltonians()

◆ Read()

◆ Reset()

◆ Write()

Member Data Documentation

◆ coordinates

◆ coordinates_scatter

◆ CustomHamiltoniansHandle

◆ EF

◆ H0

◆ H1

◆ H1_transverse

◆ Hamiltonians_loaded

◆ Hcoupling

◆ Hscatter

◆ Hscatter_transverse

◆ Opt

◆ param

◆ S0

◆ S1

◆ S1_transverse

◆ Scoupling

◆ Sscatter

◆ Sscatter_transverse

◆ varargin