CASM::Monte::OccCandidateList Class Reference

#include <OccCandidate.hh>

Detailed Description

List of asym / species_index pairs indicating allowed variable occupation dof

Definition at line 120 of file OccCandidate.hh.

Public Types
typedef std::vector< OccCandidate >::const_iterator	const_iterator

Public Member Functions
	OccCandidateList ()
	OccCandidateList (const Conversions &convert)
Index	index (const OccCandidate &cand) const
Index	index (Index asym, Index species_index) const
const OccCandidate &	operator[] (Index candidate_index) const
const_iterator	begin () const
const_iterator	end () const
Index	size () const
const std::vector< OccSwap > &	canonical_swap () const
const std::vector< OccSwap > &	grand_canonical_swap () const

Private Member Functions
void	_make_possible_swaps (const Conversions &convert)
	Construct m_canonical_swaps, m_grand_canonical_swaps. More...

Private Attributes
std::vector< std::vector< Index > >	m_species_to_cand_index
	m_converter[asym][species_index] -> candidate_index More...
std::vector< OccCandidate >	m_candidate
Index	m_end
std::vector< OccSwap >	m_canonical_swap
	vector of allowed canonical swaps More...
std::vector< OccSwap >	m_grand_canonical_swap
	vector of allowed grand canonical swaps More...

Member Typedef Documentation

const_iterator

typedef std::vector<OccCandidate>::const_iterator CASM::Monte::OccCandidateList::const_iterator

Definition at line 122 of file OccCandidate.hh.

Constructor & Destructor Documentation

OccCandidateList() [1/2]

CASM::Monte::OccCandidateList::OccCandidateList ( )

inline

Definition at line 124 of file OccCandidate.hh.

OccCandidateList() [2/2]

CASM::Monte::OccCandidateList::OccCandidateList

(

const Conversions &

convert

)

Definition at line 64 of file OccCandidate.cc.

Member Function Documentation

_make_possible_swaps()

void CASM::Monte::OccCandidateList::_make_possible_swaps ( const Conversions &  convert )

private

Construct m_canonical_swaps, m_grand_canonical_swaps.

• Currently settings is not used, but we could add restrictions

Definition at line 100 of file OccCandidate.cc.

begin()

const_iterator CASM::Monte::OccCandidateList::begin ( ) const

inline

Definition at line 144 of file OccCandidate.hh.

canonical_swap()

const std::vector<OccSwap>& CASM::Monte::OccCandidateList::canonical_swap ( ) const

inline

Definition at line 150 of file OccCandidate.hh.

end()

const_iterator CASM::Monte::OccCandidateList::end ( ) const

inline

Definition at line 146 of file OccCandidate.hh.

grand_canonical_swap()

const std::vector<OccSwap>& CASM::Monte::OccCandidateList::grand_canonical_swap ( ) const

inline

Definition at line 154 of file OccCandidate.hh.

index() [1/2]

Index CASM::Monte::OccCandidateList::index ( const OccCandidate &  cand ) const

inline

Return index into std::vector<OccCandidate>, or _candidate.size() if not allowed

Definition at line 130 of file OccCandidate.hh.

index() [2/2]

Index CASM::Monte::OccCandidateList::index ( Index  asym, Index  species_index  ) const

inline

Return index into std::vector<OccCandidate>, or _candidate.size() if not allowed

Definition at line 136 of file OccCandidate.hh.

operator[]()

const OccCandidate& CASM::Monte::OccCandidateList::operator[] ( Index  candidate_index ) const

inline

Definition at line 140 of file OccCandidate.hh.

size()

Index CASM::Monte::OccCandidateList::size ( ) const

inline

Definition at line 148 of file OccCandidate.hh.

Member Data Documentation

m_candidate

std::vector<OccCandidate> CASM::Monte::OccCandidateList::m_candidate

private

Definition at line 165 of file OccCandidate.hh.

m_canonical_swap

std::vector<OccSwap> CASM::Monte::OccCandidateList::m_canonical_swap

private

vector of allowed canonical swaps

Definition at line 172 of file OccCandidate.hh.

m_end

Index CASM::Monte::OccCandidateList::m_end

private

Number of allowed candidates, what is returned if a candidate is not allowed

Definition at line 169 of file OccCandidate.hh.

m_grand_canonical_swap

std::vector<OccSwap> CASM::Monte::OccCandidateList::m_grand_canonical_swap

private

vector of allowed grand canonical swaps

Definition at line 175 of file OccCandidate.hh.

m_species_to_cand_index

std::vector<std::vector<Index> > CASM::Monte::OccCandidateList::m_species_to_cand_index

private

m_converter[asym][species_index] -> candidate_index

Definition at line 163 of file OccCandidate.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/monte_carlo/OccCandidate.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/monte_carlo/OccCandidate.cc