Orbit.hh

Go to the documentation of this file.

#ifndef ORBIT_HH
#define ORBIT_HH

#include <iostream>

#include "casm/clusterography/Cluster.hh"

namespace CASM {

  template<typename CoordType> class BasicStructure;
  class Site;

  template<typename ClustType>
  class GenericOrbit;

  class SiteCluster;
  typedef GenericOrbit<SiteCluster> SiteOrbit;

  class HopCluster;
  typedef GenericOrbit<HopCluster> HopOrbit;

  class FunctionVisitor;

  class BasisSet;

  //GenericOrbit class definition begins here:
  template<typename ClustType>
  class GenericOrbit : public Array<ClustType > {
  private:
    mutable Index index;
    Index permute_rep_ID, coord_rep_ID;
    Array<GenericOrbit *> sub_cluster;

  public:
    using Array<ClustType > :: size;
    using Array<ClustType > :: at;
    using Array<ClustType > :: clear;

    ClustType  prototype;

    Array< Array<SymOp> > equivalence_map;

    GenericOrbit(const ClustType  &init_prototype) : index(-1), permute_rep_ID(-1), coord_rep_ID(-1), prototype(init_prototype) {};

    void set_lattice(const Lattice &new_home, COORD_TYPE mode);

    void get_equivalent(const SymGroup &sym_group, double tol);

    GenericOrbit &apply_sym(const SymOp &op);

    bool contains(const ClustType  &test_clust, double tol) const;
    bool contains(const typename ClustType::WhichCoordType &test_site, double tol) const;

    Index find(const ClustType  &test_clust, double tol) const;
    Index find(const ClustType  &test_clust, Coordinate &trans, double tol) const;

    void collect_basis_info(const Array<typename ClustType::WhichCoordType> &basis, const Coordinate &shift);
    void collect_basis_info(const Array<typename ClustType::WhichCoordType> &basis);

    SymGroupRep const *get_full_permutation_representation();

    SymGroupRep const *get_full_coord_representation();

    double max_length() const {
      return prototype.max_length();
    }
    double min_length() const {
      return prototype.min_length();
    }

    //Not implemented
    void read(std::istream &stream, int num_sites, COORD_TYPE mode);
    void read(std::istream &stream, COORD_TYPE mode, const SymGroup &sym_group); //Modified by Ivy


    ReturnArray<std::string> orbit_function_cpp_strings(const Array<FunctionVisitor *> &labelers);

    ReturnArray<std::string> flower_function_cpp_strings(const Array<FunctionVisitor *> &labelers, Index nlist_index);

    ReturnArray<std::string> delta_occfunc_flower_function_cpp_strings(BasisSet site_basis, const Array<FunctionVisitor *> &labelers, Index nlist_index, Index b_index, Index f_index);

    //Access index, which is private
    Index get_index() const {
      return this->index;
    };

    //Allows you to set the index since it's private
    void set_index(Index ind) const { //Added by Ivy 05/05/2013 -- This may be a temporary fix depending on how we want to treat index
      this->index = ind;
    };

    jsonParser &to_json(jsonParser &json) const;

    void from_json(const jsonParser &json);

  };

  // Some template weirdness is not allowing this to compile on flux.
  //   So I'm specializing for SiteCluster in ClusterFunctions.hh/.cc
  /*
  template<typename ClustType>
  jsonParser &to_json(const GenericOrbit<ClustType> &orbit, jsonParser &json) {
    return orbit.to_json(json);
  }

  template<typename ClustType>
  void from_json(GenericOrbit<ClustType> &orbit, const jsonParser &json) {
    orbit.from_json(json);
  }
  */


};

#include "casm/clusterography/Orbit_impl.hh"

#endif