SemiLagrangian3.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_LAGRANGIAN3_HPP
#define CUBBYFLOW_SEMI_LAGRANGIAN3_HPP

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

namespace CubbyFlow
{
class SemiLagrangian3 : public AdvectionSolver3
{
 public:
    SemiLagrangian3() = default;

    SemiLagrangian3(const SemiLagrangian3&) = default;

    SemiLagrangian3(SemiLagrangian3&&) noexcept = default;

    ~SemiLagrangian3() override = default;

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

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

    void Advect(const ScalarGrid3& input, const VectorField3& flow, double dt,
                ScalarGrid3* output,
                const ScalarField3& boundarySDF = ConstantScalarField3(
                    std::numeric_limits<double>::max())) final;

    void Advect(const CollocatedVectorGrid3& input, const VectorField3& flow,
                double dt, CollocatedVectorGrid3* output,
                const ScalarField3& boundarySDF = ConstantScalarField3(
                    std::numeric_limits<double>::max())) final;

    void Advect(const FaceCenteredGrid3& input, const VectorField3& flow,
                double dt, FaceCenteredGrid3* output,
                const ScalarField3& boundarySDF = ConstantScalarField3(
                    std::numeric_limits<double>::max())) final;

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

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

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

 private:
    [[nodiscard]] Vector3D BackTrace(const VectorField3& flow, double dt,
                                     double h, const Vector3D& startPt,
                                     const ScalarField3& boundarySDF) const;
};

using SemiLagrangian3Ptr = std::shared_ptr<SemiLagrangian3>;
}  // namespace CubbyFlow

#endif