Skip to content

Commit

Permalink
[docs]: Changing some names to improve the english of the text
Browse files Browse the repository at this point in the history
  • Loading branch information
hentt30 committed Jul 12, 2021
1 parent 550ba44 commit 239ae82
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/source/execute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ correction tag
- ]_ will be used for each optimization, where :math:`d` is the distance of the nearest neighbor in the unit cell. (Default: :math:`0.15 + 0.84d`)
- conduction_cut_guess: Initial Guess for the Nelder-Mead algorithm for cut in valence correction. If not provided, the default value of :math:`0.15 + 0.84d` will be used will be used for each optimization, where :math:`d` is the distance of the nearest neighbor in the unit cell. (Default: :math:`0.15 + 0.84d`)
- tolerance: Minimum level of precision for the result of the Nelder-Mead algorithm (Default: 0.01)
- fractionary_valence_treshold: :ref:`Treshold <frac_correction>` :math:`\epsilon` for fractionary valence correction (Default: 10).
- fractionary_valence_treshold: :ref:`Treshold <frac_correction>` :math:`\epsilon` for fractional valence correction (Default: 10).
- overwrite_vbm: In some special cases [6]_, it is necessary to overwrite the value of band projection in a given orbital and ion. This tag is made for these situations. It is necessary to inform the chemical element symbol of the corresponding ion, the orbital and the value to be replaced. The program immediately overwrites the old projection values for the last valence band and use the new values for DFT -1/2 calculations (Default: No overwrite)
- overwrite_vbm: In some special cases [6]_, it is necessary to overwrite the value of band projection in a given orbital and ion. This tag is made for these situations. It is necessary to inform the chemical element symbol of the corresponding ion, the orbital and the value to be replaced. The program immediately overwrites the old projection values for the first conduction band and use the new values for DFT -1/2 calculations (Default: No overwrite)

Expand All @@ -148,11 +148,11 @@ The values that the correction_code tag can assume are listed below:
---------------------------

- v: Simple valence correction
- vf: Fractionary valence correction
- vf: Fractional valence correction
- vc: Simple valence and simple conduction corrections
- vfc: Fractionary valence and simple conduction corrections
- vcf: Simple valence and fractionary conduction corrections
- vfcf: Fractionary valence and fractionary conduction corrections
- vfc: Fractional valence and simple conduction corrections
- vcf: Simple valence and fractional conduction corrections
- vfcf: Fractional valence and fractional conduction corrections


The example below shows an use of correction tag in the :code:`minushalf.yaml` file:
Expand Down

0 comments on commit 239ae82

Please sign in to comment.