arpes

Full name: ase2sprkkr.input_parameters.definitions.arpes

Module class hierarchy

Inheritance diagram of ase2sprkkr.input_parameters.definitions.arpes.ArpesInputParametersDefinition


Description

ARPES task input parameters definition

Description of the sections and parameters

ARPES - Angle resolved photoemission spectroscopy

INPUT PARAMETERS arpes contains:
--------------------------------
        SECTION CONTROL (optional) contains:
    ----------------------------------------
        DATASET : String  (optional)      Filename prefix; nonempty ADSI is appended with an underscore for native DATSET outputs.
        SFNFIL : String  (optional, add non-default)  Shape-function file used for full-potential calculations.
        ADSI : _AdsiString ≝ ARPES  (optional)  Filename suffix appended to DATASET with an underscore; empty means no suffix.
        POTFIL : String  (optional)       The potential file (see SPRKKR documentation for its format). It isn't necessary to set it, it will be set by the calculator.
        KRWS : Integer ≝ 1  (optional)    If it is 0, RWS is taken from the potential file and scaled. If 1, RWS is calculated by scaling the muffin-tin radii by a common scaling factor. (This setting is forced in the case of FULLPOT.)
        KRMT : AnyOf(0,1,2,3,4,5,6)  (optional)

            Possible values:
              0                RMT is taken from the potential file
              1                RMT = min( x*RWS )
              2                RMT = min( d_ij / 2 )
              3                RMT from atomic charge density (=> KRWS=1)
              4                RMT from atomic Hartree potential (=> KRWS=1)
              5                RMT from total atomic potential (=> KRWS=1)
              6                take average of 3 and 4 (=> KRWS=1)

            It controls how the muffin-tin radii are calculated.

        PRINT : Integer ≝ 0  (optional)   Verbosity of the output (0-5). Do not affect the results in any way, just the amount of the printed output.
        NONMAG : Flag ≝ False  (optional)  The system considered is non-magnetic. This leads to a higher symmetry and a faster calculation.
        NOSYM : Flag ≝ False  (optional)  Set this flag, if you want to supress all symetry consideration. This leads to a slower calculation.
        NOHFF : Flag ≝ False  (optional)  Disable hyper-fine-field calculation. It's disabled by default for SCF task. TASK.HFF takes precedence.
        FSOHFF : Flag ≝ False  (optional)  Calculate the relativistic decomposition of the hyperfine field into Fermi-contact, spin-dipolar, and orbital contributions. Sets SPLITSS automatically.
        SPLITSS : Flag ≝ False  (optional)  Evaluate single-site contributions on a separate energy contour. GRID and NE must each contain two values.



        SECTION TAU (optional) contains:
    ------------------------------------
        BZINT : AnyOf(POINTS,WEYL,CLUSTER)  (optional)

            Possible values:
              POINTS           special points method
              WEYL             Weyl method
              CLUSTER          Cluster method


            The Weyl method (BZINT=WEYL) is a point sampling method using more or less ran-
            dom points. The number of k-points used for the integration varies quadratically be-
            tween 0.0 and ImE according to the imaginary part of the energy.

            The special point method (BZINT=POINTS) uses a regular k-point grid with NKTAB
            points. It is the standard method and gives a good compromise concerning accuracy
            and efficiency. For BZINT=POINTS the parameter NKTAB will be adjusted to allow a
            regular mesh.


            The mode of BZ-integration used for calculation of the scattering  path operator τ

        NKTAB : Integer ≝ 250  (optional)  Number of points for the special points method
        NKTAB2D : Integer  (optional)     Number of points for the special points method for 2D region of 2D problem
        NKTAB3D : Integer  (optional)     Number of points for the special points method for 3D region of 2D problem
        NKMIN : Integer ≝ 300  (optional)  Minimal number of k-points used for Weyl integration
        NKMAX : Integer ≝ 500  (optional)  Maximal number of k-points used for Weyl integration
        KKRMODE : AnyOf(STANDARD,TB,IMPURITY)  (optional)

        Expert options:
        --------------
            CLUSTER : Flag ≝ False  (optional, expert)  Do cluster type calculation.
            NSHLCLU : Integer  (optional, expert)  Number of atomic shells around the central atom of a cluster
            CLURAD : Real  (optional, expert)  Radius of the cluster in multiples of ALAT.
            IQCNTR : Site  (optional, expert)  The center of the cluster is set at the site position with number IQCNTR of the specified basis.
            ITCNTR : AtomicType  (optional, expert)  The center of the cluster is set at one of the site positions that is occupied by the atomic type ITCNTR.
            NLOUT : Integer ≝ 3  (optional, expert)  The calculated τ -matrix is printed up to lmax=NLOUT.
            MOL : Flag ≝ False  (optional, expert)  Cluster type calculation but for a molecular system. The system is specified as for CLUSTER.



        SECTION ENERGY (optional) contains:
    ---------------------------------------
        GRID : Array(of AnyOf(0,1,2,3,4,5,6,7,8,9,10,11) with length 1<=n<=2) ≝ ['1']  (optional)

            Possible values (aliases in parentheses):
              0                only real energies -- Gauss integration mesh
              1 (REAL)         only real energies -- equidistant path
              2 (RECTANG)      rectangular complex path
              3 (STRAIGHT)     straight complex path parallel to real axis
              4 (RECT-LOG)     rectangular complex grid, return to real axis on log scale
              5 (ARC)          arc in the complex plain
              6 (XAS)          standard X-ray mesh from E_Fermi to 3.5 Ry
              7 (XMOD)         X-ray mesh
              8                arc in the complex plane (logarithim)
              9                arc in the complex plane (Akai's scheme)
              10               ellipse in the complex plain
              11               semi circle (5) plus straight line (3)

            Type of the grid for the energy-mesh

        NE : Array(of Integer with length 1<=n<=2) ≝ [300]  (optional)  Number of points in energy-mesh
        ImE : Energy (<Real> [Ry|eV]) ≝ 0.0 Ry  (optional)
        SPLITSS : Flag ≝ False  (optional)  Evaluate single-site contributions on a separate energy contour. GRID and NE must each contain two values.
        EMIN : Real  (optional)           Minimum of the energy window in Ry (absolute energy)
        EMINEV : Real ≝ -8.0 (if EMIN isn't set)  (optional)  EMIN, given in eV with respect to the Fermi level
        EMAX : Real  (optional)           Maximum of the energy window in Ry (absolute energy)
        EMAXEV : Real ≝ 5.0 (if EMAX isn't set)  (optional)  EMAX, given in eV with respect to the Fermi level
        EWORK_EV : Real ≝ 4.2  (optional)  Work function in eV.
        IMV_INI_EV : Real ≝ 0.05  (optional)  Imaginary part of the potential in eV (initial state)
        IMV_FIN_EV : Real ≝ 2.0  (optional)  Imaginary part of the potential in eV (final state)



        SECTION SITES (optional) contains:
    --------------------------------------
        NL : Array(of Integer) ≝ [4]  (optional)  Angula momentum cutoff (the first discarded l-space)



        SECTION TASK contains:
    --------------------------
        TASK : AnyOf(ARPES,AIPES,SPLEED,BAND) ≝ Default the shared TASK selector from the requested task context.

            Possible values:
              ARPES            Angle resolved photoemission spectroscopy
              AIPES            Angle integrated photoemission spectroscopy
              SPLEED           Spin polarized LEED (experimental feature)
              BAND             band structure calculations (experimental feature)

            Type of the calculation

        IQ_AT_SURF : Site ≝ 1  (optional)
        MILLER_HKL : Array(of Integer of length 3) ≝ [0 0 1]  (optional)
        CRYS_VECS : Flag ≝ False  (optional)  Presence disables primitive crystal vectors for Miller indices in the 3D surface construction.

        Expert options:
        --------------
            STRVER : Integer ≝ 1  (optional, expert, always add)  Set to 0 to supply the ARPES input file 'struc.inp' manually (and do not generate it).
            INPVER : Integer ≝ 1  (optional, expert, always add)  Set to 0 to use an old input.inp from old rslab



        SECTION SPEC_PH (optional) contains:
    ----------------------------------------
        THETA : Real ≝ 45.0  (optional)   Direction of the photon (the polar coordinate)
        PHI : Real ≝ 0.0  (optional)      Direction of the photon (the azimuth coordinate)
        POL_P : AnyOf(P,S,C+,C-) ≝ P  (optional)  Polarization of the light
        EPHOT : Real ≝ 25.0  (optional)   Photon energy in eV

        Expert options:
        --------------
            ALQ : Real ≝ 45.0  (optional, expert)  Alignment of polarization vector or pol.ellipsis
            DELQ : Real ≝ 0.0  (optional, expert)  Phase shift between real and imaginary part of e-vector, delq=90 for circular polarized light
            NPOL : AnyOf(0,1,2,3) ≝ 1  (optional, expert)

                Possible values:
                  0                unpolarized and p-s dichroism for the calculation
                  1                p-pol or rcp or elliptical (depends on icirc, etc.)
                  2                s-pol or lcp or elliptical (depends on icirc, etc.)
                  3                dichroism (ddad, ldad)

                Controls the polarization and dichroism

            ICIRC : AnyOf(0,1,2) ≝ 1  (optional, expert)

                Possible values:
                  0                elliptically pol. light: alq, delq arbitrary
                  1                linear pol. light: alq arbitrary, delq=0
                  2                circular pol. light: alq=45, delq = 90

                controls the polarization and dichroism

            IDREH : AnyOf(0,1,-1) ≝ 0  (optional, expert)

                Possible values:
                  0                linearly polarized (equals icirc=1)
                  1                right circular polarization
                  -1               left circular polarization

                Helicity of the photons

            IFSP : AnyOf(0,1)  (optional, expert)

                Possible values:
                  0                fixed
                  1                variable

                Photon azimuth angle type

            THETA_FIX : Real  (optional, expert)  Light and electrons are at fixed polarization angle



        SECTION SPEC_EL (optional) contains:
    ----------------------------------------
        THETA : Range ≝ SPEC_INPUT defaults differ for photoemission and SPLEED.  (optional)  Scattering angle
        PHI : Range ≝ SPEC_INPUT defaults differ for photoemission and SPLEED.  (optional)  Scattering angle
        NT : Integer ≝ 1  (optional)      Number of angular values for a rotation in polar coordinate.
        NP : Integer ≝ 1  (optional)      Number of angular values for a rotation in azimuth coordinate.
        KA : Range  (optional)            Scatering in momentum space
        K1 : Range  (optional)            Translating vector of the scatering in momentum space
        NK1 : Integer  (optional)         Number of momentum steps for the integration
        K2 : Range  (optional)            Translating vector 2 of the scatering in momentum space
        NK2 : Integer  (optional)         Number of momentum steps 2 for the integration
        K3 : Range  (optional)            Translating vector 3 of the scatering in momentum space
        NK3 : Integer  (optional)         Number of momentum steps 3 for the integration
        K4 : Range  (optional)            Translating vector 4 of the scatering in momentum space
        NK4 : Integer  (optional)         Number of momentum steps 4 for the integration
        POL_E : FixedValue(PZ) ≝ PZ  (optional)
        SPOL : Integer  (optional)
        PSPIN : Array(of Real of length 3)  (optional)
        BETA1 : Real  (optional)          Begin of the rotation
        BETA2 : Real  (optional)          End of the rotation
        ROTAXIS : Array(of Integer of length 3)  (optional)  Axis of the rotation

        Expert options:
        --------------
            TYP : AnyOf(0,1,2,3,4) ≝ 1  (optional, expert)

                Possible values:
                  0                i(e) diagram
                  1                rotation diagram -> phi scan
                  2                scattering-angle diagram -> theta scan
                  3                orthonormal projection
                  4                stereographic projection

                3,4 only for angular resolved
                pe (ups, xps) note: nt=np-> nx,ny

                Crystal coordinats in splout, xpsrun, or upsrun

            ISTR : Array(of Integer of length 2) ≝ [0 0]  (optional, expert)  beam number (h,k)
            POL0 : Array(of Integer of length 3) ≝ [0 0 0]  (optional, expert)  initial pol.
            POL0L : Array(of Integer of length 3) ≝ [0 0 0]  (optional, expert)  initial pol. in the laboratory system
            Q1 : Complex ≝ (1+0j)  (optional, expert)  Amplitude 1 of the photoelectron used in spin polarized calculations
            Q2 : Complex ≝ 0j  (optional, expert)  Amplitude 2 of the photoelectron used in spin polarized calculations
            Q3 : Complex ≝ 0j  (optional, expert)  Amplitude 3 of the photoelectron used in spin polarized calculations
            Q4 : Complex ≝ (1+0j)  (optional, expert)  Amplitude 4 of the photoelectron used in spin polarized calculations



        SECTION SPEC_STR (optional) contains:
    -----------------------------------------
        N_LAYDBL : Array(of Integer of length 2) ≝ [10 10]  (optional)
        NLAT_G_VEC : Integer ≝ 57  (optional)
        N_LAYER : Integer ≝ 50  (optional)
        SURF_BAR : Array(of Real) ≝ [0.25 0.25]  (optional)
        TRANSP_BAR : Flag ≝ False  (optional)

Functions

_electron_angle_default(option)

SPEC_INPUT defaults differ for photoemission and SPLEED.

_electron_spol_default(option)

_task_default(option)

Default the shared TASK selector from the requested task context.

_validate_angular_scan(parameters, ...)

angular_scan_errors(parameters)

Return inconsistencies rejected by SPEC_INPUT, using its unset defaults.

input_parameters_definition()

Classes

ArpesInputParametersDefinition(name[, ...])

Shared SPEC_INPUT schema for ARPES-family tasks.