Favago Transport Programming Interface

Introduction

Interfaces

Data structures

Examples







ws_Ribbon

  Copyright (C) 2009-2015 Peter Rakyta, Ph.D.
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see http://www.gnu.org/licenses/.

Description

Returns a class handle of the workspace for the interface Ribbon.

Syntax

class_handle = ws_Ribbon( )

Attributes
CreateH An instance of interface CreateHamiltonians. Responsible for creating Hamiltonians of the scattering region.
FL_handles An instance of interface Transport_Interface.
Surface_tmp An instance of interface Surface_Green_function. Describes the unit cell of the scattering region.
Surface_interface A list of interfaces Surface_Green_function. Use as interface regions between the leads and scattering region in hexagonal lattice.
PeierlsTransform_Scatter An instance of interface Peierls. Responsible for the Peierls transformation in the scattering region.
PeierlsTransform_Leads An instance of interface Peierls. Responsible for the Peierls transformation in the leads.
gauge_field Function handle $$y=f( coordinates)$$ for the gauge transformation in the scattering region.
transversepotential A function handle $$y=f( coordinates)$$ to calculate the transverse potential in the cross section of the ribbon.
filenameIn Input filename for the xml input structure.
filenameOut Output filename for the xml input structure.
silent Set true for less verboseness, or false otherwise.
width Integer. Gives the number of the atomic sites in the cross section of the ribbon.
height Integer. Gives the height of the ribbon in units of the lattice vector.
phi A vector of pair potential phases in the left (1st) and right (2nd) superconductor
E The energy used in the calculations.
EF The Fermi energy in the units of eV.
q The transverse momentum quantum number.
Surface_tmp An instance of interface Surface_Green_function.
PNpotential The height of the p-n potential across the ribbon in the units of eV.
PNeta The width of the p-n potential step in units of the total width of the ribbon. ($0 less PNeta less 1$)
rCC The site-site distance in units of $\AA$.
h The Planck constant.
qe The elementary charge unit.
tree The xml tree of the input file.