CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::ConfigEnumRandomLocalParams Struct Reference

#include <ConfigEnumRandomLocal.hh>

Detailed Description

Parameters controlling ConfigEnumRandomLocal.

Definition at line 26 of file ConfigEnumRandomLocal.hh.

Public Member Functions

 ConfigEnumRandomLocalParams (MTRand &_mtrand, DoFKey _dof_key, Index _n_config, double _mag, bool _normal_distribution)
 

Public Attributes

MTRand & mtrand
 Random number generator. More...
 
DoFKey dof_key
 
Index n_config
 Number of random configurations to generate. More...
 
double mag
 Magnitude used to scale random vector at each site. More...
 
bool normal_distribution
 True if using "normal" distribution, else using "uniform" distribution. More...
 

Constructor & Destructor Documentation

◆ ConfigEnumRandomLocalParams()

CASM::ConfigEnumRandomLocalParams::ConfigEnumRandomLocalParams ( MTRand &  _mtrand,
DoFKey  _dof_key,
Index  _n_config,
double  _mag,
bool  _normal_distribution 
)

Definition at line 8 of file ConfigEnumRandomLocal.cc.

Member Data Documentation

◆ dof_key

DoFKey CASM::ConfigEnumRandomLocalParams::dof_key

Name of site degree of freedom for which normal coordinates are to be generated.

DoFKey is a typedef for std::string

Definition at line 37 of file ConfigEnumRandomLocal.hh.

◆ mag

double CASM::ConfigEnumRandomLocalParams::mag

Magnitude used to scale random vector at each site.

Definition at line 43 of file ConfigEnumRandomLocal.hh.

◆ mtrand

MTRand& CASM::ConfigEnumRandomLocalParams::mtrand

Random number generator.

Definition at line 31 of file ConfigEnumRandomLocal.hh.

◆ n_config

Index CASM::ConfigEnumRandomLocalParams::n_config

Number of random configurations to generate.

Definition at line 40 of file ConfigEnumRandomLocal.hh.

◆ normal_distribution

bool CASM::ConfigEnumRandomLocalParams::normal_distribution

True if using "normal" distribution, else using "uniform" distribution.

Definition at line 46 of file ConfigEnumRandomLocal.hh.


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