GridBackwardEulerDiffusionSolver2.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_BACKWARD_EULER_DIFFUSION_SOLVER2_HPP
#define CUBBYFLOW_GRID_BACKWARD_EULER_DIFFUSION_SOLVER2_HPP

#include <Core/Solver/FDM/FDMLinearSystemSolver2.hpp>
#include <Core/Solver/Grid/GridDiffusionSolver2.hpp>

namespace CubbyFlow
{
class GridBackwardEulerDiffusionSolver2 final : public GridDiffusionSolver2
{
 public:
    enum class BoundaryType
    {
        Dirichlet,
        Neumann
    };

    explicit GridBackwardEulerDiffusionSolver2(
        BoundaryType boundaryType = BoundaryType::Neumann);

    GridBackwardEulerDiffusionSolver2(
        const GridBackwardEulerDiffusionSolver2&) = delete;

    GridBackwardEulerDiffusionSolver2(
        GridBackwardEulerDiffusionSolver2&&) noexcept = delete;

    ~GridBackwardEulerDiffusionSolver2() override = default;

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

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

    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() }) override;

    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() }) override;

    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() }) override;

    void SetLinearSystemSolver(const FDMLinearSystemSolver2Ptr& solver);

 private:
    void BuildMarkers(const Vector2UZ& size,
                      const std::function<Vector2D(size_t, size_t)>& pos,
                      const ScalarField2& boundarySDF,
                      const ScalarField2& fluidSDF);

    void BuildMatrix(const Vector2UZ& size, const Vector2D& c);

    void BuildVectors(const ConstArrayView2<double>& f, const Vector2D& c);

    void BuildVectors(const ConstArrayView2<Vector2D>& f, const Vector2D& c,
                      size_t component);

    BoundaryType m_boundaryType;
    FDMLinearSystem2 m_system;
    FDMLinearSystemSolver2Ptr m_systemSolver;
    Array2<char> m_markers;
};

using GridBackwardEulerDiffusionSolver2Ptr =
    std::shared_ptr<GridBackwardEulerDiffusionSolver2>;
}  // namespace CubbyFlow

#endif