PotentialDefinition

class ase2sprkkr.potentials.potential_definitions.PotentialDefinition(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())[source]

This class describes the format of a potential file

Class hierarchy

Inheritance diagram of ase2sprkkr.potentials.potential_definitions.PotentialDefinition


Constructor

Parameters:

validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

__init__(name, members=[], written_name=None, info=None, description=None, is_optional=None, is_hidden=False, is_expert=False, experimental=False, has_hidden_members=False, name_in_grammar=None, force_order=None, name_regex=False, result_class=None, is_repeated=False, repeated_delimiter=None, repeated_count=None, repeated_with_name=False, write_condition=None, warning_condition=None, validators=())
Parameters:

validators (Callable[[Any, Any, str], Any] | Iterable[Callable[[Any, Any, str], Any]] | None)

child_class

Definition of the standard child class:

alias of ase2sprkkr.potentials.potential_definitions.PotSectionDefinition

result_class

The parsing of a potential file results in an instance of Potential.

alias of ase2sprkkr.potentials.potentials.Potential

configuration_type_name = 'POTENTIAL FILE'

Name of the container type in the runtime documentation

force_order = True

The order of items in potential file is fixed

delimiter = *******************************************************************************
Parameters:

name (Optional[str])

Return type:

ParserElement

custom_class

Unknown sections will be of this type

alias of ase2sprkkr.potentials.custom_potential_section.CustomPotentialSection

_generic_info()[source]
classmethod custom_value_grammar()[source]

Unknown sections are parsed by this grammar

custom_name_characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-() '

There can be space in a potential-section name