CollocatedVectorGrid3.h

Go to the documentation of this file.

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

#include <Core/Array/Array3.h>
#include <Core/Array/ArraySamplers3.h>
#include <Core/Grid/VectorGrid3.h>

namespace CubbyFlow
{
    class CollocatedVectorGrid3 : public VectorGrid3
    {
    public:
        CollocatedVectorGrid3();

        virtual ~CollocatedVectorGrid3();

        virtual Size3 GetDataSize() const = 0;

        virtual Vector3D GetDataOrigin() const = 0;

        const Vector3D& operator()(size_t i, size_t j, size_t k) const;

        Vector3D& operator()(size_t i, size_t j, size_t k);

        double DivergenceAtDataPoint(size_t i, size_t j, size_t k) const;

        Vector3D CurlAtDataPoint(size_t i, size_t j, size_t k) const;

        VectorDataAccessor GetDataAccessor();

        ConstVectorDataAccessor GetConstDataAccessor() const;

        DataPositionFunc GetDataPosition() const;

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

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

        // VectorField3 implementations
        Vector3D Sample(const Vector3D& x) const override;

        double Divergence(const Vector3D& x) const override;

        Vector3D Curl(const Vector3D& x) const override;

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

    protected:
        void SwapCollocatedVectorGrid(CollocatedVectorGrid3* other);

        void SetCollocatedVectorGrid(const CollocatedVectorGrid3& other);

        void GetData(std::vector<double>* data) const override;

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

    private:
        Array3<Vector3D> m_data;
        LinearArraySampler3<Vector3D, double> m_linearSampler;
        std::function<Vector3D(const Vector3D&)> m_sampler;

        void OnResize(
            const Size3& resolution,
            const Vector3D& gridSpacing,
            const Vector3D& origin,
            const Vector3D& initialValue) final;

        void ResetSampler();
    };

    using CollocatedVectorGrid3Ptr = std::shared_ptr<CollocatedVectorGrid3>;
}

#endif