AdvectionSolver3.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_ADVECTION_SOLVER3_HPP
#define CUBBYFLOW_ADVECTION_SOLVER3_HPP

#include <Core/Field/ConstantScalarField.hpp>
#include <Core/Field/VectorField.hpp>
#include <Core/Grid/CollocatedVectorGrid.hpp>
#include <Core/Grid/FaceCenteredGrid.hpp>
#include <Core/Grid/ScalarGrid.hpp>

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

    AdvectionSolver3(const AdvectionSolver3&) = default;

    AdvectionSolver3(AdvectionSolver3&&) noexcept = default;

    virtual ~AdvectionSolver3() = default;

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

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

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

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

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

using AdvectionSolver3Ptr = std::shared_ptr<AdvectionSolver3>;
}  // namespace CubbyFlow

#endif