GridDiffusionSolver3.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_SOLVER3_HPP
#define CUBBYFLOW_GRID_DIFFUSION_SOLVER3_HPP

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

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

    GridDiffusionSolver3(const GridDiffusionSolver3&) = delete;

    GridDiffusionSolver3(GridDiffusionSolver3&&) noexcept = delete;

    virtual ~GridDiffusionSolver3() = default;

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

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

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

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

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

using GridDiffusionSolver3Ptr = std::shared_ptr<GridDiffusionSolver3>;
}  // namespace CubbyFlow

#endif