CollocatedVectorGrid2.h

Go to the documentation of this file.

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

#include <Core/Array/Array2.h>
#include <Core/Array/ArraySamplers2.h>
#include <Core/Grid/VectorGrid2.h>

namespace CubbyFlow
{
    class CollocatedVectorGrid2 : public VectorGrid2
    {
    public:
        CollocatedVectorGrid2();

        virtual ~CollocatedVectorGrid2();

        virtual Size2 GetDataSize() const = 0;

        virtual Vector2D GetDataOrigin() const = 0;

        const Vector2D& operator()(size_t i, size_t j) const;

        Vector2D& operator()(size_t i, size_t j);

        double DivergenceAtDataPoint(size_t i, size_t j) const;

        double CurlAtDataPoint(size_t i, size_t j) const;

        VectorDataAccessor GetDataAccessor();

        ConstVectorDataAccessor GetConstDataAccessor() const;

        DataPositionFunc GetDataPosition() const;

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

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

        // VectorField2 implementations
        Vector2D Sample(const Vector2D& x) const override;

        double Divergence(const Vector2D& x) const override;

        double Curl(const Vector2D& x) const override;

        std::function<Vector2D(const Vector2D&)> Sampler() const override;

    protected:
        void SwapCollocatedVectorGrid(CollocatedVectorGrid2* other);

        void SetCollocatedVectorGrid(const CollocatedVectorGrid2& other);
        
        void GetData(std::vector<double>* data) const override;

        void SetData(const std::vector<double>& data) override;

    private:
        Array2<Vector2D> m_data;
        LinearArraySampler2<Vector2D, double> m_linearSampler;
        std::function<Vector2D(const Vector2D&)> m_sampler;

        void OnResize(
            const Size2& resolution,
            const Vector2D& gridSpacing,
            const Vector2D& origin,
            const Vector2D& initialValue) final;

        void ResetSampler();
    };

    using CollocatedVectorGrid2Ptr = std::shared_ptr<CollocatedVectorGrid2>;
}

#endif