param_Lead_DFT.m

Go to the documentation of this file.

%%    Eotvos Quantum Transport Utilities - param_Lead_DFT
%    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 param_Lead_DFT.m
%> @brief Base class to construct a structure containing physical parameters of a specific lead for DFT calculations.
%> @} 
%> @brief Base class to construct a structure containing physical parameters of a specific lead for DFT calculations.
%> @Available
%> EQuUs v4.9.145 or later
%%
classdef param_Lead_DFT

    properties
        %> The superconducting pair potential
        pair_potential
        %> An instance of structure @shape describing the geometry of the scattering region. 
        FileName
        %> Cell array of structure @Atom. 
        Atom
        %> A physical parameter, see the individual lattice documentations for details
        vargamma_sc
          %> Orientation of the lead. Set to +1 (default) if the propagating direction of the states heading to the central device is defined in the +x or +y direction, and "-1" otherwise.
        Lead_Orientation
        %> The number of regular sites in the cross section of one unit cell in the lead.
        M
        %> Coordinates of the atoms
        coordinates
        %> Whether to use a separate calculation for the Lead (Useful to decrease the size of the system)
        Use_External_Lead
        %> In case of external Leads the Fermi energy might differ
        E_Fermi
    end



methods (Access=public)
    
%% Contructor of the class
%> @brief Constructor of the class.
%> @return An instance of the class
    function obj = param_Lead_DFT() 
        
        % initializing class members
        obj.pair_potential = [];
        obj.FileName = [];
        obj.Atom = [];
        obj.vargamma_sc = [];
        obj.Lead_Orientation = 1;
        obj.M = []; 
        obj.Use_External_Lead = 0;
        
    end
    
%% CopyParameters
%> @brief Copy the attributes of the input structure into the present object.
%> @param An instance of class identical to the present class or its superclass.
%> @return Returns with the modified class
    function obj = CopyParameters(obj, param_lead_in ) 
        
        % checking the type of the class
        class_type_obj = class( obj );
        class_type_input = class( param_lead_in );
        
        if ~strcmpi( class_type_input, class_type_obj )        
            supClasses = superclasses(obj);
            if sum( strcmp( supClasses, class_type_input ) ) == 0
                error(['EQuUs:Structures:', class(obj), ':CopyParameters'], 'Invalid type of the input parameter');
            end            
        end
        
        % copy the attribute from the input
        fieldnames_input = fieldnames( param_lead_in );
        for idx = 1:length(fieldnames_input)
            fieldname = fieldnames_input{idx};
            obj.(fieldname) = param_lead_in.(fieldname);
        end
        
    end        

    
end % public methods end

end