Variables-test

From The Yambo Project
Jump to navigation Jump to search

All Variables (alphabetical order)

BDmRange BEnRange BEnSteps BLongDir BndsRnXd
BndsRnXp BoseCut BoseTemp BS_CPU BS_nCPU_LinAlg_DIAGO
BS_nCPU_LinAlg_INV BS_ROLEs bse BSEBands BSEEhEny
BSEmod BSENGBlk BSENGexx BSEPSInvTrs BSHayTrs
bsk BSKmod BSSInvMode BSSInvPFratio BSSmod
CGrdSpXd chi ChiLinAlgMod Chimod cohsex
CUTBox CUTCol_test CUTCylLen CUTGeo CUTRadius
CUTwsGvec DbGdQsize DbGdQsize DBsFRAGpm DBsIOoff
DIP_Threads DipApproach DipApproach DipPDirect DipPDirect
DmERefXd DmRngeXd DmRngeXp DrClassic DrudeWBS
DrudeWXd dScStep DysSolver EhEngyXd ElecTemp
Em1Anys em1d em1s EMStpsXd EnRngeXd
EnRngeXp ETStpsXd ETStpsXp ExtendOut EXXRLvcs
FFTGvecs Gauge GbndRnge GDamping GDmRnge
GEnRnge GEnSteps GfnQP_E GfnQP_N GfnQP_Wc
GfnQP_Wc_dos GfnQP_Wc_E GfnQP_Wv GfnQP_Wv_dos GfnQP_Wv_E
GfnQP_Z GfnQPdb GrFnTpXd GTermEn GTermKind
gw0 HF_and_locXC IDEm1Ref IkSigLim IkXLim
K_Threads KfnQP_E KfnQP_N KfnQP_Wc KfnQP_Wc_dos
KfnQP_Wc_E KfnQP_Wv KfnQP_Wv_dos KfnQP_Wv_E KfnQP_Z
KfnQPdb LifeTrCG LongDrXd LongDrXp LRC_alpha
MaxGvecs MEM_tresh MetDamp Nelectro NewtDchk
NGBlkXd NLogCPUs NoCondSumRule NonPDirs OccTresh
OnMassShell optics PAR_def_mode PAR_def_mode PPAPntXp
Qdirection QPerange QPerange QpgFull QPkrange
QPkrange QpntsRXd QptCoord QShiftOrder RandGvec
RandQpts Reflectivity rim_cut SE_CPU SE_ROLEs
SE_Threads setup ShiftedPaths ShiftedPaths StdoHash
UseNLCC VXCRLvcs WehCpl WFbuffIO X_finite_q_CPU
X_finite_q_nCPU_LinAlg_INV X_finite_q_ROLEs X_q_0_CPU X_q_0_nCPU_LinAlg_INV X_q_0_ROLEs
X_Threads XfnQP_E XfnQP_N XfnQP_Wc XfnQP_Wc_dos
XfnQP_Wc_E XfnQP_Wv XfnQP_Wv_dos XfnQP_Wv_E XfnQP_Z
XfnQPdb

Global options

Nelectro (Units: , Format: )Default: From ns.db1 Verbosity: -V gen
Meaning: Electrons number
Usage:

ElecTemp (Units: , Format: ) Verbosity: -V gen
Meaning: Electronic Temperature
Usage:

BoseTemp (Units: , Format: ) Verbosity: -V gen
Meaning: Bosonic Temperature
Usage:

OccTresh (Units: , Format: ) Verbosity: -V gen
Meaning: Occupation treshold (metallic bands)
Usage:

StdoHash (Units: , Format: Integer)Default: 40 Verbosity: -V io
Meaning: Number of hashes in live-timing output
Usage:

DBsIOoff (Units: , Format: String) Verbosity: -V io
Meaning: List of databases not written to disk
Usage: Space-separated list of DB with NO I/O. DB is (DIP,X,HF,COLLs,J,GF,CARRIERs,OBS,W,SC,BS,ALL)

DBsFRAGpm (Units: , Format: String) Verbosity: -V io
Meaning: List of databases to be fragmented
Usage: Space-separated list of +DB to FRAG and -DB to NOT FRAG, where DB is (DIP,X,W,HF,COLLS,K,BS,QINDX,RT,ELP

WFbuffIO (Units: , Format: ) Verbosity: -V io
Meaning:
Usage:

MEM_tresh (Units: , Format: ) Verbosity: -V gen
Meaning: Threshold on traced memory allocations/deallocations
Usage:

NLogCPUs (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

PAR_def_mode (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

FFTGvecs (Units: RL/Energy, Format: Integer/Real) Verbosity: -V RL
Meaning: Number of G-vectors or energy cut off for expanding the wavefunctions/FFT transforms
Usage: It needs careful convergence. Determines the memory needed.

Initialization

setup (Units: , Format: String)
Meaning: Runlevel name
Usage:

MaxGvecs (Units: RL/Energy, Format: Integer/Real) Verbosity: -V RL
Meaning: Maximum number of G-vectors that can be used by code
Usage:

IkSigLim (Units: Range, Format: Integer ) Verbosity: -V kpt
Meaning: QP K-points indices range
Usage:

IkXLim (Units: , Format: ) Verbosity: -V kpt
Meaning:
Usage:

QptCoord (Units: , Format: ) Verbosity: -V kpt
Meaning:
Usage:

Random integration method and cutoff

rim_cut (Units: , Format: String)
Meaning: Runlevel name
Usage:

RandQpts (Units: RL, Format: Integer)
Meaning: Number of random q-points in the BZ
Usage: It needs convergence: values like 10^6 can be used to ensure convergence.

CUTGeo (Units: None, Format: String)
Meaning: Cutoff geometry
Usage: Allowed values are: "box/cylinder/sphere X/Y/Z/XY...", e.g. "box xy" or "cylinder y".

CUTBox (Units: Length, Format: Vector)
Meaning: Dimensions of box
Usage:

CUTRadius (Units: Length, Format: Real)
Meaning: Sphere/cylinder radius.
Usage:

CUTCylLen (Units: , Format: )
Meaning:
Usage:

CUTwsGvec (Units: , Format: )
Meaning:
Usage:

RandGvec (Units: , Format: ) Verbosity: -V RL
Meaning:
Usage:

QpgFull (Units: , Format: ) Verbosity: -V RL
Meaning:
Usage:

Em1Anys (Units: , Format: ) Verbosity: -V RL
Meaning:
Usage:

IDEm1Ref (Units: , Format: ) Verbosity: -V RL
Meaning:
Usage:

CUTCol_test (Units: , Format: ) Verbosity: -V RL
Meaning:
Usage:

Hartree-Fock Self-energy and Vxc

HF_and_locXC (Units: , Format: String)
Meaning: Runlevel name
Usage:

EXXRLvcs (Units: RL/Energy, Format: Integer/Real)
Meaning: Number of G-vectors used in the sum of the exchange self-energy Sx.
Usage: It needs careful convergence: not particularly time consuming, large values can be used to ensure convergence.

VXCRLvcs (Units: , Format: )
Meaning:
Usage:

QPkrange (Units: , Format: )
Meaning:
Usage:

UseNLCC (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

QPerange (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

SE_CPU (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

SE_ROLEs (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

SE_Threads (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

GW

cohsex (Units: , Format: String)
Meaning: Runlevel name
Usage:

gw0 (Units: , Format: String)
Meaning: Runlevel name
Usage:

QPkrange (Units: None, Format: Range)
Meaning: First and last Indexes of kpoints and bands the self energy correction is calculated
Usage: If interested in non consecutive kpoints or bands multiple rows can be also considered

GbndRnge (Units: None, Format: Range)
Meaning: Bands range: Specifies the number of bands entering in the sum over states in the correlation part of the self energy
Usage: It needs several empty states. Single quasiparticle states converges very slowly with respect GbndRnge, energy differences (e.g. gaps) behave better. See also GTermKind variable in order to speed up the convergences.

GDamping (Units: , Format: )
Meaning:
Usage:

dScStep (Units: , Format: )
Meaning:
Usage:

DysSolver (Units: , Format: )
Meaning:
Usage:

LifeTrCG (Units: , Format: )
Meaning:
Usage: Need -l option

GfnQPdb See XfnQPdb

GfnQP_N See XfnQP_N

GfnQP_E See XfnQP_E

GfnQP_Z See XfnQP_Z

GfnQP_Wv_E See XfnQP_Wv_E

GfnQP_Wv See XfnQP_Wv

GfnQP_Wv_dos See XfnQP_Wv_dos

GfnQP_Wc_E See XfnQP_Wc_E

GfnQP_Wc See XfnQP_Wc

GfnQP_Wc_dos See XfnQP_Wc_dos

GTermKind (Units: None, Format: String) Verbosity: -V qp
Meaning: Type of terminator to accelarate onvergence with respect empty states
Usage: Default is "none", possible options are "BG" for the Bruneval-Gonze terminator. See BG[1]

GTermEn (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

NewtDchk (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

ExtendOut (Units: None, Format: Flag) Verbosity: -V qp
Meaning: Extended output: Print more quantities in qp output files
Usage: Optional variable (-V qp). Uncomment to activate

OnMassShell (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

QPerange (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

GEnSteps (Units:  ?, Format: ) Verbosity: -V qp
Meaning:
Usage: -g s

GEnRnge (Units:  ?, Format: ) Verbosity: -V qp
Meaning:
Usage: -g s

GDmRnge (Units:  ?, Format: ) Verbosity: -V qp
Meaning:
Usage: -g s

Screening

em1d (Units: , Format: String)
Meaning: Runlevel name
Usage:

em1s (Units: , Format: String)
Meaning: Runlevel name
Usage:

NGBlkXd (Units: RL/Energy, Format: Integer/Real)
Meaning: Number of G-vectors or energy cut off in the screening.
Usage: Determines the size of the dielectric matrix in G-space. Needed for inclusion of local field effects, it should be much smaller than the number of G-vectors needed to expand the wavefunctions. It needs careful convergence.

PPAPntXp (Units: Energy, Format: Real)
Meaning: Plasmon pole Imaginary Energy (Default 1 Ha)
Usage: The self energy in the imaginary axis should be a smooth function so it should not have a strong dependence on this pole energy. Set it at an higher value of the plasmon energy (see EELS spectrum)

BndsRnXp See BndsRnXd

EnRngeXp See EnRngeXd

DmRngeXp See DmRngeXd

ETStpsXp See ETStpsXd

LongDrXp See LongDrXd

Optics/chi in G-space

optics (Units: , Format: String)
Meaning: Runlevel name
Usage:

chi (Units: , Format: String)
Meaning: Runlevel name
Usage:

Chimod (Units: None, Format: String)
Meaning: Type of kernel in TDDFT Dyson equation
Usage: Do not set this manually - set using the appropriate -k command line option. Allowed values: IP/Hartree/ALDA/LRC/BSfxc. IP indicates no kernel (independent particle level/RPA without local fields)

X_Threads (Units: , Format: )
Meaning:
Usage:

DIP_Threads (Units: , Format: )
Meaning:
Usage:

QpntsRXd (Units: None, Format: Range)
Meaning: Range of indexes of q-points/transferred momenta to be computed.
Usage: Set to 1 1 to select just the long wavelength term.

BndsRnXd (Units: None, Format: Range)
Meaning: Bands range: Specifies the number of bands entering in the sum over states in the RPA response function
Usage: It needs several empty states. See also GTermKind variable in order to speed up the convergences.::See also: GTermKind

EnRngeXd (Units: Energy, Format: Range)
Meaning: Energy range the spectrum is calculated across.
Usage: Extremae of the energy range across which optical spectra will be computed.

DmRngeXd (Units: Energy, Format: Range)
Meaning: Determines the damping used across the requested spectral range.
Usage: Typically this is kept constant. If different values are used, the damping at each energy will be interpolated linearly. This can be useful when poor k-point sampling leads to large oscillations at higher energy.

ETStpsXd (Units: None, Format: Integer)
Meaning: Number of energy steps in computing X
Usage: Determines the number of steps in energy the response function/spectrum is computed for in the desired range defined by EnRngeXd. In the case of a full frequency GW the range is fixed by the occupied/empty states included in the calculation, the number of frequency requires a careful check

LongDrXd (Units: Length, Format: Vector)
Meaning: Electric field direction
Usage: Pay attention how the system is oriented when treating non 3D systems and choose a direction in the plane/axis where your system lies

XfnQPdb (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_N (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_E (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_Z (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_Wv_E (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_Wv (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_Wv_dos (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_Wc_E (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_Wc (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

XfnQP_Wc_dos (Units: , Format: ) Verbosity: -V qp
Meaning:
Usage:

NonPDirs (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

ChiLinAlgMod (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

GrFnTpXd (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DmERefXd (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

CGrdSpXd (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

EMStpsXd (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DrudeWXd (Units: Energy, Format: Complex) Verbosity: -V resp
Meaning: Drude plasmon energy and inverse lifetime.
Usage:

EhEngyXd (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DrClassic (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DipApproach (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DipPDirect (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

ShiftedPaths (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

Qdirection (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

QShiftOrder (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DbGdQsize (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

PAR_def_mode (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

X_q_0_CPU (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

X_q_0_ROLEs (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

X_q_0_nCPU_LinAlg_INV (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

X_finite_q_CPU (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

X_finite_q_ROLEs (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

X_finite_q_nCPU_LinAlg_INV (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

Optics/BSE in eh-space

bse (Units: , Format: String)
Meaning: Runlevel name
Usage:

K_Threads (Units: , Format: Integer)
Meaning:
Usage:

BSEmod (Units: , Format: )
Meaning:
Usage:

BSKmod (Units: , Format: )
Meaning:
Usage:

BEnRange (Units: , Format: )
Meaning:
Usage:

BDmRange (Units: , Format: )
Meaning:
Usage:

BEnSteps (Units: , Format: )
Meaning:
Usage:

BLongDir (Units: , Format: )
Meaning:
Usage:

BSEBands (Units: None, Format: Range)
Meaning: Bands range: Specifies the band states from which the electron-hole basis of the BSE kernel is constructed
Usage: Choose few bands close to the Fermi level.

KfnQPdb See XfnQPdb

KfnQP_N See XfnQP_N

KfnQP_E See XfnQP_E

KfnQP_Z See XfnQP_Z

KfnQP_Wv_E See XfnQP_Wv_E

KfnQP_Wv See XfnQP_Wv

KfnQP_Wv_dos See XfnQP_Wv_dos

KfnQP_Wc_E See XfnQP_Wc_E

KfnQP_Wc See XfnQP_Wc

KfnQP_Wc_dos See XfnQP_Wc_dos

BoseCut (Units: , Format: ) Verbosity: -V gen
Meaning:
Usage:

DbGdQsize (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DipApproach (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DipPDirect (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

ShiftedPaths (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

Gauge (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

NoCondSumRule (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

MetDamp (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

Reflectivity (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

DrudeWBS (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

BSEEhEny (Units: , Format: ) Verbosity: -V resp
Meaning:
Usage:

BS_CPU (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

BS_ROLEs (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

BS_nCPU_LinAlg_INV (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

BS_nCPU_LinAlg_DIAGO (Units: , Format: ) Verbosity: -V par
Meaning:
Usage:

Bethe Salpeter/TDDFT Kernel

LRC_alpha (Units: , Format: )
Meaning:
Usage:

bsk (Units: , Format: )
Meaning:
Usage:

BSENGexx (Units: RL/Energy, Format: Integer/Real)
Meaning: G-components to be summed in the Exchange part of the BSE kernel, which takes into account the Local-field effects
Usage: Small values increase speed. Convergence tests are required.

BSENGBlk (Units: RL/Energy, Format: Integer/Real)
Meaning: Number of RL-components of the Screened Coulomb Potential matrix W(G,G'), to be included in the sum of the e-h attractive Kernel
Usage: Try using the diagonal terms only first (BSresKmod BScplKmod variables); use a smaller number than the dimension of the Screened interaction matrix

WehCpl (Units: , Format: )
Meaning:
Usage:

BSSmod (Units: , Format: )
Meaning:
Usage:

BSHayTrs (Units: None, Format: Real)
Meaning: Haydock treshold. Strict(>0)/Average(<0)
Usage:

BSSInvMode (Units: , Format: )
Meaning:
Usage:

BSEPSInvTrs (Units: , Format: )
Meaning:
Usage:

BSSInvPFratio (Units: , Format: )
Meaning:
Usage: