Direction.hpp

/* Copyright (c) 2013       David Sichau <mail"at"sichau"dot"eu>
 *               2013-2015  Simon Tanaka <tanakas"at"gmx"dot"ch>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef DIRECTION_HPP_
#define DIRECTION_HPP_

#include <UtilLib/include/Singleton.hpp>
#include <array>

namespace LbmLib {

enum Direction {
    T = 0,  
    E = 1,  
    N = 2,  
    W = 3,  
    S = 4,  
    NE = 5, 
    NW = 6, 
    SW = 7, 
    SE = 8  
};

Direction getInverseDirection(const Direction& d);


class DirectionIterator {
 public:
    DirectionIterator() {}

    ~DirectionIterator() {}

    std::array<Direction, 9>::const_iterator begin() const;

    std::array<Direction, 9>::const_iterator end() const;

 private:
    static std::array<Direction, 9> directions_;
};

class CDEDirectionsIteratorD2Q4 {
 public:
    CDEDirectionsIteratorD2Q4() {}

    ~CDEDirectionsIteratorD2Q4() {}

    std::array<Direction, 4>::const_iterator begin() const;

    std::array<Direction, 4>::const_iterator end() const;

 private:
    static std::array<Direction, 4> directions_;
};


class CDEDirectionsIteratorD2Q5 {
 public:
    CDEDirectionsIteratorD2Q5() {}

    ~CDEDirectionsIteratorD2Q5() {}

    std::array<Direction, 5>::const_iterator begin() const;

    std::array<Direction, 5>::const_iterator end() const;

 private:
    static std::array<Direction, 5> directions_;
};
}  // end namespace

#endif  /* DIRECTION_HPP_ */