ScalarField.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_SCALAR_FIELD_HPP
#define CUBBYFLOW_SCALAR_FIELD_HPP

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

#include <functional>
#include <memory>

namespace CubbyFlow
{
template <size_t N>
class ScalarField : public Field<N>
{
 public:
    ScalarField() = default;

    ~ScalarField() override = default;

    ScalarField(const ScalarField&) = default;

    ScalarField(ScalarField&&) noexcept = default;

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

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

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

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

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

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

using ScalarField2 = ScalarField<2>;

using ScalarField3 = ScalarField<3>;

using ScalarField2Ptr = std::shared_ptr<ScalarField2>;

using ScalarField3Ptr = std::shared_ptr<ScalarField3>;
}  // namespace CubbyFlow

#endif