CustomScalarField.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_CUSTOM_SCALAR_FIELD_HPP
#define CUBBYFLOW_CUSTOM_SCALAR_FIELD_HPP

#include <Core/Field/ScalarField.hpp>

namespace CubbyFlow
{
template <size_t N>
class CustomScalarField final : public ScalarField<N>
{
 public:
    class Builder;

    CustomScalarField(
        std::function<double(const Vector<double, N>&)> customFunction,
        double derivativeResolution = 1e-3);

    CustomScalarField(
        std::function<double(const Vector<double, N>&)> customFunction,
        std::function<Vector<double, N>(const Vector<double, N>&)>
            customGradientFunction,
        double derivativeResolution = 1e-3);

    CustomScalarField(
        std::function<double(const Vector<double, N>&)> customFunction,
        std::function<Vector<double, N>(const Vector<double, N>&)>
            customGradientFunction,
        std::function<double(const Vector<double, N>&)>
            customLaplacianFunction);

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

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

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

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

    static Builder GetBuilder();

 private:
    std::function<double(const Vector<double, N>&)> m_customFunction;
    std::function<Vector<double, N>(const Vector<double, N>&)>
        m_customGradientFunction;
    std::function<double(const Vector<double, N>&)> m_customLaplacianFunction;
    double m_resolution = 1e-3;
};

using CustomScalarField2 = CustomScalarField<2>;

using CustomScalarField3 = CustomScalarField<3>;

using CustomScalarField2Ptr = std::shared_ptr<CustomScalarField2>;

using CustomScalarField3Ptr = std::shared_ptr<CustomScalarField3>;

template <size_t N>
class CustomScalarField<N>::Builder final
{
 public:
    Builder& WithFunction(
        const std::function<double(const Vector<double, N>&)>& func);

    Builder& WithGradientFunction(
        const std::function<Vector<double, N>(const Vector<double, N>&)>& func);

    Builder& WithLaplacianFunction(
        const std::function<double(const Vector<double, N>&)>& func);

    Builder& WithDerivativeResolution(double resolution);

    CustomScalarField<N> Build() const;

    std::shared_ptr<CustomScalarField<N>> MakeShared() const;

 private:
    double m_resolution = 1e-3;
    std::function<double(const Vector<double, N>&)> m_customFunction;
    std::function<Vector<double, N>(const Vector<double, N>&)>
        m_customGradientFunction;
    std::function<double(const Vector<double, N>&)> m_customLaplacianFunction;
};
}  // namespace CubbyFlow

#endif