PCISPHSolver3.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_PCISPH_SOLVER3_HPP
#define CUBBYFLOW_PCISPH_SOLVER3_HPP

#include <Core/Solver/Particle/SPH/SPHSolver3.hpp>

namespace CubbyFlow
{
class PCISPHSolver3 : public SPHSolver3
{
 public:
    class Builder;

    PCISPHSolver3();

    PCISPHSolver3(double targetDensity, double targetSpacing,
                  double relativeKernelRadius);

    PCISPHSolver3(const PCISPHSolver3&) = delete;

    PCISPHSolver3(PCISPHSolver3&&) noexcept = delete;

    ~PCISPHSolver3() override = default;

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

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

    [[nodiscard]] double GetMaxDensityErrorRatio() const;

    void SetMaxDensityErrorRatio(double ratio);

    [[nodiscard]] unsigned int GetMaxNumberOfIterations() const;

    void SetMaxNumberOfIterations(unsigned int n);

    [[nodiscard]] static Builder GetBuilder();

 protected:
    void AccumulatePressureForce(double timeIntervalInSeconds) override;

    void OnBeginAdvanceTimeStep(double timeStepInSeconds) override;

 private:
    [[nodiscard]] double ComputeDelta(double timeStepInSeconds) const;
    [[nodiscard]] double ComputeBeta(double timeStepInSeconds) const;

    double m_maxDensityErrorRatio = 0.01;
    unsigned int m_maxNumberOfIterations = 5;

    ParticleSystemData3::VectorData m_tempPositions;
    ParticleSystemData3::VectorData m_tempVelocities;
    ParticleSystemData3::VectorData m_pressureForces;
    ParticleSystemData3::ScalarData m_densityErrors;
};

using PCISPHSolver3Ptr = std::shared_ptr<PCISPHSolver3>;

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

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

#endif