Lattice_SSH.m

Go to the documentation of this file.

%%    Eotvos Quantum Transport Utilities - Lattice_SSH
%    Copyright (C) 2018 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/.
%
%> @addtogroup structures Structures
%> @{
%> @file Lattice_SSH.m
%> @brief Class containing physical parameters of the SSH lattice.
%> @} 
%> @brief Class containing physical parameters of the SSH lattice.
%> @Available
%> EQuUs v4.9 or later
%%
classdef Lattice_SSH

    properties
        %> On-site energy
        epsilon
        %> The firts alternating nearest neighbour hopping parameter
        vargamma1
        %> The second alternating nearest neighbour hopping parameter
        vargamma3
        %> on-site energy difference between sublattices A and B
        deltaAB
    end



methods (Access=public)
    
%% Contructor of the class
%> @brief Constructor of the class.
%> @return An instance of the class
    function obj = Lattice_SSH() 
        
        % initializing class members
        obj.epsilon = 0;
        obj.vargamma1 = 1;
        obj.vargamma3 = 1;
        obj.deltaAB = 0;
        
    end

    
end % public methods end

end