Struct template AccumulateWithinDistance

Struct template AccumulateWithinDistance

Aboria::AccumulateWithinDistance

Synopsis

// In header: </home/travis/build/martinjrobins/Aboria/src/Symbolic.h>

template<typename T, int LNormNumber = 2, 
         typename Terminal = typename detail::accumulate_within_distance<              T, mpl::int_<LNormNumber>> > 
struct AccumulateWithinDistance {
  // types
  typedef Terminal                           data_type;
  typedef proto::terminal< data_type >::type expr_type;

  // construct/copy/destruct
  explicit AccumulateWithinDistance(const double = 1);
  template<typename T2> 
    explicit AccumulateWithinDistance(const double, const T2 &);

  // public member functions
  void set_init(const typename data_type::init_type &);
  void set_max_distance(const double);
};

Description

an accumulation expression, for example a sum or product, over neighbouring particles within a given radius

`AccumulateWithinDistance` public construct/copy/destruct

explicit AccumulateWithinDistance(const double max_distance = 1);

empty constructor, makes an instantiation of the functor class T

template<typename T2> 
  explicit AccumulateWithinDistance(const double max_distance, const T2 & arg);

constructor that passes a single argument to the functor class T

`AccumulateWithinDistance` public member functions

void set_init(const typename data_type::init_type & arg);

a function used to set the initial value of the accumulation

void set_max_distance(const double max_distance);