CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Member Functions | Public Attributes | List of all members
CASM::DoF_impl::SublatComp Struct Reference

#include <OccupationDoFTraits.hh>

Detailed Description

Specifies the composition on one or more equivalent sublattices

Example, specify sublattices 0 and 1 are "A":0.5, "B":0.5 with:

SublatComp sublat_comp { {0, 1}, {{"A", 0.5}, {"B", 0.5}} };
CASM::DoF_impl::SublatComp::SublatComp
SublatComp(std::initializer_list< Index > _indices, std::initializer_list< std::pair< std::string, double >> _values)
Definition: OccupationDoFTraits.hh:25

Definition at line 24 of file OccupationDoFTraits.hh.

Public Member Functions

 SublatComp (std::initializer_list< Index > _indices, std::initializer_list< std::pair< std::string, double >> _values)
 
 SublatComp (std::set< Index > _indices, std::map< std::string, double > _values)
 

Public Attributes

std::set< Index > indices
 
std::map< std::string, double > values
 

Constructor & Destructor Documentation

◆ SublatComp() [1/2]

CASM::DoF_impl::SublatComp::SublatComp ( std::initializer_list< Index >  _indices,
std::initializer_list< std::pair< std::string, double >>  _values 
)
inline

Definition at line 25 of file OccupationDoFTraits.hh.

◆ SublatComp() [2/2]

CASM::DoF_impl::SublatComp::SublatComp ( std::set< Index >  _indices,
std::map< std::string, double >  _values 
)
inline

Definition at line 29 of file OccupationDoFTraits.hh.

Member Data Documentation

◆ indices

std::set<Index> CASM::DoF_impl::SublatComp::indices

Definition at line 32 of file OccupationDoFTraits.hh.

◆ values

std::map<std::string, double> CASM::DoF_impl::SublatComp::values

Definition at line 33 of file OccupationDoFTraits.hh.

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