SemiLagrangian2.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_SEMI_LAGRANGIAN2_HPP
#define CUBBYFLOW_SEMI_LAGRANGIAN2_HPP

#include <Core/Solver/Advection/AdvectionSolver2.hpp>

namespace CubbyFlow
{
class SemiLagrangian2 : public AdvectionSolver2
{
 public:
    SemiLagrangian2() = default;

    SemiLagrangian2(const SemiLagrangian2&) = default;

    SemiLagrangian2(SemiLagrangian2&&) noexcept = default;

    ~SemiLagrangian2() override = default;

    SemiLagrangian2& operator=(const SemiLagrangian2&) = default;

    SemiLagrangian2& operator=(SemiLagrangian2&&) noexcept = default;

    void Advect(const ScalarGrid2& input, const VectorField2& flow, double dt,
                ScalarGrid2* output,
                const ScalarField2& boundarySDF = ConstantScalarField2(
                    std::numeric_limits<double>::max())) final;

    void Advect(const CollocatedVectorGrid2& input, const VectorField2& flow,
                double dt, CollocatedVectorGrid2* output,
                const ScalarField2& boundarySDF = ConstantScalarField2(
                    std::numeric_limits<double>::max())) final;

    void Advect(const FaceCenteredGrid2& input, const VectorField2& flow,
                double dt, FaceCenteredGrid2* output,
                const ScalarField2& boundarySDF = ConstantScalarField2(
                    std::numeric_limits<double>::max())) final;

 protected:
    [[nodiscard]] virtual std::function<double(const Vector2D&)>
    GetScalarSamplerFunc(const ScalarGrid2& input) const;

    [[nodiscard]] virtual std::function<Vector2D(const Vector2D&)>
    GetVectorSamplerFunc(const CollocatedVectorGrid2& input) const;

    [[nodiscard]] virtual std::function<Vector2D(const Vector2D&)>
    GetVectorSamplerFunc(const FaceCenteredGrid2& input) const;

 private:
    [[nodiscard]] Vector2D BackTrace(const VectorField2& flow, double dt,
                                     double h, const Vector2D& startPt,
                                     const ScalarField2& boundarySDF) const;
};

using SemiLagrangian2Ptr = std::shared_ptr<SemiLagrangian2>;
}  // namespace CubbyFlow

#endif