CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Member Functions | Private Attributes | List of all members
CASM::ClusterSpecs_impl::CutoffRadiusNeighborhood Class Reference

Detailed Description

Generate a vector of UnitCellCoord that are within cutoff_radius distance to any site in the phenomenal cluster

Definition at line 448 of file ClusterSpecs.cc.

Public Member Functions

 CutoffRadiusNeighborhood (IntegralCluster const &_phenomenal, double _cutoff_radius, bool _include_phenomenal_sites)
 
std::vector< xtal::UnitCellCoord > operator() (Structure const &prim, SiteFilterFunction site_filter)
 

Private Attributes

IntegralCluster phenomenal
 
double cutoff_radius
 
bool include_phenomenal_sites
 

Constructor & Destructor Documentation

◆ CutoffRadiusNeighborhood()

CASM::ClusterSpecs_impl::CutoffRadiusNeighborhood::CutoffRadiusNeighborhood ( IntegralCluster const &  _phenomenal,
double  _cutoff_radius,
bool  _include_phenomenal_sites 
)
inline

Definition at line 450 of file ClusterSpecs.cc.

Member Function Documentation

◆ operator()()

std::vector<xtal::UnitCellCoord> CASM::ClusterSpecs_impl::CutoffRadiusNeighborhood::operator() ( Structure const &  prim,
SiteFilterFunction  site_filter 
)
inline

Definition at line 457 of file ClusterSpecs.cc.

Member Data Documentation

◆ cutoff_radius

double CASM::ClusterSpecs_impl::CutoffRadiusNeighborhood::cutoff_radius
private

Definition at line 469 of file ClusterSpecs.cc.

◆ include_phenomenal_sites

bool CASM::ClusterSpecs_impl::CutoffRadiusNeighborhood::include_phenomenal_sites
private

Definition at line 470 of file ClusterSpecs.cc.

◆ phenomenal

IntegralCluster CASM::ClusterSpecs_impl::CutoffRadiusNeighborhood::phenomenal
private

Definition at line 468 of file ClusterSpecs.cc.

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