ENERGY_CORRECTION

Sets the various options for the Energy Correction [Edit on GitHub]

Keywords

Keyword descriptions

SECTION_PARAMETERS

Type: logical
Default: F
Lone keyword: T
Usage: &ENERGY_CORRECTION T

Description: Controls the activation of the energy_correction

[Edit on GitHub]

ADMM

Type: logical
Default: F
Lone keyword: T
Usage: ADMM

Description: Decide whether to perform ADMM in the exact exchange calc. for DC-DFT. The ADMM XC correction is governed by the AUXILIARY_DENSITY_MATRIX_METHOD section in &DFT. In most cases, the Hartree-Fock exchange is not too expensive and there is no need for ADMM, ADMM can however provide significant speedup and memory savings in case of diffuse basis sets.

[Edit on GitHub]

ALGORITHM

Type: enum
Default: DIAGONALIZATION
Usage: ALGORITHM DIAGONALIZATION

Description: Algorithm used to solve KS equation

Valid values:

  • DIAGONALIZATION Diagonalization of KS matrix.

  • MATRIX_SIGN Matrix Sign algorithm

  • TRS4 Trace resetting trs4 algorithm

  • TC2 Trace resetting tc2 algorithm

  • OT_DIAG OT diagonalization

[Edit on GitHub]

CHECK_S_INV

Type: logical
Default: F
Lone keyword: T
Usage: CHECK_S_INV

Description: Perform an accuracy check on the inverse/sqrt of the s matrix.

[Edit on GitHub]

DEBUG_EXTERNAL_METHOD

Type: logical
Default: F
Lone keyword: T
Usage: DEBUG_EXTERNAL_METHOD T

Description: Uses an internal pseudo-energy to test EXTERNAL energy method.

[Edit on GitHub]

DEBUG_FORCES

Type: logical
Default: F
Lone keyword: T
Usage: DEBUG_FORCES T

Description: Additional output to debug energy correction forces.

[Edit on GitHub]

DEBUG_STRESS

Type: logical
Default: F
Lone keyword: T
Usage: DEBUG_STRESS T

Description: Additional output to debug energy correction forces.

[Edit on GitHub]

DYNAMIC_THRESHOLD

Type: logical
Default: F
Lone keyword: T
Usage: DYNAMIC_THRESHOLD .TRUE.

Description: Should the threshold for the purification be chosen dynamically

[Edit on GitHub]

ELECTRONIC_TEMPERATURE

Type: real
Default: 0.00000000E+000 [K]
Aliases: ELEC_TEMP, FD_TEMP
Usage: ELECTRONIC_TEMPERATURE [K] 300

Description: Electronic temperature for Harris functional with Fermi-Dirac smearing.

[Edit on GitHub]

ENERGY_FUNCTIONAL

Type: enum
Default: HARRIS
Usage: ENERGY_FUNCTIONAL HARRIS

Description: Functional used in energy correction

Valid values:

  • HARRIS Harris functional

  • DCDFT Density-corrected DFT

  • EXTERNAL External calculated energy

[Edit on GitHub]

EPS_DEFAULT

Type: real
Default: 1.00000000E-007
Usage: EPS_DEFAULT 1.0E-7

Description: Threshold used for accuracy estimates within energy correction.

[Edit on GitHub]

EPS_FILTER

Type: real
Default: 1.00000000E-012
Usage: EPS_FILTER 1.0E-12

Description: Threshold used for filtering matrix operations.

[Edit on GitHub]

EPS_LANCZOS

Type: real
Default: 1.00000000E-003
Usage: EPS_LANCZOS 1.0E-4

Description: Threshold used for lanczos estimates.

[Edit on GitHub]

ERROR_CUTOFF

Type: real
Default: 1.00000000E-005
Usage: ERROR_CUTOFF 1.E-6

Description: Cutoff value for error estimation.

[Edit on GitHub]

ERROR_ESTIMATION

Type: logical
Default: F
Lone keyword: T
Usage: ERROR_ESTIMATION

Description: Perform an error estimation for the response forces/stress. Requires error estimates for the RHS of the response equation from input.

[Edit on GitHub]

ERROR_ESTIMATION_METHOD

Type: string
Default: E
Usage: ERROR_ESTIMATION_METHOD E

Description: Method used for error estimation: F(ull); D(ifferenc); E(xtrapolate).

[Edit on GitHub]

ERROR_SUBSPACE_SIZE

Type: integer
Default: 250
Usage: ERROR_SUBSPACE_SIZE 100

Description: MAX. size of subspace for response vector extrapolation.

[Edit on GitHub]

EXTERNAL_RESPONSE_ERROR_FILENAME

Type: string
Default: TREXIO
Usage: EXTERNAL_RESPONSE_ERROR_FILENAME

Description: Name of the file that contains response error information.

[Edit on GitHub]

EXTERNAL_RESPONSE_FILENAME

Type: string
Default: TREXIO
Usage: EXTERNAL_RESPONSE_FILENAME

Description: Name of the file that contains response information.

[Edit on GitHub]

EXTERNAL_RESULT_FILENAME

Type: string
Default: CP2K_EXRESP.result
Usage: EXTERNAL_RESULT_FILENAME

Description: Name of the file that contains results from external response calculation.

[Edit on GitHub]

FACTORIZATION

Type: enum
Default: CHOLESKY
Usage: FACTORIZATION CHOLESKY

Description: Algorithm used to calculate factorization of overlap matrix

Valid values:

  • CHOLESKY Cholesky factorization of overlap matrix

[Edit on GitHub]

FIXED_MU

Type: logical
Default: F
Lone keyword: T
Usage: FIXED_MU .TRUE.

Description: Should the calculation be performed at fixed chemical potential, or should it be found fixing the number of electrons

[Edit on GitHub]

HARRIS_BASIS

Type: string[ ]
Default: ORBITAL
Usage: HARRIS_BASIS ORBITAL

Description: Specifies the type of basis to be used for the KG energy correction. Options are: (1) the default orbital basis (ORBITAL); (2) the primitive functions of the default orbital basis (PRIMITIVE); (3) the basis set labeled in Kind section (HARRIS)

[Edit on GitHub]

MAO

Type: logical
Default: F
Lone keyword: T
Usage: MAO T

Description: Use modified atomic orbitals (MAO) to solve Harris equation

[Edit on GitHub]

MAO_EPS1

Type: real
Default: 1.00000000E+003
Usage: MAO_EPS1 0.001

Description: Occupation threshold used to determine number of MAOs. KIND section MAO keyword sets the minimum.

[Edit on GitHub]

MAO_EPS_GRAD

Type: real
Default: 1.00000000E-005
Usage: MAO_EPS_GRAD 1.0E-4

Description: Threshold used for MAO iterations.

[Edit on GitHub]

MAO_IOLEVEL

Type: integer
Default: 1
Usage: MAO_IOLEVEL 0

Description: Verbosity of MAO output: (0) no output … (3) fully verbose

[Edit on GitHub]

MAO_MAX_ITER

Type: integer
Default: 0
Usage: MAO_MAX_ITER 100

Description: Maximum iterations in MAO optimization.

[Edit on GitHub]

MATRIX_CLUSTER_TYPE

Type: enum
Default: ATOMIC
Usage: MATRIX_CLUSTER_TYPE MOLECULAR

Description: Specify how atomic blocks should be clustered in the used matrices, in order to improve flop rate, and possibly speedup the matrix multiply. Note that the atomic s_preconditioner can not be used. Furthermore, since screening is on matrix blocks, slightly more accurate results can be expected with molecular.

Valid values:

  • ATOMIC Using atomic blocks

  • MOLECULAR Using molecular blocks.

[Edit on GitHub]

MAX_ITER_LANCZOS

Type: integer
Default: 128
Usage: MAX_ITER_LANCZOS

Description: Maximum number of lanczos iterations.

[Edit on GitHub]

MU

Type: real
Default: -1.00000000E-001
Usage: MU 0.0

Description: Value (or initial guess) for the chemical potential, i.e. some suitable energy between HOMO and LUMO energy.

[Edit on GitHub]

NON_MONOTONIC

Type: logical
Default: T
Lone keyword: T
Usage: NON_MONOTONIC .TRUE.

Description: Should the purification be performed non-monotonically. Relevant for TC2 only.

[Edit on GitHub]

OT_INITIAL_GUESS

Type: enum
Default: ATOMIC
Usage: OT_INITIAL_GUESS ATOMIC

Description: Initial guess of density matrix used for OT Diagonalization

Valid values:

  • ATOMIC Generate an atomic density using the atomic code

  • GROUND_STATE Using the ground-state density.

[Edit on GitHub]

REPORT_ALL_SPARSITIES

Type: logical
Default: F
Lone keyword: T
Usage: REPORT_ALL_SPARSITIES

Description: Run the sparsity report at the end of the SCF

[Edit on GitHub]

SIGN_METHOD

Type: enum
Default: NEWTONSCHULZ
Usage: SIGN_METHOD NEWTONSCHULZ

Description: Method used for the computation of the sign matrix.

Valid values:

  • NEWTONSCHULZ Newton-Schulz iteration.

  • PROOT p-th order root iteration

References: VandeVondele2012, Niklasson2003

[Edit on GitHub]

SIGN_ORDER

Type: integer
Default: 2
Usage: SIGN_ORDER 2

Description: Order of the method used for the computation of the sign matrix.

[Edit on GitHub]

SKIP_EC

Type: logical
Default: F
Lone keyword: T
Usage: SKIP_EC T

Description: Skip EC calculation if ground-state calculation has not converged.

[Edit on GitHub]

S_INVERSION

Type: enum
Default: SIGN_SQRT
Usage: S_INVERSION MOLECULAR

Description: Method used to compute the inverse of S.

Valid values:

  • SIGN_SQRT Using the inverse sqrt as obtained from sign function iterations.

  • HOTELLING Using the Hotellign iteration.

[Edit on GitHub]

S_PRECONDITIONER

Type: enum
Default: ATOMIC
Usage: S_PRECONDITIONER MOLECULAR

Description: Preconditions S with some appropriate form.

Valid values:

  • NONE No preconditioner

  • ATOMIC Using atomic blocks

  • MOLECULAR Using molecular sub-blocks. Recommended if molecules are defined and not too large.

[Edit on GitHub]

S_SQRT_METHOD

Type: enum
Default: NEWTONSCHULZ
Usage: S_SQRT_METHOD NEWTONSCHULZ

Description: Method for the caclulation of the sqrt of S.

Valid values:

  • NEWTONSCHULZ Using a Newton-Schulz-like iteration

  • PROOT Using the p-th root method.

[Edit on GitHub]

S_SQRT_ORDER

Type: integer
Default: 3
Aliases: SIGN_SQRT_ORDER
Usage: S_SQRT_ORDER 3

Description: Order of the iteration method for the calculation of the sqrt of S.

[Edit on GitHub]