-
Christian Godenschwager authoredIf you have access to the old closed source waLBerla repository, you may restore the complete history with the following command git fetch git@i10git.cs.fau.de:software/walberla.git 'refs/replace/*:refs/replace/*'
bf76deb1
Forked from
waLBerla / waLBerla
1600 commits behind the upstream repository.
D2Q5.h 8.60 KiB
//====================================================================================================================
// Caution: This file has been generated automatically. All manual changes are lost when file is regenerated!
// Changes should be done in Stencil.in.h,and then all stencils classes can be generated again.
//====================================================================================================================
#ifndef DOXY_SKIP_INTERNAL
#pragma once
#include "Directions.h"
#include "Iterator.h"
namespace walberla {
namespace stencil {
namespace internal
{
//***************************************************************************************************************
/*! \brief Defines a D-dimensional stencil info with Q directions.
*
* \ingroup stencil
*
* A stencil is defined by picking a subset of all possible directions. These directions are listed in the
* dir array. So when iterating a stencil, one iterates the dir array which contains the directions.
* To get the properties for these directions, the global arrays of Directions.h can be used:
*
\code
using namespace stencil;
for( uint_t i = 0; i < D2Q5::Size; ++i )
{
int cx = cx[ D2Q5::dir[i] ];
Direction inverse = inverseDir[ D2Q5::dir[i] ];
}
\endcode
*
* Since all these arrays are constant, the lookup can be resolved at compile time and no performance overhead
* should be generated.
*
* For more convenient iteration, use the provided iterator.
* The following code is equivalent to the code example above:
\code
using namespace stencil;
for( auto dir = D2Q5::begin(); dir != D2Q5::end(); ++dir )
{
int cx = dir.cx();
Direction inverse = dir.inverseDir();
}
\endcode
*
*/
//***************************************************************************************************************
template<typename Dummy = int>
struct D2Q5
{
//**Member Variables******************************************************************************************
/*! \name Member Variables*/
//@{
static const char * NAME;
static const uint_t D = 2;
static const uint_t Q = 5;
static const uint_t POS_Q = 5 / 2;
static const uint_t Dimension = 2;
static const uint_t Size = 5;
static const bool containsCenter = true;
static const uint_t noCenterFirstIdx = 1;
static const Direction dir [5];
static const Direction dir_pos [POS_Q];
static const uint_t idx [NR_OF_DIRECTIONS];
static const Direction d_per_d [NR_OF_DIRECTIONS][5/2];
static const uint_t d_per_d_length[NR_OF_DIRECTIONS];
static const Direction dir_neighbors [NR_OF_DIRECTIONS][NR_OF_DIRECTIONS];
static const uint_t dir_neighbors_length [NR_OF_DIRECTIONS];
static bool containsDir(Direction d) { return idx[d] < NR_OF_DIRECTIONS; }
static uint_t invDirIdx (Direction d) { return idx[stencil::inverseDir[d]]; }
//}
//************************************************************************************************************
//** Iteration *********************************************************************************************
/*! \name Iteration*/
//@{
typedef stencil::Iterator<D2Q5> iterator;
static iterator begin() { return iterator(0); }
static iterator beginNoCenter() { return iterator(noCenterFirstIdx); }
static iterator end() { return iterator(5); }
//}
//************************************************************************************************************
};
template<typename Dummy> const uint_t D2Q5<Dummy>::D;
template<typename Dummy> const uint_t D2Q5<Dummy>::Q;
template<typename Dummy> const uint_t D2Q5<Dummy>::POS_Q;
template<typename Dummy> const uint_t D2Q5<Dummy>::Dimension;
template<typename Dummy> const uint_t D2Q5<Dummy>::Size;
template<typename Dummy> const bool D2Q5<Dummy>::containsCenter;
template<typename Dummy> const uint_t D2Q5<Dummy>::noCenterFirstIdx;
template<typename Dummy> const char * D2Q5<Dummy>::NAME = "D2Q5";
/// Subset of directions. Defines the stencil
template<typename Dummy>
const Direction D2Q5<Dummy>::dir[5] = { C,N,S,W,E };
/**
* \brief Contains only half of the directions ( the positive ones )
*
* Use this f.e. in situations where direction have to be handled pairwise,
* the direction together with its inverse direction.
*/
template<typename Dummy>
const Direction D2Q5<Dummy>::dir_pos[POS_Q] = { N,E };
/**
* \brief Maps direction enums, to an index
*
* Use this when working with fields: The direction enum
* cannot be used as field index directly. Consider having a D2Q4
* stencil, then the fourth field index f ranges from 0 to 3, but the
* direction enums are S=1,N=2,E=3,W=4 start at 1.
* So a stencil class is needed to map back from direction to field index
*/
template<typename Dummy>
const uint_t D2Q5<Dummy>::idx[NR_OF_DIRECTIONS] = { 0,1,2,3,4,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR,INVALID_DIR };
/** * \brief Maps a direction to a set of sub-directions
*
* A sub-direction is defined as a direction that contains the letters of the original direction
* i.e. SW is a sub-direction of S and W.
* the following code shows how to iterate over all sub-directions, that are contained in the stencil of W
*
\code
template<typename Stencil>
//...
stencil::Direction dir = stencil::W;
for (int i=0; i < Stencil::d_per_d_length[dir]; ++i)
stencil::Direction subDirection = Stencil::d_per_d[dir][i];
\endcode
*
*/
template<typename Dummy>
const Direction D2Q5<Dummy>::d_per_d[NR_OF_DIRECTIONS][5/2] = { {C},
{N},
{S},
{W},
{E},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{} };
/**
* \brief Length of the d_per_d array
* For usage see documentation of d_per_d
*/
template<typename Dummy>
const uint_t D2Q5<Dummy>::d_per_d_length [NR_OF_DIRECTIONS] = { 1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 };
/**
* \brief Views directions as cells in a 3x3x3 grid. Describes neighborhood between cells/directions.
*
* Basis a 3x3x3 grid where every cell corresponds to a direction.
* The following array provides answer to the question: What are the neighboring cells of a given
* cell using the current stencil. If a neighbor is not in this 3x3x3 grid it can not be described
* by a direction and is not returned. Therefore N , for example, has more neighbors that NW.
* By definition, the neighbors of C are identical to the dir[] array without C itself.
*/
template<typename Dummy>
const Direction D2Q5<Dummy>::dir_neighbors[NR_OF_DIRECTIONS][NR_OF_DIRECTIONS] = { {N,S,W,E},
{C,NW,NE},
{C,SW,SE},
{C,NW,SW},
{C,NE,SE},
{TN,TS,TW,TE},
{BN,BS,BW,BE}, {N,W},
{N,E},
{S,W},
{S,E},
{T,TNE,TNW},
{T,TSE,TSW},
{T,TNW,TSW},
{T,TNE,TSE},
{B,BNE,BNW},
{B,BSE,BSW},
{B,BNW,BSW},
{B,BNE,BSE},
{TN,TE},
{TN,TW},
{TS,TE},
{TS,TW},
{BN,BE},
{BN,BW},
{BS,BE},
{BS,BW} };
/**
* \brief Length of the dir_neighbors array
* For usage see documentation of dir_neighbors
*/
template<typename Dummy>
const uint_t D2Q5<Dummy>::dir_neighbors_length[NR_OF_DIRECTIONS] = { 4,3,3,3,3,4,4,2,2,2,2,3,3,3,3,3,3,3,3,2,2,2,2,2,2,2,2 };
} // namespace internal
typedef internal::D2Q5<> D2Q5;
} // namespace stencil
} // namespace walberla
#endif // DOXY_SKIP_INTERNAL