CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
CASM::ScoreMappedProperties Class Reference

#include <MappedProperties.hh>

Detailed Description

Resolve mapping conflicts by 'scoring' the MappedProperties structure

Options:

{
"method" : "deformation_cost",
"lattice_weight" : number in range [0,1.0]
}
{
"method" : "minimum",
"property" : property name (i.e. "energy")
}
{
"method" : "maximum",
"property" : property name (i.e. "some property")
}
{
"method" : "direct_selection",
"name" : configname to force as 'best' (i.e. "SCEL3_1_1_3_0_0_0/4")
}
CASM::ConfigIO::configname
ConfigIO::GenericConfigFormatter< std::string > configname()
Constructs DataFormmaterDictionary containing all Configuration DatumFormatters.
Definition: ConfigIO.cc:563
CASM::name
GenericDatumFormatter< std::string, DataObject > name()
Definition: DataFormatterTools.hh:924

Definition at line 145 of file MappedProperties.hh.

Classes

struct  Option
 

Public Types

enum class  Method { deformation_cost , minimum , maximum , direct_selection }
 

Public Member Functions

 ScoreMappedProperties (Option _opt=Option(Method::minimum, "energy"))
 Default uses minimum energy. More...
 
double operator() (const MappedProperties &obj) const
 
bool validate (const MappedProperties &obj) const
 
bool operator== (const ScoreMappedProperties &B) const
 
bool operator!= (const ScoreMappedProperties &B) const
 
const Option & option () const
 

Static Public Member Functions

static std::string method_name (Method m)
 

Private Attributes

Option m_opt
 

Member Enumeration Documentation

◆ Method

enum CASM::ScoreMappedProperties::Method
strong
Enumerator
deformation_cost 
minimum 
maximum 
direct_selection 

Definition at line 147 of file MappedProperties.hh.

Constructor & Destructor Documentation

◆ ScoreMappedProperties()

CASM::ScoreMappedProperties::ScoreMappedProperties ( ScoreMappedProperties::Option  _opt = Option(Method::minimum,                                                      "energy"))
explicit

Default uses minimum energy.

Definition at line 101 of file MappedProperties.cc.

Member Function Documentation

◆ method_name()

static std::string CASM::ScoreMappedProperties::method_name ( Method  m)
inlinestatic

Definition at line 149 of file MappedProperties.hh.

◆ operator!=()

bool CASM::ScoreMappedProperties::operator!= ( const ScoreMappedProperties &  B) const

Definition at line 149 of file MappedProperties.cc.

◆ operator()()

double CASM::ScoreMappedProperties::operator() ( const MappedProperties &  obj) const

Definition at line 104 of file MappedProperties.cc.

◆ operator==()

bool CASM::ScoreMappedProperties::operator== ( const ScoreMappedProperties &  B) const

Definition at line 145 of file MappedProperties.cc.

◆ option()

const Option& CASM::ScoreMappedProperties::option ( ) const
inline

Definition at line 192 of file MappedProperties.hh.

◆ validate()

bool CASM::ScoreMappedProperties::validate ( const MappedProperties &  obj) const

Definition at line 130 of file MappedProperties.cc.

Member Data Documentation

◆ m_opt

Option CASM::ScoreMappedProperties::m_opt
private

Definition at line 195 of file MappedProperties.hh.

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