#include <DoF.hh>

Inheritance diagram for CASM::ContinuousDoF:

Detailed Description

Definition at line 341 of file DoF.hh.

Public Member Functions
	ContinuousDoF ()

	ContinuousDoF (const std::string &tname, double tmin, double tmax)

	ContinuousDoF (const std::string &tname, Index _ID, double tmin, double tmax)

double	value () const

bool	compare (const ContinuousDoF &RHS, bool compare_value) const

bool	operator== (const ContinuousDoF &RHS) const

double	remote_value () const

double const *	remote_ptr () const

void	register_remote (const RemoteHandle &handle)

void	perturb_dof ()

ContinuousDoF *	copy () const

jsonParser &	to_json (jsonParser &json) const

const std::string &	type_name () const

std::string	type_name_prefix () const

std::string	type_name_suffix () const

Index	ID () const

void	set_ID (Index new_ID)

bool	is_locked () const

void	lock_ID ()

void	unlock_ID ()

Protected Attributes
std::string	m_type_name

Index	m_dof_ID

bool	m_ID_lock

Private Attributes
double	min_val

double	max_val

double	current_val

double	current_min

double	current_max

const double *	m_remote_ptr
	Allows DoF to point to a remote value for faster/easier evaluation. More...

Constructor & Destructor Documentation

CASM::ContinuousDoF::ContinuousDoF ( )

inline

Definition at line 348 of file DoF.hh.

CASM::ContinuousDoF::ContinuousDoF	(	const std::string &	tname,
		double	tmin,
		double	tmax
	)

inline

Definition at line 351 of file DoF.hh.

CASM::ContinuousDoF::ContinuousDoF	(	const std::string &	tname,
		Index	_ID,
		double	tmin,
		double	tmax
	)

inline

Definition at line 355 of file DoF.hh.

Member Function Documentation

bool CASM::ContinuousDoF::compare	(	const ContinuousDoF &	RHS,
		bool	compare_value
	)		const

inline

Definition at line 363 of file DoF.hh.

ContinuousDoF* CASM::ContinuousDoF::copy ( ) const

inline

Definition at line 395 of file DoF.hh.

Index CASM::DoF::ID ( ) const

inlineinherited

Definition at line 71 of file DoF.hh.

bool CASM::DoF::is_locked ( ) const

inlineinherited

Definition at line 82 of file DoF.hh.

void CASM::DoF::lock_ID ( )

inlineinherited

Definition at line 86 of file DoF.hh.

bool CASM::ContinuousDoF::operator== ( const ContinuousDoF & RHS ) const

inline

Definition at line 371 of file DoF.hh.

void CASM::ContinuousDoF::perturb_dof ( )

inline

Definition at line 391 of file DoF.hh.

void CASM::ContinuousDoF::register_remote ( const RemoteHandle & handle )

inline

Definition at line 386 of file DoF.hh.

double const* CASM::ContinuousDoF::remote_ptr ( ) const

inline

Definition at line 382 of file DoF.hh.

double CASM::ContinuousDoF::remote_value ( ) const

inline

Definition at line 377 of file DoF.hh.

void CASM::DoF::set_ID ( Index new_ID )

inlineinherited

Definition at line 75 of file DoF.hh.

jsonParser& CASM::ContinuousDoF::to_json ( jsonParser & json ) const

inlinevirtual

Implements CASM::DoF.

Definition at line 399 of file DoF.hh.

const std::string& CASM::DoF::type_name ( ) const

inlineinherited

Definition at line 49 of file DoF.hh.

std::string CASM::DoF::type_name_prefix ( ) const

inlineinherited

Definition at line 53 of file DoF.hh.

std::string CASM::DoF::type_name_suffix ( ) const

inlineinherited

Definition at line 62 of file DoF.hh.

void CASM::DoF::unlock_ID ( )

inlineinherited

Definition at line 90 of file DoF.hh.

double CASM::ContinuousDoF::value ( ) const

inline

Definition at line 359 of file DoF.hh.

Member Data Documentation

double CASM::ContinuousDoF::current_max

private

Definition at line 343 of file DoF.hh.

double CASM::ContinuousDoF::current_min

private

Definition at line 343 of file DoF.hh.

double CASM::ContinuousDoF::current_val

private

Definition at line 342 of file DoF.hh.

Index CASM::DoF::m_dof_ID

protectedinherited

dof_ID is a way to distinguish between DoFs with the same name but different identities dof_ID for now usually refers to the site index of a cluster (e.g., 0, 1, 2 of a triplet) or an index into the primitive cell neighbor list. Other usage cases may be introduced later

Definition at line 27 of file DoF.hh.

bool CASM::DoF::m_ID_lock

protectedinherited

Definition at line 28 of file DoF.hh.

const double* CASM::ContinuousDoF::m_remote_ptr

private

Allows DoF to point to a remote value for faster/easier evaluation.

Definition at line 346 of file DoF.hh.

std::string CASM::DoF::m_type_name

protectedinherited

Definition at line 23 of file DoF.hh.

double CASM::ContinuousDoF::max_val

private

Definition at line 342 of file DoF.hh.

double CASM::ContinuousDoF::min_val

private

Definition at line 342 of file DoF.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/basis_set/DoF.hh

Detailed Description

Public Member Functions

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation