CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::OrbitFunctionTraits Class Referenceabstract

#include <OrbitFunctionTraits.hh>

+ Inheritance diagram for CASM::OrbitFunctionTraits:

Detailed Description

virtual base class for printing orbit functions of type specified by implementation.

Definition at line 63 of file OrbitFunctionTraits.hh.

Public Member Functions

 OrbitFunctionTraits (std::string const &_name, std::string const &_short_desc, std::string const &_long_desc)
 
virtual ~OrbitFunctionTraits ()
 
std::string const & name () const
 
std::string const & short_desc () const
 
std::string const & long_desc () const
 
virtual std::unique_ptr< ClexBasisBuilderbasis_builder () const =0
 
virtual void print_param_pack_initilialization () const
 
virtual std::string clexulator_point_prepare_string (Structure const &_prim, std::map< UnitCellCoord, std::set< UnitCellCoord > > const &_nhood, PrimNeighborList &_nlist, std::string const &indent) const
 
virtual std::string clexulator_global_prepare_string (Structure const &_prim, std::map< UnitCellCoord, std::set< UnitCellCoord > > const &_nhood, PrimNeighborList &_nlist, std::string const &indent) const
 
virtual void print_typedefs (std::ostream &out, std::string const &class_name, std::string const &indent) const
 
virtual void print_eval_table_declarations (std::ostream &out, std::string const &class_name, ClexBasis const &clex, std::string const &indent) const
 
virtual std::string name () const =0
 
virtual void print_param_pack_initilialization () const
 
virtual void print_to_point_prepare () const
 
virtual void print_to_global_prepare () const
 
virtual void print_typedefs (std::ostream &out, std::string const &class_name, std::string const &indent) const
 
virtual void print_eval_table_definitions (std::ostream &out, std::string const &class_name, ClexBasis const &clex, std::string const &indent) const
 

Static Public Member Functions

static std::string class_desc ()
 
static string class_desc ()
 

Private Attributes

std::string m_name
 
std::string m_short_desc
 
std::string m_long_desc
 
std::vector< std::string > m_signature
 
std::vector< std::string > m_arg_names
 

Constructor & Destructor Documentation

◆ OrbitFunctionTraits()

CASM::OrbitFunctionTraits::OrbitFunctionTraits ( std::string const &  _name,
std::string const &  _short_desc,
std::string const &  _long_desc 
)
inline

Definition at line 67 of file OrbitFunctionTraits.hh.

◆ ~OrbitFunctionTraits()

virtual CASM::OrbitFunctionTraits::~OrbitFunctionTraits ( )
inlinevirtual

Definition at line 71 of file OrbitFunctionTraits.hh.

Member Function Documentation

◆ basis_builder()

virtual std::unique_ptr<ClexBasisBuilder> CASM::OrbitFunctionTraits::basis_builder ( ) const
pure virtual

◆ class_desc() [1/2]

static std::string CASM::OrbitFunctionTraits::class_desc ( )
inlinestatic

Definition at line 65 of file OrbitFunctionTraits.hh.

◆ class_desc() [2/2]

static string CASM::OrbitFunctionTraits::class_desc ( )
inlinestatic

Definition at line 12 of file OrbitFunctionWriter.hh.

◆ clexulator_global_prepare_string()

virtual std::string CASM::OrbitFunctionTraits::clexulator_global_prepare_string ( Structure const &  _prim,
std::map< UnitCellCoord, std::set< UnitCellCoord > > const &  _nhood,
PrimNeighborList _nlist,
std::string const &  indent 
) const
inlinevirtual

Definition at line 90 of file OrbitFunctionTraits.hh.

◆ clexulator_point_prepare_string()

virtual std::string CASM::OrbitFunctionTraits::clexulator_point_prepare_string ( Structure const &  _prim,
std::map< UnitCellCoord, std::set< UnitCellCoord > > const &  _nhood,
PrimNeighborList _nlist,
std::string const &  indent 
) const
inlinevirtual

Definition at line 83 of file OrbitFunctionTraits.hh.

◆ long_desc()

std::string const& CASM::OrbitFunctionTraits::long_desc ( ) const
inline

Definition at line 77 of file OrbitFunctionTraits.hh.

◆ name() [1/2]

std::string const& CASM::OrbitFunctionTraits::name ( ) const
inline

Definition at line 73 of file OrbitFunctionTraits.hh.

◆ name() [2/2]

virtual std::string CASM::OrbitFunctionTraits::name ( ) const
pure virtual

◆ print_eval_table_declarations()

virtual void CASM::OrbitFunctionTraits::print_eval_table_declarations ( std::ostream &  out,
std::string const &  class_name,
ClexBasis const &  clex,
std::string const &  indent 
) const
inlinevirtual

Definition at line 99 of file OrbitFunctionTraits.hh.

◆ print_eval_table_definitions()

virtual void CASM::OrbitFunctionTraits::print_eval_table_definitions ( std::ostream &  out,
std::string const &  class_name,
ClexBasis const &  clex,
std::string const &  indent 
) const
inlinevirtual

Definition at line 28 of file OrbitFunctionWriter.hh.

◆ print_param_pack_initilialization() [1/2]

virtual void CASM::OrbitFunctionTraits::print_param_pack_initilialization ( ) const
inlinevirtual

Definition at line 81 of file OrbitFunctionTraits.hh.

◆ print_param_pack_initilialization() [2/2]

virtual void CASM::OrbitFunctionTraits::print_param_pack_initilialization ( ) const
inlinevirtual

Definition at line 19 of file OrbitFunctionWriter.hh.

◆ print_to_global_prepare()

virtual void CASM::OrbitFunctionTraits::print_to_global_prepare ( ) const
inlinevirtual

Definition at line 23 of file OrbitFunctionWriter.hh.

◆ print_to_point_prepare()

virtual void CASM::OrbitFunctionTraits::print_to_point_prepare ( ) const
inlinevirtual

Definition at line 21 of file OrbitFunctionWriter.hh.

◆ print_typedefs() [1/2]

virtual void CASM::OrbitFunctionTraits::print_typedefs ( std::ostream &  out,
std::string const &  class_name,
std::string const &  indent 
) const
inlinevirtual

Definition at line 96 of file OrbitFunctionTraits.hh.

◆ print_typedefs() [2/2]

virtual void CASM::OrbitFunctionTraits::print_typedefs ( std::ostream &  out,
std::string const &  class_name,
std::string const &  indent 
) const
inlinevirtual

Definition at line 25 of file OrbitFunctionWriter.hh.

◆ short_desc()

std::string const& CASM::OrbitFunctionTraits::short_desc ( ) const
inline

Definition at line 75 of file OrbitFunctionTraits.hh.

Member Data Documentation

◆ m_arg_names

std::vector<std::string> CASM::OrbitFunctionTraits::m_arg_names
private

Definition at line 36 of file OrbitFunctionWriter.hh.

◆ m_long_desc

std::string CASM::OrbitFunctionTraits::m_long_desc
private

Definition at line 109 of file OrbitFunctionTraits.hh.

◆ m_name

std::string CASM::OrbitFunctionTraits::m_name
private

Definition at line 105 of file OrbitFunctionTraits.hh.

◆ m_short_desc

std::string CASM::OrbitFunctionTraits::m_short_desc
private

Definition at line 108 of file OrbitFunctionTraits.hh.

◆ m_signature

std::vector<std::string> CASM::OrbitFunctionTraits::m_signature
private

Definition at line 35 of file OrbitFunctionWriter.hh.


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