VectorField.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_VECTOR_FIELD_HPP
#define CUBBYFLOW_VECTOR_FIELD_HPP

#include <Core/Field/Field.hpp>
#include <Core/Matrix/Matrix.hpp>

#include <functional>
#include <memory>

namespace CubbyFlow
{
template <size_t N>
struct GetCurl
{
    // Do nothing
};

template <>
struct GetCurl<2>
{
    using Type = double;
};

template <>
struct GetCurl<3>
{
    using Type = Vector3D;
};

template <size_t N>
class VectorField : public Field<N>
{
 public:
    VectorField() = default;

    ~VectorField() override = default;

    VectorField(const VectorField&) = default;

    VectorField(VectorField&&) noexcept = default;

    VectorField& operator=(const VectorField&) = default;

    VectorField& operator=(VectorField&&) noexcept = default;

    [[nodiscard]] virtual Vector<double, N> Sample(
        const Vector<double, N>& x) const = 0;

    [[nodiscard]] virtual double Divergence(const Vector<double, N>& x) const;

    [[nodiscard]] virtual typename GetCurl<N>::Type Curl(
        const Vector<double, N>& x) const;

    [[nodiscard]] virtual std::function<
        Vector<double, N>(const Vector<double, N>&)>
    Sampler() const;
};

using VectorField2 = VectorField<2>;

using VectorField3 = VectorField<3>;

using VectorField2Ptr = std::shared_ptr<VectorField2>;

using VectorField3Ptr = std::shared_ptr<VectorField3>;
}  // namespace CubbyFlow

#endif