#include <CanonicalConditions.hh>

Detailed Description

Conditions for a Canonical run: Temperature Composition Tolerance (for comparing conditions)

Definition at line 21 of file CanonicalConditions.hh.

Public Member Functions
	CanonicalConditions ()
	Default constructor. More...

	CanonicalConditions (const PrimClex &_primclex, double _temperature, const Eigen::VectorXd &_param_comp, double _tol)
	Constructor. More...

const PrimClex &	primclex () const

double	temperature () const

double	beta () const

Eigen::VectorXd	param_composition () const
	parametric composition: comp_x More...

double	param_composition (Index index) const
	parametric composition: dcomp_x(index) More...

Eigen::VectorXd	mol_composition () const
	mol composition: comp_n More...

double	mol_composition (Index index) const
	mol composition: comp_n(index) More...

double	tolerance () const

void	set_temperature (double in_temp)
	Set the temperature of the current grand canonical condition. More...

void	set_param_composition (const Eigen::VectorXd &in_param_comp)
	Set parametric composition. More...

void	set_param_composition (Index ind, double in_param_comp)
	Set a single parametric composition by specifying an index and a value. More...

CanonicalConditions &	operator+= (const CanonicalConditions &RHS)
	Add temperature and all chemical potentials to *this. More...

CanonicalConditions	operator+ (const CanonicalConditions &RHS) const

CanonicalConditions &	operator-= (const CanonicalConditions &RHS)
	Subtract temperature and all chemical potentials to *this. More...

CanonicalConditions	operator- (const CanonicalConditions &RHS) const

bool	operator== (const CanonicalConditions &RHS) const
	Compare temperature and all chemical potentials to *this. More...

bool	operator!= (const CanonicalConditions &RHS) const
	Compare temperature and all chemical potentials to *this. More...

int	operator/ (const CanonicalConditions &RHS_inc) const
	Divide ALL parameters and return the greatest number in absolute value. More...

Protected Attributes
const PrimClex *	m_primclex

double	m_temperature
	Temperature. More...

double	m_beta
	Inverse temperature. Includes Boltzmann term. More...

Eigen::VectorXd	m_param_composition
	Vector of the param composition. More...

double	m_tolerance
	Tolerance for comparison operators == and !=. More...

Constructor & Destructor Documentation

◆ CanonicalConditions() [1/2]

CASM::Monte::CanonicalConditions::CanonicalConditions ( )

inline

Default constructor.

Definition at line 24 of file CanonicalConditions.hh.

◆ CanonicalConditions() [2/2]

CASM::Monte::CanonicalConditions::CanonicalConditions	(	const PrimClex &	_primclex,
		double	_temperature,
		const Eigen::VectorXd &	_param_comp,
		double	_tol
	)

Constructor.

Parameters

_primclex	PrimClex
_temperature	in K
_param_comp	Parametric composition
_tol	tolerance for comparing conditions
_primclex	PrimClex
_temperature	in K
_param_chem_pot	Parametric composition chemical potential
_tol	tolerance for comparing conditions

Definition at line 19 of file CanonicalConditions.cc.

Member Function Documentation

◆ beta()

double CASM::Monte::CanonicalConditions::beta ( ) const

Definition at line 41 of file CanonicalConditions.cc.

◆ mol_composition() [1/2]

Eigen::VectorXd CASM::Monte::CanonicalConditions::mol_composition ( ) const

mol composition: comp_n

Definition at line 54 of file CanonicalConditions.cc.

◆ mol_composition() [2/2]

double CASM::Monte::CanonicalConditions::mol_composition ( Index index ) const

mol composition: comp_n(index)

Definition at line 59 of file CanonicalConditions.cc.

◆ operator!=()

bool CASM::Monte::CanonicalConditions::operator!= ( const CanonicalConditions & RHS ) const

Compare temperature and all chemical potentials to *this.

Definition at line 129 of file CanonicalConditions.cc.

◆ operator+()

CanonicalConditions CASM::Monte::CanonicalConditions::operator+ ( const CanonicalConditions & RHS ) const

Add temperature and all chemical potentials together and return a new Condition

Definition at line 97 of file CanonicalConditions.cc.

◆ operator+=()

CanonicalConditions & CASM::Monte::CanonicalConditions::operator+= ( const CanonicalConditions & RHS )

Add temperature and all chemical potentials to *this.

Definition at line 89 of file CanonicalConditions.cc.

◆ operator-()

CanonicalConditions CASM::Monte::CanonicalConditions::operator- ( const CanonicalConditions & RHS ) const

Subtract temperature and all chemical potentials together and return a new Condition

Definition at line 111 of file CanonicalConditions.cc.

◆ operator-=()

CanonicalConditions & CASM::Monte::CanonicalConditions::operator-= ( const CanonicalConditions & RHS )

Subtract temperature and all chemical potentials to *this.

Definition at line 103 of file CanonicalConditions.cc.

◆ operator/()

int CASM::Monte::CanonicalConditions::operator/ ( const CanonicalConditions & RHS_inc ) const

Divide ALL parameters and return the greatest number in absolute value.

Definition at line 133 of file CanonicalConditions.cc.

◆ operator==()

bool CASM::Monte::CanonicalConditions::operator== ( const CanonicalConditions & RHS ) const

Compare temperature and all chemical potentials to *this.

Definition at line 116 of file CanonicalConditions.cc.

◆ param_composition() [1/2]

Eigen::VectorXd CASM::Monte::CanonicalConditions::param_composition ( ) const

parametric composition: comp_x

Definition at line 44 of file CanonicalConditions.cc.

◆ param_composition() [2/2]

double CASM::Monte::CanonicalConditions::param_composition ( Index index ) const

parametric composition: dcomp_x(index)

Definition at line 49 of file CanonicalConditions.cc.

◆ primclex()

const PrimClex & CASM::Monte::CanonicalConditions::primclex ( ) const

Definition at line 37 of file CanonicalConditions.cc.

◆ set_param_composition() [1/2]

void CASM::Monte::CanonicalConditions::set_param_composition ( const Eigen::VectorXd & in_param_comp )

Set parametric composition.

Definition at line 75 of file CanonicalConditions.cc.

◆ set_param_composition() [2/2]

void CASM::Monte::CanonicalConditions::set_param_composition	(	Index	ind,
		double	in_param_comp
	)

Set a single parametric composition by specifying an index and a value.

Definition at line 81 of file CanonicalConditions.cc.

◆ set_temperature()

void CASM::Monte::CanonicalConditions::set_temperature ( double in_temp )

Set the temperature of the current grand canonical condition.

Definition at line 68 of file CanonicalConditions.cc.

◆ temperature()

double CASM::Monte::CanonicalConditions::temperature ( ) const

Definition at line 39 of file CanonicalConditions.cc.

◆ tolerance()

double CASM::Monte::CanonicalConditions::tolerance ( ) const

Definition at line 63 of file CanonicalConditions.cc.

Member Data Documentation

◆ m_beta

double CASM::Monte::CanonicalConditions::m_beta

protected

Inverse temperature. Includes Boltzmann term.

Definition at line 104 of file CanonicalConditions.hh.

◆ m_param_composition

Eigen::VectorXd CASM::Monte::CanonicalConditions::m_param_composition

protected

Vector of the param composition.

Definition at line 107 of file CanonicalConditions.hh.

◆ m_primclex

const PrimClex* CASM::Monte::CanonicalConditions::m_primclex

protected

Definition at line 98 of file CanonicalConditions.hh.

◆ m_temperature

double CASM::Monte::CanonicalConditions::m_temperature

protected

Temperature.

Definition at line 101 of file CanonicalConditions.hh.

◆ m_tolerance

double CASM::Monte::CanonicalConditions::m_tolerance

protected

Tolerance for comparison operators == and !=.

Definition at line 110 of file CanonicalConditions.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/canonical/CanonicalConditions.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/monte_carlo/canonical/CanonicalConditions.cc

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ CanonicalConditions() [1/2]

◆ CanonicalConditions() [2/2]

Member Function Documentation

◆ beta()

◆ mol_composition() [1/2]

◆ mol_composition() [2/2]

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/()

◆ operator==()

◆ param_composition() [1/2]

◆ param_composition() [2/2]

◆ primclex()

◆ set_param_composition() [1/2]

◆ set_param_composition() [2/2]

◆ set_temperature()

◆ temperature()

◆ tolerance()

Member Data Documentation

◆ m_beta

◆ m_param_composition

◆ m_primclex

◆ m_temperature

◆ m_tolerance