ONETEP logo ONETEP
ONETEP  >  Documentation

Documentation

ONETEP calculations are defined by a single free-format input file with a .dat extension. Comments are introduced by the characters #, ; or !. The keywords are divided into three levels: basic, intermediate and expert, and may be of several types.

Go to: Basic | Intermediate | Expert | Top | ONETEP home

Basic keywords

KeywordTypeDescription
CHARGEIntegerTotal charge of system
CONSTANT_EFIELDTextConstant electric field to be applied
CUBE_FORMATLogicalUse cube format for plot files
CUTOFF_ENERGYPhysicalEquivalent plane wave kinetic energy cutoff
DO_PROPERTIESLogicalPermit calculation of properties
GEOM_MAX_ITERIntegerMaximum number of geometry optimisation iterations
GEOM_METHODTextGeometry optimisation method
GRD_FORMATLogicalUse .grd format for plot files
HOMO_DENS_PLOTIntegerNumber of canonical orbital densities to plot below HOMO
KERNEL_CUTOFFRealDensity kernel cutoff radius in bohr
LATTICE_CARTBlockSimulation cell lattice vectors in Cartesian coordinates
LUMO_DENS_PLOTIntegerNumber of canonical orbital densities to plot above LUMO
MD_DELTA_TPhysicalMolecular dynamics time step
MD_NUM_ITERIntegerNumber of molecular dynamics iterations
MD_TEMPERATUREPhysicalMolecular dynamics temperature
NNHOLogicalConvert NGWFs into non-orthogonal natural hybrid orbitals
OUTPUT_DETAILTextSpecify level of output detail
POPN_BOND_CUTOFFPhysicalMulliken population analysis bond length cutoff
POPN_CALCULATELogicalPerform Mulliken population analysis
POSITIONS_ABSBlockAtomic positions in Cartesian coordinates
READ_DENSKERNLogicalRead density kernel to restart
READ_TIGHTBOX_NGWFSLogicalRead NGWFs to restart
SPECIESBlockAtomic species information
SPECIES_CONSTRAINTSBlockAtomic species geometry optimisation constraints
SPECIES_NGWF_PLOTBlockAtomic species for plotting NGWFs
SPECIES_POTBlockPseudopotentials for atomic species
SPINIntegerTotal spin of system
SPIN_POLARIZEDLogicalPerform spin polarized calculation
TASKTextSpecify task
WRITE_DENSITY_PLOTLogicalWrite out charge density and electrostatic potential for plotting
WRITE_DENSKERNLogicalWrite density kernel for future restart
WRITE_FORCESLogicalInclude ionic forces in output
WRITE_NGWF_PLOTLogicalWrite out NGWFs for plotting
WRITE_TIGHTBOX_NGWFSLogicalWrite NGWFs for future restart
XC_FUNCTIONALTextExchange-correlation functional

Go to: Basic | Intermediate | Expert | Top | ONETEP home

Intermediate keywords

KeywordTypeDescription
DOS_SMEARPhysicalHalf-width for Gaussian smearing of density of states
EXACT_LNVLogicalUse Li-Nunes-Vanderbilt algorithm (not Millam-Scuseria variant)
FFTBOX_PREFTextPreferred FFT box size
GEOM_BACKUP_ITERIntegerBackup frequency for geometry optimisation
GEOM_CONTINUATIONLogicalContinue a previous geometry optimisation
GEOM_CONVERGENCE_WINIntegerNumber of geometry optimisation iterations for convergence criteria to be met
GEOM_DISP_TOLPhysicalDisplacement convergence tolerance for geometry optimisation
GEOM_ENERGY_TOLPhysicalEnergy convergence tolerance for geometry optimisation
GEOM_FORCE_TOLPhysicalForce convergence tolerance for geometry optimisation
GEOM_FREQUENCY_ESTPhysicalEstimated average phonon frequency for geometry optimisation
GEOM_MODULUS_ESTPhysicalEstimated bulk modulus for geometry optimisation
LNV_THRESHOLD_ORIGRealConvergence threshold for density kernel RMS gradient
MAXIT_HOTELLINGIntegerMaximum number of iterations for inverting the overlap matrix
MAXIT_LNVIntegerMaximum number of density kernel iterations
MAXIT_NGWF_CGIntegerMaximum number of NGWF conjugate gradient iterations
MAXIT_PALSER_MANOIntegerMaximum number of Palser-Manolopoulos iterations
MAXIT_PENIntegerMaximum number of penalty functional iterations
MD_ALGORITHMTextMolecular dynamics integration algorithm
MD_THERMOSTATTextMolecular dynamics thermostat
MINIT_LNVIntegerMinimum number of density kernel iterations
NGWF_THRESHOLD_ORIGRealConvergence threshold for NGWF RMS gradient
NUM_EIGENVALUESIntegerNumber of Kohn-Sham states above and below Fermi level to calculate
PEN_PARAMRealPenalty functional parameter in hartree
POSITIONS_ABS_INTERMEDIATEBlockIntermediate atomic positions in Cartesian coordinates for transition state search
POSITIONS_ABS_PRODUCTBlockProduct atomic positions in Cartesian coordinates for transition state search
SPECIES_ATOMIC_SETBlockAtomic species initial NGWFs
TIMINGS_LEVELIntegerSet level of detail in timings
TSSEARCH_DISP_TOLPhysicalTransition state search displacement tolerance
TSSEARCH_FORCE_TOLPhysicalTransition state search force tolerance
TSSEARCH_METHODTextTransition state search method
TSSEARCH_LSTQST_PROTOCOLTextTransition state search LSTQST protocol

Go to: Basic | Intermediate | Expert | Top | ONETEP home

Expert keywords

KeywordTypeDescription
CHECK_ATOMSLogicalCheck atoms are a reasonable distance apart
COREHAM_DENSKERN_GUESSLogicalInitialize density kernel by simple diagonalisation
DELTA_E_CONVLogicalUse consecutive energy gains as NGWF convergence criterion
DENSITY_BATCH_SIZEIntegerBatch size for NGWF communications during density evaluation
ELEC_CG_MAXIntegerReset frequency for NGWF conjugate gradients
GEOM_PRINT_INV_HESSIANLogicalPrint inverse Hessian
KERNEL_UPDATELogicalUpdate density kernel during NGWF line search
KINETIC_INT_BATCH_SIZEIntegerBatch size for NGWF communications during kinetic energy integrals
K_ZERORealParameter for kinetic energy preconditioning in inverse bohr
LNV_CG_TYPETextVariant of conjugate gradient algorithm to use for density kernel optimisation
LOCPOT_INT_BATCH_SIZEIntegerBatch size for NGWF communications during local potential integrals
MAX_RESID_HOTELLINGRealMaximum residual value allowed when inverting overlap matrix
MD_COLLISION_FREQUENCYPhysicalMolecular dynamics: collision frequency for Andersen thermostat
NGWF_CG_TYPETextVariant of conjugate gradient algorithm to use for NGWF optimisation
NGWF_GRAD_BATCH_SIZEIntegerBatch size for NGWF communications during NGWF gradient evaluation
NGWF_HALORealHalo width for NGWF radii in bohr
OCC_MIXRealMixing fraction of occupancy preconditioned NGWF gradient
ODD_PSINC_GRIDLogicalForce and odd number of points in the simulation cell psinc grid
OLD_LNVLogicalUse legacy algorithm for backwards compatibility
OVLP_FOR_NONLOCALLogicalUse overlap sparsity pattern for nonlocal pseudopotential matrix
PPD_NPOINTSTextPPD size in grid points
PRECOND_REALLogicalApply kinetic energy preconditioning in real space
PRECOND_RECIPLogicalApply kinetic energy preconditioning in reciprocal space
PRECOND_SCHEMETextSpecify scheme for kinetic energy preconditioning
PRINT_QCLogicalPrint calculation summary for quality control testing
PSINC_SPACINGTextPsinc grid spacing in bohr
R_PRECONDRealRadial cutoff for real-space preconditioning in bohr
SMOOTH_PROJECTORSRealHalfwidth of Gaussian filter for smoothing non-local projectors in bohr
TSSEARCH_CG_MAX_ITERIntegerMaximum number of transition state search conjugate gradients iterations
TSSEARCH_QST_MAX_ITERIntegerMaximum number of transition state search QST iterations
USE_SPACE_FILLING_CURVELogicalDistribute atoms according to a space-filling curve
VERBOSE_EWALD_FORCESLogicalPrint full details of Ewald forces

CHARGE

Syntax:CHARGE [Integer]
Description:Specifies the total charge of the system in units of the proton charge i.e. a positive charge corresponds to a system deficient of electrons.
Default:0 ; charge neutral
Example:charge +1

Go to: Basic | Intermediate | Expert | Top | ONETEP home


CHECK_ATOMS

Syntax:CHECK_ATOMS [Logical]
Description:Perform a check on the atomic positions to ensure that no two atoms are unphysically close.
Default:True
Example:check_atoms F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


CONSTANT_EFIELD

Syntax:CONSTANT_EFIELD [Text]
Description:Specifies a constant electric field to apply to the system in terms of Cartesian vector components in atomic units Ha/(e a0).
Default:0.0 0.0 0.0 ; zero field
Example:constant_efield 1.0e-3 0.0 0.0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


COREHAM_DENSKERN_GUESS

Syntax:COREHAM_DENSKERN_GUESS [Logical]
Description:Generate an initial guess for the density kernel using a Hamiltonian generated by simple atomic screening of the pseudopotential. The density kernel may be obtained by the Palser-Manolopoulos algorithm or direct diagonalization. If false, a simple diagonal approximation is used for the density kernel.
Default:True
Example:coreham_denskern_guess F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


CUBE_FORMAT

Syntax:CUBE_FORMAT [Logical]
Description:Output volumetric data (e.g. charge density, potential, NGWFs, canonical orbitals) in cube format. This can be visualized using free software such as gOpenMol, MOLEKEL and XCrySDen.
Default:False
Example:cube_format T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


CUTOFF_ENERGY

Syntax:CUTOFF_ENERGY [Value] [Unit]
Description:Chooses the psinc basis set to correspond as closely as possible to a plane-wave basis with this cutoff energy. See section 3 of Skylaris et al., J. Phys.: Condens. Matter 17, 5757 (2005) for more details.
Default:20 Ha
Example:cutoff_energy 500 eV

Go to: Basic | Intermediate | Expert | Top | ONETEP home


DELTA_E_CONV

Syntax:DELTA_E_CONV [Logical]
Description:When aggressive density kernel truncation is applied, the energy is not guaranteed to decrease monotonically. When DELTA_E_CONV is true, consecutive energy gains are used as an additional convergence criterion.
Default:True
Example:delta_e_conv F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


DENSITY_BATCH_SIZE

Syntax:DENSITY_BATCH_SIZE [Integer]
Description:Specifies the number of NGWFs to communicate in a single batch during the evaluation of the electronic density. May be used for tuning parallel performance, especially if "stack full" warnings are reported.
Default:10
Example:density_batch_size 5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


DO_PROPERTIES

Syntax:DO_PROPERTIES [Logical]
Description:Enables the calculation of properties including: charge and spin densities, electrostatic potential, Mulliken population analysis, canonical orbitals and energies and density of states.
Default:False
Example:do_properties T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


DOS_SMEAR

Syntax:DOS_SMEAR [Value] [Unit]
Description:Specifies the Gaussian smearing for the density of states calculated if properties are requested. If the smearing width is negative, the density of states is not calculated.
Default:0.1 eV
Example:dos_smear 7 mRy

Go to: Basic | Intermediate | Expert | Top | ONETEP home


ELEC_CG_MAX

Syntax:ELEC_CG_MAX [Integer]
Description:Specifies the maximum number of NGWF conjugate gradients iterations between resets.
Default:5
Example:elec_cg_max 1 ; steepest descents

Go to: Basic | Intermediate | Expert | Top | ONETEP home


EXACT_LNV

Syntax:EXACT_LNV [Logical]
Description:Specifies that the normalization constraint on the density matrix should be imposed exactly, using the purified density kernel (as in the original Li-Nunes-Vanderbilt algorithm [Phys. Rev. B 47, 10891 (1993)]) rather than the auxiliary kernel (as in the Millam-Scuseria variant [J. Chem. Phys. 106, 5569 (1997)]).
Default:True
Example:exact_lnv F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


FFTBOX_PREF

Syntax:FFTBOX_PREF [Text]
Description:Specifies a size for the FFT-box that is preferable to the smallest possible size that would normally be chosen (e.g. if the FFT library on a particular machine favours certain sizes). The FFT-box is specified by three integers (which must all be odd) that give the number of coarse grid points in the a1, a2 and a3 directions respectively.
Default:0 0 0 ; use smallest possible
Example:fftbox_pref 65 65 65

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_BACKUP_ITER

Syntax:GEOM_BACKUP_ITER [Integer]
Description:Specifies the backup frequency for geometry optimisation. If the input filename is rootname.dat then the backup filename is rootname.continuation.
Default:1 ; every iteration
Example:geom_backup_iter 5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_CONTINUATION

Syntax:GEOM_CONTINUATION [Logical]
Description:Continue a geometry optimization from a previous run using the .continuation backup file.
Default:False
Example:geom_continuation T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_CONVERGENCE_WIN

Syntax:GEOM_CONVERGENCE_WIN [Integer]
Description:Specifies the number of consecutive iterations during which the convergence criteria must be met.
Default:2
Example:geom_convergence_win 3

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_DISP_TOL

Syntax:GEOM_DISP_TOL [Value] [Unit]
Description:Specifies atomic displacement tolerance used as one of the criteria for convergence of geometry optimization. The positions of all atoms must change by less than this tolerance to satisfy this criterion.
Default:10-3 a0
Example:geom_disp_tol 1.0e-4 nm

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_ENERGY_TOL

Syntax:GEOM_ENERGY_TOL [Value] [Unit]
Description:Specifies the tolerance for enthalpy per atom over the convergence window as a criterion for geometry optimization convergence.
Default:10-6 Ha per atom
Example:geom_energy_tol 0.2 meV

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_FORCE_TOL

Syntax:GEOM_FORCE_TOL [Value] [Unit]
Description:Specifies the tolerance for maximum atomic force as a criterion for geometry optimization convergence. Note that units involving a forward slash (/) must be quoted as in the example below.
Default:0.02 Ha/a0
Example:geom_force_tol 0.1 "ev/ang"

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_FREQUENCY_EST

Syntax:GEOM_FREQUENCY_EST [Value] [Unit]
Description:Specifies the estimated average phonon frequency (as an energy) used to initialize the inverse Hessian matrix for geometry optimization.
Default:50 Ha
Example:geom_frequency_est 0.2 eV

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_MAX_ITER

Syntax:GEOM_MAX_ITER [Integer]
Description:Specifies the maximum number of iterations for geometry optimisation.
Default:10
Example:geom_max_iter 30

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_METHOD

Syntax:GEOM_METHOD [Text]
Description:Specifies the method for geometry optimisation, currently either CARTESIAN for the BFGS algorithm based on Cartesian atomic coordinates [e.g. Pfrommer et al., J. Comp. Phys. 131, 233 (1997)] or DELOCALIZED for delocalized internal coordinates [Andzelm et al., Chem. Phys. Lett. 335 321 (2001)].
Default:CARTESIAN
Example:geom_method DELOCALIZED

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_MODULUS_EST

Syntax:GEOM_MODULUS_EST [Value] [Unit]
Description:Specifies the estimated bulk modulus used to initialize the inverse Hessian matrix for geometry optimization.
Default:500 Ha/a03
Example:geom_modulus_est 100 GPa

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GEOM_PRINT_INV_HESSIAN

Syntax:GEOM_PRINT_INV_HESSIAN [Logical]
Description:Include information about the inverse Hessian matrix in the ouput of a geometry optimization.
Default:False
Example:geom_print_inv_hessian T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


GRD_FORMAT

Syntax:GRD_FORMAT [Logical]
Description:Output volumetric data (e.g. charge density, potential, NGWFs, canonical orbitals) in .grd format used by Accelrys Materials Studio.
Default:True
Example:grd_format F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


HOMO_DENS_PLOT

Syntax:HOMO_DENS_PLOT [Integer]
Description:Specifies the number of canonical orbitals below the HOMO to plot, if DO_PROPERTIES is set to true. Thus a value of zero plots only the HOMO, a negative value disables plotting and a positive value of N plots the N+1 highest occupied canonical orbitals.
Default:5 ; plot the HOMO and the five canonical orbitals below
Example:homo_dens_plot 0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


KERNEL_CUTOFF

Syntax:KERNEL_CUTOFF [Real]
Description:Specifies the density kernel spatial cutoff in atomic units (a0). Matrix elements are only included if the corresponding NGWF centres are closer than this distance.
Default:1000.0 ; i.e. effectively infinite
Example:kernel_cutoff 25.0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


KERNEL_UPDATE

Syntax:KERNEL_UPDATE [Logical]
Description:Update the density kernel when taking a trial step for NGWF optimization.
Default:False
Example:kernel_update T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


KINETIC_INT_BATCH_SIZE

Syntax:KINETIC_INT_BATCH_SIZE [Integer]
Description:Specifies the number of NGWFs to communicate in a single batch during the evaluation of the kinetic energy integrals. May be used for tuning parallel performance, especially if "stack full" warnings are reported.
Default:10
Example:kinetic_int_batch_size 5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


K_ZERO

Syntax:K_ZERO [Real]
Description:Specifies the kinetic energy preconditioning parameter as an inverse length in atomic units (a0-1). See Mostofi et al., J. Chem. Phys. 119, 8842 (2003) for further details.
Default:3.0
Example:k_zero 4.0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


LATTICE_CART

Syntax:%BLOCK LATTICE_CART
  a1x  a1y  a1z
  a2x  a2y  a2z
  a3x  a3y  a3z
%ENDBLOCK LATTICE_CART
Description:Specifies the lattice vectors a1, a2 and a3 for the simulation cell as Cartesian coordinates in atomic units (a0).
Example:%block lattice_cart
 7.500000 0.000000 0.000000 ; hexagonal unit cell with
-3.750000 6.495191 0.000000 ;   a = 7.5 a0
 0.000000 0.000000 9.000000 ;   c = 9.0 a0
%endblock lattice_cart

Go to: Basic | Intermediate | Expert | Top | ONETEP home


LNV_CG_TYPE

Syntax:LNV_CG_TYPE [Text]
Description:Specifies the variant of the conjugate gradients algorithm used for the optimization of the density kernel, currently either LNV_FLETCHER for Fletcher-Reeves or LNV_POLAK for Polak-Ribière.
Default:LNV_FLETCHER
Example:lnv_cg_type LNV_POLAK

Go to: Basic | Intermediate | Expert | Top | ONETEP home


LNV_THRESHOLD_ORIG

Syntax:LNV_THRESHOLD_ORIG [Real]
Description:Specifies the convergence threshold for the RMS gradient of the density kernel.
Default:10-9
Example:lnv_threshold_orig 1.0e-8

Go to: Basic | Intermediate | Expert | Top | ONETEP home


LOCPOT_INT_BATCH_SIZE

Syntax:LOCPOT_INT_BATCH_SIZE [Integer]
Description:Specifies the number of NGWFs to communicate in a single batch during the evaluation of the local potential integrals. May be used for tuning parallel performance, especially if "stack full" warnings are reported.
Default:10
Example:locpot_int_batch_size 5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


LUMO_DENS_PLOT

Syntax:LUMO_DENS_PLOT [Integer]
Description:Specifies the number of canonical orbitals above the LUMO to plot, if DO_PROPERTIES is set to true. Thus a value of zero plots only the LUMO, a negative value disables plotting and a positive value of N plots the N+1 lowest unoccupied canonical orbitals.
Default:5 ; plot the LUMO and the five canonical orbitals above
Example:lumo_dens_plot 0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MAXIT_HOTELLING

Syntax:MAXIT_HOTELLING [Integer]
Description:Specifies the maximum number of iterations in the Hotelling algorithm used to invert the overlap matrix. See Ozaki, Phys. Rev. B. 64, 195110 (2001) for more details. If MAXIT_HOTELLING is zero, then the inverse is computed using a traditional O(N3) method.
Default:50
Example:maxit_hotelling 100

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MAXIT_LNV

Syntax:MAXIT_LNV [Integer]
Description:Specifies the maximum number of iterations for the density kernel optimization.
Default:8
Example:maxit_lnv 3

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MAXIT_NGWF_CG

Syntax:MAXIT_NGWF_CG [Integer]
Description:Specifies the maximum number of iterations for the NGWF conjugate gradients optimization.
Default:100
Example:maxit_ngwf_cg 25

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MAXIT_PALSER_MANO

Syntax:MAXIT_PALSER_MANO [Integer]
Description:Specifies the maximum number of iterations for the Palser-Manolopoulos algorithm [Phys. Rev. B. 58, 12704 (1998)] used to initialize the density kernel before the main optimization begins (when COREHAM_DENSKERN_GUESS is true, the default). If MAXIT_PALSER_MANO is negative then a traditional O(N3) diagonalization is used.
Default:50
Example:maxit_palser_mano 30

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MAXIT_PEN

Syntax:MAXIT_PEN [Integer]
Description:Specifies the maximum number of iterations for the penalty-functional algorithm [Haynes et al., Phys. Rev. B. 59, 12173 (1999)] used to refine the density kernel intialization before the main optimization begins. When reading the density kernel from disk this should normally be set to zero.
Default:3
Example:maxit_pen 5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MAX_RESID_HOTELLING

Syntax:MAX_RESID_HOTELLING [Real]
Description:Specifies the maximum residual allowed when inverting the overlap matrix by the Hotelling method. See Ozaki, Phys. Rev. B. 64, 195110 (2001) for more details.
Default:10-12
Example:max_resid_hotelling 1.0e-10

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MD_ALGORITHM

Syntax:MD_ALGORITHM [Text]
Description:Specifies the integration algorithm for molecular dynamics, currently either LEAPFROGVERLET or VELOCITYVERLET.
Default:LEAPFROGVERLET
Example:md_algorithm VELOCITYVERLET

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MD_COLLISION_FREQUENCY

Syntax:MD_COLLISION_FREQUENCY [Value] [Unit]
Description:Specifies the collision frequency for the Andersen thermostat as an energy.
Default:0.152 Ha ; about 1015 Hz
Example:md_collision_frequency 4.0 eV

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MD_DELTA_T

Syntax:MD_DELTA_T [Value] [Unit]
Description:Specifies the time step for molecular dynamics.
Default:40 aut ; 40 atomic units of time
Example:md_delta_t 1.0 fs

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MD_NUM_ITER

Syntax:MD_NUM_ITER [Integer]
Description:Specifies the number of molecular dynamics steps.
Default:100
Example:md_num_iter 1000

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MD_TEMPERATURE

Syntax:MD_TEMPERATURE [Value] [Unit]
Description:Specifies the temperature for molecular dynamics as an energy.
Default:9.5 × 10-4 Ha ; approximately 300 K
Example:md_temperature 25.85 meV

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MD_THERMOSTAT

Syntax:MD_THERMOSTAT [Text]
Description:Specifies the thermostat for molecular dynamics, currently either NONE or ANDERSEN.
Default:NONE
Example:md_thermostat ANDERSEN

Go to: Basic | Intermediate | Expert | Top | ONETEP home


MINIT_LNV

Syntax:MINIT_LNV [Integer]
Description:Specifies the minimum number of iterations for the density kernel optimization.
Default:3
Example:minit_lnv 1

Go to: Basic | Intermediate | Expert | Top | ONETEP home


NGWF_CG_TYPE

Syntax:NGWF_CG_TYPE [Text]
Description:Specifies the variant of the conjugate gradients algorithm used for the optimization of the NGWFs, currently either NGWF_FLETCHER for Fletcher-Reeves or NGWF_POLAK for Polak-Ribière.
Default:NGWF_FLETCHER
Example:ngwf_cg_type NGWF_POLAK

Go to: Basic | Intermediate | Expert | Top | ONETEP home


NGWF_GRAD_BATCH_SIZE

Syntax:NGWF_GRAD_BATCH_SIZE [Integer]
Description:Specifies the number of NGWFs to communicate in a single batch during the evaluation of the NGWF gradient. May be used for tuning parallel performance, especially if "stack full" warnings are reported.
Default:10
Example:ngwf_grad_batch_size 5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


NGWF_HALO

Syntax:NGWF_HALO [Real]
Description:Specifies a halo size for the NGWFs to include matrix elements between NGWFs which do not directly overlap. In atomic units (a0). A negative value indicates that no halo should be used.
Default:-1.0 ; no halo
Example:ngwf_halo 1.0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


NGWF_THRESHOLD_ORIG

Syntax:NGWF_THRESHOLD_ORIG [Real]
Description:Specifies the convergence threshold for the RMS gradient of the NGWFs.
Default:2 × 10-6
Example:ngwf_threshold_orig 1.0e-5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


NNHO

Syntax:NNHO [Logical]
Description:Generate non-orthogonal natural hybrid orbitals from the NGWFs. See Foster et al., J. Am. Chem. Soc. 102, 7211 (1980) for more details.
Default:False
Example:nnho T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


NUM_EIGENVALUES

Syntax:NUM_EIGENVALUES [Integer]
Description:Specifies the number of canonical orbital eigenvalues above and below the Fermi level to print when properties are required.
Default:10
Example:num_eigenvalues 5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


OCC_MIX

Syntax:OCC_MIX [Real]
Description:Specifies the fraction of the NGWF gradient to which occupancy preconditioning is applied.
Default:0.25
Example:occ_mix 1.0 ; fully preconditioned gradient

Go to: Basic | Intermediate | Expert | Top | ONETEP home


ODD_PSINC_GRID

Syntax:ODD_PSINC_GRID [Logical]
Description:Forces the simulation cell psinc grid to contain an odd number of points in each direction.
Default:False
Example:odd_osinc_grid T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


OLD_LNV

Syntax:OLD_LNV [Logical]
Description:Enables backwards compatibility with legacy code.
Default:False
Example:old_lnv T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


OUTPUT_DETAIL

Syntax:OUTPUT_DETAIL [Text]
Description:Specifies the level of detail in ONETEP's output: either BRIEF, NORMAL or VERBOSE.
Default:NORMAL
Example:output_detail VERBOSE

Go to: Basic | Intermediate | Expert | Top | ONETEP home


OVLP_FOR_NONLOCAL

Syntax:OVLP_FOR_NONLOCAL [Logical]
Description:Forces the nonlocal pseudopotential matrix and hence the Hamiltonian to have the sparsity pattern of the overlap matrix.
Default:False
Example:ovlp_for_nonlocal T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


PEN_PARAM

Syntax:PEN_PARAM [Real]
Description:Specifies the energy parameter in hartrees for the penalty-functional algorithm [Haynes et al., Phys. Rev. B. 59, 12173 (1999)] used to refine the density kernel intialization before the main optimization begins.
Default:4.0
Example:pen_param 5.0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


POPN_BOND_CUTOFF

Syntax:POPN_BOND_CUTOFF [Value] [Unit]
Description:Specifies the bond length cutoff to use when performing Mulliken population analysis.
Default:3 Å
Example:popn_bond_cutoff 5.0 ang

Go to: Basic | Intermediate | Expert | Top | ONETEP home


POPN_CALCULATE

Syntax:POPN_CALCULATE [Logical]
Description:Perform Mulliken population analysis.
Default:True if DO_PROPERTIES is true, otherwise false.
Example:popn_calculate F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


POSITIONS_ABS

Syntax:%BLOCK POSITIONS_ABS
  S1  R1x  R1y  R1z
  S2  R2x  R2y  R2z
  .   .    .    .
  .   .    .    .
  SN  RNx  RNy  RNz
%ENDBLOCK POSITIONS_ABS
Description:Specifies the atomic positions as Cartesian coordinates in atomic units (a0). In the above syntax, Si denotes the species of atom i (max 4 characters) and Ri its position vector. Note that all atoms are currently required to be positioned within the simulation cell.
Example:%block positions_abs
 C  5.0 5.0 5.0 ; CO2 molecule
 O  2.7 5.0 5.0 ; centred in a cubic simulation cell
 O  7.3 5.0 5.0 ; with sides of 10 a0
%endblock positions_abs

Go to: Basic | Intermediate | Expert | Top | ONETEP home


POSITIONS_ABS_INTERMEDIATE

Syntax:See POSITIONS_ABS above.
Description:Specifies the atomic positions as Cartesian coordinates in atomic units (a0) for the intermediate in a transition state search.
Example:See POSITIONS_ABS above.

Go to: Basic | Intermediate | Expert | Top | ONETEP home


POSITIONS_ABS_PRODUCT

Syntax:See POSITIONS_ABS above.
Description:Specifies the atomic positions as Cartesian coordinates in atomic units (a0) for the product in a transition state search.
Example:See POSITIONS_ABS above.

Go to: Basic | Intermediate | Expert | Top | ONETEP home


PPD_NPOINTS

Syntax:PPD_NPOINTS [Text]
Description:Specifies the size of the parallelepipeds (PPDs) used to group the simulation cell psinc grid points for efficiency. The size of the PPD is given by three integers corresponding to the number of grid points in the a1, a2 and a3 directions respectively. These integers must all be factors of the simulation cell psinc grid size in the relevant direction.
Default:0 0 0 ; select automatically
Example:ppd_npoints 5 7 6

Go to: Basic | Intermediate | Expert | Top | ONETEP home


PRECOND_REAL

Syntax:PRECOND_REAL [Logical]
Description:Apply kinetic energy preconditioning by a convolution in real-space. See Mostofi et al., J. Chem. Phys. 119, 8842 (2003) for further details.
Default:False
Example:precond_real T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


PRECOND_RECIP

Syntax:PRECOND_RECIP [Logical]
Description:Apply kinetic energy preconditioning by a multiplication in reciprocal-space. See Mostofi et al., J. Chem. Phys. 119, 8842 (2003) for further details.
Default:True
Example:precond_recip F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


PRECOND_SCHEME

Syntax:PRECOND_SCHEME [Text]
Description:Specifies the form of the kinetic energy preconditioner used, currently one of:
  • BG - Bowler-Gillan scheme: Comput. Phys. Commun. 112, 103 (1998)
  • MAURI - Mauri scheme
  • TETER - Teter-Payne-Allan scheme: Phys. Rev. B 40, 12255 (1989)
  • NONE - no kinetic energy preconditioning
Default:TETER
Example:precond_scheme MAURI

Go to: Basic | Intermediate | Expert | Top | ONETEP home


PRINT_QC

Syntax:PRINT_QC [Text]
Description:Include a summary of the calculation in the output for the purposes of "quality control" on code modifications.
Default:False
Example:print_qc T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


PSINC_SPACING

Syntax:PSINC_SPACING [Text]
Description:Specifies the spacing between psinc grid points in the simulation cell by three real values (in atomic units a0) in the a1, a2 and a3 directions respectively. These spacings must all be factors of the simulation cell lengths in the relevant directions.
Default:0.0 0.0 0.0 ; select automatically
Example:psinc_spacing 0.4 0.5 0.5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


READ_DENSKERN

Syntax:READ_DENSKERN [Logical]
Description:Read in the density kernel from disk. If the input filename is rootname.dat then the density kernel filename is rootname.denskern.
Default:False
Example:read_denskern T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


READ_TIGHTBOX_NGWFS

Syntax:READ_TIGHTBOX_NGWFS [Logical]
Description:Read in the NGWFs from disk. If the input filename is rootname.dat then the NGWFs filename is rootname.tightbox_ngwfs.
Default:False
Example:read_tightbox_ngwfs T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


R_PRECOND

Syntax:R_PRECOND [Real]
Description:Specifies the radius in atomic units (a0) of the real-space kinetic energy preconditioner (used to accelerate the convolution).
Default:2.0
Example:r_precond 1.5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SMOOTH_PROJECTORS

Syntax:SMOOTH_PROJECTORS [Real]
Description:Specifies the half-width in atomic units (a0) of a Gaussian filter used to smooth the nonlocal projectors. A negative value indicates that no smoothing should be applied.
Default:-0.4 ; no smoothing
Example:smooth_projectors 0.5

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SPECIES

Syntax:%BLOCK SPECIES
  S1  X1  Z1  n1  R1
  S2  X2  Z2  n2  R2
  .   .   .   .   .
  .   .   .   .   .
  SN  XN  ZN  nN  RN
%ENDBLOCK SPECIES
Description:Defines the atomic species. In the above syntax, Si denotes the species of atom i (max 4 characters), corresponding to the element with symbol Xi and atomic number ZN, and with which are associated ni NGWFs of radius RN in atomic units (a0). More than one atomic species may refer to the same element, e.g. so that different ionic constraints may be applied to them.
Example:%block species
 C1  C  6  4  6.0 ; species C1 is carbon with 4 NGWFs of radius 6.0 a0
 C2  C  6  4  7.0 ; species C2 is also carbon but has 7.0 a0 NGWF radii
 H   H  1  1  5.0 ; species H is hydrogen with 1 NGWF of radius 5.0 a0
%endblock species

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SPECIES_ATOMIC_SET

Syntax:%BLOCK SPECIES_ATOMIC_SET
  S1  <Fireball filename 1> | AUTO
  S2  <Fireball filename 2> | AUTO
  .                .
  .                .
%ENDBLOCK SPECIES_ATOMIC_SET
Description:Specifies the fireball (truncated pseudoatomic orbital) files for the atomic species which provide initial guesses for the NGWFs. In the above syntax, Si denotes atomic species i (max 4 characters). If AUTO is specified, then STO-3G and 6-31G* basis functions are generated automatically as required.
Default:AUTO for all species when this block is absent
Example:%block species_atomic_set
 C1  C_01.fbl
 H   AUTO
%endblock species_atomic_set

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SPECIES_CONSTRAINTS

Syntax:%BLOCK SPECIES_CONSTRAINTS
  S1  NONE|FIXED|LINE|PLANE  [C1x  C1y  C1z]
  .             .              .    .   .
  .             .              .    .   .
%ENDBLOCK SPECIES_CONSTRAINTS
Description:Defines the constraints for the atomic species for use during geometry optimization. In the above syntax, Si denotes atomic species i (max 4 characters). The constraint type is one of NONE (no constraint), FIXED (atom is constrained to remain fixed), LINE (atom is constrained to a line) or PLANE (atom is constrained to a plane). In the case of LINE and PLANE, three further real values are required, to specify the direction vector of the line or the normal vector to the plane (in Cartesian coordinates) respectively.
Example:%block species_constraints
 C1  FIXED             ; atoms of species C1 are fixed
 C2  LINE  1.0 0.0 0.0 ; atoms of species C2 can only move parallel to the x-axis
 H   PLANE 0.0 0.0 1.0 ; atoms of species H can only move in the xy-plane
%endblock species_constraints

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SPECIES_NGWF_PLOT

Syntax:%BLOCK SPECIES_NGWF_PLOT
  S1
  S2
  .
%ENDBLOCK SPECIES_NGWF_PLOT
Description:Defines the atomic species whose NGWFs are to be plotted during the calculation. In the above syntax, Si denotes atomic species i to plot.
Example:%block species_ngwf_plot
 C1
 C2
 H
%endblock species_ngwf_plot

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SPECIES_POT

Syntax:%BLOCK SPECIES_POT
  S1  <Pseudopotential filename 1>
  S2  <Pseudopotential filename 2>
  .                .
  .                .
%ENDBLOCK SPECIES_POT
Description:Specifies the pseudopotential files for the atomic species. In the above syntax, Si denotes atomic species i (max 4 characters). The files are currently required to be in the CASTEP .recpot format and to define norm-conserving pseudopotentials.
Example:%block species_pot
 C1  C_01.recpot
 C2  C_00.recpot
 H   H_01.recpot
%endblock species_pot

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SPIN

Syntax:SPIN [Integer]
Description:Specifies the total spin of the system in units of ½h/(2π). If the total spin is non-zero, a spin-polarized calculation will automatically be selected.
Default:0
Example:spin 1

Go to: Basic | Intermediate | Expert | Top | ONETEP home


SPIN_POLARIZED

Syntax:SPIN_POLARIZED [Logical]
Description:Specifies that a spin-polarized calculation should be performed.
Default:False, unless SPIN is non-zero, in which case true.
Example:spin_polarized T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TASK

Syntax:TASK [Text]
Description:Specifies the task to be carried out, currently one of:
  • SINGLEPOINT - single point energy calculation
  • PROPERTIES - properties using results from a previous calculation
  • GEOMETRYOPTIMIZATION - geometry optimization using Cartesian or delocalized internal coordinates
  • MOLECULARDYNAMICS - molecular dynamics simulation
  • TRANSITIONSTATESEARCH - transition state search
Default:SINGLEPOINT
Example:task GEOMETRYOPTIMIZATION

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TIMINGS_LEVEL

Syntax:TIMINGS_LEVEL [Integer]
Description:Specifies the amount of detail in the timing information collected:
  • 0 - total time only reported
  • 1 - timings for routines averaged across all processors
  • 2 - timings for routines on all processors individually
Default:1
Example:timings_level 0

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TSSEARCH_CG_MAX_ITER

Syntax:TSSEARCH_CG_MAX_ITER [Integer]
Description:Specifies the maximum number of conjugate gradients iterations for the transition state search.
Default:20
Example:tssearch_cg_max_iter 30

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TSSEARCH_DISP_TOL

Syntax:TSSEARCH_DISP_TOL [Value] [Unit]
Description:Specifies atomic displacement tolerance used as one of the criteria for convergence of a transition state search. The positions of all atoms must change by less than this tolerance to satisfy this criterion.
Default:10-2 a0
Example:tssearch_disp_tol 1.0e-3 nm

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TSSEARCH_FORCE_TOL

Syntax:TSSEARCH_FORCE_TOL [Value] [Unit]
Description:Specifies the tolerance for maximum atomic force as a criterion for transition state search convergence. Note that units involving a forward slash (/) must be quoted as in the example below.
Default:0.005 Ha/a0
Example:tssearch_force_tol 0.05 'ev/ang'

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TSSEARCH_METHOD

Syntax:TSSEARCH_METHOD [Text]
Description:Specifies the method for transition state search, currently only LSTQST.
Default:LSTQST
Example:tssearch_method LSTQST

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TSSEARCH_LSTQST_PROTOCOL

Syntax:TSSEARCH_LSTQST_PROTOCOL [Text]
Description:Specifies the protocol for transition state search with the LSTQST method, currently one of LSTMAXIMUM, HALGREN-LIPSCOMB, LST/OPTIMIZATION, COMPLETELSTQST or QST/OPTIMIZATION.
Default:LSTMAXIMUM
Example:tssearch_lstqst_protocol LST/OPTIMIZATION

Go to: Basic | Intermediate | Expert | Top | ONETEP home


TSSEARCH_QST_MAX_ITER

Syntax:TSSEARCH_QST_MAX_ITER [Integer]
Description:Specifies the maximum number of QST iterations for the transition state search.
Default:5
Example:tssearch_qst_max_iter 10

Go to: Basic | Intermediate | Expert | Top | ONETEP home


USE_SPACE_FILLING_CURVE

Syntax:USE_SPACE_FILLING_CURVE [Logical]
Description:Use a Hilbert space-filling curve to distribute the atoms among processors in a parallel calculation.
Default:True
Example:use_space_filling_curve F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


VERBOSE_EWALD_FORCES

Syntax:VERBOSE_EWALD_FORCES [Logical]
Description:Include details of the Ewald forces in the output.
Default:False
Example:verbose_ewald_forces T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


WRITE_DENSITY_PLOT

Syntax:WRITE_DENSITY_PLOT [Logical]
Description:Specifies that the charge density, electrostatic potential and spin density (if appropriate) be written out for plotting if properties are requested.
Default:True
Example:write_density_plot F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


WRITE_DENSKERN

Syntax:WRITE_DENSKERN [Logical]
Description:Write the density kernel to disk. If the input filename is rootname.dat then the density kernel filename is rootname.denskern.
Default:True
Example:write_denskern F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


WRITE_FORCES

Syntax:WRITE_FORCES [Logical]
Description:Include the forces in the output of a single point energy calculation.
Default:False
Example:write_forces T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


WRITE_NGWF_PLOT

Syntax:WRITE_NGWF_PLOT [Logical]
Description:Write out NGWFs for species listed in the SPECIES_NGWF_PLOT to disk for plotting during a single point energy calculation, in the cube and/or .grd formats as requested.
Default:False
Example:write_ngwf_plot T

Go to: Basic | Intermediate | Expert | Top | ONETEP home


WRITE_TIGHTBOX_NGWFS

Syntax:WRITE_TIGHTBOX_NGWFS [Logical]
Description:Write the NGWFs to disk. If the input filename is rootname.dat then the NGWFs filename is rootname.tightbox_ngwfs.
Default:True
Example:write_tightbox_ngwfs F

Go to: Basic | Intermediate | Expert | Top | ONETEP home


XC_FUNCTIONAL

Syntax:XC_FUNCTIONAL [Text]
Description:Specifies the exchange-correlation functional to use, currently one of:
  • LDA - default local (spin) density approximation, currently CAPZ
  • GGA - default generalized gradient approximation, currently RPBE
  • CAPZ - Perdew-Zunger parameterization [Phys. Rev. B 23, 5048 (1981)] of the Ceperley-Alder Monte Carlo data [Phys. Rev. Lett. 45, 566 (1980)] and Gell-Mann-Brueckner expansion [Phys. Rev. 106, 364 (1957)]
  • VWN - Vosko, Wilk and Nusair parameterization [Phys. Rev. B 22, 3812 (1980)] of the LDA
  • PW91 - Perdew and Wang GGA [Phys. Rev. B 45, 13244 (1992)]
  • PBE - Perdew, Burke and Ernzerhof GGA [Phys. Rev. Lett. 77, 3865 (1996) and Erratum]
  • REVPBE - revised PBE by Zhang and Yang [Phys. Rev. Lett. 80, 890 (1998)]
  • RPBE - revised PBE by Hammer, Hansen and Norskov [Phys. Rev. B 59, 7413 (1999)]
Default:LDA
Example:xc_functional PBE

Go to: Basic | Intermediate | Expert | Top | ONETEP home