VertexCenteredVectorGrid.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_VERTEX_CENTERED_VECTOR_GRID_HPP
#define CUBBYFLOW_VERTEX_CENTERED_VECTOR_GRID_HPP

#include <Core/Grid/CollocatedVectorGrid.hpp>

namespace CubbyFlow
{
template <size_t N>
class VertexCenteredVectorGrid final : public CollocatedVectorGrid<N>
{
 public:
    CUBBYFLOW_GRID_TYPE_NAME(VertexCenteredVectorGrid, N)

    class Builder;

    using CollocatedVectorGrid<N>::Resize;
    using CollocatedVectorGrid<N>::Resolution;
    using CollocatedVectorGrid<N>::Origin;
    using CollocatedVectorGrid<N>::GridSpacing;
    using CollocatedVectorGrid<N>::DataView;
    using CollocatedVectorGrid<N>::DataPosition;

    VertexCenteredVectorGrid() = default;

    VertexCenteredVectorGrid(
        const Vector<size_t, N>& resolution,
        const Vector<double, N>& gridSpacing =
            Vector<double, N>::MakeConstant(1),
        const Vector<double, N>& origin = Vector<double, N>{},
        const Vector<double, N>& initialValue = Vector<double, N>{});

    ~VertexCenteredVectorGrid() override = default;

    VertexCenteredVectorGrid(const VertexCenteredVectorGrid& other);

    VertexCenteredVectorGrid(VertexCenteredVectorGrid&& other) noexcept;

    VertexCenteredVectorGrid& operator=(const VertexCenteredVectorGrid& other);

    VertexCenteredVectorGrid& operator=(
        VertexCenteredVectorGrid&& other) noexcept;

    [[nodiscard]] Vector<size_t, N> DataSize() const override;

    [[nodiscard]] Vector<double, N> DataOrigin() const override;

    void Swap(Grid<N>* other) override;

    void Set(const VertexCenteredVectorGrid& other);

    void Fill(const Vector<double, N>& value,
              ExecutionPolicy policy = ExecutionPolicy::Parallel) override;

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

    [[nodiscard]] std::shared_ptr<VectorGrid<N>> Clone() const override;

    static Builder GetBuilder();

 protected:
    using CollocatedVectorGrid<N>::SwapCollocatedVectorGrid;
    using CollocatedVectorGrid<N>::SetCollocatedVectorGrid;
};

using VertexCenteredVectorGrid2 = VertexCenteredVectorGrid<2>;

using VertexCenteredVectorGrid3 = VertexCenteredVectorGrid<3>;

using VertexCenteredVectorGrid2Ptr = std::shared_ptr<VertexCenteredVectorGrid2>;

using VertexCenteredVectorGrid3Ptr = std::shared_ptr<VertexCenteredVectorGrid3>;

template <size_t N>
class VertexCenteredVectorGrid<N>::Builder final : public VectorGridBuilder<N>
{
 public:
    Builder& WithResolution(const Vector<size_t, N>& resolution);

    Builder& WithGridSpacing(const Vector<double, N>& gridSpacing);

    Builder& WithOrigin(const Vector<double, N>& gridOrigin);

    Builder& WithInitialValue(const Vector<double, N>& initialVal);

    VertexCenteredVectorGrid Build() const;

    std::shared_ptr<VertexCenteredVectorGrid<N>> MakeShared() const;

    [[nodiscard]] std::shared_ptr<VectorGrid<N>> Build(
        const Vector<size_t, N>& resolution,
        const Vector<double, N>& gridSpacing,
        const Vector<double, N>& gridOrigin,
        const Vector<double, N>& initialVal) const override;

 private:
    Vector<size_t, N> m_resolution = Vector<size_t, N>::MakeConstant(1);
    Vector<double, N> m_gridSpacing = Vector<double, N>::MakeConstant(1.0);
    Vector<double, N> m_gridOrigin;
    Vector<double, N> m_initialVal;
};
}  // namespace CubbyFlow

#endif