VectorGrid3.h

Go to the documentation of this file.

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

#include <Core/Array/ArrayAccessor3.h>
#include <Core/Field/VectorField3.h>
#include <Core/Grid/Grid3.h>

namespace CubbyFlow
{
    class VectorGrid3 : public VectorField3, public Grid3
    {
    public:
        using VectorDataAccessor = ArrayAccessor3<Vector3D>;

        using ConstVectorDataAccessor = ConstArrayAccessor3<Vector3D>;

        VectorGrid3();

        virtual ~VectorGrid3();

        void Clear();

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

        void Resize(
            const Size3& resolution,
            const Vector3D& gridSpacing = Vector3D(1, 1, 1),
            const Vector3D& origin = Vector3D(),
            const Vector3D& initialValue = Vector3D());

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

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

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

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

        virtual std::shared_ptr<VectorGrid3> 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 Size3& resolution,
            const Vector3D& gridSpacing,
            const Vector3D& origin,
            const Vector3D& initialValue) = 0;
    };

    using VectorGrid3Ptr = std::shared_ptr<VectorGrid3>;

    class VectorGridBuilder3
    {
    public:
        VectorGridBuilder3();

        virtual ~VectorGridBuilder3();

        virtual VectorGrid3Ptr Build(
            const Size3& resolution,
            const Vector3D& gridSpacing,
            const Vector3D& gridOrigin,
            const Vector3D& initialVal) const = 0;
    };

    using VectorGridBuilder3Ptr = std::shared_ptr<VectorGridBuilder3>;
}

#endif