ML EATOM REF: Difference between revisions

From VASP Wiki
No edit summary
No edit summary
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TAGDEF|ML_FF_EATOM|[real array]|0.0}}
{{DISPLAYTITLE:ML_EATOM_REF}}
{{TAGDEF|ML_EATOM_REF|[real array]|0.0}}


Description: Reference total energies of isolated atoms used in the machine learning force field method.
Description: Reference total energies of isolated atoms used in the machine learning force field method.
----
----
This tag is only used if {{TAG|ML_FF_ISCALE_TOTEN_MB}}=1.
This tag is only used if {{TAGO|ML_ISCALE_TOTEN|1}}.


If {{TAG|ML_FF_EATOM}} is not provided in the {{TAG|INCAR}} file then 0.0 is assumed for all species in the system.
If {{TAG|ML_EATOM_REF}} is not provided in the {{TAG|INCAR}} file then 0.0 is assumed for all species in the system.


By default this tag is not used since all energies are scaled to the average of the training data ({{TAG|ML_FF_ISCALE_TOTEN_MB}}=2).
By default this tag is not used since all energies are scaled to the average of the training data ({{TAGO|ML_ISCALE_TOTEN|2}}).


If this tag is used, each reference energy should be obtained from a VASP calculation of an isolated atoms in a sufficiently large simulation box. The reference is then simply taken from the Helmholtz free energy from the {{TAG|OSZICAR}} file (value following "1 F=" in that file).  
If this tag is used, each reference energy should be obtained from a VASP calculation of an isolated atoms in a sufficiently large simulation box. The reference is then simply taken from the Helmholtz free energy from the {{TAG|OSZICAR}} file (value following "1 F=" in that file).  
Line 13: Line 14:
The reference energies are simply set in one line as a list for each species, i.e. like the following
The reference energies are simply set in one line as a list for each species, i.e. like the following


  {{TAGBL|ML_FF_EATOM}} = E_1 E_2 E_3 ...
  ML_EATOM_REF = E_1 E_2 E_3 ...


where E_1, E_2, E_2 etc. are the energies for species 1, 2, 3 etc. (corresponding to the order they occur in the {{TAG|POTCAR}} file).
where E_1, E_2, E_2 etc. are the energies for species 1, 2, 3 etc. (corresponding to the order they occur in the {{TAG|POTCAR}} file).


The unit of the energies is eV/atom.
The unit of the energies is eV/atom. {{NB|mind|Reference energies are stored in the {{FILE|ML_AB}} file and are reused whenever the file is read in, i.e, in case of a continued training ({{TAGO|ML_MODE|train}} with {{FILE|ML_AB}} present), refitting ({{TAGO|ML_MODE|refit}}) or a re-selection run ({{TAGO|ML_MODE|select}}). However, since VASP 6.4.3 the values in the {{FILE|INCAR}} file take precedence, hence, reference energies from the {{FILE|ML_AB}} file can be updated by providing new values for the {{TAGO|ML_EATOM_REF}} tag in the {{FILE|INCAR}} file. In case you are unsure, check the {{FILE|ML_LOGFILE}} which lists the values actually used.}}


== Related Tags and Sections ==
== Related tags and articles ==
{{TAG|ML_FF_LMLFF}}, {{TAG|ML_FF_ISTART}}, {{TAG|ML_FF_IERR}}, {{TAG|ML_FF_ISCALE_TOTEN_MB}}
{{TAG|ML_LMLFF}}, {{TAG|ML_MODE}}, {{TAG|ML_ISCALE_TOTEN}}


{{sc|ML_FF_EATOM|Examples|Examples that use this tag}}
{{sc|ML_EATOM_REF|Examples|Examples that use this tag}}
----
----


[[Category:INCAR]][[Category:Machine Learning]][[Category:Machine Learned Force Fields]][[Category: Alpha]]
[[Category:INCAR tag]][[Category:Machine-learned force fields]]

Latest revision as of 10:23, 19 February 2024

ML_EATOM_REF = [real array]
Default: ML_EATOM_REF = 0.0 

Description: Reference total energies of isolated atoms used in the machine learning force field method.


This tag is only used if ML_ISCALE_TOTEN = 1.

If ML_EATOM_REF is not provided in the INCAR file then 0.0 is assumed for all species in the system.

By default this tag is not used since all energies are scaled to the average of the training data (ML_ISCALE_TOTEN = 2).

If this tag is used, each reference energy should be obtained from a VASP calculation of an isolated atoms in a sufficiently large simulation box. The reference is then simply taken from the Helmholtz free energy from the OSZICAR file (value following "1 F=" in that file).

The reference energies are simply set in one line as a list for each species, i.e. like the following

ML_EATOM_REF = E_1 E_2 E_3 ...

where E_1, E_2, E_2 etc. are the energies for species 1, 2, 3 etc. (corresponding to the order they occur in the POTCAR file).

The unit of the energies is eV/atom.

Mind: Reference energies are stored in the ML_AB file and are reused whenever the file is read in, i.e, in case of a continued training (ML_MODE = train with ML_AB present), refitting (ML_MODE = refit) or a re-selection run (ML_MODE = select). However, since VASP 6.4.3 the values in the INCAR file take precedence, hence, reference energies from the ML_AB file can be updated by providing new values for the ML_EATOM_REF tag in the INCAR file. In case you are unsure, check the ML_LOGFILE which lists the values actually used.

Related tags and articles

ML_LMLFF, ML_MODE, ML_ISCALE_TOTEN

Examples that use this tag