SPHSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: SPHSolver3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D SPH solver.
> Created Time: 2017/06/03
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_SPH_SOLVER3_H
#define CUBBYFLOW_SPH_SOLVER3_H

#include <Core/Solver/Particle/ParticleSystemSolver3.h>
#include <Core/SPH/SPHSystemData3.h>

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

        SPHSolver3();

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

        virtual ~SPHSolver3();

        double GetEosExponent() const;

        void SetEosExponent(double newEosExponent);

        double GetNegativePressureScale() const;

        void SetNegativePressureScale(double newNegativePressureScale);

        double GetViscosityCoefficient() const;

        void SetViscosityCoefficient(double newViscosityCoefficient);

        double GetPseudoViscosityCoefficient() const;

        void SetPseudoViscosityCoefficient(double newPseudoViscosityCoefficient);

        double GetSpeedOfSound() const;

        void SetSpeedOfSound(double newSpeedOfSound);

        double GetTimeStepLimitScale() const;

        void SetTimeStepLimitScale(double newScale);

        SPHSystemData3Ptr GetSPHSystemData() const;

        static Builder GetBuilder();

    protected:
        unsigned int GetNumberOfSubTimeSteps(double timeIntervalInSeconds) const override;

        void AccumulateForces(double timeStepInSeconds) override;

        void OnBeginAdvanceTimeStep(double timeStepInSeconds) override;

        void OnEndAdvanceTimeStep(double timeStepInSeconds) override;

        virtual void AccumulateNonPressureForces(double timeStepInSeconds);

        virtual void AccumulatePressureForce(double timeStepInSeconds);

        void ComputePressure();

        void AccumulatePressureForce(
            const ConstArrayAccessor1<Vector3D>& positions,
            const ConstArrayAccessor1<double>& densities,
            const ConstArrayAccessor1<double>& pressures,
            ArrayAccessor1<Vector3D> pressureForces);

        void AccumulateViscosityForce();

        void ComputePseudoViscosity(double timeStepInSeconds);

    private:
        double m_eosExponent = 7.0;

        double m_negativePressureScale = 0.0;

        double m_viscosityCoefficient = 0.01;

        double m_pseudoViscosityCoefficient = 10.0;

        double m_speedOfSound = 100.0;

        double m_timeStepLimitScale = 1.0;
    };

    using SPHSolver3Ptr = std::shared_ptr<SPHSolver3>;
    
    template <typename DerivedBuilder>
    class SPHSolverBuilderBase3
    {
    public:
        DerivedBuilder& WithTargetDensity(double targetDensity);

        DerivedBuilder& WithTargetSpacing(double targetSpacing);

        DerivedBuilder& WithRelativeKernelRadius(double relativeKernelRadius);

    protected:
        double m_targetDensity = WATER_DENSITY;
        double m_targetSpacing = 0.1;
        double m_relativeKernelRadius = 1.8;
    };

    template <typename T>
    T& SPHSolverBuilderBase3<T>::WithTargetDensity(double targetDensity)
    {
        m_targetDensity = targetDensity;
        return static_cast<T&>(*this);
    }

    template <typename T>
    T& SPHSolverBuilderBase3<T>::WithTargetSpacing(double targetSpacing)
    {
        m_targetSpacing = targetSpacing;
        return static_cast<T&>(*this);
    }

    template <typename T>
    T& SPHSolverBuilderBase3<T>::WithRelativeKernelRadius(double relativeKernelRadius)
    {
        m_relativeKernelRadius = relativeKernelRadius;
        return static_cast<T&>(*this);
    }

    class SPHSolver3::Builder final : public SPHSolverBuilderBase3<SPHSolver3::Builder>
    {
    public:
        SPHSolver3 Build() const;

        SPHSolver3Ptr MakeShared() const;
    };
}

#endif