VectorGrid.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_VECTOR_GRID_HPP
#define CUBBYFLOW_VECTOR_GRID_HPP

#include <Core/Array/ArrayView.hpp>
#include <Core/Field/VectorField.hpp>
#include <Core/Grid/Grid.hpp>

namespace CubbyFlow
{
template <size_t N>
class VectorGrid : public VectorField<N>, public Grid<N>
{
 public:
    using VectorDataView = ArrayView<Vector<double, N>, N>;

    using ConstVectorDataView = ArrayView<const Vector<double, N>, N>;

    using Grid<N>::Resolution;
    using Grid<N>::GridSpacing;
    using Grid<N>::Origin;

    VectorGrid() = default;

    ~VectorGrid() override = default;

    VectorGrid(const VectorGrid& other);

    VectorGrid(VectorGrid&& other) noexcept;

    VectorGrid& operator=(const VectorGrid& other);

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

    void Clear();

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

    void Resize(const Vector<double, N>& gridSpacing,
                const Vector<double, N>& origin);

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

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

    [[nodiscard]] virtual std::shared_ptr<VectorGrid<N>> Clone() const = 0;

    void Serialize(std::vector<uint8_t>* buffer) const override;

    void Deserialize(const std::vector<uint8_t>& buffer) override;

 protected:
    using Grid<N>::SetSizeParameters;
    using Grid<N>::GetData;
    using Grid<N>::SetData;

    virtual void OnResize(const Vector<size_t, N>& resolution,
                          const Vector<double, N>& gridSpacing,
                          const Vector<double, N>& origin,
                          const Vector<double, N>& initialValue) = 0;
};

using VectorGrid2 = VectorGrid<2>;

using VectorGrid3 = VectorGrid<3>;

using VectorGrid2Ptr = std::shared_ptr<VectorGrid2>;

using VectorGrid3Ptr = std::shared_ptr<VectorGrid3>;

template <size_t N>
class VectorGridBuilder
{
 public:
    VectorGridBuilder() = default;

    virtual ~VectorGridBuilder() = default;

    VectorGridBuilder(const VectorGridBuilder& other) = delete;

    VectorGridBuilder(VectorGridBuilder&& other) noexcept = delete;

    VectorGridBuilder& operator=(const VectorGridBuilder& other) = delete;

    VectorGridBuilder& operator=(VectorGridBuilder&& other) noexcept = delete;

    [[nodiscard]] virtual 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 = 0;
};

using VectorGridBuilder2 = VectorGridBuilder<2>;

using VectorGridBuilder3 = VectorGridBuilder<3>;

using VectorGridBuilder2Ptr = std::shared_ptr<VectorGridBuilder2>;

using VectorGridBuilder3Ptr = std::shared_ptr<VectorGridBuilder3>;
}  // namespace CubbyFlow

#endif