#include <SupercellIO.hh>
Inheritance diagram for CASM::ScelIO::SupercellCheckBase< Base >:
Detailed Description
template<typename Base>
class CASM::ScelIO::SupercellCheckBase< Base >
Definition at line 16 of file SupercellIO.hh.
Public Types | |
| typedef std::tuple< bool, SymOp, Eigen::MatrixXi > | result_type |
Public Member Functions | |
| SupercellCheckBase (std::string name, std::string desc) | |
| bool | parse_args (const std::string &args) override |
| Expects arguments of the form 'is_supercell_of(scelname)'. More... | |
| bool | init (const Supercell &_tmplt) const override |
| Set pointer to ref supercell. More... | |
| std::vector< std::string > | col_header (const Supercell &_tmplt) const override |
| col_header returns: {'short_name(refcell_name)'} More... | |
| const result_type & | _evaluate (const Supercell &scel, const Supercell &unit) const |
Protected Member Functions | |
| Supercell const & | refcell () const |
Protected Attributes | |
| std::string | m_refcell_name |
| Reference supercell name, given meaning by derived class. More... | |
Private Attributes | |
| const Supercell * | m_refcell |
| Reference supercell, given meaning by derived class. More... | |
| notstd::cloneable_ptr< result_type > | m_last_result |
| const Supercell * | m_last_scel |
| const Supercell * | m_last_unit |
Member Typedef Documentation
◆ result_type
| typedef std::tuple<bool, SymOp, Eigen::MatrixXi> CASM::ScelIO::SupercellCheckBase< Base >::result_type |
Definition at line 18 of file SupercellIO.hh.
Constructor & Destructor Documentation
◆ SupercellCheckBase()
| CASM::ScelIO::SupercellCheckBase< Base >::SupercellCheckBase | ( | std::string | name, |
| std::string | desc | ||
| ) |
Definition at line 19 of file SupercellIO_impl.hh.
Member Function Documentation
◆ _evaluate()
| const SupercellCheckBase< Base >::result_type & CASM::ScelIO::SupercellCheckBase< Base >::_evaluate | ( | const Supercell & | scel, |
| const Supercell & | unit | ||
| ) | const |
Call is_supercell using prim.factor_group() to try possible orientations
Returns (bool, SymOp op, Eigen::MatrixXi T) with:
- scel is supercell of unit?
- If true: scel.lattice() == apply(op, unit.lattice()) * T
Definition at line 76 of file SupercellIO_impl.hh.
◆ col_header()
|
override |
col_header returns: {'short_name(refcell_name)'}
col_header returns: {'name(refcell_name)'}
Definition at line 63 of file SupercellIO_impl.hh.
◆ init()
|
override |
Set pointer to ref supercell.
Definition at line 48 of file SupercellIO_impl.hh.
◆ parse_args()
|
override |
Expects arguments of the form 'is_supercell_of(scelname)'.
Definition at line 28 of file SupercellIO_impl.hh.
◆ refcell()
|
protected |
Definition at line 91 of file SupercellIO_impl.hh.
Member Data Documentation
◆ m_last_result
|
mutableprivate |
Definition at line 54 of file SupercellIO.hh.
◆ m_last_scel
|
mutableprivate |
Definition at line 55 of file SupercellIO.hh.
◆ m_last_unit
|
mutableprivate |
Definition at line 56 of file SupercellIO.hh.
◆ m_refcell
|
mutableprivate |
Reference supercell, given meaning by derived class.
Definition at line 52 of file SupercellIO.hh.
◆ m_refcell_name
|
protected |
Reference supercell name, given meaning by derived class.
Definition at line 46 of file SupercellIO.hh.
The documentation for this class was generated from the following files:
- /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/SupercellIO.hh
- /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/SupercellIO_impl.hh
