#include <dof_space_analysis.hh>

Inheritance diagram for CASM::DoFSpaceIO::CombinedJsonOutput:

Detailed Description

Implementation that outputs all results to one JSON file at <output_dir>/dof_space.json

Definition at line 166 of file dof_space_analysis.hh.

Public Member Functions
	CombinedJsonOutput (fs::path output_dir)

	~CombinedJsonOutput ()

void	write_symmetry (Index state_index, std::string const &identifier, ConfigEnumInput const &config_enum_input, SymGroup const &lattice_point_group, SymGroup const &factor_group, SymGroup const &crystal_point_group) override

void	write_structure (Index state_index, std::string const &identifier, ConfigEnumInput const &config_enum_input) override
	Write input state structure. More...

void	write_dof_space (Index state_index, DoFSpace const &dof_space, std::string const &identifier, ConfigEnumInput const &config_enum_input, std::optional< SymRepTools_v2::VectorSpaceSymReport > const &sym_report) override
	Write dof space analysis. More...

void	write_symmetry (Index state_index, std::string const &identifier, ConfigEnumInput const &config_enum_input, std::vector< PermuteIterator > const &group)

virtual void	write_symmetry (Index state_index, std::string const &identifier, ConfigEnumInput const &config_enum_input, SymGroup const &lattice_point_group, SymGroup const &factor_group, SymGroup const &crystal_point_group)=0

void	write_symmetry (Index state_index, std::string const &identifier, ConfigEnumInput const &config_enum_input, std::vector< PermuteIterator > const &group)

void	write_dof_space_error (make_symmetry_adapted_dof_space_error const &e, Index state_index, DoFSpace const &dof_space, std::string const &identifier, ConfigEnumInput const &config_enum_input, std::optional< SymRepTools_v2::VectorSpaceSymReport > const &sym_report)
	Write dof space analysis error information. More...

std::vector< Error > const &	errors () const

std::vector< Error > &	errors ()

void	write_errors () const

Private Member Functions
jsonParser &	_output_json (Index state_index)

Private Attributes
jsonParser	m_combined_json

fs::path	m_output_dir

std::vector< Error >	m_errors

Constructor & Destructor Documentation

◆ CombinedJsonOutput()

CASM::DoFSpaceIO::CombinedJsonOutput::CombinedJsonOutput ( fs::path output_dir )

Definition at line 241 of file dof_space_analysis.cc.

◆ ~CombinedJsonOutput()

CASM::DoFSpaceIO::CombinedJsonOutput::~CombinedJsonOutput ( )

Definition at line 251 of file dof_space_analysis.cc.

Member Function Documentation

◆ _output_json()

jsonParser & CASM::DoFSpaceIO::CombinedJsonOutput::_output_json ( Index state_index )

private

Definition at line 295 of file dof_space_analysis.cc.

◆ errors() [1/2]

std::vector<Error>& CASM::DoFSpaceIO::OutputImpl::errors ( )

inlineinherited

Definition at line 83 of file dof_space_analysis.hh.

◆ errors() [2/2]

std::vector<Error> const& CASM::DoFSpaceIO::OutputImpl::errors ( ) const

inlineinherited

Definition at line 82 of file dof_space_analysis.hh.

◆ write_dof_space()

void CASM::DoFSpaceIO::CombinedJsonOutput::write_dof_space	(	Index	state_index,
		DoFSpace const &	dof_space,
		std::string const &	identifier,
		ConfigEnumInput const &	config_enum_input,
		std::optional< SymRepTools_v2::VectorSpaceSymReport > const &	sym_report
	)

overridevirtual

Write dof space analysis.

Implements CASM::DoFSpaceIO::OutputImpl.

Definition at line 286 of file dof_space_analysis.cc.

◆ write_dof_space_error()

void CASM::DoFSpaceIO::OutputImpl::write_dof_space_error	(	make_symmetry_adapted_dof_space_error const &	e,
		Index	state_index,
		DoFSpace const &	dof_space,
		std::string const &	identifier,
		ConfigEnumInput const &	config_enum_input,
		std::optional< SymRepTools_v2::VectorSpaceSymReport > const &	sym_report
	)

inherited

Write dof space analysis error information.

Definition at line 45 of file dof_space_analysis.cc.

◆ write_errors()

void CASM::DoFSpaceIO::OutputImpl::write_errors ( ) const

inherited

Write dof space analysis error information to <current_path>/dof_space_errors.json

Definition at line 58 of file dof_space_analysis.cc.

◆ write_structure()

void CASM::DoFSpaceIO::CombinedJsonOutput::write_structure	(	Index	state_index,
		std::string const &	identifier,
		ConfigEnumInput const &	config_enum_input
	)

overridevirtual

Write input state structure.

Implements CASM::DoFSpaceIO::OutputImpl.

Definition at line 278 of file dof_space_analysis.cc.

◆ write_symmetry() [1/4]

void CASM::DoFSpaceIO::OutputImpl::write_symmetry	(	Index	state_index,
		std::string const &	identifier,
		ConfigEnumInput const &	config_enum_input,
		std::vector< PermuteIterator > const &	group
	)

inherited

Write symmetry groups (lattice point group, factor_group, crystal_point_group)

Definition at line 31 of file dof_space_analysis.cc.

◆ write_symmetry() [2/4]

void CASM::DoFSpaceIO::OutputImpl::write_symmetry

Write symmetry groups (lattice point group, factor_group, crystal_point_group)

Definition at line 40 of file dof_space_analysis.cc.

◆ write_symmetry() [3/4]

void CASM::DoFSpaceIO::CombinedJsonOutput::write_symmetry	(	Index	state_index,
		std::string const &	identifier,
		ConfigEnumInput const &	config_enum_input,
		SymGroup const &	lattice_point_group,
		SymGroup const &	factor_group,
		SymGroup const &	crystal_point_group
	)

overridevirtual

Write symmetry groups (lattice point group, factor_group, crystal_point_group)

lattice_point_group: point group of supercell lattice
factor_group: subgroup of supercell factor group that keeps configuration DoF invariant and selected sites invariant
crystal_point_group: factor_group excluding translations

Implements CASM::DoFSpaceIO::OutputImpl.

Definition at line 258 of file dof_space_analysis.cc.

◆ write_symmetry() [4/4]

virtual void CASM::DoFSpaceIO::OutputImpl::write_symmetry

Write symmetry groups (lattice point group, factor_group, crystal_point_group)

lattice_point_group: point group of supercell lattice
factor_group: subgroup of supercell factor group that keeps configuration DoF invariant and selected sites invariant
crystal_point_group: factor_group excluding translations

Member Data Documentation

◆ m_combined_json

jsonParser CASM::DoFSpaceIO::CombinedJsonOutput::m_combined_json

private

Definition at line 197 of file dof_space_analysis.hh.

◆ m_errors

std::vector<Error> CASM::DoFSpaceIO::OutputImpl::m_errors

privateinherited

Definition at line 90 of file dof_space_analysis.hh.

◆ m_output_dir

fs::path CASM::DoFSpaceIO::CombinedJsonOutput::m_output_dir

private

Definition at line 199 of file dof_space_analysis.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/enumerator/io/dof_space_analysis.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/enumerator/io/dof_space_analysis.cc

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ CombinedJsonOutput()

◆ ~CombinedJsonOutput()

Member Function Documentation

◆ _output_json()

◆ errors() [1/2]

◆ errors() [2/2]

◆ write_dof_space()

◆ write_dof_space_error()

◆ write_errors()

◆ write_structure()

◆ write_symmetry() [1/4]

◆ write_symmetry() [2/4]

◆ write_symmetry() [3/4]

◆ write_symmetry() [4/4]

Member Data Documentation

◆ m_combined_json

◆ m_errors

◆ m_output_dir