Base class to construct a structure containing physical parameters of the scattering region for DFT calculations. More...

Public Member Functions
function	CopyParameters (param_scatter_in)
	Copy the attributes of the input structure into the present object. More...

function	param_scatter_DFT ()
	Constructor of the class. More...

Public Attributes
Property	Atom
	Cell array of structure Atom. More...

Property	coordinates
	Coordinates of the atoms. More...

Property	E_Fermi
	Fermi energy from the calculation that gave us the Hamiltonian (e.g.: DFT) More...

Property	ElementNumber
	Number of the element in the periodic table. More...

Property	ElementSymbol
	The chemical symbol of the atom. More...

Property	FileName
	String containing the filename of the external Hamiltonain source (see Custom_Hamiltonians for details) More...

Property	LatticeVectors
	Lattice vectors of the bulk structure if it is one. More...

Property	nspin
	The number of spins in the representations: More...

Property	pair_potential
	The superconducting pair potential. More...

Property	shape
	An instance of structure shape describing the geometry of the scattering region. More...

Detailed Description

Base class to construct a structure containing physical parameters of the scattering region for DFT calculations.

Available

EQuUs v4.9.145 or later

Definition at line 26 of file param_scatter_DFT.m.

Constructor & Destructor Documentation

◆ param_scatter_DFT()

function param_scatter_DFT::param_scatter_DFT ( )

Constructor of the class.

Returns: An instance of the class

Member Function Documentation

◆ CopyParameters()

function param_scatter_DFT::CopyParameters ( param_scatter_in )

Copy the attributes of the input structure into the present object.

Parameters

An	instance of class identical to the present class or its superclass.

Returns: Returns with the modified class

Member Data Documentation

◆ Atom

Property param_scatter_DFT::Atom

Cell array of structure Atom.

Definition at line 41 of file param_scatter_DFT.m.

◆ coordinates

Property param_scatter_DFT::coordinates

Coordinates of the atoms.

Definition at line 63 of file param_scatter_DFT.m.

◆ E_Fermi

Property param_scatter_DFT::E_Fermi

Fermi energy from the calculation that gave us the Hamiltonian (e.g.: DFT)

Definition at line 44 of file param_scatter_DFT.m.

◆ ElementNumber

Property param_scatter_DFT::ElementNumber

Number of the element in the periodic table.

Definition at line 47 of file param_scatter_DFT.m.

◆ ElementSymbol

Property param_scatter_DFT::ElementSymbol

The chemical symbol of the atom.

Definition at line 50 of file param_scatter_DFT.m.

◆ FileName

Property param_scatter_DFT::FileName

String containing the filename of the external Hamiltonain source (see Custom_Hamiltonians for details)

Definition at line 38 of file param_scatter_DFT.m.

◆ LatticeVectors

Property param_scatter_DFT::LatticeVectors

Lattice vectors of the bulk structure if it is one.

Definition at line 53 of file param_scatter_DFT.m.

◆ nspin

Property param_scatter_DFT::nspin

The number of spins in the representations:

Definition at line 60 of file param_scatter_DFT.m.

◆ pair_potential

Property param_scatter_DFT::pair_potential

The superconducting pair potential.

Definition at line 32 of file param_scatter_DFT.m.

◆ shape

Property param_scatter_DFT::shape

An instance of structure shape describing the geometry of the scattering region.

Definition at line 35 of file param_scatter_DFT.m.

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

param_scatter_DFT.m

Public Member Functions

Public Attributes