ResultFileDefinition

class ase2sprkkr.outputs.result_options.ResultFileDefinition(name, file_type=None)[source]

Class hierarchy

Inheritance diagram of ase2sprkkr.outputs.result_options.ResultFileDefinition


Constructor

__init__(name, file_type=None)[source]
result_class

alias of ase2sprkkr.outputs.result_options.OutputFileOption

name_in_grammar = False

Is the name of the value/section present in the file?

When False, the option/section name is not written to the file at all. The value(s) of the option/section is/are then expected to be located in the file just after the previous one.

By default, all options and sections… are named (in the configuration file). However, the attribute can be redefined in instantiated objects and/or descendant classes to change the behavior.

convert_value(option, value, item=False)[source]

Resolve value relative to the result owning option.

item is accepted for the common value-definition conversion API.

Parameters:
Return type:

ase2sprkkr.common.file_utils.FilePath

validate_converted(option, value, why='set', item=False)[source]

Accept converted value; remaining arguments match the common API.

Parameters:
Return type:

Tuple[ase2sprkkr.common.warnings.ValidationResult, …]