test_CreateHamiltonians.m

Go to the documentation of this file.

%%   Eotvos Quantum Transport Utilities
%    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 unit_tests Unit Tests
%> @{
%> @file test_CreateHamiltonians.m
%> @brief Testfile to check functionalities of the class CreateHamiltonians.
%> @Available
%> EQuUs v4.8.... or later
%> @}
%> @brief Testfile to check functionalities of the class CreateHamiltonians.
function test_CreateHamiltonians()

filename = mfilename('fullpath');
[directory, fncname] = fileparts( filename );

    % create input structures
    [Opt, param] = parseInput( 'Input_Ribbon.xml');
    
    % adjusting the shape of the scattering region
    param.scatter.shape.width = 200;
    param.scatter.shape.height = 400;
    
    % creating class CreateHamiltonians
    cCreateHamiltonians = CreateHamiltonians( Opt, param );
    
    %% test of method of removing indexes from the Hamiltonian
    disp( '***** test of class Ribbon_Keldysh, Transport_Interface_Keldysh *****' );    
    
    % creating the Hamiltonian of the scattering region
    cCreateHamiltonians.CreateScatterH()
    
    % retriving the created Hamiltonian
    Hscatter0 = cCreateHamiltonians.Read('Hscatter');
    
    % defining a circle shaped area that should be removed from the Hamiltonian
    cCircle = structures('circle');
    cCircle.radius = 30;
    cCircle.center.x = param.scatter.shape.width/2;
    cCircle.center.y = param.scatter.shape.height/2;
    
    % determine indexes that should be removed
    cCoordinates0 = cCreateHamiltonians.Read('coordinates');
    indexes = (cCoordinates0.x - cCircle.center.x).^2 + (cCoordinates0.y - cCircle.center.y).^2 < cCircle.radius^2;
    
    % removing sites from the Hamiltonian
    cCreateHamiltonians.RemoveSites( indexes )
    
    % checking the number of remaininng sites
    Hscatter = cCreateHamiltonians.Read('Hscatter');
    
    size_Hscatter0 = size(Hscatter0);
    size_Hscatter = size(Hscatter);
    
    checkpoint = norm( size_Hscatter0 - size_Hscatter - length(find(indexes))*[1 1] );
    if checkpoint > 1e-10
        warning(['EQuUs:Tests:', fncname, ':checkpoint failed with error ', num2str( checkpoint)]);
    end
    
    % checking the structure Coordinates
    cCoordinates = cCreateHamiltonians.Read('coordinates');
    checkpoint = norm( length(cCoordinates0.x) - length(cCoordinates.x) - length(find(indexes)) );
    if checkpoint > 1e-10
        warning(['EQuUs:Tests:', fncname, ':checkpoint failed with error ', num2str( checkpoint)]);
    end

end