VertexCenteredVectorGrid2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: VertexCenteredVectorGrid2.h
> Project Name: CubbyFlow
> Author: Dongmin Kim
> Purpose: 2-D Vertex-centered vector grid structure.
> Created Time: 2017/08/04
> Copyright (c) 2018, Dongmin Kim
*************************************************************************/
#ifndef CUBBYFLOW_VERTEX_CENTERED_VECTOR_GRID2_H
#define CUBBYFLOW_VERTEX_CENTERED_VECTOR_GRID2_H

#include <Core/Grid/CollocatedVectorGrid2.h>

namespace CubbyFlow
{
    class VertexCenteredVectorGrid2 final : public CollocatedVectorGrid2
    {
    public:
        CUBBYFLOW_GRID2_TYPE_NAME(VertexCenteredVectorGrid2)

        class Builder;

        VertexCenteredVectorGrid2();

        VertexCenteredVectorGrid2(
            size_t resolutionX, size_t resolutionY,
            double gridSpacingX = 1.0, double gridSpacingY = 1.0,
            double originX = 0.0, double originY = 0.0,
            double initialValueU = 0.0, double initialValueV = 0.0);

        VertexCenteredVectorGrid2(
            const Size2& resolution,
            const Vector2D& gridSpacing = Vector2D(1.0, 1.0),
            const Vector2D& origin = Vector2D(),
            const Vector2D& initialValue = Vector2D());

        VertexCenteredVectorGrid2(const VertexCenteredVectorGrid2& other);

        Size2 GetDataSize() const override;

        Vector2D GetDataOrigin() const override;

        void Swap(Grid2* other) override;

        void Set(const VertexCenteredVectorGrid2& other);

        VertexCenteredVectorGrid2& operator=(const VertexCenteredVectorGrid2& other);

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

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

        std::shared_ptr<VectorGrid2> Clone() const override;

        static Builder GetBuilder();
    };

    using VertexCenteredVectorGrid2Ptr = std::shared_ptr<VertexCenteredVectorGrid2>;

    class VertexCenteredVectorGrid2::Builder final : public VectorGridBuilder2
    {
    public:
        Builder& WithResolution(const Size2& resolution);

        Builder& WithResolution(size_t resolutionX, size_t resolutionY);

        Builder& WithGridSpacing(const Vector2D& gridSpacing);

        Builder& WithGridSpacing(double gridSpacingX, double gridSpacingY);

        Builder& WithOrigin(const Vector2D& gridOrigin);

        Builder& WithOrigin(double gridOriginX, double gridOriginY);

        Builder& WithInitialValue(double initialValU, double initialValV);

        VertexCenteredVectorGrid2 Build() const;

        VertexCenteredVectorGrid2Ptr MakeShared() const;

        VectorGrid2Ptr Build(
            const Size2& resolution,
            const Vector2D& gridSpacing,
            const Vector2D& gridOrigin,
            const Vector2D& initialVal) const override;

    private:
        Size2 m_resolution{ 1, 1 };
        Vector2D m_gridSpacing{ 1, 1 };
        Vector2D m_gridOrigin{ 0, 0 };
        Vector2D m_initialVal{ 0, 0 };
    };
}

#endif