GridBackwardEulerDiffusionSolver3.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_SOLVER3_HPP
#define CUBBYFLOW_GRID_BACKWARD_EULER_DIFFUSION_SOLVER3_HPP

#include <Core/Solver/FDM/FDMLinearSystemSolver3.hpp>
#include <Core/Solver/Grid/GridDiffusionSolver3.hpp>

namespace CubbyFlow
{
class GridBackwardEulerDiffusionSolver3 final : public GridDiffusionSolver3
{
 public:
    enum class BoundaryType
    {
        Dirichlet,
        Neumann
    };

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

    GridBackwardEulerDiffusionSolver3(
        const GridBackwardEulerDiffusionSolver3&) = delete;

    GridBackwardEulerDiffusionSolver3(
        GridBackwardEulerDiffusionSolver3&&) noexcept = delete;

    ~GridBackwardEulerDiffusionSolver3() override = default;

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

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

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

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

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

    void SetLinearSystemSolver(const FDMLinearSystemSolver3Ptr& solver);

 private:
    void BuildMarkers(
        const Vector3UZ& size,
        const std::function<Vector3D(size_t, size_t, size_t)>& pos,
        const ScalarField3& boundarySDF, const ScalarField3& fluidSDF);

    void BuildMatrix(const Vector3UZ& size, const Vector3D& c);

    void BuildVectors(const ConstArrayView3<double>& f, const Vector3D& c);

    void BuildVectors(const ConstArrayView3<Vector3D>& f, const Vector3D& c,
                      size_t component);

    BoundaryType m_boundaryType;
    FDMLinearSystem3 m_system;
    FDMLinearSystemSolver3Ptr m_systemSolver;
    Array3<char> m_markers;
};

using GridBackwardEulerDiffusionSolver3Ptr =
    std::shared_ptr<GridBackwardEulerDiffusionSolver3>;
}  // namespace CubbyFlow

#endif