CASM::ConfigEnumOptions Struct Reference

#include <enumerate_configurations.hh>

Detailed Description

Options for the enumerate_configurations function.

Definition at line 23 of file enumerate_configurations.hh.

Public Member Functions
	ConfigEnumOptions (PrimClex const &primclex)

Public Attributes
std::string	method_name
	Method name, for printing progress. More...
bool	primitive_only = true
std::string	filter_expression
	If not empty, expression used to construct filter. More...
std::function< bool(Configuration const &)>	filter
	If filter(configuration)==true, keep configuration, else skip. More...
bool	dry_run = false
	If dry_run==true, do not save results, just print to screen. More...
int	verbosity = 10
	Printing verbosity level. More...
PrimClex const *	primclex_ptr = nullptr
	Use while transitioning Supercell to no longer need a PrimClex const * More...
bool	output_configurations = false
FormattedDataFileOptions	output_options
	Options for construcing FormattedDataFile object. More...
bool	output_filtered_configurations = false
	If true, include output for configurations that were filtered out. More...

Constructor & Destructor Documentation

ConfigEnumOptions()

CASM::ConfigEnumOptions::ConfigEnumOptions ( PrimClex const &  primclex )

inline

Definition at line 24 of file enumerate_configurations.hh.

Member Data Documentation

dry_run

bool CASM::ConfigEnumOptions::dry_run = false

If dry_run==true, do not save results, just print to screen.

Definition at line 40 of file enumerate_configurations.hh.

filter

std::function<bool(Configuration const &)> CASM::ConfigEnumOptions::filter

If filter(configuration)==true, keep configuration, else skip.

Definition at line 37 of file enumerate_configurations.hh.

filter_expression

std::string CASM::ConfigEnumOptions::filter_expression

If not empty, expression used to construct filter.

Definition at line 34 of file enumerate_configurations.hh.

method_name

std::string CASM::ConfigEnumOptions::method_name

Method name, for printing progress.

Definition at line 27 of file enumerate_configurations.hh.

output_configurations

bool CASM::ConfigEnumOptions::output_configurations = false

If true, output a selection file with information about enumerated configurations

Definition at line 50 of file enumerate_configurations.hh.

output_filtered_configurations

bool CASM::ConfigEnumOptions::output_filtered_configurations = false

If true, include output for configurations that were filtered out.

Definition at line 56 of file enumerate_configurations.hh.

output_options

FormattedDataFileOptions CASM::ConfigEnumOptions::output_options

Options for construcing FormattedDataFile object.

Definition at line 53 of file enumerate_configurations.hh.

primclex_ptr

PrimClex const* CASM::ConfigEnumOptions::primclex_ptr = nullptr

Use while transitioning Supercell to no longer need a PrimClex const *

Definition at line 46 of file enumerate_configurations.hh.

primitive_only

bool CASM::ConfigEnumOptions::primitive_only = true

If primitive_only==true, only the primitive configuration is inserted, otherwise non-primitive are also inserted

Definition at line 31 of file enumerate_configurations.hh.

verbosity

int CASM::ConfigEnumOptions::verbosity = 10

Printing verbosity level.

Definition at line 43 of file enumerate_configurations.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/app/enum/enumerate_configurations.hh