TraversalOption.h

Go to the documentation of this file.

 
#pragma once
 
#include <set>
 
#include "autopas/options/InteractionTypeOption.h"
#include "autopas/options/Option.h"
 
namespace autopas {
inline namespace options {
class TraversalOption : public Option<TraversalOption> {
 public:
  enum Value {
    // DirectSum Traversals:
    ds_sequential,
 
    // LinkedCell Traversals:
    lc_c01,
    lc_c01_combined_SoA,
    lc_c04,
    lc_c04_HCP,
    lc_c04_combined_SoA,
    lc_c08,
    lc_c18,
    lc_sliced,
    lc_sliced_balanced,
    lc_sliced_c02,
 
    // Octree Traversals:
    ot_c01,
    ot_c18,
 
    // VerletClusterLists Traversals:
    vcl_c01_balanced,
    vcl_c06,
    vcl_cluster_iteration,
    vcl_sliced,
    vcl_sliced_balanced,
    vcl_sliced_c02,
 
    // VerletList Traversals:
    vl_list_iteration,
 
    // VerletListCells Traversals:
    vlc_c01,
    vlc_c18,
    vlc_c08,
    vlc_sliced,
    vlc_sliced_balanced,
    vlc_sliced_c02,
 
    // PairwiseVerletLists Traversals - same traversals as VLC but with a new name for the pairwise container
    vlp_c01,
    vlp_c18,
    vlp_sliced,
    vlp_sliced_balanced,
    vlp_sliced_c02,
 
    vlp_c08,
 
    // VarVerlet Traversals:
    vvl_as_built,
  };
 
  TraversalOption() = default;
 
  constexpr TraversalOption(Value option) : _value(option) {}
 
  constexpr operator Value() const { return _value; }
 
  static std::set<TraversalOption> getDiscouragedOptions() {
    return {Value::ds_sequential, Value::vcl_cluster_iteration};
  }
 
  static std::set<TraversalOption> getAllPairwiseOptions() { return getAllOptions(); }
 
  static std::set<TraversalOption> getAllTriwiseOptions() {
    return {Value::ds_sequential, Value::lc_c01, Value::lc_c08, Value::lc_sliced, Value::lc_sliced_c02, Value::lc_c04};
  }
 
  static std::set<TraversalOption> getMostPairwiseOptions() {
    std::set<TraversalOption> mostPairwiseOptions;
    auto allOptions = getAllOptions();
    auto discouragedOptions = getDiscouragedOptions();
    std::set_difference(allOptions.begin(), allOptions.end(), discouragedOptions.begin(), discouragedOptions.end(),
                        std::inserter(mostPairwiseOptions, mostPairwiseOptions.begin()));
    return mostPairwiseOptions;
  }
 
  static std::set<TraversalOption> getMostTriwiseOptions() {
    std::set<TraversalOption> mostTriwiseOptions;
    auto allOptions = getAllTriwiseOptions();
    auto discouragedOptions = getDiscouragedOptions();
    std::set_difference(allOptions.begin(), allOptions.end(), discouragedOptions.begin(), discouragedOptions.end(),
                        std::inserter(mostTriwiseOptions, mostTriwiseOptions.begin()));
    return mostTriwiseOptions;
  }
 
  static std::set<TraversalOption> getAllOptionsOf(const autopas::InteractionTypeOption &interactionType) {
    switch (interactionType) {
      case autopas::InteractionTypeOption::pairwise:
        return getAllPairwiseOptions();
      case autopas::InteractionTypeOption::triwise:
        return getAllTriwiseOptions();
      default:
        return {};
    }
  }
 
  static std::map<TraversalOption, std::string> getOptionNames() {
    return {
        // DirectSum Traversals:
        {TraversalOption::ds_sequential, "ds_sequential"},
 
        // LinkedCell Traversals:
        {TraversalOption::lc_sliced, "lc_sliced"},
        {TraversalOption::lc_sliced_balanced, "lc_sliced_balanced"},
        {TraversalOption::lc_sliced_c02, "lc_sliced_c02"},
        {TraversalOption::lc_c01, "lc_c01"},
        {TraversalOption::lc_c01_combined_SoA, "lc_c01_combined_SoA"},
        {TraversalOption::lc_c04, "lc_c04"},
        {TraversalOption::lc_c04_HCP, "lc_c04_HCP"},
        {TraversalOption::lc_c04_combined_SoA, "lc_c04_combined_SoA"},
        {TraversalOption::lc_c08, "lc_c08"},
        {TraversalOption::lc_c18, "lc_c18"},
 
        // VerletClusterLists Traversals:
        {TraversalOption::vcl_cluster_iteration, "vcl_cluster_iteration"},
        {TraversalOption::vcl_c06, "vcl_c06"},
        {TraversalOption::vcl_c01_balanced, "vcl_c01_balanced"},
        {TraversalOption::vcl_sliced, "vcl_sliced"},
        {TraversalOption::vcl_sliced_c02, "vcl_sliced_c02"},
        {TraversalOption::vcl_sliced_balanced, "vcl_sliced_balanced"},
 
        // VerletList Traversals:
        {TraversalOption::vl_list_iteration, "vl_list_iteration"},
 
        // VerletListCells Traversals:
        {TraversalOption::vlc_sliced, "vlc_sliced"},
        {TraversalOption::vlc_sliced_c02, "vlc_sliced_c02"},
        {TraversalOption::vlc_c18, "vlc_c18"},
        {TraversalOption::vlc_c01, "vlc_c01"},
        {TraversalOption::vlc_c08, "vlc_c08"},
        {TraversalOption::vlc_sliced_balanced, "vlc_sliced_balanced"},
 
        // VarVerlet Traversals:
        {TraversalOption::vvl_as_built, "vvl_as_built"},
 
        // PairwiseVerlet Traversals:
        {TraversalOption::vlp_sliced, "vlp_sliced"},
        {TraversalOption::vlp_sliced_c02, "vlp_sliced_c02"},
        {TraversalOption::vlp_c18, "vlp_c18"},
        {TraversalOption::vlp_c01, "vlp_c01"},
        {TraversalOption::vlp_sliced_balanced, "vlp_sliced_balanced"},
        {TraversalOption::vlp_c08, "vlp_c08"},
 
        // Octree Traversals:
        {TraversalOption::ot_c18, "ot_c18"},
        {TraversalOption::ot_c01, "ot_c01"},
    };
  };
 
 private:
  Value _value{Value(-1)};
};
}  // namespace options
}  // namespace autopas