CellCenteredScalarGrid.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_CELL_CENTERED_SCALAR_GRID_HPP
#define CUBBYFLOW_CELL_CENTERED_SCALAR_GRID_HPP

#include <Core/Grid/ScalarGrid.hpp>

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

    class Builder;

    using ScalarGrid<N>::Resize;
    using ScalarGrid<N>::Resolution;
    using ScalarGrid<N>::Origin;
    using ScalarGrid<N>::GridSpacing;

    CellCenteredScalarGrid() = default;

    CellCenteredScalarGrid(
        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>{},
        double initialValue = 0.0);

    ~CellCenteredScalarGrid() override = default;

    CellCenteredScalarGrid(const CellCenteredScalarGrid& other);

    CellCenteredScalarGrid(CellCenteredScalarGrid&& other) noexcept;

    CellCenteredScalarGrid& operator=(const CellCenteredScalarGrid& other);

    CellCenteredScalarGrid& operator=(CellCenteredScalarGrid&& 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 CellCenteredScalarGrid& other);

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

    static Builder GetBuilder();

 protected:
    using ScalarGrid<N>::SwapScalarGrid;
    using ScalarGrid<N>::SetScalarGrid;
};

using CellCenteredScalarGrid2 = CellCenteredScalarGrid<2>;

using CellCenteredScalarGrid3 = CellCenteredScalarGrid<3>;

using CellCenteredScalarGrid2Ptr = std::shared_ptr<CellCenteredScalarGrid2>;

using CellCenteredScalarGrid3Ptr = std::shared_ptr<CellCenteredScalarGrid3>;

template <size_t N>
class CellCenteredScalarGrid<N>::Builder final : public ScalarGridBuilder<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(double initialVal);

    CellCenteredScalarGrid<N> Build() const;

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

    [[nodiscard]] std::shared_ptr<ScalarGrid<N>> Build(
        const Vector<size_t, N>& resolution,
        const Vector<double, N>& gridSpacing,
        const Vector<double, N>& gridOrigin, double 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>{};
    double m_initialVal = 0.0;
};
}  // namespace CubbyFlow

#endif