GridDiffusionSolver2.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_GRID_DIFFUSION_SOLVER2_HPP
#define CUBBYFLOW_GRID_DIFFUSION_SOLVER2_HPP

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

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

    GridDiffusionSolver2(const GridDiffusionSolver2&) = delete;

    GridDiffusionSolver2(GridDiffusionSolver2&&) noexcept = delete;

    virtual ~GridDiffusionSolver2() = default;

    GridDiffusionSolver2& operator=(const GridDiffusionSolver2&) = delete;

    GridDiffusionSolver2& operator=(GridDiffusionSolver2&&) noexcept = delete;

    virtual void Solve(const ScalarGrid2& source, double diffusionCoefficient,
                       double timeIntervalInSeconds, ScalarGrid2* dest,
                       const ScalarField2& boundarySDF =
                           ConstantScalarField2{
                               std::numeric_limits<double>::max() },
                       const ScalarField2& fluidSDF = ConstantScalarField2{
                           -std::numeric_limits<double>::max() }) = 0;

    virtual void Solve(
        const CollocatedVectorGrid2& source, double diffusionCoefficient,
        double timeIntervalInSeconds, CollocatedVectorGrid2* dest,
        const ScalarField2& boundarySDF =
            ConstantScalarField2{ std::numeric_limits<double>::max() },
        const ScalarField2& fluidSDF = ConstantScalarField2{
            -std::numeric_limits<double>::max() }) = 0;

    virtual void Solve(const FaceCenteredGrid2& source,
                       double diffusionCoefficient,
                       double timeIntervalInSeconds, FaceCenteredGrid2* dest,
                       const ScalarField2& boundarySDF =
                           ConstantScalarField2{
                               std::numeric_limits<double>::max() },
                       const ScalarField2& fluidSDF = ConstantScalarField2{
                           -std::numeric_limits<double>::max() }) = 0;
};

using GridDiffusionSolver2Ptr = std::shared_ptr<GridDiffusionSolver2>;
}  // namespace CubbyFlow

#endif