Coordinates Class Reference

Structure containing the coordinates and other quantum number identifiers of the sites in the Hamiltonians. More...

Public Member Functions
function	Combine (cCoordinates)
	Combines the present structure with the instance given as an input. More...
function	Coordinates ()
	Constructor of the class. More...
function	KeepSites (indexes)
	Keep only sites in the structure defined by the input parameter #indexes. More...
function	RemoveSites (indexes)
	Removes sites from the structure. More...
function	Shift (shift_vector)
	Combines the present structure with the instance given as an input. More...
function	Transform2BdG ()
	Transforms sthe structure into the BdG model in the Nambu space representation. More...

Public Attributes
Property	a
	The lattice vector of the translational invariant lead in units of the lattice constant. More...
Property	b
	The lattice vector in the transverse direction in units of the lattice constant. More...
Property	BdG_u
	Array of logicals. Used in the Bogoliubov de Gennes Hamiltonians. Values "true" gives sites corresponding to the "u" component of the wave function, and values "false" stand for the sites of the "v" component of the wave function. More...
Property	LatticeConstant
	Units of length. More...
Property	OrbitalTypes
	Cell array containing the orbital types of the sites. More...
Property	spinup
	Array of logicals. Used in system including a spin degree of freedom. Values "true" gives sites with spin up, and values "false" stand for the spin down sites. More...
Property	x
	A vector containing the $x$ coordinates of the sites in units of the lattice constant. More...
Property	y
	A vector containing the $y$ coordinates of the sites in units of the lattice constant. More...
Property	z
	A vector containing the $z$ coordinates of the sites in units of the lattice constant. More...

Detailed Description

Structure containing the coordinates and other quantum number identifiers of the sites in the Hamiltonians.

Definition at line 24 of file Coordinates.m.

Constructor & Destructor Documentation

Coordinates()

function Coordinates::Coordinates

(

)

Constructor of the class.

Returns

An instance of the class

Member Function Documentation

Combine()

function Coordinates::Combine

(

cCoordinates

)

Combines the present structure with the instance given as an input.

Parameters

cCoordinates

An instance of a structure to be combined with.

Returns

Returns with the combinied structure

KeepSites()

function Coordinates::KeepSites

(

indexes

)

Keep only sites in the structure defined by the input parameter #indexes.

Parameters

indexes

Logical array. Sites with true values will be kept in the structure.

Returns

Returns with the modified structure

RemoveSites()

function Coordinates::RemoveSites

(

indexes

)

Removes sites from the structure.

Parameters

indexes

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

Returns

Returns with the modified structure

Shift()

function Coordinates::Shift

(

shift_vector

)

Combines the present structure with the instance given as an input.

Parameters

shift_vector

A two- or three component vector describing the coordinate shift.

Returns

Returns with the shifted structure

Transform2BdG()

function Coordinates::Transform2BdG

(

)

Transforms sthe structure into the BdG model in the Nambu space representation.

Returns

Returns with the transformed instance of the structure

Member Data Documentation

a

Property Coordinates::a

The lattice vector of the translational invariant lead in units of the lattice constant.

Definition at line 39 of file Coordinates.m.

b

Property Coordinates::b

The lattice vector in the transverse direction in units of the lattice constant.

Definition at line 42 of file Coordinates.m.

BdG_u

Property Coordinates::BdG_u

Array of logicals. Used in the Bogoliubov de Gennes Hamiltonians. Values "true" gives sites corresponding to the "u" component of the wave function, and values "false" stand for the sites of the "v" component of the wave function.

Definition at line 54 of file Coordinates.m.

LatticeConstant

Property Coordinates::LatticeConstant

Units of length.

Definition at line 45 of file Coordinates.m.

OrbitalTypes

Property Coordinates::OrbitalTypes

Cell array containing the orbital types of the sites.

Definition at line 48 of file Coordinates.m.

spinup

Property Coordinates::spinup

Array of logicals. Used in system including a spin degree of freedom. Values "true" gives sites with spin up, and values "false" stand for the spin down sites.

Definition at line 51 of file Coordinates.m.

x

Property Coordinates::x

A vector containing the $x$ coordinates of the sites in units of the lattice constant.

Definition at line 30 of file Coordinates.m.

y

Property Coordinates::y

A vector containing the $y$ coordinates of the sites in units of the lattice constant.

Definition at line 33 of file Coordinates.m.

z

Property Coordinates::z

A vector containing the $z$ coordinates of the sites in units of the lattice constant.

Definition at line 36 of file Coordinates.m.

---

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

• Coordinates.m