SemiLagrangian3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: SemiLagrangian3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Implementation of 3-D semi-Lagrangian advection solver.
> Created Time: 2017/08/07
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_SEMI_LAGRANGIAN3_H
#define CUBBYFLOW_SEMI_LAGRANGIAN3_H

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

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

        virtual ~SemiLagrangian3();

        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:
        virtual std::function<double(const Vector3D&)> GetScalarSamplerFunc(const ScalarGrid3& input) const;

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

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

    private:
        Vector3D BackTrace(
            const VectorField3& flow,
            double dt,
            double h,
            const Vector3D& pt0,
            const ScalarField3& boundarySDF) const;
    };

    using SemiLagrangian3Ptr = std::shared_ptr<SemiLagrangian3>;
}

#endif