pyiron_atomistics.atomistics.structure.periodic_table.PeriodicTable

class pyiron_atomistics.atomistics.structure.periodic_table.PeriodicTable(file_name=None)

Bases: object

An Object which stores an elementary table which can be modified for the current session

__init__(file_name=None)

Parameters:

file_name (str) – Possibility to choose an source hdf5 file

Methods

__init__([file_name])	param file_name: Possibility to choose an source hdf5 file
add_element(parent_element, new_element[, ...])	Add "additional" chemical elements to the Periodic Table.
atomic_number_to_abbreviation(atom_no)	param atom_no:
element(arg, **qwargs)	The method searches through the periodic table. If the table contains the element, it will return an Object of the type ChemicalElement containing all parameters from the periodic table. The option **qwargs allows a direct modification of the tag-values during the creation process :param arg: sort of element :type arg: str, ChemicalElement :param **qwargs: e.g. a dictionary of tags.
from_dict(obj_dict)
from_hdf(hdf)	loads an element with his parameters from the hdf5 job file by creating an Object of the ChemicalElement type.
is_element(symbol)	Compares the Symbol with the Abbreviations of elements inside the periodic table :param symbol: name of element, str :type symbol: str

add_element(parent_element, new_element, use_parent_potential=False, **qwargs)

Add “additional” chemical elements to the Periodic Table. These can be used to distinguish between the various potentials which may exist for a given species or to introduce artificial elements such as pseudohydrogen. For this case set use_parent_potential = False and add in the directory containing the potential files a new file which is derived from the name new element.

This function may be also used to provide additional information for the identical chemical element, e.g., to define a Fe_up and Fe_down to perform the correct symmetry search as well as initialization.

Parameters:

• parent_element (str) – name of parent element

• new_element (str) – name of new element

• use_parent_potential – True: use the potential from the parent species

• **qwargs – define tags and their values, e.g. spin = “up”, relax = [True, True, True]

Returns: new element (ChemicalElement)

atomic_number_to_abbreviation(atom_no)

Parameters:

atom_no

Returns:

element(arg, **qwargs)

The method searches through the periodic table. If the table contains the element, it will return an Object of the type ChemicalElement containing all parameters from the periodic table. The option **qwargs allows a direct modification of the tag-values during the creation process :param arg: sort of element :type arg: str, ChemicalElement :param **qwargs: e.g. a dictionary of tags

Returns element (ChemicalElement): a element with all its properties (Abbreviation, AtomicMass, Weight, …)

from_hdf(hdf)

loads an element with his parameters from the hdf5 job file by creating an Object of the ChemicalElement type. The new element will be stored in the current periodic table. Changes in the tags will also be modified inside the periodic table.

Parameters:

hdf (Hdfio) – Hdfio object which will be used to read the data from a hdf5 file

Returns:

is_element(symbol)

Compares the Symbol with the Abbreviations of elements inside the periodic table :param symbol: name of element, str :type symbol: str

Returns boolean: true for the same element, false otherwise