q3::QEInputFormat Class Reference

A pw.x namelist input, recognised by its .in or .qe extension. More...

#include <qe_input_format.hpp>

Inheritance diagram for q3::QEInputFormat:

Public Member Functions
std::unique_ptr< InputParser >	create_parser () const override
	A QEInputParser.
int	detection_priority () const override
	extension_detection_priority: above the fallback, below name-based formats.
std::string	display_name () const override
	How a log line names a pw.x input.
std::vector< std::string >	names () const override
	"qe", and "espresso".
bool	recognizes (const std::filesystem::path &path) const override
	A file, not a directory, whose extension is .in or .qe.
Public Member Functions inherited from q3::InputFormat
virtual	~InputFormat ()=default
virtual bool	claims_working_directory (const std::filesystem::path &) const
virtual void	write_companion_outputs (const InputData &, const generated::Results &) const

Static Public Attributes
static constexpr int	extension_detection_priority = 100
	Ranked above the YAML fallback, below formats recognised by name or contents.

Detailed Description

A pw.x namelist input, recognised by its .in or .qe extension.

Definition at line 21 of file qe_input_format.hpp.

Member Function Documentation

create_parser()

std::unique_ptr< InputParser > q3::QEInputFormat::create_parser ( ) const

inlineoverridevirtual

A QEInputParser.

Implements q3::InputFormat.

Definition at line 50 of file qe_input_format.hpp.

detection_priority()

int q3::QEInputFormat::detection_priority ( ) const

inlineoverridevirtual

extension_detection_priority: above the fallback, below name-based formats.

Implements q3::InputFormat.

Definition at line 37 of file qe_input_format.hpp.

References extension_detection_priority.

display_name()

std::string q3::QEInputFormat::display_name ( ) const

inlineoverridevirtual

How a log line names a pw.x input.

Implements q3::InputFormat.

Definition at line 32 of file qe_input_format.hpp.

names()

std::vector< std::string > q3::QEInputFormat::names ( ) const

inlineoverridevirtual

"qe", and "espresso".

Implements q3::InputFormat.

Definition at line 27 of file qe_input_format.hpp.

recognizes()

bool q3::QEInputFormat::recognizes ( const std::filesystem::path &  path ) const

inlineoverridevirtual

A file, not a directory, whose extension is .in or .qe.

Implements q3::InputFormat.

Definition at line 42 of file qe_input_format.hpp.

Member Data Documentation

extension_detection_priority

constexpr int q3::QEInputFormat::extension_detection_priority = 100

staticconstexpr

Ranked above the YAML fallback, below formats recognised by name or contents.

Definition at line 24 of file qe_input_format.hpp.

Referenced by detection_priority().

---

The documentation for this class was generated from the following file:

• src/io/input/parser/qe_input_format.hpp