CASM::OccFuncLabeler Class Reference

#include <FunctionVisitor.hh>

Inheritance diagram for CASM::OccFuncLabeler:

Detailed Description

Selectively relabel all OccupantFunctions in a Function tree, using their set_formula() method. OccFuncLabeler is constructed using a template string, which should be of the form (substr1 + "%n" + substr2 + "%f" + substr3 + "%b" + substr4), where substr1, etc, are user-defined substrings. "%n" indicates the placement of the neighbor_list index, "%f" indicates the placement of the function index, and "%b" indicates the placement of the basis site index. The relative order of "%n", "%f", and "%b" is determined by the user.

Definition at line 76 of file FunctionVisitor.hh.

Public Member Functions
	OccFuncLabeler (const std::string &_template)
std::string	type_name () const
bool	visit (OccupantFunction &host, BasisSet const *bset_ptr) const
virtual bool	visit (Variable const &host, BasisSet const *bset_ptr) const
virtual bool	visit (Variable &host, BasisSet const *bset_ptr) const
virtual bool	visit (OccupantFunction const &host, BasisSet const *bset_ptr) const
virtual bool	visit (PolynomialFunction const &host, BasisSet const *bset_ptr) const
virtual bool	visit (PolynomialFunction &host, BasisSet const *bset_ptr) const

Private Member Functions
virtual bool	_generic_visit (Function &host, BasisSet const *bset_ptr) const
virtual bool	_generic_visit (Function const &host, BasisSet const *bset_ptr) const
virtual bool	_visit (const Array< Function * > &host_list, BasisSet const *bset_ptr) const

Private Attributes
std::vector< std::string >	m_sub_strings

Constructor & Destructor Documentation

OccFuncLabeler()

CASM::OccFuncLabeler::OccFuncLabeler

(

const std::string &

_template

)

Definition at line 78 of file FunctionVisitor.cc.

Member Function Documentation

_generic_visit() [1/2]

bool CASM::FunctionVisitor::_generic_visit ( Function &  host, BasisSet const *  bset_ptr  ) const

privatevirtualinherited

Reimplemented in CASM::SubExpressionLabeler.

Definition at line 55 of file FunctionVisitor.cc.

_generic_visit() [2/2]

bool CASM::FunctionVisitor::_generic_visit ( Function const &  host, BasisSet const *  bset_ptr  ) const

privatevirtualinherited

Reimplemented in CASM::SubExpressionLabeler, and CASM::OccFuncEvaluator.

Definition at line 61 of file FunctionVisitor.cc.

_visit()

virtual bool CASM::FunctionVisitor::_visit ( const Array< Function * > &  host_list, BasisSet const *  bset_ptr  ) const

inlineprivatevirtualinherited

Definition at line 60 of file FunctionVisitor.hh.

type_name()

std::string CASM::OccFuncLabeler::type_name ( ) const

inlinevirtual

Implements CASM::FunctionVisitor.

Definition at line 82 of file FunctionVisitor.hh.

visit() [1/6]

bool CASM::OccFuncLabeler::visit ( OccupantFunction &  host, BasisSet const *  bset_ptr  ) const

virtual

Reimplemented from CASM::FunctionVisitor.

Definition at line 84 of file FunctionVisitor.cc.

visit() [2/6]

bool CASM::FunctionVisitor::visit ( OccupantFunction const &  host, BasisSet const *  bset_ptr  ) const

virtualinherited

Reimplemented in CASM::OccFuncEvaluator.

Definition at line 35 of file FunctionVisitor.cc.

visit() [3/6]

bool CASM::FunctionVisitor::visit ( PolynomialFunction &  host, BasisSet const *  bset_ptr  ) const

virtualinherited

Definition at line 50 of file FunctionVisitor.cc.

visit() [4/6]

bool CASM::FunctionVisitor::visit ( PolynomialFunction const &  host, BasisSet const *  bset_ptr  ) const

virtualinherited

Definition at line 45 of file FunctionVisitor.cc.

visit() [5/6]

bool CASM::FunctionVisitor::visit ( Variable &  host, BasisSet const *  bset_ptr  ) const

virtualinherited

Reimplemented in CASM::VariableLabeler.

Definition at line 31 of file FunctionVisitor.cc.

visit() [6/6]

bool CASM::FunctionVisitor::visit ( Variable const &  host, BasisSet const *  bset_ptr  ) const

virtualinherited

Definition at line 26 of file FunctionVisitor.cc.

Member Data Documentation

m_sub_strings

std::vector<std::string> CASM::OccFuncLabeler::m_sub_strings

private

Definition at line 77 of file FunctionVisitor.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/basis_set/FunctionVisitor.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/basis_set/FunctionVisitor.cc