dash::halo::StencilPoint< NumDimensions, CoeffT > Class Template Reference

Stencil point with raletive coordinates for N dimensions e.g. More...

#include <Stencil.h>

Public Types
using	coefficient_t = CoeffT

Public Member Functions
	StencilPoint ()
	Default Contructor. More...
template<typename... Values>
constexpr	StencilPoint (typename std::enable_if< sizeof...(Values)==NumDimensions - 1, spoint_value_t >::type value, Values... values)
	Constructor. More...
template<typename... Values>
constexpr	StencilPoint (typename std::enable_if< sizeof...(Values)==NumDimensions - 1, CoeffT >::type coefficient, spoint_value_t value, Values... values)
	Constructor. More...
int	max () const
	Returns maximum distance to center over all dimensions. More...
template<typename ElementCoordsT >
ElementCoordsT	stencil_coords (ElementCoordsT &coords) const
	Returns coordinates adjusted by stencil point. More...
template<typename ElementCoordsT , typename ViewSpecT >
std::pair< ElementCoordsT, bool >	stencil_coords_check (ElementCoordsT coords, const ViewSpecT &view) const
	Returns coordinates adjusted by a stencil point and a boolean to indicate a if the adjusted coordinate points to elements out of the given ViewSpecpossible (inside: true, else: false). More...
template<typename ElementCoordsT , typename ViewSpecT >
std::pair< ElementCoordsT, bool >	stencil_coords_check_abort (ElementCoordsT coords, const ViewSpecT &view) const
	Returns coordinates adjusted by a stencil point and a boolean to indicate a if the adjusted coordinate points to elements out of the given ViewSpec: possible (inside: true, else: false). More...
CoeffT	coefficient () const
	Returns the coefficient for this stencil point. More...
constexpr const std::array< spoint_value_t, NumDimensions > &	values () const
	Return value with all dimensions as array of NumDimensions elements. More...
spoint_value_t	dim (dim_t dimension) const
	The value in the given dimension. More...
constexpr spoint_value_t	operator[] (size_t dimension) const
	Subscript operator, access to value in dimension given by index. More...
spoint_value_t &	operator[] (size_t dimension)
	Subscript assignment operator, access to value in dimension given by index. More...
constexpr bool	operator== (const self_t &other) const
	Equality comparison operator. More...
constexpr bool	operator!= (const self_t &other) const
	Equality comparison operator. More...
constexpr dim_t	rank () const
	The number of dimensions of the value. More...

Static Public Member Functions
template<typename ElementCoordsT >
static ElementCoordsT	stencil_coords (ElementCoordsT coords, const StencilPoint< NumDimensions, CoeffT > &stencilp)
	Returns coordinates adjusted by a given stencil point. More...
static constexpr dim_t	ndim ()
	The number of dimensions of the value. More...

Detailed Description

template<dim_t NumDimensions, typename CoeffT = double>
class dash::halo::StencilPoint< NumDimensions, CoeffT >

Stencil point with raletive coordinates for N dimensions e.g.

StencilPoint<2>(-1,-1) -> north west

Examples:

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

Definition at line 19 of file Stencil.h.

Constructor & Destructor Documentation

StencilPoint() [1/3]

template<dim_t NumDimensions, typename CoeffT = double>

dash::halo::StencilPoint< NumDimensions, CoeffT >::StencilPoint ( )

inline

Default Contructor.

All stencil point values are 0 and default coefficient = 1.0.

Definition at line 33 of file Stencil.h.

                 {
    for(dim_t d = 0; d < NumDimensions; ++d) {
      this->_values[d] = 0;
    }
  }

StencilPoint() [2/3]

template<dim_t NumDimensions, typename CoeffT = double>

template<typename... Values>

constexpr dash::halo::StencilPoint< NumDimensions, CoeffT >::StencilPoint ( typename std::enable_if< sizeof...(Values)==NumDimensions - 1, spoint_value_t >::type  value, Values...  values  )

inline

Constructor.

Custom stencil point values for all dimensions and default coefficient = 1.0.

Definition at line 46 of file Stencil.h.

  : Base_t::Dimensional(value, (spoint_value_t) values...) {}

StencilPoint() [3/3]

template<dim_t NumDimensions, typename CoeffT = double>

template<typename... Values>

constexpr dash::halo::StencilPoint< NumDimensions, CoeffT >::StencilPoint ( typename std::enable_if< sizeof...(Values)==NumDimensions - 1, CoeffT >::type  coefficient, spoint_value_t  value, Values...  values  )

inline

Constructor.

Custom values and custom coefficient.

Definition at line 58 of file Stencil.h.

  : Base_t::Dimensional(value, (spoint_value_t) values...),
    _coefficient(coefficient) {}

Member Function Documentation

coefficient()

template<dim_t NumDimensions, typename CoeffT = double>

CoeffT dash::halo::StencilPoint< NumDimensions, CoeffT >::coefficient ( ) const

inline

Returns the coefficient for this stencil point.

Definition at line 139 of file Stencil.h.

References dash::halo::StencilPoint< NumDimensions, CoeffT >::coefficient().

Referenced by dash::halo::StencilPoint< NumDimensions, CoeffT >::coefficient().

{ return _coefficient; }

dim()

spoint_value_t dash::Dimensional< spoint_value_t , NumDimensions >::dim ( dim_t  dimension ) const

inlineinherited

The value in the given dimension.

Parameters

dimension

The dimension

Returns

The value in the given dimension

Definition at line 152 of file Dimensional.h.

                                         {
    DASH_ASSERT_LT(
      dimension, NumDimensions,
      "Dimension for Dimensional::extent() must be lower than " <<
      NumDimensions);
    return _values[dimension];
  }

max()

template<dim_t NumDimensions, typename CoeffT = double>

int dash::halo::StencilPoint< NumDimensions, CoeffT >::max ( ) const

inline

Returns maximum distance to center over all dimensions.

Definition at line 69 of file Stencil.h.

                  {
    int max = 0;
    for(dim_t d = 0; d < NumDimensions; ++d)
      max = std::max(max, (int) std::abs(this->_values[d]));
    return max;
  }

ndim()

static constexpr dim_t dash::Dimensional< spoint_value_t , NumDimensions >::ndim ( )

inlinestaticinherited

The number of dimensions of the value.

Definition at line 207 of file Dimensional.h.

                                {
    return NumDimensions;
  }

operator!=()

constexpr bool dash::Dimensional< spoint_value_t , NumDimensions >::operator!= ( const self_t &  other ) const

inlineinherited

Equality comparison operator.

Definition at line 193 of file Dimensional.h.

                                                        {
    return !(*this == other);
  }

operator==()

constexpr bool dash::Dimensional< spoint_value_t , NumDimensions >::operator== ( const self_t &  other ) const

inlineinherited

Equality comparison operator.

Definition at line 186 of file Dimensional.h.

                                                        {
    return this == &other || _values == other._values;
  }

operator[]() [1/2]

constexpr spoint_value_t dash::Dimensional< spoint_value_t , NumDimensions >::operator[] ( size_t  dimension ) const

inlineinherited

Subscript operator, access to value in dimension given by index.

Alias for dim.

Parameters

dimension

The dimension

Returns

The value in the given dimension

Definition at line 167 of file Dimensional.h.

                                                           {
    return _values[dimension];
  }

operator[]() [2/2]

spoint_value_t & dash::Dimensional< spoint_value_t , NumDimensions >::operator[] ( size_t  dimension )

inlineinherited

Subscript assignment operator, access to value in dimension given by index.

Alias for dim.

Parameters

dimension

The dimension

Returns

A reference to the value in the given dimension

Definition at line 179 of file Dimensional.h.

                                             {
    return _values[dimension];
  }

rank()

constexpr dim_t dash::Dimensional< spoint_value_t , NumDimensions >::rank ( ) const

inlineinherited

The number of dimensions of the value.

Definition at line 200 of file Dimensional.h.

                               {
    return NumDimensions;
  }

stencil_coords() [1/2]

template<dim_t NumDimensions, typename CoeffT = double>

template<typename ElementCoordsT >

ElementCoordsT dash::halo::StencilPoint< NumDimensions, CoeffT >::stencil_coords ( ElementCoordsT &  coords ) const

inline

Returns coordinates adjusted by stencil point.

Definition at line 80 of file Stencil.h.

                                                              {
    return StencilPoint<NumDimensions, CoeffT>::stencil_coords(coords, this);
  }

stencil_coords() [2/2]

template<dim_t NumDimensions, typename CoeffT = double>

template<typename ElementCoordsT >

static ElementCoordsT dash::halo::StencilPoint< NumDimensions, CoeffT >::stencil_coords ( ElementCoordsT  coords, const StencilPoint< NumDimensions, CoeffT > &  stencilp  )

inlinestatic

Returns coordinates adjusted by a given stencil point.

Definition at line 88 of file Stencil.h.

                                                         {
    for(dim_t d = 0; d < NumDimensions; ++d) {
      coords[d] += stencilp[d];
    }

    return coords;
  }

stencil_coords_check()

template<dim_t NumDimensions, typename CoeffT = double>

template<typename ElementCoordsT , typename ViewSpecT >

std::pair<ElementCoordsT, bool> dash::halo::StencilPoint< NumDimensions, CoeffT >::stencil_coords_check ( ElementCoordsT  coords, const ViewSpecT &  view  ) const

inline

Returns coordinates adjusted by a stencil point and a boolean to indicate a if the adjusted coordinate points to elements out of the given ViewSpecpossible (inside: true, else: false).

Definition at line 104 of file Stencil.h.

                                                        {
    bool halo = false;
    for(dim_t d = 0; d < NumDimensions; ++d) {
      coords[d] += this->_values[d];
      if(coords[d] < view.offset(d) || coords[d] >= view.offset(d) + view.extent(d))
        halo = true;
    }

    return std::make_pair(coords, halo);
  }

stencil_coords_check_abort()

template<dim_t NumDimensions, typename CoeffT = double>

template<typename ElementCoordsT , typename ViewSpecT >

std::pair<ElementCoordsT, bool> dash::halo::StencilPoint< NumDimensions, CoeffT >::stencil_coords_check_abort ( ElementCoordsT  coords, const ViewSpecT &  view  ) const

inline

Returns coordinates adjusted by a stencil point and a boolean to indicate a if the adjusted coordinate points to elements out of the given ViewSpec: possible (inside: true, else: false).

If one dimension points to an element outside the ViewSpec this method returns immediately the unfinished adjusted coordinate and true. Otherwise the adjusted coordinate and false is returned,

Definition at line 125 of file Stencil.h.

                                                        {
    for(dim_t d = 0; d < NumDimensions; ++d) {
      coords[d] += this->_values[d];
      if(coords[d] < view.offset(d) || coords[d] >= view.offset(d) + view.extent(d))
        return std::make_pair(coords, true);
    }

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

values()

constexpr const std::array<spoint_value_t , NumDimensions>& dash::Dimensional< spoint_value_t , NumDimensions >::values ( ) const

inlineinherited

Return value with all dimensions as array of NumDimensions elements.

Definition at line 142 of file Dimensional.h.

                                                                        {
    return _values;
  }

---

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

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