OutputSectionDefinition
- class ase2sprkkr.outputs.output_definitions.OutputSectionDefinition(name, members=[], alternative_names=[], info=None, description=None, is_optional=False, is_hidden=False, is_expert=False, has_hidden_members=False, name_in_grammar=None, force_order=None, write_alternative_name=False, name_regex=False, result_class=None, is_repeated=False)[source]
This class describes the format of one value of a standard potential section
Class hierarchy
Constructor
- Parameters:
write_alternative_name (bool)
- __init__(name, members=[], alternative_names=[], info=None, description=None, is_optional=False, is_hidden=False, is_expert=False, has_hidden_members=False, name_in_grammar=None, force_order=None, write_alternative_name=False, name_regex=False, result_class=None, is_repeated=False)
Definition of container (e.g. section of an input file). For the rest of the parameters see the
RealItemDefinition
.- Parameters:
has_hidden_members (bool) – If true, this section is not intended for a direct editing
is_repeated (bool or string) – The section can be repeated. The name of the section appears only once on the beginning (this differs from ValueDefinition.is_repeated #TODO - merge the meaning of the swtich). If a non-empty string is given, the values are divided by the string.
force_order (bool) – If True, the items has to retain the order, if False, the items can be in the input file in any order.
write_alternative_name (bool)
- force_order = True
The order of items in output file is fixed
- name_in_grammar = False
Parsed parts of the output have no names, they are identified by its positions
- child_class
standard child class
alias of
OutputValueDefinition
- custom_class = None
There is no custom class in the output, only known parts of the file are parsed
- delimiter = '\n'
options are delimited by newline in ouptut.
- grammar_of_delimiter = Suppress:({[ ] WordStart})
- Parameters:
name (str | None)
- Return type:
ParserElement