FDMLinearSystem3.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_FDM_LINEAR_SYSTEM3_HPP
#define CUBBYFLOW_FDM_LINEAR_SYSTEM3_HPP

#include <Core/Array/Array.hpp>
#include <Core/Matrix/Matrix.hpp>
#include <Core/Matrix/MatrixCSR.hpp>

namespace CubbyFlow
{
struct FDMMatrixRow3
{
    double center = 0.0;

    double right = 0.0;

    double up = 0.0;

    double front = 0.0;
};

using FDMVector3 = Array3<double>;

using FDMMatrix3 = Array3<FDMMatrixRow3>;

struct FDMLinearSystem3
{
    void Clear();

    void Resize(const Vector3UZ& size);

    FDMMatrix3 A;

    FDMVector3 x;

    FDMVector3 b;
};

struct FDMCompressedLinearSystem3
{
    void Clear();

    MatrixCSRD A;

    VectorND x;

    VectorND b;
};

struct FDMBLAS3
{
    using ScalarType = double;
    using VectorType = FDMVector3;
    using MatrixType = FDMMatrix3;

    static void Set(ScalarType s, VectorType* result);

    static void Set(const VectorType& v, VectorType* result);

    static void Set(ScalarType s, MatrixType* result);

    static void Set(const MatrixType& m, MatrixType* result);

    static double Dot(const VectorType& a, const VectorType& b);

    static void AXPlusY(double a, const VectorType& x, const VectorType& y,
                        VectorType* result);

    static void MVM(const MatrixType& m, const VectorType& v,
                    VectorType* result);

    static void Residual(const MatrixType& a, const VectorType& x,
                         const VectorType& b, VectorType* result);

    [[nodiscard]] static ScalarType L2Norm(const VectorType& v);

    [[nodiscard]] static ScalarType LInfNorm(const VectorType& v);
};

struct FDMCompressedBLAS3
{
    using ScalarType = double;
    using VectorType = VectorND;
    using MatrixType = MatrixCSRD;

    static void Set(ScalarType s, VectorType* result);

    static void Set(const VectorType& v, VectorType* result);

    static void Set(ScalarType s, MatrixType* result);

    static void Set(const MatrixType& m, MatrixType* result);

    static double Dot(const VectorType& a, const VectorType& b);

    static void AXPlusY(double a, const VectorType& x, const VectorType& y,
                        VectorType* result);

    static void MVM(const MatrixType& m, const VectorType& v,
                    VectorType* result);

    static void Residual(const MatrixType& a, const VectorType& x,
                         const VectorType& b, VectorType* result);

    [[nodiscard]] static ScalarType L2Norm(const VectorType& v);

    [[nodiscard]] static ScalarType LInfNorm(const VectorType& v);
};
}  // namespace CubbyFlow

#endif