dash::halo::StencilSpec< StencilPointT, NumStencilPoints > Class Template Reference

A collection of stencil points (Stencil) e.g. More...

#include <Stencil.h>

Public Types
using	stencil_size_t = std::size_t
using	stencil_index_t = std::size_t
using	StencilArray_t = std::array< StencilPointT, NumStencilPoints >
using	StencilPoint_t = StencilPointT
using	DistanceDim_t = std::pair< spoint_value_t, spoint_value_t >
using	DistanceAll_t = std::array< DistanceDim_t, NumDimensions >
using	DistanceTotal_t = std::array< spoint_distance_t, NumDimensions >

Public Member Functions
constexpr	StencilSpec (const StencilArray_t &specs)
	Constructor. More...
template<typename... Values>
constexpr	StencilSpec (const StencilPointT &value, const Values &... values)
	Constructor. More...
	StencilSpec (const Self_t &other)
	Copy Constructor. More...
constexpr const StencilArray_t &	specs () const
const std::pair< stencil_index_t, bool >	index (StencilPointT stencil) const
	Returns the stencil point index for a given StencilPoint. More...
DistanceTotal_t	total_distances () const
	Returns the total distances of all stencil points for all dimensions. More...
spoint_distance_t	total_distances (dim_t dim) const
	Returns the total distances of all stencil points for all dimensions. More...
DistanceAll_t	minmax_distances () const
	Returns the minimal and maximal distances of all stencil points for all dimensions. More...
DistanceDim_t	minmax_distances (dim_t dim) const
	Returns the minimal and maximal distances of all stencil points for the given dimension. More...
constexpr const StencilPointT &	operator[] (stencil_index_t index) const

Static Public Member Functions
static constexpr stencil_size_t	num_stencil_points ()

Detailed Description

template<typename StencilPointT, std::size_t NumStencilPoints>
class dash::halo::StencilSpec< StencilPointT, NumStencilPoints >

A collection of stencil points (Stencil) e.g.

StencilSpec<dash::StencilPoint<2>, 2,2>({StencilPoint<2>(-1,0), StencilPoint<2>(1,0)}) -> north and south

Examples:

ex.11.halo-stencil/main.cpp.

Definition at line 167 of file Stencil.h.

Constructor & Destructor Documentation

StencilSpec() [1/3]

template<typename StencilPointT, std::size_t NumStencilPoints>

constexpr dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::StencilSpec ( const StencilArray_t &  specs )

inline

Constructor.

Takes a list of StencilPoint

Definition at line 187 of file Stencil.h.

: _specs(specs) {}

StencilSpec() [2/3]

template<typename StencilPointT, std::size_t NumStencilPoints>

template<typename... Values>

constexpr dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::StencilSpec ( const StencilPointT &  value, const Values &...  values  )

inline

Constructor.

Takes all given StencilPoint. The number of arguments has to be the same as the given number of stencil points via the template argument.

Definition at line 196 of file Stencil.h.

  : _specs{ { value, (StencilPointT) values... } } {
    static_assert(sizeof...(values) == NumStencilPoints - 1,
                  "Invalid number of stencil point arguments");
  }

StencilSpec() [3/3]

template<typename StencilPointT, std::size_t NumStencilPoints>

dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::StencilSpec ( const Self_t &  other )

inline

Copy Constructor.

Definition at line 206 of file Stencil.h.

{ _specs = other._specs; }

Member Function Documentation

index()

template<typename StencilPointT, std::size_t NumStencilPoints>

const std::pair<stencil_index_t, bool> dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::index ( StencilPointT  stencil ) const

inline

Returns the stencil point index for a given StencilPoint.

Returns

The index and true if the given stecil point was found, else the index 0 and false. Keep in mind that index 0 is only a valid index, if the returned bool is true

Definition at line 228 of file Stencil.h.

                                                                          {
    for(auto i = 0; i < _specs.size(); ++i) {
      if(_specs[i] == stencil)
        return std::make_pair(i, true);
    }

    return std::make_pair(0, false);
  }

minmax_distances() [1/2]

template<typename StencilPointT, std::size_t NumStencilPoints>

DistanceAll_t dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::minmax_distances ( ) const

inline

Returns the minimal and maximal distances of all stencil points for all dimensions.

(minimum (first) <= 0 and maximum (second) >= 0)

Definition at line 267 of file Stencil.h.

Referenced by dash::halo::StencilIterator< Element_t, Pattern_t, typename HaloBlockT::GlobMem_t, StencilSpecT, StencilViewScope::ALL >::StencilIterator().

                                         {
    DistanceAll_t max_dist{};
    for(const auto& stencil_point : _specs) {
      for(auto d = 0; d < NumDimensions; ++d) {
        if(stencil_point[d] < max_dist[d].first) {
          max_dist[d].first = stencil_point[d];
          continue;
        }
        if(stencil_point[d] > max_dist[d].second)
          max_dist[d].second = stencil_point[d];
      }
    }

    return max_dist;
  }

minmax_distances() [2/2]

template<typename StencilPointT, std::size_t NumStencilPoints>

DistanceDim_t dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::minmax_distances ( dim_t  dim ) const

inline

Returns the minimal and maximal distances of all stencil points for the given dimension.

(minimum (first) <= 0 and maximum (second) >= 0)

Definition at line 287 of file Stencil.h.

                                                  {
    DistanceDim_t max_dist{};
    for(const auto& stencil_point : _specs) {
      if(stencil_point[dim] < max_dist.first) {
        max_dist.first = stencil_point[dim];
        continue;
      }
      if(stencil_point[dim] > max_dist.second)
        max_dist.second = stencil_point[dim];
    }

    return max_dist;
  }

num_stencil_points()

template<typename StencilPointT, std::size_t NumStencilPoints>

static constexpr stencil_size_t dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::num_stencil_points ( )

inlinestatic

Returns

number of stencil points

Definition at line 216 of file Stencil.h.

Referenced by dash::halo::StencilOperatorBoundary< Self_t >::update().

                                                       {
    return NumStencilPoints;
  }

operator[]()

template<typename StencilPointT, std::size_t NumStencilPoints>

constexpr const StencilPointT& dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::operator[] ( stencil_index_t  index ) const

inline

Returns

stencil point for a given index

Definition at line 303 of file Stencil.h.

References dash::index().

                                                                         {
    return _specs[index];
  }

specs()

template<typename StencilPointT, std::size_t NumStencilPoints>

constexpr const StencilArray_t& dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::specs ( ) const

inline

Returns

container storing all stencil points

Definition at line 211 of file Stencil.h.

Referenced by dash::halo::HaloSpec< NumDimensions >::halo_extension_max(), and dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::stencil_operator().

{ return _specs; }

total_distances() [1/2]

template<typename StencilPointT, std::size_t NumStencilPoints>

DistanceTotal_t dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::total_distances ( ) const

inline

Returns the total distances of all stencil points for all dimensions.

total distance = distance bewteen min and max of a dimension

Definition at line 242 of file Stencil.h.

                                          {
    DistanceTotal_t total_dist{};
    auto minmax = minmax_distances();
    for(auto d = 0; d < NumDimensions; ++d) {
      total_dist[d] = (-1) * minmax.first() + minmax.second;
    }

    return total_dist;
  }

total_distances() [2/2]

template<typename StencilPointT, std::size_t NumStencilPoints>

spoint_distance_t dash::halo::StencilSpec< StencilPointT, NumStencilPoints >::total_distances ( dim_t  dim ) const

inline

Returns the total distances of all stencil points for all dimensions.

total distance = distance bewteen min and max of a dimension

Definition at line 257 of file Stencil.h.

                                                     {
    auto minmax = minmax_distances();

    return (-1) * minmax.first() + minmax.second;
  }

---

The documentation for this class was generated from the following file:

• /tmp/tmporruphar/dash/include/dash/halo/Stencil.h