Skip to content

files input variables

This document lists and provides the description of the name (keywords) of the files input variables to be used in the input file for the abinit executable.

get1den

Mnemonics: GET the first-order density from _1DEN file
Mentioned in topic(s): topic_nonlinear, topic_ElPhonInt
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [38/1245] in all abinit tests, [7/159] in abinit tutorials

Relevant only for non self consistent RF calculations (e.g. to get electron phonon matrix elements) or for non linear RF calculations (to get mixed higher order derivatives you need several perturbed densities and wave functions). Indicate the files from which first-order densities must be obtained, in multi-dataset mode (in single dataset mode, use ird1den).

  • If get1den =0, no previously computed values are used.
  • If get1den >0, the value must be the index of the dataset from which the cell data is to be used as input data. It must be the index of a dataset already computed in the SAME run.
  • If get1den =-1, the output data of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If get1den =another negative number, it indicates the number of datasets to go backward to find the needed data (once again, going back beyond the first dataset is equivalent to using a zero get variable).

get1wf

Mnemonics: GET the first-order wavefunctions from _1WF file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [38/1245] in all abinit tests, [5/159] in abinit tutorials

Eventually used when ndtset > 0 (in the multi-dataset mode), to indicate starting wavefunctions, as an alternative to ird1wf. One should first read the explanations given for these latter variables. This variable is typically used to chain the calculations in the multi-dataset mode, since it describes from which dataset the OUTPUT wavefunctions are to be taken, as INPUT wavefunctions of the present dataset.

  • If get1wf =0, no previously computed values are used.
  • If get1wf >0, the value must be the index of the dataset from which the cell data is to be used as input data. It must be the index of a dataset already computed in the SAME run.
  • If get1wf =-1, the output data of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If get1wf =another negative number, it indicates the number of datasets to go backward to find the needed data (once again, going back beyond the first dataset is equivalent to using a zero get variable).

See also discussion in getwfk.

getbscoup

Mnemonics: GET the Bethe-Salpeter COUPling block from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

Eventually used when ndtset > 0 (multi-dataset mode), in the case of a Bethe-Salpeter calculation, to indicate that the starting coupling block of the excitonic Hamiltonian will be taken from the output of a previous dataset. It is used to chain the calculations, since it describes from which dataset the OUTPUT coupling block is to be taken, as INPUT of the present dataset.

  • If getbscoup =0, no previously computed values are used.
  • If getbscoup >0, the value must be the index of the dataset from which the cell data is to be used as input data. It must be the index of a dataset already computed in the SAME run.
  • If getbscoup =-1, the output data of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getbscoup =another negative number, it indicates the number of datasets to go backward to find the needed data (once again, going back beyond the first dataset is equivalent to using a zero get variable).

getbseig

Mnemonics: GET the Bethe-Salpeter EIGenstates from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

Eventually used when ndtset > 0 (multi-dataset mode), in the case of a Bethe-Salpeter calculation, to indicate that the starting excitonic eigenstates are to be taken from the output of a previous dataset. It is used to chain the calculations, since it describes from which dataset the OUTPUT eigenstates are to be taken, as INPUT eigenstates of the present dataset.

  • If getbseig =0, no previously computed values are used.
  • If getbseig >0, the value must be the index of the dataset from which the cell data is to be used as input data. It must be the index of a dataset already computed in the SAME run.
  • If getbseig =-1, the output data of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getbseig =another negative number, it indicates the number of datasets to go backward to find the needed data (once again, going back beyond the first dataset is equivalent to using a zero get variable).

getbsreso

Mnemonics: GET the Bethe-Salpeter RESOnant block from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

Eventually used when ndtset > 0 (multi-dataset mode), in the case of a Bethe-Salpeter calculation, to indicate that the starting resonant block of the excitonic Hamiltonian will be taken from the output of a previous dataset. It is used to chain the calculations, since it describes from which dataset the OUTPUT resonant block is to be taken, as INPUT of the present dataset.

  • If getbsreso =0, no previously computed values are used.
  • If getbsreso >0, the value must be the index of the dataset from which the cell data is to be used as input data. It must be the index of a dataset already computed in the SAME run.
  • If getbsreso =-1, the output data of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getbsreso =another negative number, it indicates the number of datasets to go backward to find the needed data (once again, going back beyond the first dataset is equivalent to using a zero get variable).

getddb

Mnemonics: GET the DDB from…
Mentioned in topic(s): topic_ElPhonInt, topic_TDepES
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [27/1245] in all abinit tests, [12/159] in abinit tutorials

This variable should be used when performing electron-phonon or temperature-dependent calculations in semiconductors with the legacy implementation that computes the e-ph matrix elements at the end of the DFPT run (for the new EPH code, see eph_task).

More detailed explanation…

The Born effective charge as well as the dielectric tensor will be read from a previous DFPT calculations of the electric field at q=Gamma. The use of this variable will trigger the cancellation of a residual dipole that leads to an unphysical divergence of the GKK with vanishing q-points. The use of this variable greatly improves the k-point convergence speed as the density of the k-point grid required to obtain the fulfillment of the charge neutrality sum rule is usually prohibitively large.

  • If getddb =0, no previously computed values are used.
  • If getddb >0, the value must be the index of the dataset from which the cell data is to be used as input data. It must be the index of a dataset already computed in the SAME run.
  • If getddb =-1, the output data of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getddb =another negative number, it indicates the number of datasets to go backward to find the needed data (once again, going back beyond the first dataset is equivalent to using a zero get variable).

Note also that, starting Abinit v9, one can also use getddb_filepath to specify the path of the file directly.

getddb_filepath

Mnemonics: GET the DDB from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Moderately used, [13/1245] in all abinit tests, [12/159] in abinit tutorials

Specify the path of the DDB file using a string instead of the dataset index. Alternative to getddb and irdddb. The string must be enclosed between quotation marks:

getddb_filepath "../outdata/out_DDB"

getddk

Mnemonics: GET the DDK wavefunctions from _1WF file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [85/1245] in all abinit tests, [12/159] in abinit tutorials

Eventually used when ndtset > 0 (in the multi-dataset mode), to indicate starting DDK wavefunctions, as an alternative to irdddk. One should first read the explanations given for the latter variable. This variable is typically used to chain the calculations in the multi-dataset mode, since it describes from which dataset the OUTPUT DDK wavefunctions are to be taken, as INPUT DDK wavefunctions of the present dataset.

  • If getddk =0, no use of previously computed output DDK wavefunction file appended with _DSx_1WF is done.
  • If getddk is positive, its value gives the index of the dataset for which the output wavefunction file appended with _1WF must be used.
  • If getddk is -1, the output 1wf file with _1WF of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getddk is a negative number, it indicates the number of datasets to go backward to find the needed wavefunction file. Going back beyond the first dataset is equivalent to using zero for the get variable.

In the case of a ddk calculation in a multi dataset run, in order to compute correctly the localisation tensor, it is mandatory to give getddk the value of the current dataset (i.e. getddk3 3 ) - this is a bit strange and should be changed in the future.

getdelfd

Mnemonics: GET the 1st derivative of wavefunctions with respect to ELectric FielD, from _1WF file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [10/1245] in all abinit tests, [1/159] in abinit tutorials

Eventually used when ndtset > 0 (in the multi-dataset mode), to indicate starting wavefunctions for the 1st derivative of wavefunctions with respect to ELectric FielD, from _1WF file. The getdelfd variable is typically used to chain the calculations in the multi-dataset mode, since it describes from which dataset the OUTPUT wavefunctions is to be taken, as INPUT wavefunctions of the present dataset.

  • If getdelfd =0, no use of previously computed output wavefunction file appended with _DSx_1WF is done.
  • If getdelfd is positive, its value gives the index of the dataset for which the output wavefunction file appended with _1WF must be used.
  • If getdelfd is -1, the output 1wf file with _1WF of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getdelfd is a negative number, it indicates the number of datasets to go backward to find the needed wavefunction file. Going back beyond the first dataset is equivalent to using zero for the get variable.

getden

Mnemonics: GET the DENsity from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [257/1245] in all abinit tests, [39/159] in abinit tutorials

Eventually used when ndtset > 0 (multi-dataset mode) and, in the case of a ground-state calculation, if iscf<0 (non-SCF calculation), to indicate that the starting density is to be taken from the output of a previous dataset. It is used to chain the calculations, since it describes from which dataset the OUTPUT density is to be taken, as INPUT density of the present dataset. Alternative to getden_filepath and irdden.

  • If getden == 0, no such use of previously computed output density file is done.

  • If getden is positive, its value gives the index of the dataset from which the output density is to be used as input. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.

  • If getden is -1, the output density of the previous dataset must be taken, which is a frequently occurring case.

  • If getden is a negative number, it indicates the number of datasets to go backward to find the needed file. Going back beyond the first dataset is equivalent to using zero for the get variable.

Be careful: the output density file of a run with non-zero ionmov does not have the proper name (it has a “TIM” indication) for use as an input of an iscf<0 calculation. One should use the output density of a ionmov == 0 run.

getden_filepath

Mnemonics: GET the DEN file from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [6/1245] in all abinit tests, [2/159] in abinit tutorials

Specify the path of the DEN file using a string instead of the dataset index. Alternative to getden and irdden. The string must be enclosed between quotation marks:

getden_filepath "../outdata/out_DEN"

getdkde

Mnemonics: GET the mixed 2nd derivative of wavefunctions with respect to K and electric field, from _1WF file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [10/1245] in all abinit tests, [1/159] in abinit tutorials

Eventually used when ndtset > 0 (in the multi-dataset mode), to indicate starting DKDE wavefunctions. The getdkde variable is typically used to chain the calculations in the multi-dataset mode, since it describes from which dataset the OUTPUT wavefunctions are to be taken, as INPUT wavefunctions of the present dataset.

  • If getdkde =0, no use of previously computed output DKDE wavefunction file appended with _DSx_1WF is done.
  • If getdkde is positive, its value gives the index of the dataset for which the output wavefunction file appended with _1WF must be used.
  • If getdkde is -1, the output 1wf file with _1WF of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getdkde is a negative number, it indicates the number of datasets to go backward to find the needed wavefunction file. Going back beyond the first dataset is equivalent to using zero for the get variable.

getdkdk

Mnemonics: GET the 2nd derivative of wavefunctions with respect to K, from _1WF file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [18/1245] in all abinit tests, [4/159] in abinit tutorials

Eventually used when ndtset > 0 (in the multi-dataset mode), to indicate starting DKDK wavefunctions. The getdkdk variable is typically used to chain the calculations in the multi-dataset mode, since it describes from which dataset the OUTPUT wavefunctions are to be taken, as INPUT wavefunctions of the present dataset.

  • If getdkdk =0, no use of previously computed output DKDK wavefunction file appended with _DSx_1WF is done.
  • If getdkdk is positive, its value gives the index of the dataset for which the output wavefunction file appended with _1WF must be used.
  • If getdkdk is -1, the output 1wf file with _1WF of the previous dataset must be taken, which is a frequently occurring case. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.
  • If getdkdk is a negative number, it indicates the number of datasets to go backward to find the needed wavefunction file. Going back beyond the first dataset is equivalent to using zero for the get variable.

getdrhodb

Mnemonics: GET the DRHODB from…
Mentioned in topic(s): topic_ElPhonInt
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: 10.3.0

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

This variable can be used when performing GWPT calculations with optdriver = 17 to read a DVDB file with the derivative of densities produced in a previous dataset. For example, one can concatenate a dataset in which an initial set of DFPT densities on a relatively coarse q-mesh is interpolated on a denser q-mesh using eph_task = 5 and eph_ngqpt_fine.

  • If getdrhodb == 0, no such use of previously computed output potential file is done.

  • If getdrhodb is positive, its value gives the index of the dataset from which the output potential is to be used as input. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.

  • If getdrhodb is -1, the output potential of the previous dataset must be taken, which is a frequently occurring case.

  • If getdrhodb is a negative number, it indicates the number of datasets to go backward to find the needed file. Going back beyond the first dataset is equivalent to using zero for the get variable.

Note also that one can also use getdrhodb_filepath to specify the path of the file directly.

getdrhodb_filepath

Mnemonics: GET the DRHODB file from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 10.3.0

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

Specify the path of the DVDB file with the first-order densities using a string instead of the dataset index. Alternative to getdrhodb and irddrhodb. The string must be enclosed between quotation marks:

getdrhodb_filepath "../outdata/out_DRHODB"

getdvdb

Mnemonics: GET the DVDB from…
Mentioned in topic(s): topic_ElPhonInt
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [18/1245] in all abinit tests, [12/159] in abinit tutorials

This variable can be used when performing electron-phonon calculations with optdriver = 7 to read a DVDB file (derivative of potential) produced in a previous dataset. For example, one can concatenate a dataset in which an initial set of DFPT potentials on a relatively coarse q-mesh is interpolated on a denser q-mesh using eph_task = 5 and eph_ngqpt_fine.

  • If getdvdb == 0, no such use of previously computed output potential file is done.

  • If getdvdb is positive, its value gives the index of the dataset from which the output potential is to be used as input. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.

  • If getdvdb is -1, the output potential of the previous dataset must be taken, which is a frequently occurring case.

  • If getdvdb is a negative number, it indicates the number of datasets to go backward to find the needed file. Going back beyond the first dataset is equivalent to using zero for the get variable.

Note also that, starting Abinit v9, one can also use getdvdb_filepath to specify the path of the file directly.

getdvdb_filepath

Mnemonics: GET the DVDB file from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Moderately used, [14/1245] in all abinit tests, [12/159] in abinit tutorials

Specify the path of the DVDB file using a string instead of the dataset index. Alternative to getdvdb and irddvdb. The string must be enclosed between quotation marks:

getdvdb_filepath "../outdata/out_DVDB"

getefmas

Mnemonics: GET the EFfective MASses from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [3/1245] in all abinit tests, [0/159] in abinit tutorials

Eventually used when ndtset > 0 (multi-dataset mode). Only relevant for optdriver=7 and eph_task=6. 10. If set to 1, take the data from a _EFMAS file as input. The latter must have been produced using prtefmas.

  • If getefmas == 0, no such use of previously computed output _EFMAS file is done.

  • If getefmas is positive, its value gives the index of the dataset from which the output _EFMAS file is to be used as input. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.

  • If getefmas is -1, the output _EFMAS file of the previous dataset must be taken, which is a frequently occurring case.

  • If getefmas is a negative number, it indicates the number of datasets to go backward to find the needed file. Going back beyond the first dataset is equivalent to using zero for the get variable.

gethaydock

Mnemonics: GET the HAYDOCK restart file from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

Eventually used when ndtset > 0 (multi-dataset mode) and, in the case of a Bethe-Salpeter calculation to indicate that the Haydock iterative technique will be restarted from the output of a previous dataset.

  • If gethaydock == 0, no such use of previously computed coupling block file is done.

  • If gethaydock is positive, its value gives the index of the dataset to be used as input.

  • If gethaydock is -1, the output of the previous dataset must be taken, which is a frequently occurring case.

  • If gethaydock is a negative number, it indicates the number of datasets to go backward to find the needed file. Going back beyond the first dataset is equivalent to using zero for the get variable.

getkden

Mnemonics: GET the Kinetic energy DENsity from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: getden
Added in version: 9.10.4

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

Only relevant when usekden=1 (meta GGA exchange-correlation functionals). Eventually used when ndtset > 0 (multi-dataset mode) and, in the case of a ground-state calculation, if iscf<0 (non-SCF calculation), to indicate that the starting kinetic energy density is to be taken from the output of a previous dataset. It can be used to chain the calculations, since it describes from which dataset the OUTPUT density is to be taken, as INPUT density of the present dataset.

  • If getkden == 0, no such use of previously computed output density file is done.

  • If getkden is positive, its value gives the index of the dataset from which the output density is to be used as input. However, if the first dataset is treated, -1 is equivalent to 0, since no dataset has been computed in the same run.

  • If getkden is -1, the output density of the previous dataset must be taken, which is a frequently occurring case.

  • If getkden is a negative number, it indicates the number of datasets to go backward to find the needed file. Going back beyond the first dataset is equivalent to using zero for the get variable.

getocc

Mnemonics: GET OCC parameters from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

This variable is typically used to chain the calculations, in the multi- dataset mode (ndtset > 0), since it describes from which dataset the array occ is to be taken, as input of the present dataset. The occupation numbers are EVOLVING variables, for which such a chain of calculations is useful.

  • If getocc == 0, no such use of previously computed output occupations is done.

  • If getocc is positive, its value gives the index of the dataset from which the data are to be used as input data. It must be the index of a dataset already computed in the SAME run.

  • If getocc is -1, the output data of the previous dataset must be taken, which is a frequently occurring case.

  • If getocc is a negative number, it indicates the number of datasets to go backward to find the needed data. Going back beyond the first dataset is equivalent to using zero for the get variable.

NOTE that a non-zero getocc MUST be used with occopt == 2, so that the number of bands has to be initialized for each k point. Of course, these numbers of bands must be identical to the numbers of bands of the dataset from which occ will be copied. The same is true for the number of k points.

getpot_filepath

Mnemonics: GET the KS POTential from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [3/159] in abinit tutorials

This variable defines the path of the POT file containing the KS ground-state potential that should be used in input. At present, it is mainly used in the EPH code when performing calculation with the Sternheimer equation. Note that the path must be inserted between quotation marks. Note also that relative paths are interpreted according to the working directory in which Abinit is executed!

getqps

Mnemonics: GET QuasiParticle Structure
Mentioned in topic(s): topic_multidtset, topic_GW, topic_Susceptibility, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [15/1245] in all abinit tests, [0/159] in abinit tutorials

Used when ndtset > 0 (multi-dataset mode) and optdriver = 3, or 4 (screening or sigma step of a GW calculation), to indicate that the eigenvalues and possibly the wavefunctions have to be taken from a previous quasi-particle calculation (instead of the usual DFT starting point). This is to achieve quasi-particle self-consistency. See also irdqps

  • If getqps == 0, no such use of previously computed values is done.

  • If getqps is positive, its value gives the index of the dataset from which the data are to be used as input data. It must be the index of a dataset already computed in the SAME run.

  • If getqps is -1, the output data of the previous dataset must be taken, which is a frequently occurring case.

  • If getqps is a negative number, it indicates the number of datasets to go backward to find the needed data. Going back beyond the first dataset is equivalent to using zero for the get variable.

getscr

Mnemonics: GET SCReening (the inverse dielectric matrix) from…
Mentioned in topic(s): topic_multidtset, topic_GW, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [75/1245] in all abinit tests, [8/159] in abinit tutorials

Used when ndtset > 0 (multi-dataset mode) and optdriver = 4 (sigma step of a GW calculation), to indicate that the dielectric matrix (_SCR file) is to be taken from the output of a previous dataset. It is used to chain the calculations, since it describes from which dataset the OUTPUT dielectric matrix is to be taken, as INPUT of the present dataset. Note also that, starting Abinit v9, one can also use getscr_filepath to specify the path of the file directly.

  • If getscr == 0, no such use of previously computed output _SCR file is done.

  • If getscr is positive, its value gives the index of the dataset from which the data are to be used as input data. It must be the index of a dataset already computed in the SAME run.

  • If getscr is -1, the output data of the previous dataset must be taken, which is a frequently occurring case.

  • If getscr is a negative number, it indicates the number of datasets to go backward to find the needed data. Going back beyond the first dataset is equivalent to using zero for the get variable.

getscr_filepath

Mnemonics: GET the SCR file from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

Specify the path of the SCR file using a string instead of the dataset index. Alternative to getscr and irdscr. The string must be enclosed between quotation marks:

getscr_filepath "../outdata/out_SCR"

getsigeph_filepath

Mnemonics: GET the SIGEPH from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: Output filename of the present dataset
Added in version: 9.1.0

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [1/159] in abinit tutorials

This variable defines the path of the SIGEPH file with the e-ph self-energy results that should be used as input for further analysis. At present, it is used by the transport driver (eph_task = 7) to read the lifetimes needed to compute carrier mobilities within the RTA.

getsuscep

Mnemonics: GET SUSCEPtibility (the irreducible polarizability) from…
Mentioned in topic(s): topic_multidtset, topic_GW, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

Used when ndtset > 0 (multi-dataset mode) and optdriver = 4 (sigma step of a GW calculation), to indicate that the irreducible polarizability (_SUSC file) is to be taken from the output of a previous dataset. It is used to chain the calculations, since it describes from which dataset the OUTPUT susceptibility is to be taken, as INPUT of the present dataset. Performing a GW calculations starting from the _SUSC file instead of the _SCR file presents the advantage that starting from the irreducible polarizability, one can calculate the screened interaction using different expressions without having to perform a screening calculation from scratch. For example, it is possible to apply a cutoff to the Coulomb interaction in order to facilitate the convergence of the GW correction with respect to the size of the supercell (see vcutgeo and icutcoul)

  • If getsuscep == 0, no such use of previously computed output _SUSC file is done.

  • If getsuscep is positive, its value gives the index of the dataset from which the data are to be used as input data. It must be the index of a dataset already computed in the SAME run.

  • If getsuscep is -1, the output data of the previous dataset must be taken, which is a frequently occurring case.

  • If getsuscep is a negative number, it indicates the number of datasets to go backward to find the needed data. Going back beyond the first dataset is equivalent to using zero for the get variable

getwfk

Mnemonics: GET the wavefunctions from _WFK file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [573/1245] in all abinit tests, [70/159] in abinit tutorials

Eventually used when ndtset > 0 (in the multi-dataset mode), to indicate starting wavefunctions, as an alternative to irdwfk. Note also that, starting Abinit v9, one can also use getwfk_filepath to specify the path of the file directly. One should read the explanations given for these latter variables as well as the present one.

The getwfk variable is typically used to chain the calculations in the multi-dataset mode, since it describes from which dataset the OUTPUT wavefunctions are to be taken, as INPUT wavefunctions of the present dataset.

We now focus on the getwfk input variable (the only one used in ground- state calculations), but the rules for getwfq, get1wf, getddk are similar, with _WFK replaced by _WFQ, _1WF or _DDK.

  • If getwfk ==0, no use of previously computed output wavefunction file appended with _DSx_WFK is done.
  • If getwfk >0, its value gives the index of the dataset for which the output wavefunction file appended with _WFK must be used.
  • If getwfk =-1, the output wf file with _WFK of the previous dataset must be taken, which is a frequently occurring case.
  • If getwfk is a negative number, it indicates the number of datasets to go backward to find the needed wavefunction file. In this case, if one refers to a non existent data set (prior to the first), the wavefunctions are not initialised from a disk file, so that it is as if getwfk =0 for that initialisation. Thanks to this rule, the use of getwfk -1 is rather straightforward: except for the first wavefunctions, that are not initialized by reading a disk file, the output wavefunction of one dataset is input of the next one.

NOTE: a negative value of a “get” variable indicates the number of datasets to go backwards; it is not the number to be subtracted from the current dataset to find the proper dataset. As an example:

  ndtset 3   jdtset 1 2 4  getXXX -1

refers to dataset 2 when dataset 4 is initialized.

getwfk_filepath

Mnemonics: GET the wavefunctions from WFK PATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Moderately used, [21/1245] in all abinit tests, [15/159] in abinit tutorials

Specify the path of the WFK file using a string instead of the dataset index. Alternative to getwfk and irdwfk. The string must be enclosed between quotation marks:

getwfk_filepath "../outdata/out_WFK"

getwfkfine_filepath

Mnemonics: GET the fine wavefunctions from FILEPATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [3/1245] in all abinit tests, [1/159] in abinit tutorials

Specify the path of the fine WFK file using a string instead of the dataset index. Alternative to getwfkfine and irdwfkfine. The string must be enclosed between quotation marks:

getwfkfine_filepath "../outdata/out_WFK"

getwfq

Mnemonics: GET the wavefunctions from _WFQ file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [37/1245] in all abinit tests, [5/159] in abinit tutorials

Eventually used when ndtset > 0 (in the multi-dataset mode), to indicate starting k+q wavefunctions, as an alternative to irdwfq. Note also that, starting Abinit v9, one can also use getwfq_filepath to specify the path of the file directly.

Similar to getwfk input variable, but will be used to initialize the wavefunctions at k+q.

getwfq_filepath

Mnemonics: GET the k+q wavefunctions from WFQ PATH
Mentioned in topic(s): topic_multidtset
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

Specify the path of the WFQ file using a string instead of the dataset index. Alternative to getwfq and irdwfq. The string must be enclosed between quotation marks:

getwfq_filepath "../outdata/out_WFQ"

indata_prefix

Mnemonics: INput DATA PREFIX
Mentioned in topic(s): topic_Control
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [8/1245] in all abinit tests, [2/159] in abinit tutorials

Prefix for input files. Replaces the analogous entry in the obsolete files_file . This variable is used when Abinit is executed with the new syntax:

abinit run.abi > run.log 2> run.err &

If this option is not specified, a prefix is automatically constructed from the input file name provided the filename ends with an extension, e.g. .ext. (.abi is recommended) If the input filename does not have a file extension, a default is provided.

ird1den

Mnemonics: Integer that governs the ReaDing of 1st-order DEN file
Mentioned in topic(s): topic_nonlinear
Variable type: integer
Dimensions: scalar
Default value: 1 if iscf < 0, 0 otherwise.

Added in version: before_v9

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

If the first-order density is needed in single dataset mode (for example in nonlinear optical response), use ird1den = 1 to read first-order densities from _DENx files produced in other calculations. In multi-dataset mode use get1den.

When iscf < 0, the reading of a DEN file is always enforced.

A non-zero value of ird1den is treated in the same way as other “ird” variables. For further information about the naming of files in ABINIT, consult the abinit help file.

ird1wf

Mnemonics: Integer that governs the ReaDing of _1WF files
Mentioned in topic(s): topic_DFPT
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

Indicates possible starting wavefunctions. As alternative, one can use the input variable get1wf. It is relevant only for Response-function calculation.

The role of the different input variables irdwfk, irdwfq and ird1wf and their getXXX counterparts is described in the following.

  • one and only one of irdwfk or getwfk MUST be non-zero
  • if irdwfk = 1: read ground state k -wavefunctions from a disk file appended with _WFK, produced in a previous ground state calculation.
  • only one of irdwfq or getwfq can be non-zero, if both of them are non-zero, use as k + q file the one defined by irdwfk and/or getwfk
  • if irdwfq = 1: read ground state k+q -wavefunctions from a disk file appended with _WFQ, produced in a previous ground state calculation.
  • at most one of ird1wf or get1wf can be non-zero
  • if both are zero, initialize first order wavefunctions to zeroes
  • if ird1wf = 1: read first-order wavefunctions from a disk file appended with _1WFx, produced in a previous response function calculation.
  • at most one of irdddk or getddk can be non-zero
  • one of them must be non-zero if an homogeneous electric field calculation is done (presently, a ddk calculation in the same dataset is not allowed)
  • if irdddk = 1: read first-order ddk wavefunctions from a disk file appended with _1WFx, produced in a previous response function calculation.

For further information about the naming of files in ABINIT, consult the abinit help file.

irdbscoup

Mnemonics: Integer that governs the ReaDing of COUPling block
Mentioned in topic(s): topic_BSE
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

If 1, will start the Bethe-Salpeter calculation from the BSC file containing the coupling block produced in a previous run.

irdbseig

Mnemonics: Integer that governs the ReaDing of BS_EIG file
Mentioned in topic(s): topic_BSE
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

If 1, will tart the Bethe-Salpeter calculation from the BS_EIG containing the exciton eigenvectors produced in a previous run.

irdbsreso

Mnemonics: Integer that governs the ReaDing of RESOnant block
Mentioned in topic(s): topic_BSE
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

If 1, will start the Bethe-Salpeter calculation from the BSR file containing the resonant block produced in a previous run.

irdchkprdm

Mnemonics: Integer that governs ReaDing of CHecK-Point files for the GW 1-RDM
Mentioned in topic(s): topic_GW, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Only relevant if: optdriver == 4
Added in version: 9.4.0

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

irdchkprdm ==1 triggers the reading of binary checkpoint files when updating the density matrix for the the linearized GW approximation. It is only meaningful when gw1rdm>0. The files that are read use the usual ABINIT input files naming convention with extension _CHKP_RDM_1.

irdddb

Mnemonics: Integer that governs the ReaDing of DDB file
Mentioned in topic(s): topic_ElPhonInt
Variable type: integer
Dimensions: scalar
Default value: 1 if iscf < 0, 0 otherwise.

Added in version: before_v9

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

This variable should be used when performing electron-phonon or temperature- dependence calculations. The Born effective charge as well as the dielectric tensor will be read from a previous DFPT calculations of the electric field at q=Gamma. The use of this variable will trigger the cancellation of a residual dipole that leads to an unphysical divergence of the GKK with vanishing q-points. The use of this variable greatly improves the k-point convergence speed as the density of the k-point grid required to obtain the fulfillment of the charge neutrality sum rule is usually prohibitively large.

A non-zero value of irdddb is treated in the same way as other “ird” variables. For further information about the naming of files in ABINIT, consult the abinit help file.

The input variable getddb is an alternative to irdddb , in the multidataset case. Note also that, starting Abinit v9, one can also use getddb_filepath to specify the path of the DDB file directly.

irdddk

Mnemonics: Integer that governs the ReaDing of DDK wavefunctions, in _1WF files
Mentioned in topic(s): topic_DFPT
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [5/1245] in all abinit tests, [0/159] in abinit tutorials

Indicates whether ABINIT should read the DDK wavefunctions as possible starting wavefunctions. As alternative, one can use the input variable getddk.

  • at most one of irdddk or getddk can be non-zero
  • one of them must be non-zero if an homogeneous electric field calculation is done (presently, a ddk calculation in the same dataset is not allowed)
  • if irdddk = 1: read first-order ddk wavefunctions from a disk file appended with _1WFx, produced in a previous response function calculation

For further information about the naming of files in ABINIT, consult the abinit help file.

irdden

Mnemonics: Integer that governs the ReaDing of density DEN file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 1 if iscf < 0, 0 otherwise.

Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

If 1, will start the ground-state calculation from the density file of a previous run. When iscf < 0, the reading of a DEN file is always enforced. Alternative to getden_filepath and getden.

A non-zero value of irdden is treated in the same way as other “ird” variables. For further information about the naming of files in ABINIT, consult the abinit help file.

irddrhodb

Mnemonics: Integer that governs the ReaDing of DRHODB file
Mentioned in topic(s): topic_ElPhonInt
Variable type: integer
Dimensions: scalar
Default value: None
Added in version: 10.3.0

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

This variable can be used when performing GWPT calculations with optdriver = 17. Set to 1, an input DRHODB file will be read. See also getdrhodb

irddvdb

Mnemonics: Integer that governs the ReaDing of DVDB file
Mentioned in topic(s): topic_ElPhonInt
Variable type: integer
Dimensions: scalar
Default value: None
Added in version: before_v9

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

This variable can be used when performing electron-phonon calculations with optdriver = 7. Set to 1, an input DVDB file will be read. See also getdvdb

irdefmas

Mnemonics: Integer to ReaD the EFfective MASses from…
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

Eventually used when ndtset > 0 (multi-dataset mode). Only relevant for optdriver=7 and eph_task=6, 10. If set to 1, take the data from a _EFMAS file as input. The latter must have been produced using prtefmas in another run.

irdhaydock

Mnemonics: Integer that governs the ReaDing of the HAYDOCK restart file
Mentioned in topic(s): topic_BSE
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

If 1, will re-start the Haydock iterative technique from the HAYDR_SAVE file produced in a previous run.

irdkden

Mnemonics: Integer that governs the ReaDing of Kinetic energy density KDEN file
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 1 if iscf < 0, irdden otherwise.

Added in version: 9.10.4

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

Only relevant when usekden=1 (meta GGA exchange-correlation functionals). If 1, will start the ground-state calculation from the kinetic energy density file of a previous run. When iscf < 0, the reading of a KDEN file is always enforced. Alternative to getkden.

A non-zero value of irdkden is treated in the same way as other “ird” variables. For further information about the naming of files in ABINIT, consult the abinit help file.

irdqps

Mnemonics: Integer that governs the ReaDing of QuasiParticle Structure
Mentioned in topic(s): topic_GW, topic_multidtset, topic_Susceptibility, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [3/1245] in all abinit tests, [0/159] in abinit tutorials

Relevant only when optdriver = 3 or 4. If 1, indicate that the eigenvalues and possibly the wavefunctions must be obtained, in order to achieve a self-consistent quasi-particle calculations. See also getqps

irdscr

Mnemonics: Integer that governs the ReaDing of the SCReening
Mentioned in topic(s): topic_GW, topic_multidtset, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [9/1245] in all abinit tests, [4/159] in abinit tutorials

Relevant only when optdriver = 4. If non-zero, indicate that the dielectric matrix must be obtained from an existing file. As alternative, one can use the input variable getscr. When optdriver = 4, at least one of irdscr or getscr (alternatively, irdsuscep or getsuscep) must be non-zero.

A non-zero value of irdscr is treated in the same way as other “ird” variables. For further information about the naming of files in ABINIT, consult the abinit help file.

irdsuscep

Mnemonics: Integer that governs the ReaDing of the SUSCEPtibility
Mentioned in topic(s): topic_GW, topic_multidtset, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

Relevant only when optdriver = 4. If non-zero, indicate that the irreducible polarizability must be obtained from an existing file. As alternative, one can use the input variable getsuscep. When optdriver = 4, at least one of irdsuscep or getsuscep (alternatively, irdscr or getscr) must be non-zero.

A non-zero value of irdsuscep is treated in the same way as other “ird” variables. For further information about the naming of files in ABINIT, consult the abinit help file.

irdwfk

Mnemonics: Integer that governs the ReaDing of _WFK files
Mentioned in topic(s): topic_multidtset
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [91/1245] in all abinit tests, [12/159] in abinit tutorials

Indicates possible starting wavefunctions. As alternative, one can use the input variables irdwfq, ird1wf or irdddk, as well as they getXXX counterparts. Here follows a global description of the usage of these input variables.

Ground-state calculation:

  • only irdwfk and getwfk have a meaning
  • at most one of irdwfk or getwfk can be non-zero
  • if irdwfk and getwfk are both zero, initialize wavefunctions with random numbers for ground state calculation.
  • if irdwfk = 1: read ground state wavefunctions from a disk file appended with _WFK, produced in a previous ground state calculation.

Response-function calculation:

  • one and only one of irdwfk or getwfk MUST be non-zero
  • if irdwfk = 1: read ground state k -wavefunctions from a disk file appended with _WFK, produced in a previous ground state calculation
  • only one of irdwfq or getwfq can be non-zero, if both of them are non-zero, use as k + q file the one defined by irdwfk and/or getwfk
  • if irdwfq = 1: read ground state k+q -wavefunctions from a disk file appended with _WFQ, produced in a previous ground state calculation
  • at most one of ird1wf or get1wf can be non-zero
  • if both are zero, initialize first order wavefunctions to 0’s.
  • if ird1wf = 1: read first-order wavefunctions from a disk file appended with _1WFx, produced in a previous response function calculation
  • at most one of irdddk or getddk can be non-zero
  • one of them must be non-zero if an homogeneous electric field calculation is done (presently, a ddk calculation in the same dataset is not allowed)
  • if irdddk = 1: read first-order ddk wavefunctions from a disk file appended with _1WFx, produced in a previous response function calculation

For further information about the naming of files in ABINIT, consult the abinit help file.

irdwfq

Mnemonics: Integer that governs the ReaDing of _WFQ files
Mentioned in topic(s): topic_DFPT
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [5/1245] in all abinit tests, [0/159] in abinit tutorials

See detailed description at irdwfq . As alternative, one can use the input variable getwfq.

kssform

Mnemonics: Kohn Sham Structure file FORMat
Mentioned in topic(s): topic_Susceptibility, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 1
Added in version: before_v9

Test list (click to open). Rarely used, [11/1245] in all abinit tests, [3/159] in abinit tutorials

Governs the choice of the format for the file that contains the Kohn-Sham electronic structure information, for use in GW calculations, see the input variables optdriver and nbandkss.

  • kssform = 1, a single file.kss (double precision) containing complete information on the Kohn Sham Structure (eigenstates and the pseudopotentials used) will be generated through full diagonalization of the complete Hamiltonian matrix. The file has at the beginning the standard abinit header.
  • kssform = 3, a single file.kss (double precision) containing complete information on the Kohn Sham Structure (eigenstates and the pseudopotentials used) will be generated through the usual conjugate gradient algorithm (so, a restricted number of states). The file has at the beginning the standard abinit header.

Warning

For the time being, istwfk must be 1 for all the k-points.

ncout

Mnemonics: Print netCDF output files
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 1
Added in version: 9.11.0

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1, ABINIT will produce a netCDF output file up to 10 datasets calculations. If set to 0, said files will not be printed.

outdata_prefix

Mnemonics: OUTput DATA PREFIX
Mentioned in topic(s): topic_Control
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [10/1245] in all abinit tests, [4/159] in abinit tutorials

Prefix for output files. Replaces the analogous entry in the obsolete files_file . This variable is used when Abinit is executed with the new syntax:

abinit run.abi > run.log 2> run.err &

If this option is not specified, a prefix is automatically constructed from the input file name provided the filename ends with an extension, e.g. .ext. (.abi is recommended) If the input filename does not have a file extension, a default is provided.

output_file

Mnemonics: OUTPUT FILE
Mentioned in topic(s): topic_Control
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Moderately used, [22/1245] in all abinit tests, [15/159] in abinit tutorials

String specifying the name of the main output file when Abinit is executed with the new syntax:

abinit run.abi > run.log 2> run.err &

If not specified, the name of the output file is automatically generated by replacing the file extension of the input file with .abo. To specify the filename in the input use the syntax:

output_file "t01.out"

with the string enclosed between double quotation marks.

pp_dirpath

Mnemonics: PseudoPotential DIRectory PATH
Mentioned in topic(s): topic_Control
Variable type: string
Dimensions: scalar
Default value:
Added in version: 9.0.0

Test list (click to open). Very frequently used, [1241/1245] in all abinit tests, [159/159] in abinit tutorials

This variable specifies the directory that will be prepended to the names of the pseudopotentials specified in pseudos. This option is useful when all your pseudos are gathered in a single directory in your file system and you don not want to type the absolute path for each pseudopotential file.

This variable is used when Abinit is executed with the new syntax:

abinit abi_in >& log &

The string must be quoted in double quotation marks:

pp_dirpath "/home/user/my_pseudos/"
pseudos "al.psp8, as.psp8"

If pp_dirpath is not present, the filenames specified in pseudos are used directly.

prt1dm

Mnemonics: PRinT 1-DiMensional potential and density
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [13/1245] in all abinit tests, [0/159] in abinit tutorials

If set >= 1, provide one-dimensional projection of potential and density, for each of the three axis. This corresponds to averaging the potential or the density on bi-dimensional slices of the FFT grid.

prtchkprdm

Mnemonics: Integer that governs PrinTing of CHecK-Point files for the GW 1-RDM
Mentioned in topic(s): topic_GW, topic_SelfEnergy
Variable type: integer
Dimensions: scalar
Default value: 0
Only relevant if: optdriver == 4
Added in version: 9.4.0

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

prtchkprdm ==1 triggers the priting of binary checkpoint files when updating the density matrix for the the linearized GW approximation. It is only meaningful when gw1rdm>0. The files that are printed use the usual ABINIT output files naming convention with extension _CHKP_RDM_1.

prtddb

Mnemonics: PRinT the Derivative Data Base file
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 1
Added in version: 9.11.0

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1, ABINIT will produce a DDB file.

prtden

Mnemonics: PRinT the DENsity
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0 if nimage > 1, 1 otherwise.

Added in version: before_v9

Test list (click to open). Moderately used, [421/1245] in all abinit tests, [59/159] in abinit tutorials

If set to 1 or a larger value, provide output of electron density in real space rho(r), in units of electrons/Bohr^3. If ionmov == 0, the name of the density file will be the root output name, followed by _DEN. If ionmov /= 0, density files will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the time step (see later)
  • then followed by _DEN

The file structure of this unformatted output file is described in this section. If prtden is lower than 0, two files will be printed for restart every prtden step, with the names being made of

  • the root temporary name,
  • followed by _DEN_x, where x is 0000 or 0001 alternatively.
  • The most recent of the two files should be used for restart, and copied to root input name_DS2_DEN
  • To perform a restart, in a multidataset mode, use ndtset 2 and jdtset 2 3 (that is 2 datasets, numbered 2 and 3)
  • In the dataset 2, get the density you just copied (getden2 -1), perform a non self-consistent calculation and print the wave function (prtwf2 1)
  • In the dataset 3, get the previous wf(getwfk3 -1), and continue the calculation
  • This complicated procedure is due to the fact that reading the density is only allowed for a non sc calculation, and also for a dataset different of 0 or the previous one, the option we choose here.

Please note that in the case of PAW (%usepaw = 1) calculations, the _DEN density output is not the full physical electron density. If what is wanted is the full physical electron density, say for post-processing with AIM or visualization, prtden > 1 will produce physical electron density or other interesting quantities (see below). Nevertheless, even in the PAW case, when chaining together calculations where the density from one calculation is to be used in a subsequent calculation, it is necessary to use the _DEN files and not one of the other files produced with prtden > 1, i.e. _PAWDEN, ATMDEN_xxx or else. Note that the usual _DEN file is always generated as soon as prtden >= 1. Options 2 to 6 for prtden are relevant only for %usepaw = 1 and control the output of the full electron density in the PAW case:

prtden=2 causes generation of a file _PAWDEN that contains the bulk valence charge density together with the PAW on-site contributions, and has the same format as the other density files. prtden=3 causes generation of a file _PAWDEN that contains the bulk full charge density (valence+core) prtden=4 causes generation of three files _ATMDEN_CORE, _ATMDEN_VAL and _ATMDEN_FULL which respectively contain the core, valence and full atomic protodensity (the density of the individual component atoms in vacuum superposed at the bulk atomic positions). This can be used to generate various visualizations of the bonding density. prtden=5 options 2 and 4 taken together. prtden=6 options 3 and 4 taken together. prtden=7 causes the generation of all the individual contributions to the bulk valence charge density: n_tilde-n_hat (_N_TILDE), n_onsite (_N_ONE) and n_tilde_onsite (_NT_ONE). This is for diagnosis purposes only.

Options 3 to 6 currently require the user to supply the atomic core and valence density in external files in the working directory. The files must be named properly; for example, the files for an atom of type 1 should be named: “core_density_atom_type1.dat” and “valence_density_atom_type1.dat”. The file should be a text file, where the first line is assumed to be a comment, and the subsequent lines contain two values each, where the first one is a radial coordinate and the second the value of the density n(r). Please note that it is n(r) which should be supplied, not n(r)/r^2. The first coordinate point must be the origin, i.e. **r = 0 **. The atomic densities are spherically averaged, so assumed to be completely spherically symmetric, even for open shells.

NOTE: in the PAW case, DO NOT use _PAWDEN or _ATMDEN_xxx files produced by prtden > 1 to chain the density output from one calculation as the input to another, use the _DEN file for that.

prtdos

Mnemonics: PRinT the Density Of States
Mentioned in topic(s): topic_printing, topic_ElecDOS, topic_AtomCentered
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [44/1245] in all abinit tests, [7/159] in abinit tutorials

Provide output of Density of States if set to 1…5. Can either use a smearing technique ( prtdos = 1 or 4), or the tetrahedron method ( prtdos = 2, 3 or 5). If prtdos = 3 or 4, provide output of angular-momentum projected Local Density of States inside a sphere centered on different atoms (all or only those specified by iatsph), and possibly output m-decomposed LDOS if prtdosm is defined.

The resolution of the linear grid of energies for which the DOS is computed can be tuned thanks to dosdeltae.

If prtdos = 1, the smeared density of states is obtained from the eigenvalues, properly weighted at each k point using wtk, and smeared according to occopt and tsmear. All levels that are present in the calculation are taken into account (occupied and unoccupied). In order to compute the DOS of an insulator with prtdos = 1, compute its density thanks to a self-consistent calculation (with a non-metallic occopt value, 0, 1 or 2), then use prtdos = 1, together with iscf = -3, and a metallic occopt, between 3 and 7, providing the needed smearing. If prtdos = 1, the name of the DOS file is the root name for the output files, followed by “_DOS”.

  • Note 1: occopt must be between 3 and 7.
  • Note 2: The sampling of the Brillouin Zone that is needed to get a converged DOS is usually much finer than the sampling needed to converge the total energy or the geometry of the system, unless tsmear is very large (hence the DOS is not obtained properly). A separate convergence study is needed.

If prtdos = 2, the DOS is computed using the tetrahedron method. As in the case of prtdos = 1, all levels that are present in the calculation are taken into account (occupied and unoccupied). In this case, the k-points must have been defined using the input variable ngkpt or the input variable kptrlatt. There must be at least two non-equivalent points in the Irreducible Brillouin Zone to use prtdos = 2. It is strongly advised that you use a non-shifted k-point grid (shiftk 0 0 0): such grids naturally contain more extremal points (band minima and maxima at Gamma or at the zone- boundaries) than shifted grids, and lead to more non-equivalent points than shifted grids, for the same grid spacing. There is no need to take care of the occopt or tsmear input variables, and there is no subtlety to be taken into account for insulators. The computation can be done in the self- consistent case as well as in the non-self-consistent case, using iscf = -3. This allows one to refine the DOS at fixed starting density. In that case, if ionmov == 0, the name of the potential file will be the root output name, followed by _DOS (like in the prtdos = 1 case). However, if ionmov /= 0, potential files will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the time step (see later)
  • then followed by _DOS.

If prtdos = 3, the same tetrahedron method as for prtdos = 2 is used, but the angular-momentum projected (l=0,1,2,3,4) DOS in sphere centered on the atoms is computed (not directly the total atom-centered DOS). The preparation of this case, the parameters under which the computation is to be done, and the file denomination is similar to the prtdos = 2 case. However, three additional input variables might be provided, describing the atoms that are the center of the sphere (input variables natsph and iatsph), as well as the radius of this sphere (input variable ratsph). In case of PAW, ratsph radius has to be greater or equal to the largest PAW radius of the atom types considered (which is read from the PAW atomic data file; see rc_sph or r_paw). Additionally, printing and/or approximations in PAW mode can be controlled with pawprtdos keyword (in particular, pawprtdos = 2 can be used to compute quickly a very good approximation of the DOS).

If prtdos = 4, delivers the sphere-projected DOS (like prtdos = 3), on the basis of a smearing approach (like prtdos = 1). See (like prtdos = 1 for the additional input variables to be specified.

If prtdos = 5, delivers the spin-spin DOS in the nspinor == 2 case, using the tetrahedron method (as prtdos = 2).

prtdosm

Mnemonics: PRinT the Density Of States with M decomposition
Mentioned in topic(s): topic_printing, topic_ElecDOS, topic_AtomCentered
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [1/159] in abinit tutorials

Relevant only when prtdos = 3. If set to 1, the m-decomposed LDOS is delivered in DOS file. Note that prtdosm computes the M-resolved partial dos for complex spherical harmonics,giving e.g. DOS(L,M) == DOS(L,-M) (without spin-orbit). In the contrary, the DFT+U occupation matrix, see dmatpawu is in the real spherical harmonics basis. If set to 2, the m-decomposed LDOS is delivered in DOS file. In this case, prtdosm computes the M-resolved partial dos for real spherical harmonics in the same basis as the DFT+U occupation matrix.

prteig

Mnemonics: PRinT EIGenenergies
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0 if nimage > 1, 1 otherwise.

Added in version: before_v9

Test list (click to open). Moderately used, [182/1245] in all abinit tests, [37/159] in abinit tutorials

If set to 1, a file *_EIG, containing the k-points and one-electron eigenvalues is printed.

If set to 2, with ionmov /= 0, eigenenergies file will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the time step (see later)
  • then followed by _EIG.

The file structure of this unformatted output file is described in this section. No output is provided by a negative value of this variable.

prtelf

Mnemonics: PRinT Electron Localization Function (ELF)
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [3/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1 or a larger value, provide output of ELF in real space elf(r). This is a dimensionless quantity bounded between 0 and 1. The name of the ELF file will be the root output name, followed by _ELF. Like a _DEN file, it can be analyzed by cut3d. However unlike densities, in case of spin polarized calculations, the spin down component can not be obtained by subtracting the spin up component to the total ELF. Hence when spin polarized calculations are performed the code produces also output files with _ELF_UP and _ELF_DOWN extensions. (For technical reasons these files contain also two components but the second is zero. So to perform analysis of _ELF_UP and _ELF_DOWN files with cut3d you have to answer “ispden= 0 → Total density” when cut3d ask you which ispden to choose. Also remember that spin down component can not be obtained by using cut3d on the _ELF file. Sorry for the inconvenience, this will be fixed in the next release.) ELF is not yet implemented in non collinear spin case. If prtelf is set to 2, in the case of spin polarized calculation, the total ELF is computed from an alternative approach which should better take into account the existence of spin dependent densities (see the documentation in /doc/theory/ELF of your ABINIT repository)

Please note that ELF is not yet implemented in the case of PAW (%usepaw = 1) calculations.

prtevk

Mnemonics: PRinT EVK
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: 9.11.0

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1, ABINIT will produce a netCDF EVK file.

prtfsurf

Mnemonics: PRinT Fermi SURFace file
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1, provide Fermi surface file in the BXSF format (Xcrysden) If prtfsurf = 1, a _BXSF file readable by XCrySDen will be produced at the end of the calculation. The file contains information on the band structure of the system and can be used to visualize the Fermi surface or any other energy isosurface. prtfsurf = 1 is compatible only with SCF calculations (iscf > 1) or NSCF runs in which the occupation factors and Fermi level are recalculated once convergence is achieved (iscf = -3). The two methods should produce the same Fermi surface provided that the k-meshes are sufficiently dense. The k-mesh used for the sampling of the Fermi surface can be specified using the standard variables ngkpt, (shiftk, and nshiftk. Note, however, that the mesh must be homogeneous and centered on gamma (multiple shifts are not supported by Xcrysden)

prtgden

Mnemonics: PRinT the Gradient of electron DENsity
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1 or a larger value, provide output of gradient of electron density in real space grho(r), in units of Bohr^-(5/2). The names of the gradient of electron density files will be the root output name, followed by _GDEN1, _GDEN2, GDEN3 for each principal direction (indeed it is a vector). Like a _DEN file, it can be analyzed by cut3d. The file structure of this unformatted output file is described in this section.

prtgeo

Mnemonics: PRinT the GEOmetry analysis
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [6/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1 or a larger value, provide output of geometry analysis (bond lengths and bond angles). The value of prtgeo is taken by the code to be the maximum coordination number of atoms in the system. It will deduce a maximum number of “nearest” and “next-nearest” neighbors accordingly, and compute corresponding bond lengths. It will compute bond angles for the “nearest” neighbours only. If ionmov == 0, the name of the file will be the root output name, followed by _GEO. If ionmov /= 0, one file will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the time step (see later)
  • then followed by _GEO

The content of the file should be rather self-explanatory. No output is provided by prtgeo is lower than or equal to 0. If prtgeo > 0, the maximum number of atoms (natom) is 9999.

prtgkk

Mnemonics: PRinT the GKK matrix elements file
Mentioned in topic(s): topic_printing, topic_ElPhonInt
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [5/1245] in all abinit tests, [1/159] in abinit tutorials

If set to 1, provide output of electron-phonon “gkk” matrix elements, for further treatment by mrggkk utility or anaddb utility. Note that symmetry will be disabled for the calculation of the perturbation, forcing the inclusion of all k-points and all perturbation directions. Additional information on electron-phonon treatment in ABINIT is given in the tutorial eph_intro tutorial and subsequent ones, eph4mob tutorial and eph4zpr tutorial.

prtgsr

Mnemonics: PRinT the GSR file
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0 if nimage > 1, 1 otherwise.

Added in version: before_v9

Test list (click to open). Rarely used, [6/1245] in all abinit tests, [2/159] in abinit tutorials

If set to 1, ABINIT will produce a GSR file at the end of the GS calculation. The GSR file contains the most important GS results (band structure, forces, stresses, electronic density). The GSR file can be read by AbiPy and used for further post-processing.

prthist

Mnemonics: PRinT the HISTory file
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 1
Added in version: 9.11.0

Test list (click to open). Rarely used, [0/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1, ABINIT will produce a HIST file. The HIST file contains the history of structural relaxations or molecular dynamics calculations. This file can be used to restart the calculation or to analyze the results at the end of calculation.

prtkbff

Mnemonics: PRinT Kleynman-Bylander Form Factors
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Only relevant if: iomode == 3
Added in version: 8.7.3

Test list (click to open). Rarely used, [2/1245] in all abinit tests, [0/159] in abinit tutorials

This input variable activates the output of the Kleynman-Bylander form factors in the netcdf WFK file produced at the end of the ground-state calculation. Remember to set iomode to 3.

The form factors are needed to compute the matrix elements of the commutator [Vnl, r] of the non-local part of the (NC) pseudopotentials. This WFK file can therefore be used to perform optical and/or many-body calculations with external codes such as DP/EXC and Yambo. The option is ignored if PAW.

Important

At the time of writing November 28, 2024, istwfk must be set to 1 for all k-points in the IBZ since external codes do not support wavefunctions given on the reduced G-sphere. Moreover useylm must be 0 (default if NC pseudos).

prtkden

Mnemonics: PRinT the Kinetic energy DENsity
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 1 if usekden == 1 and nimage == 1 else 0
Added in version: before_v9

Test list (click to open). Rarely used, [11/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1 or a larger value, provide output of kinetic energy density in real space tau(r), in units of Bohr^-5. The name of the kinetic energy density file will be the root output name, followed by _KDEN. Like a _DEN file, it can be analyzed by cut3d. The file structure of this unformatted output file is described in this section. Note that the computation of the kinetic energy density must be activated, thanks to the input variable usekden.

prtkpt

Mnemonics: PRinT the K-PoinTs sets
Mentioned in topic(s): topic_printing, topic_Output, topic_k-points
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [16/1245] in all abinit tests, [1/159] in abinit tutorials

If set /= 0, proceeds to a detailed analysis of different k point grids. Works only if kptopt is positive, and neither kptrlatt nor ngkpt are defined. ABINIT will stop after this analysis.

Different sets of k point grids are defined, with common values of shiftk. In each set, ABINIT increases the length of vectors of the supercell (see kptrlatt) by integer steps. The different sets are labelled by “iset”. For each k point grid, kptrlen and nkpt are computed (the latter always invoking kptopt = 1, that is, full use of symmetries). A series is finished when the computed kptrlen is twice larger than the input variable kptrlen. After the examination of the different sets, ABINIT summarizes, for each nkpt, the best possible grid, that is, the one with the largest computed kptrlen.

Note that this analysis is also performed when prtkpt = 0, as soon as neither kptrlatt nor ngkpt are defined. But, in this case, no analysis report is given, and the code selects the grid with the smaller ngkpt for the desired kptrlen. However, this analysis takes some times (well sometimes, it is only a few seconds - it depends on the value of the input kptrlen), and it is better to examine the full analysis for a given cell and set of symmetries, shiftk for all the production runs.

If set to -2, the code stops in invars1 after the computation of the irreducible set and a file named kpts.nc with the list of the k-points and the corresponding weights is produced

prtlden

Mnemonics: PRinT the Laplacian of electron DENsity
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1 or a larger value, provide output of Laplacian of electron density in real space grho(r), in units of Bohr^-(7/2). The name of the Laplacian of electron density file will be the root output name, followed by _LDEN. Like a _DEN file, it can be analyzed by cut3d. The file structure of this unformatted output file is described in this section.

prtpot

Mnemonics: PRinT total POTential
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [29/1245] in all abinit tests, [1/159] in abinit tutorials

If set >=1, provide output of the total (Kohn-Sham) potential (sum of local pseudo-potential, Hartree potential, and xc potential).

If ionmov == 0, the name of the potential file will be the root output name, followed by _POT. If ionmov /= 0, potential file will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the time step (see later)
  • then followed by _POT.

The file structure of this unformatted output file is described in this section. No output is provided by a negative value of this variable.

NB: In DFPT calculations, prtpot is automatically set to 1 as the POT files might be used to perform EPH calculations unless the user explictly sets prtpot to 0 in the input file.

prtpsps

Mnemonics: PRint the PSPS file
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1, the code produces a netcdf file (PSPS.nc) with the internal tables used by Abinit to apply the pseudopotential part of the KS Hamiltonian. The data can be visualized with AbiPy. If prtpsps is set to -1, the code will exit after the output of the PSPS.nc file.

prtspcur

Mnemonics: PRinT the SPin CURrent density
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1 or a larger value, provide output of the current density of different direction spins (x,y,z) in the whole unit cell. Should require spinorial wave functions nspinor = 2. Experimental: this does not work yet.

prtstm

Mnemonics: PRinT the STM density
Mentioned in topic(s): topic_printing, topic_STM
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [3/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1, provide output of the electron density in real space rho(r), made only from the electrons close to the Fermi energy, in a range of energy (positive or negative), determined by the (positive or negative, but non-zero) value of the STM bias stmbias.

Specifying a non-zero negative value is also allowed, and will produce also the output of an electron density in real space, like the above, but moreover will additionally filter it to have the contribution of one band only, whose number is the absolute value of prtstm . Obviously abs( prtstm ) must be smaller or equal to nband. This allow one to perform a detailed band-by-band analysis.

The electron density obtained from prtstm =1, is a very approximate way to obtain STM profiles: one can choose an equidensity surface, and consider that the STM tip will follow this surface. Such equidensity surface might be determined with the help of Cut3D, and further post-processing of it (to be implemented). The big approximations of this technique are: neglect of the finite size of the tip, and position- independent transfer matrix elements between the tip and the surface. The charge density is provided in units of electrons/Bohr^3. The name of the STM density file will be the root output name, followed by _STM. Like a _DEN file, it can be analyzed by cut3d.

The file structure of this unformatted output file is described in this section. For the STM charge density to be generated, one must give, as an input file, the converged wavefunctions obtained from a previous run, at exactly the same k-points and cut-off energy, self-consistently determined, using the occupation numbers from occopt = 7.

In the run with positive prtstm , one has to use:

Note that you might have to adjust the value of nband as well, for the treatment of unoccupied states, because the automatic determination of nband will often not include enough unoccupied states. When prtstm is non-zero, the stress tensor is set to zero. No other printing variables for density or potentials should be activated (e.g. prtden has to be set to zero).

prtsuscep

Mnemonics: PRinT the SUSCEPtibility file (the irreducible polarizability)
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [12/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 0, no _SUSC file will be produced after the screening calculation, only the _SCR file will be output.

prtvclmb

Mnemonics: PRinT V CouLoMB
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

If set >= 0 outputs a file with the Coulomb potential, defined as Hartree + local Pseudopotential.

If prtvclmb=1 and in case of PAW (%usepaw > 0), the full core potential is added for the Hartree part, with the on-site corrections vh1 - vht1.

If prtvclmb=2, only the smooth part of the Coulomb potential is output.

prtvha

Mnemonics: PRinT V_HArtree
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [15/1245] in all abinit tests, [0/159] in abinit tutorials

If set >=1, provide output of the Hartree potential.

If ionmov == 0, the name of the potential file will be the root output name, followed by _VHA. If ionmov /= 0, potential files will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the time step (see later)
  • then followed by _VHA.

The file structure of this unformatted output file is described in this section. No output is provided by a negative value of this variable.

prtvhxc

Mnemonics: PRinT V_HXC
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [18/1245] in all abinit tests, [0/159] in abinit tutorials

If set >=1, provide output of the sum of the Hartree potential and xc potential.

If ionmov == 0, the name of the potential file will be the root output name, followed by _VHXC. If ionmov /= 0, potential files will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the time step (see later)
  • then followed by _VHXC.

The file structure of this unformatted output file is described in this section. No output is provided by a negative value of this variable.

prtvol

Mnemonics: PRinT VOLume
Mentioned in topic(s): topic_printing, topic_Output
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [261/1245] in all abinit tests, [18/159] in abinit tutorials

Control the volume of printed output. In particular, this concerns the explicit echo of eigenenergies and residuals for all bands and k points in the main output file. Also, the analysis of the value and location of the maximal density (and magnetization). Standard choice is 0. Positive values (all are allowed) generally print more and more in the output and log files, while negative values are for debugging (or preprocessing only), and cause the code to stop at some point.

  • 0 → The eigenenergies and residuals for all bands and k points are not echoed in the main output file. There are exceptions: the eigenvalues of the first k point are printed at the end of the SCF loop, and also, if iscf = -2 and kptopt<=0, the eigenvalues for all the k points are printed anyway, for a maximum of 50 k-points. Due to some subtlety, if for some dataset prtvol is non-zero, the limit for input and output echoes cannot be enforced, so it is like if prtvol = 1 for all the datasets for which prtvol was set to 0.
  • 1 → the eigenvalues for the first k-point are printed in all cases, at the end of the SCF loop.
  • 2 → all the eigenvalues and the residuals are printed at the end of the SCF loop. Also, the analysis of the value and location of the maximal density (and magnetization) is printed.
  • 3 → Print memory information for lobpcg.
  • 4 → Like 3 and prints information of lobpcg algorithm convergence.
  • 10 → the eigenvalues are printed for every SCF iteration, as well as other additions.
  • 11 → even more information …

Debugging options:

  • = -1 → stop in abinit (main program), before call driver. Useful to see the effect of the preprocessing of input variables (memory needed, effect of symmetries, k points…) without going further. Run very fast, on the order of the second.
  • =-2 → same as -1, except that print only the first dataset. All the non default input variables associated to all datasets are printed in the output file, but only for the first dataset. Also all the input variables are written in the NetCDF file “OUT.nc”, even if the value is the default.
  • = -3 → stop in gstate, before call scfcv, move or brdmin. Useful to debug pseudopotentials
  • = -4 → stop in move, after completion of all loops
  • = -5 → stop in brdmin, after completion of all loops
  • = -6 → stop in scfcv, after completion of all loops
  • = -7 → stop in vtorho, after the first rho is obtained
  • = -8 → stop in vtowfk, after the first k point is treated
  • = -9 → stop in cgwf, after the first wf is optimized
  • = -10 → stop in getghc, after the Hamiltonian is applied once

This debugging feature is not yet activated in the RF routines. Note that fftalg offers another option for debugging.

prtvolimg

Mnemonics: PRinT VOLume for IMaGes
Mentioned in topic(s): topic_printing, topic_Output
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [6/1245] in all abinit tests, [0/159] in abinit tutorials

Control the volume of printed output when an algorithm using images of the cell is used (nimage > 1). When such an algorithm is activated, the printing volume (in output file) can be large and difficult to read. Using prtvolimg=1, the printing volume, for each image, is reduced to unit cell, atomic positions, total energy, forces, stresses, velocities and convergence residuals. Using prtvolimg=2, the printing volume, for each image, is reduced to total energy and convergence residuals only.

prtvpsp

Mnemonics: PRinT V_PSeudoPotential
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [4/1245] in all abinit tests, [0/159] in abinit tutorials

If set >=1, provide output of the local pseudo potential.

If ionmov == 0, the name of the potential file will be the root output name, followed by _VPSP. If ionmov /= 0, potential files will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the timestep (see later)
  • then followed by _VPSP.

The file structure of this unformatted output file is described in this section. No output is provided by a negative value of this variable.

prtvxc

Mnemonics: PRinT V_XC
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [15/1245] in all abinit tests, [0/159] in abinit tutorials

If set >=1, provide output of the exchange-correlation potential.

If ionmov == 0, the name of the potential file will be the root output name, followed by _VXC. If ionmov /= 0, potential files will be output at each time step, with the name being made of

  • the root output name,
  • followed by _TIMx, where x is related to the timestep (see later)
  • then followed by _VXC.

The file structure of this unformatted output file is described in this section. No output is provided by a negative value of this variable.

prtwant

Mnemonics: PRinT WANT file
Mentioned in topic(s): topic_printing, topic_Wannier
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Moderately used, [18/1245] in all abinit tests, [6/159] in abinit tutorials

Flag used to indicate that either the Wannier90 or the WanT interfaces will be used.

  • prtwant = 1 → Use the ABINIT- WanT interface.

Provide an output file that can be used by the WanT postprocessing program (see http://www.wannier-transport.org). The value of the prtwant indicates the version of the WanT code that can read it. Currently only the value prtwant = 1 is implemented, corresponding to WanT version 1.0.1, available since Oct. 22, 2004.

Notes: Several requirements must be fulfilled by the wavefunction. Among them, two are mandatory:

  • An uniform grid of k-points, including the GAMMA point must be used.
  • The use of time reversal symmetry is not allowed (istwfk=1)
  • The list of k-points must be ordered, such that the coordinates, namely three-components vectors has the third index varying the most rapidly, then the second index, then the first index

If these requirement are not fulfilled, the program will stop and an error message is returned.

As an example of k-point grid in case of systems that have some 3D character (1D systems are easy):

nkpt 8
kpt
0   0   0
0   0   1/2
0   1/2 0
0   1/2 1/2
1/2 0   0
1/2 0   1/2
1/2 1/2 0
1/2 1/2 1/2
istwfk *1

Also, in order to use WanT as a post-processing program for ABINIT you might have to recompile it with the appropriate flags (see ABINIT makefile). Up to now only the -convert big-endian was found to be mandatory, for machines with little-endian default choice.

  • prtwant = 2 → Use the ABINIT- Wannier90 interface.

ABINIT will produce the input files required by Wannier90 and it will run Wannier90 to produce the Maximally-locallized Wannier functions (see http://www.wannier.org ).

Notes

  • The files that are created can also be used by Wannier90 in stand-alone mode.
  • In order to use Wannier90 as a post-processing program for ABINIT you might have to recompile it with the appropriate flags (see ABINIT makefile). You might use ./configure –enable-wannier90
  • There are some other variables related to the interface of Wannier90 and ABINIT. See w90 varset.
  • prtwant = 3 → Use the ABINIT- Wannier90 interface after converting the input wavefunctions to quasi-particle wavefunctions.

ABINIT will produce the input files required by Wannier90 and it will run Wannier90 to produce the Maximally-localized Wannier functions (see http://www.wannier.org ).

Notes

  • An input file of DFT wave functions is required which is completely consistent with the _KSS file used in the self-consistent GW calculation. This means that kssform 3 must be used to create the _KSS file and the output _WFK file from the same run must be used as input here.
  • Wannier90 requires nshiftk = 1, and shiftk = 0 0 0 is recommended. The k-point set used for the GW calculation, typically the irreducible BZ set created using kptopt = 1, and that for the Abinit- Wannier90 interface must be consistent.
  • Full-BZ wavefunctions should be generated in the run calling the interface by setting kptopt = 3, iscf = -2, and nstep = 3. This will simply use symmetry to transform the input IBZ wavefunctions to the full BZ set, still consistent with the GW _KSS input.
  • The final _QPS file created by the self-consistent GW run is required as input.
  • Any value of gwcalctyp between between 20 and 29 should be suitable, so, for example, Hartree-Fock maximally-localized Wannier functions could be generated setting gwcalctyp = 25.

prtwf

Mnemonics: PRinT the WaveFunction
Mentioned in topic(s): topic_printing, topic_vdw
Variable type: integer
Dimensions: scalar
Default value: 0 if nimage > 1, 1 otherwise.

Added in version: before_v9

Test list (click to open). Moderately used, [261/1245] in all abinit tests, [46/159] in abinit tutorials

If prtwf = 1, provide output of wavefunction and eigenvalue file The file structure of this unformatted output file is described in this section. For a standard ground-state calculation, the name of the wavefunction file will be the root output name, followed by _WFK. If nqpt = 1, the root name will be followed by _WFQ. For response-function calculations, the root name will be followed by _1WFx, where x is the number of the perturbation. The dataset information will be added as well, if relevant.

If prtwf = 0, no wavefunction output is provided.

If prtwf = -1, the code writes the wavefunction file only if convergence is not achieved in the self-consistent cycle.

If prtwf = 2, a file pwfn.data is produced, to be used as input for the CASINO QMC code. See more explanation at the end of this section. If prtwf = 3, the file that is created is nearly the same as with prtwf = 1, except that the records that should contain the wavefunction is empty (so, such records exist, but store nothing). This is useful to generate size-reduced DDK files, to perform an optic run. Indeed, in the latter case, only matrix elements are needed [so, no wavefunction], but possibly a large number of conduction bands, so that the DDK file might be huge if it contains the wavefunctions.

If tfkinfunc=2, prtwf =0 is enforced.

Further explanation for the prtwf = 2 case. To produce a wave function suitable for use as a CASINO trial wave function, certain ABINIT parameters must be set correctly. Primarily, CASINO (and QMC methods generally) can only take advantage of time-reversal symmetry, and not the full set of symmetries of the crystal structure. Therefore, ABINIT must be instructed to generate k-points not just in the Irreducible Brillouin Zone, but in a full half of the Brillouin Zone (using time-reversal symmetry to generate the other half). Additionally, unless instructed otherwise, Abinit avoids the need for internal storage of many of the coefficients of its wave functions for k-points that have the property 2k=G_latt, where G_latt is a reciprocal lattice vector, by making use of the property that c_k(G)=c^*_k(-G-G_latt). Abinit must be instructed not to do this in order to output the full set of coefficients for use in CASINO. See the ABINIT theoretical background documents ABINIT/Infos/Theory/geometry.pdf and ABINIT/Infos/Theory/1WF.pdf for more information. The first of these requirements is met by setting the ABINIT input variable kptopt to 2 and the second by setting istwfk to 1 for all the k points. Since CASINO is typically run with relatively small numbers of k-points, this is easily done by defining an array of “1” in the input file. For example, for the 8 k-points generated with ngkpt 2 2 2, we add the following lines to the input file:

# Turn off special storage mode for time-reversal k-points
istwfk 1 1 1 1 1 1 1 1
# Use only time reversal symmetry, not full set of symmetries.
kptopt 2

Other useful input variables of relevance to the plane waves ABINIT will produce include ecut, nshiftk, shiftk, nband, occopt, occ, spinat and nsppol (see relevant input variable documents in ABINIT/Infos/). If ABINIT is run in multiple dataset mode, the different wave functions for the various datasets are exported as pwfn1.data, pwfn2.data, …, pwfnn.data where the numbers are the contents of the contents of the input array jdtset (defaults to 1,2,…,ndtset). Once the routine is incorporated into the ABINIT package it is anticipated that there will be an input variable to control whether or not a CASINO pwfn.data file is written.

Other issues related to prtwf = 2. The exporter does not currently work when ABINIT is used in parallel mode on multiple processors if k-point parallelism is chosen. ABINIT does not store the full wave function on each processor but rather splits the k-points between the processors, so no one processor could write out the whole file. Clearly this could be fixed but we have not done it yet. The sort of plane wave DFT calculations usually required to generate QMC trial wave functions execute very rapidly anyway and will generally not require a parallel machines. The outqmc routine currently bails out with an error if this combination of modes is selected - this will hopefully be fixed later. There has not been very extensive testing of less common situations such as different numbers of bands for different k-points, and more complicated spin polarized systems, so care should be taken when using the output in these circumstances. If there is any doubt about the output of this routine, the first place to look is the log file produced by ABINIT: if there are any warnings about incorrectly normalized orbitals or non-integer occupation numbers there is probably something set wrong in the input file.

prtwf_full

Mnemonics: PRinT Wavefunction file on the FULL mesh
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Only relevant if: prtwf == 1
Added in version: before_v9

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

If set to 1 in a ground-state calculation, the code will output another WFK file (with extension FULL_WFK) containing the wavefunctions in the full BZ as well as a text file with the tables used for the tetrahedron method. Note that prtwf_full requires prtwf == 1 and a ground-state calculation done on a homogeneous k-mesh (see ngkpt and shiftk). The tetrahedron table is produced only if the number of k-points in the irreducible zone (nkpt) is greater than 3.

prtxml

Mnemonics: PRinT an XML output
Mentioned in topic(s): topic_printing
Variable type: integer
Dimensions: scalar
Default value: 0
Added in version: before_v9

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

Create an XML output with common values. The corresponding DTD is distributed in sources as extras/post_processing/abinitRun.dtd. All the DTD is not yet implemented and this one is currently restricted to ground-state computations (and derivative such as geometry optimisation).

pseudos

Mnemonics: PSEUDOpotentialS
Mentioned in topic(s): topic_Control
Variable type: string
Dimensions: scalar
Default value:
Added in version: 9.0.0

Test list (click to open). Very frequently used, [1241/1245] in all abinit tests, [159/159] in abinit tutorials

String defining the list of pseudopotential files when Abinit is executed with the new syntax:

abinit abi_in >& log &

The string must be quoted in double quotation marks and multiple files should be separated by a comma, e.g.

pseudos "al.psp8, as.psp8"

This variable is mandatory and the list must contain ntypat pseudos ordered according to the znucl array.

Relative and absolute paths are allowed as in:

pseudos "../pseudos/al.psp8, ..//pseudos/as.psp8"

or

pseudos "/home/user/pseudos/al.psp8, /home/user/pseudos/as.psp8"

If all the pseudos are located in the same directory, it is much easier to use a common prefix with pp_dirpath. For instance, the previous example is equivalent to:

pp_dirpath "/home/user/pseudos"
pseudos "al.psp8, as.psp8"

Important

Shell variables e.g. $HOME or tilde syntax ~ for user home are not supported in pseudopotential names. The only exception is the shell variable $ABI_PSPDIR that can be used in conjunction with pp_dirpath

pp_dirpath = "$ABI_PSPDIR"
pseudos "al.psp8, as.psp8"

Before running the calculation, one should set the value of $ABI_PSPDIR inside the terminal using:

```sh
export ABI_PSPDIR="/home/user/pseudos"
```

tmpdata_prefix

Mnemonics: TeMPorary DATA PREFIX
Mentioned in topic(s): topic_Control
Variable type: string
Dimensions: scalar
Default value: None
Added in version: 9.0.0

Test list (click to open). Rarely used, [8/1245] in all abinit tests, [2/159] in abinit tutorials

Prefix for temporary files. Replaces the analogous entry in the obsolete files_file . This variable is used when Abinit is executed with the new syntax:

abinit run.abi > run.log 2> run.err &

If this option is not specified, a prefix is automatically constructed from the input file name provided the filename ends with an extension, e.g. .ext.

If the input filename does not have a file extension, a default is provided.

write_files

Mnemonics: write files
Mentioned in topic(s): topic_printing
Variable type: string
Dimensions: scalar
Default value: default
Added in version: 9.11.0

Test list (click to open). Rarely used, [1/1245] in all abinit tests, [0/159] in abinit tutorials

Supra-variable controlling the underlying printing options of the prt-type variables. It can be used as a simple string flagging the desired outputs as follows:

  • “default” → An empty string will produce only the log and abo files
  • “none” → It will deactivate all printing options currently available. Only the log and abo file will be produced following a calculation.
  • “ddb” → Activates the printing of the DDB file. Refer to prtddb for further documentation.
  • “den_1” → Activates the printing of the density file under option 1 of the prtden variable.
  • “den_2” → Activates the printing of the density file under option 2 of the prtden variable.
  • “den_3” → Activates the printing of the density file under option 3 of the prtden variable.
  • “den_4” → Activates the printing of the density file under option 4 of the prtden variable.
  • “den_5” → Activates the printing of the density file under option 5 of the prtden variable.
  • “den_6” → Activates the printing of the density file under option 6 of the prtden variable.
  • “den_7” → Activates the printing of the density file under option 7 of the prtden variable.
  • “dos_1” → Activates the printing of the density of states file under option 1 of the prtdos variable.
  • “dos_2” → Activates the printing of the density of states file under option 2 of the prtdos variable.
  • “dos_3” → Activates the printing of the density of states file under option 3 of the prtdos variable.
  • “dos_4” → Activates the printing of the density of states file under option 4 of the prtdos variable.
  • “dos_5” → Activates the printing of the density of states file under option 5 of the prtdos variable.
  • “dosm_1” → Activates the printing of the density of states file with M decomposition. Refer to prtdosm variable for further documentation.
  • “ebands_1” → Activates the printing of the electronic bands using option 1 as in prtebands.
  • “ebands_2” → Activates the printing of the electronic bands using option 2 as in prtebands.
  • “eig” → Activates the printing of the eigenvalues file. Refer to prteig for further documentation.
  • “elf” → Activates the printing of the electron localization function. Refer to prtelf for further documentation.
  • “evk” → Activates the printing of the netCDF EVK file. Refer to prtevk for further documentation.
  • “fsurf” → Activates the printing of the Fermi surface file. Refer to prtfsurf for further documentation.
  • “gden” → Activates the printing of the gradient of the electronic density file. Refer to prtgden for further documentation.
  • “geo” → Activates the printing of the geometry analysis. Refer to prtgeo for further documentation.
  • “gkk” → Activates the printing of the GKK matrix file. Refer to prtgkk for further documentation.
  • “gsr” → Activates the printing of the GSR file. Refer to prtgsr for further documention.
  • “hist” → Activates the printing of the HIST file. Refer to prthist for further documentation.
  • “kbff” → Activates the printing of the Kleynman-Bylander form factors. Refer to prtkbff for further documentation.
  • “kden” → Activates the printing of the kinetic energy density file. Refer to prtkden for further documentation.
  • “lden” → Activates the printing of the Laplacian of the eletronic density. Refer to prtlden for further documentation.
  • “ncout” → Activates the printing of the OUT file in netCDF format. Refer to ncout for further documentation.
  • “pot” → Activates the printing of the total potential. Refer to prtpot for further documentation.
  • “psps_1” → Activates the printing of the pseudopotential tables in netCDF format. Refer to prtpsps for further documentation.
  • “psps_-1” → Activates the printing of the pseudopotential tables in netCDF format with code exit after printing. Refer to prtpsps for further documentation.
  • “stm” → Activates the printing of the STM density. Refer to prtstm for further documentation.
  • “suscep” → Activates the printing of the susceptibility file. Refer to prtsuscep for further documentation.
  • “vclmb_1” → Activates the printing of the Coulomb potential. Refer to prtvclmb for further documentation.
  • “vclmb_2” → Activates the printing of the Coulomb potential. Refer to prtvclmb for further documentation.
  • “vha” → Activates the printing of the Hartree potential. Refer to prtvha for further documentation.
  • “vhxc” → Activates the printing of the sum of the Hartree and XC potentials. Refer to prtvhxc for further documentation.
  • “vpsp” → Activates the printing of the local pseudopotential. Refer to prtvpsp for further documentation.
  • “vxc” → Activates the printing of the XC potential. Refer to prtvxc for further documentation.
  • “want_1” → Activates the printing of the Wannierization in different settings. Refer to prtwant for further documentation.
  • “want_2” → Activates the printing of the Wannierization in different settings. Refer to prtwant for further documentation.
  • “want_2” → Activates the printing of the Wannierization in different settings. Refer to prtwant for further documentation.
  • “wf_1” → Activates the printing of the wavefunction file. Refer to prtwf for further documentation.
  • “wf_full_1” → Activates the printing of the wavefunction file on the full mesh. Refer to prtwf_full for further documentation.
  • “wf_2” → Activates the printing of the wavefunction file. Refer to prtwf for further documentation.
  • “wf_3” → Activates the printing of the wavefunction file. Refer to prtwf for further documentation.
  • “wf_-1” → Activates the printing of the wavefunction file. Refer to prtwf for further documentation.
  • “xml” → Activates the printing of the xml file. Refer to prtxml for further documentation.