Grid2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: Grid2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Abstract base class for 2-D cartesian grid structure.
> Created Time: 2017/07/05
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_GRID2_H
#define CUBBYFLOW_GRID2_H

#include <Core/BoundingBox/BoundingBox2.h>
#include <Core/Size/Size2.h>
#include <Core/Utils/Serialization.h>
#include <Core/Vector/Vector2.h>

#include <memory>
#include <string>

namespace CubbyFlow
{
    class Grid2 : public Serializable
    {
    public:
        using DataPositionFunc = std::function<Vector2D(size_t, size_t)>;

        Grid2();

        virtual ~Grid2();

        virtual std::string TypeName() const = 0;

        const Size2& Resolution() const;

        const Vector2D& Origin() const;

        const Vector2D& GridSpacing() const;

        const BoundingBox2D& BoundingBox() const;

        DataPositionFunc CellCenterPosition() const;

        void ForEachCellIndex(const std::function<void(size_t, size_t)>& func) const;

        void ParallelForEachCellIndex(const std::function<void(size_t, size_t)>& func) const;

        bool HasSameShape(const Grid2& other) const;

        virtual void Swap(Grid2* other) = 0;

    protected:
        void SetSizeParameters(const Size2& resolution, const Vector2D& gridSpacing, const Vector2D& origin);

        void SwapGrid(Grid2* other);

        void SetGrid(const Grid2& other);

        virtual void GetData(std::vector<double>* data) const = 0;

        virtual void SetData(const std::vector<double>& data) = 0;

    private:
        Size2 m_resolution;
        Vector2D m_gridSpacing = Vector2D(1, 1);
        Vector2D m_origin;
        BoundingBox2D m_boundingBox = BoundingBox2D(Vector2D(), Vector2D());
    };

    using Grid2Ptr = std::shared_ptr<Grid2>;

#define CUBBYFLOW_GRID2_TYPE_NAME(DerivedClassName) \
    std::string TypeName() const override \
    { \
        return #DerivedClassName; \
    }
}

#endif