差分

このページの2つのバージョン間の差分を表示します。

--- ase:jacapo:psp [2019/05/24 16:47] – kimi
+++ ase:jacapo:psp [2022/08/23 13:34] (現在) – 外部編集 127.0.0.1
@@ 行 1: / 行 1: @@
 ====== Pseudopotential related method ======
+===== Pseudopotential file =====
 <code>
+set_pseudopotentials(self, pspdict)
 </code>
-<code>
+Set all the pseudopotentials from a dictionary.
-get_psp(self, sym=None, z=None)
-get the pseudopotential filename from the psp database
-:Parameters:
+The dictionary should have this form::
-sym : string
+  {symbol1: path1,
-the chemical symbol of the species
+   symbol2: path2}
-z : integer
+<code>
-the atomic number of the species
+  get_psp(self, sym=None, z=None)
-you can only specify sym or z. Returns the pseudopotential
-filename, not the full path.
 </code>
-<code>
+^argument^type^notes^
+|sym |string  |the chemical symbol of the species   |
+|z |integer  |the atomic number of the species  |
-get_psp_nuclear_charge(self, psp)
+  * ''get_psp'' get the pseudopotential filename from the psp database
-get the nuclear charge of the atom from teh psp-file.
+  * you can only specify ''sym'' or ''z''. Returns the pseudopotential filename, not the full path.
-This is not the same as the atomic number, nor is it
+=== set_psp ===
-necessarily the negative of the number of valence electrons,
-since a psp may be an ion. this function is needed to compute
-centers of ion charge for the dipole moment calculation.
-We read in the valence ion configuration from the psp file and
-add up the charges in each shell.
-</code>
 <code>
+set_psp(self, sym=None, z=None, psp=None)
-get_psp_valence(self, psp)
-get the psp valence charge on an atom from the pspfile.
 </code>
-<code>
-set_pseudopotentials(self, pspdict)
+^argument^type^notes^
-Set all the pseudopotentials from a dictionary.
+|sym |string  |chemical symbol of the species  |
+|z |integer  |the atomic number of the species  |
+|psp |string  |filename of the pseudopotential  |
-The dictionary should have this form::
+  * ''set_psp'' set the pseudopotential file for a species or an atomic number.
+  * you can only set ''sym'' or ''z''.
-{symbol1: path1,
+== examples ==
-symbol2: path2}
-</code>
 <code>
-set_psp(self, sym=None, z=None, psp=None)
-set the pseudopotential file for a species or an atomic number.
-:Parameters:
-sym : string
-chemical symbol of the species
-z : integer
-the atomic number of the species
-psp : string
-filename of the pseudopotential
-you can only set sym or z.
-examples::
 set_psp('N',psp='pspfile')
 set_psp(z=6,psp='pspfile')
 </code>
 <code>
@@ 行 88: / 行 60: @@
 a nearly empty database, and I have not thought about how to
 resolve that
+</code>
+===== Nuclear charge =====
+<code>
+get_psp_nuclear_charge(self, psp)
+get the nuclear charge of the atom from teh psp-file.
+This is not the same as the atomic number, nor is it
+necessarily the negative of the number of valence electrons,
+since a psp may be an ion. this function is needed to compute
+centers of ion charge for the dipole moment calculation.
+We read in the valence ion configuration from the psp file and
+add up the charges in each shell.
+</code>
+===== Valence charge =====
+<code>
+get_number_of_electrons = get_valence(self, atoms=None)
+get_psp_valence(self, psp)
+get the psp valence charge on an atom from the pspfile.
+</code>
+<code>
+get_valence(self, atoms=None)
+return the total number of valence electrons for the
+atoms. valence electrons are read directly from the
+pseudopotentials.
+the psp filenames are stored in the ncfile. They may be just
+the name of the file, in which case the psp may exist in the
+same directory as the ncfile, or in $DACAPOPATH, or the psp
+may be defined by an absolute or relative path. This function
+deals with all these possibilities.
 </code>