DoFSpace.hh

Go to the documentation of this file.

#ifndef CASM_enumerator_io_json_DoFSpace
#define CASM_enumerator_io_json_DoFSpace
 
#include <string>
 
#include "casm/enumerator/ConfigEnumInput.hh"
#include "casm/global/definitions.hh"
#include "casm/global/eigen.hh"
#include "casm/symmetry/SymRepTools.hh"
#include "casm/symmetry/VectorSpaceSymReport.hh"
 
namespace CASM {
 
class DoFSpace;
template <typename T>
class InputParser;
class Structure;
template <typename T>
struct jsonConstructor;
template <typename T>
struct jsonMake;
class jsonParser;
 
// jsonParser &to_json(DoFSpace const &dofspace, jsonParser &json);
 
void from_json(DoFSpace &dofspace, jsonParser const &json,
               std::shared_ptr<Structure const> const &shared_prim);
 
jsonParser &to_json(
    DoFSpace const &dofspace, jsonParser &json,
    std::optional<std::string> const &identifier = std::nullopt,
    std::optional<ConfigEnumInput> const &input_state = std::nullopt,
    std::optional<VectorSpaceSymReport> const &sym_report = std::nullopt);
 
jsonParser &to_json(
    DoFSpace const &dofspace, jsonParser &json,
    std::optional<std::string> const &identifier,
    std::optional<ConfigEnumInput> const &input_state,
    std::optional<SymRepTools_v2::VectorSpaceSymReport> const &sym_report);
 
template <>
struct jsonConstructor<DoFSpace> {
  static DoFSpace from_json(
      jsonParser const &json,
      std::shared_ptr<Structure const> const &shared_prim);
};
 
template <>
struct jsonMake<DoFSpace> {
  static std::unique_ptr<DoFSpace> make_from_json(
      jsonParser const &json,
      std::shared_ptr<Structure const> const &shared_prim);
};
 
struct AxesCounterParams {
  // DoFSpace axes (column vector matrix, may be a subspace)
 
  Eigen::MatrixXd axes;
 
  // Counter min, max, and increment values (size must match axes.cols())
 
  Eigen::VectorXd min_vector;
  Eigen::VectorXd max_vector;
  Eigen::VectorXd inc_vector;
 
  // If scalar_input==true, Counter min, max, increment should be set with
  // constant vectors sized as necessary to match axes
  bool scalar_input;
 
  double min_scalar;
  double max_scalar;
  double inc_scalar;
};
 
void parse(InputParser<AxesCounterParams> &parser, Index dof_space_dimension);
 
}  // namespace CASM
 
#endif