CASM  1.1.0
A Clusters Approach to Statistical Mechanics
SymInfo_stream_io.hh
Go to the documentation of this file.
1 #ifndef CASM_symmetry_SymInfo_stream_io
2 #define CASM_symmetry_SymInfo_stream_io
3 
4 #include <iomanip>
5 #include <iostream>
6 #include <string>
7 
8 #include "casm/casm_io/enum/stream_io.hh"
9 #include "casm/global/definitions.hh"
10 #include "casm/symmetry/SymInfo.hh"
11 
12 namespace CASM {
13 
14 class SymGroup;
15 struct SymInfo;
16 
17 ENUM_TRAITS(symmetry_type)
18 ENUM_IO_DECL(symmetry_type)
19 
20 struct SymInfoOptions {
22  SymInfoOptions(COORD_TYPE _coord_type = FRAC, double _tol = TOL,
23  Index _prec = 7, bool _print_matrix_tau = false)
24  : coord_type(_coord_type),
25  tol(_tol),
26  prec(_prec),
27  print_matrix_tau(_print_matrix_tau) {}
28  COORD_TYPE coord_type;
29  double tol;
30  Index prec;
31  bool print_matrix_tau;
32 };
33 
35 void print_sym_info(Log &log, const SymInfo &info,
36  SymInfoOptions opt = SymInfoOptions());
37 
39 std::string to_string(const SymInfo &info,
40  SymInfoOptions opt = SymInfoOptions());
41 
43 std::string to_brief_unicode(const SymInfo &info,
44  SymInfoOptions opt = SymInfoOptions());
45 
47 std::string description(const SymOp &op, const xtal::Lattice &lat,
48  SymInfoOptions opt = SymInfoOptions());
49 
51 void description(Log &log, const SymGroup &g, const xtal::Lattice &lat,
52  SymInfoOptions opt = SymInfoOptions());
53 
55 std::string brief_description(const SymOp &op, const xtal::Lattice &lat,
56  SymInfoOptions opt = SymInfoOptions());
57 
59 void brief_description(Log &log, const SymGroup &g, const xtal::Lattice &lat,
60  SymInfoOptions opt = SymInfoOptions());
61 
62 } // namespace CASM
63 
64 #endif
ENUM_TRAITS
#define ENUM_TRAITS(ENUM)
Definition: io_traits.hh:213
stream_io.hh
ENUM_IO_DECL
#define ENUM_IO_DECL(ENUM)
Definition: stream_io.hh:8
CASM::Log
Definition: Log.hh:48
CASM::SymGroup
SymGroup is a collection of symmetry operations that satisfy the group property The symmetry operatio...
Definition: SymGroup.hh:42
CASM::SymOp
SymOp is the Coordinate representation of a symmetry operation it keeps fraction (FRAC) and Cartesian...
Definition: SymOp.hh:28
CASM::to_string
std::string to_string(ENUM val)
Return string representation of enum class.
Definition: io_traits.hh:172
CASM::symmetry_type
symmetry_type
Definition: SymInfo.hh:14
CASM
Main CASM namespace.
Definition: APICommand.hh:8
CASM::to_brief_unicode
std::string to_brief_unicode(const SymInfo &info, SymInfoOptions opt=SymInfoOptions())
Print symmetry symbol to string.
Definition: SymInfo_stream_io.cc:364
CASM::description
std::string description(const SymOp &op, const xtal::Lattice &lat, SymInfoOptions opt=SymInfoOptions())
Print SymInfo to string.
Definition: SymInfo_stream_io.cc:454
CASM::COORD_TYPE
COORD_TYPE
Definition: enum.hh:6
CASM::log
Log & log()
Definition: Log.hh:424
CASM::brief_description
std::string brief_description(const SymOp &op, const xtal::Lattice &lat, SymInfoOptions opt=SymInfoOptions())
Print SymInfo to brief string.
Definition: SymInfo_stream_io.cc:489
CASM::FRAC
const COORD_TYPE FRAC
Definition: enum.hh:8
CASM::TOL
const double TOL
Definition: definitions.hh:30
CASM::print_sym_info
void print_sym_info(Log &log, const SymInfo &info, SymInfoOptions opt=SymInfoOptions())
Print SymInfo.
Definition: SymInfo_stream_io.cc:32
CASM::Index
INDEX_TYPE Index
For long integer indexing:
Definition: definitions.hh:39
CASM::SymInfo
Simple struct to be used as return type for SymOp::info().
Definition: SymInfo.hh:26
CASM::SymInfoOptions
Options for printing SymInfo.
Definition: SymInfo_stream_io.hh:21
CASM::SymInfoOptions::SymInfoOptions
SymInfoOptions(COORD_TYPE _coord_type=FRAC, double _tol=TOL, Index _prec=7, bool _print_matrix_tau=false)
Definition: SymInfo_stream_io.hh:22