APICSolver3.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_APIC_SOLVER3_HPP
#define CUBBYFLOW_APIC_SOLVER3_HPP

#include <Core/Solver/Hybrid/PIC/PICSolver3.hpp>

namespace CubbyFlow
{
class APICSolver3 : public PICSolver3
{
 public:
    class Builder;

    APICSolver3();

    APICSolver3(const Vector3UZ& resolution, const Vector3D& gridSpacing,
                const Vector3D& gridOrigin);

    APICSolver3(const APICSolver3&) = delete;

    APICSolver3(APICSolver3&&) noexcept = delete;

    ~APICSolver3() override = default;

    APICSolver3& operator=(const APICSolver3&) = delete;

    APICSolver3& operator=(APICSolver3&&) noexcept = delete;

    [[nodiscard]] static Builder GetBuilder();

 protected:
    void TransferFromParticlesToGrids() override;

    void TransferFromGridsToParticles() override;

 private:
    Array1<Vector3D> m_cX;
    Array1<Vector3D> m_cY;
    Array1<Vector3D> m_cZ;
};

using APICSolver3Ptr = std::shared_ptr<APICSolver3>;

class APICSolver3::Builder final : public GridFluidSolverBuilderBase3<Builder>
{
 public:
    [[nodiscard]] APICSolver3 Build() const;

    [[nodiscard]] APICSolver3Ptr MakeShared() const;
};
}  // namespace CubbyFlow

#endif