VertexCenteredScalarGrid2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: VertexCenteredScalarGrid2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 2-D Vertex-centered scalar grid structure.
> Created Time: 2017/07/07
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_VERTEX_CENTERED_SCALAR_GRID2_H
#define CUBBYFLOW_VERTEX_CENTERED_SCALAR_GRID2_H

#include <Core/Grid/ScalarGrid2.h>

namespace CubbyFlow
{
    class VertexCenteredScalarGrid2 final : public ScalarGrid2
    {
    public:
        CUBBYFLOW_GRID2_TYPE_NAME(VertexCenteredScalarGrid2)

        class Builder;

        VertexCenteredScalarGrid2();

        VertexCenteredScalarGrid2(
            size_t resolutionX, size_t resolutionY,
            double gridSpacingX = 1.0, double gridSpacingY = 1.0,
            double originX = 0.0, double originY = 0.0,
            double initialValue = 0.0);

        VertexCenteredScalarGrid2(
            const Size2& resolution,
            const Vector2D& gridSpacing = Vector2D(1.0, 1.0),
            const Vector2D& origin = Vector2D(),
            double initialValue = 0.0);

        VertexCenteredScalarGrid2(const VertexCenteredScalarGrid2& other);

        Size2 GetDataSize() const override;

        Vector2D GetDataOrigin() const override;

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

        void Swap(Grid2* other) override;

        void Set(const VertexCenteredScalarGrid2& other);

        VertexCenteredScalarGrid2& operator=(const VertexCenteredScalarGrid2& other);

        static Builder GetBuilder();
    };

    using VertexCenteredScalarGrid2Ptr = std::shared_ptr<VertexCenteredScalarGrid2>;

    class VertexCenteredScalarGrid2::Builder final : public ScalarGridBuilder2
    {
    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 initialVal);

        VertexCenteredScalarGrid2 Build() const;

        VertexCenteredScalarGrid2Ptr MakeShared() const;

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

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

#endif