CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
CASM::Clex Class Reference

#include <Clex.hh>

Detailed Description

Data structure used for cluster expansions.

Definition at line 24 of file Clex.hh.

Public Member Functions

 Clex ()
 
 Clex (const PrimClex &_primclex)
 
 Clex (const PrimClex &_primclex, const ClexDescription &_desc)
 
const PrimClex & primclex () const
 
const ClexDescription & desc () const
 
const SiteOrbitree & orbitree () const
 
Clexulator & clexulator (Log &status_log=null_log()) const
 
const ECIContainer & eci () const
 

Private Attributes

const PrimClex * m_primclex
 Pointer to PrimClex. More...
 
ClexDescription m_desc
 Cluster expansion description: name, property, calctype, ref, bset, eci. More...
 
const SiteOrbitree * m_orbitree
 Pointer to SiteOrbitree held by PrimClex. More...
 
Clexulator m_clexulator
 
const ECIContainer * m_eci
 Pointer to ECIContainer held by PrimClex. More...
 

Constructor & Destructor Documentation

CASM::Clex::Clex ( )
inline

Definition at line 28 of file Clex.hh.

CASM::Clex::Clex ( const PrimClex &  _primclex)
inline

Definition at line 30 of file Clex.hh.

CASM::Clex::Clex ( const PrimClex &  _primclex,
const ClexDescription &  _desc 
)
inline

Definition at line 33 of file Clex.hh.

Member Function Documentation

Clexulator & CASM::Clex::clexulator ( Log &  status_log = null_log()) const

Definition at line 24 of file Clex.cc.

const ClexDescription & CASM::Clex::desc ( ) const

Definition at line 12 of file Clex.cc.

const ECIContainer & CASM::Clex::eci ( ) const

Definition at line 32 of file Clex.cc.

const SiteOrbitree & CASM::Clex::orbitree ( ) const

Definition at line 16 of file Clex.cc.

const PrimClex & CASM::Clex::primclex ( ) const

Definition at line 8 of file Clex.cc.

Member Data Documentation

Clexulator CASM::Clex::m_clexulator
mutableprivate

Clexulator (obtained from PrimClex, but must be separate object because of how Clexulator are evaluated)

Definition at line 62 of file Clex.hh.

ClexDescription CASM::Clex::m_desc
private

Cluster expansion description: name, property, calctype, ref, bset, eci.

Definition at line 55 of file Clex.hh.

const ECIContainer* CASM::Clex::m_eci
mutableprivate

Pointer to ECIContainer held by PrimClex.

Definition at line 65 of file Clex.hh.

const SiteOrbitree* CASM::Clex::m_orbitree
mutableprivate

Pointer to SiteOrbitree held by PrimClex.

Definition at line 58 of file Clex.hh.

const PrimClex* CASM::Clex::m_primclex
private

Pointer to PrimClex.

Definition at line 52 of file Clex.hh.


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