VertexCenteredScalarGrid3.h

Go to the documentation of this file.

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

#include <Core/Grid/ScalarGrid3.h>

namespace CubbyFlow
{
    class VertexCenteredScalarGrid3 final : public ScalarGrid3
    {
    public:
        CUBBYFLOW_GRID3_TYPE_NAME(VertexCenteredScalarGrid3)

        class Builder;

        VertexCenteredScalarGrid3();

        VertexCenteredScalarGrid3(
            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 initialValue = 0.0);

        VertexCenteredScalarGrid3(
            const Size3& resolution,
            const Vector3D& gridSpacing = Vector3D(1.0, 1.0, 1.0),
            const Vector3D& origin = Vector3D(),
            double initialValue = 0.0);

        VertexCenteredScalarGrid3(const VertexCenteredScalarGrid3& other);

        Size3 GetDataSize() const override;

        Vector3D GetDataOrigin() const override;

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

        void Swap(Grid3* other) override;

        void Set(const VertexCenteredScalarGrid3& other);

        VertexCenteredScalarGrid3& operator=(const VertexCenteredScalarGrid3& other);

        static Builder GetBuilder();
    };

    using VertexCenteredScalarGrid3Ptr = std::shared_ptr<VertexCenteredScalarGrid3>;

    class VertexCenteredScalarGrid3::Builder final : public ScalarGridBuilder3
    {
    public:
        Builder& WithResolution(const Size3& resolution);

        Builder& WithResolution(size_t resolutionX, size_t resolutionY, size_t resolutionZ);

        Builder& WithGridSpacing(const Vector3D& gridSpacing);

        Builder& WithGridSpacing(double gridSpacingX, double gridSpacingY, double gridSpacingZ);

        Builder& WithOrigin(const Vector3D& gridOrigin);

        Builder& WithOrigin(double gridOriginX, double gridOriginY, double gridOriginZ);

        Builder& WithInitialValue(double initialVal);

        VertexCenteredScalarGrid3 Build() const;

        VertexCenteredScalarGrid3Ptr MakeShared() const;

        ScalarGrid3Ptr Build(
            const Size3& resolution,
            const Vector3D& gridSpacing,
            const Vector3D& gridOrigin,
            double initialVal) const override;

    private:
        Size3 m_resolution{ 1, 1, 1 };
        Vector3D m_gridSpacing{ 1, 1, 1 };
        Vector3D m_gridOrigin{ 0, 0, 0 };
        double m_initialVal = 0.0;
    };
}

#endif