VectorGrid2.h

Go to the documentation of this file.

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

#include <Core/Array/ArrayAccessor2.h>
#include <Core/Field/VectorField2.h>
#include <Core/Grid/Grid2.h>

namespace CubbyFlow
{
    class VectorGrid2 : public VectorField2, public Grid2
    {
    public:
        using VectorDataAccessor = ArrayAccessor2<Vector2D>;

        using ConstVectorDataAccessor = ConstArrayAccessor2<Vector2D>;

        VectorGrid2();

        virtual ~VectorGrid2();

        void Clear();

        void Resize(
            size_t resolutionX, size_t resolutionY,
            double gridSpacingX = 1.0, double gridSpacingY = 1.0,
            double originX = 0.0, double originY = 0.0,
            double initialValueX = 0.0, double initialValueY = 0.0);

        void Resize(
            const Size2& resolution,
            const Vector2D& gridSpacing = Vector2D(1, 1),
            const Vector2D& origin = Vector2D(),
            const Vector2D& initialValue = Vector2D());

        void Resize(
            double gridSpacingX, double gridSpacingY,
            double originX, double originY);

        void Resize(const Vector2D& gridSpacing, const Vector2D& origin);

        virtual void Fill(const Vector2D& value, ExecutionPolicy policy = ExecutionPolicy::Parallel) = 0;

        virtual void Fill(const std::function<Vector2D(const Vector2D&)>& func, ExecutionPolicy policy = ExecutionPolicy::Parallel) = 0;

        virtual std::shared_ptr<VectorGrid2> Clone() const = 0;

        void Serialize(std::vector<uint8_t>* buffer) const override;

        void Deserialize(const std::vector<uint8_t>& buffer) override;

    protected:
        virtual void OnResize(
            const Size2& resolution,
            const Vector2D& gridSpacing,
            const Vector2D& origin,
            const Vector2D& initialValue) = 0;
    };

    using VectorGrid2Ptr = std::shared_ptr<VectorGrid2>;

    class VectorGridBuilder2
    {
    public:
        VectorGridBuilder2();

        virtual ~VectorGridBuilder2();

        virtual VectorGrid2Ptr Build(
            const Size2& resolution,
            const Vector2D& gridSpacing,
            const Vector2D& gridOrigin,
            const Vector2D& initialVal) const = 0;
    };

    using VectorGridBuilder2Ptr = std::shared_ptr<VectorGridBuilder2>;
}

#endif