Grid3.h

Go to the documentation of this file.

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

#include <Core/BoundingBox/BoundingBox3.h>
#include <Core/Size/Size3.h>
#include <Core/Utils/Serialization.h>
#include <Core/Vector/Vector3.h>

#include <memory>
#include <string>

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

        Grid3();

        virtual ~Grid3();

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

        const Size3& Resolution() const;

        const Vector3D& Origin() const;

        const Vector3D& GridSpacing() const;

        const BoundingBox3D& BoundingBox() const;

        DataPositionFunc CellCenterPosition() const;

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

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

        virtual void Serialize(std::vector<uint8_t>* buffer) const = 0;

        virtual void Deserialize(const std::vector<uint8_t>& buffer) = 0;

        bool HasSameShape(const Grid3& other) const;

        virtual void Swap(Grid3* other) = 0;

    protected:
        void SetSizeParameters(const Size3& resolution, const Vector3D& gridSpacing, const Vector3D& origin);

        void SwapGrid(Grid3* other);

        void SetGrid(const Grid3& other);

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

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

    private:
        Size3 m_resolution;
        Vector3D m_gridSpacing = Vector3D(1, 1, 1);
        Vector3D m_origin;
        BoundingBox3D m_boundingBox = BoundingBox3D(Vector3D(), Vector3D());
    };

    using Grid3Ptr = std::shared_ptr<Grid3>;

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

}

#endif