ConstantScalarField.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_CONSTANT_SCALAR_FIELD_HPP
#define CUBBYFLOW_CONSTANT_SCALAR_FIELD_HPP

#include <Core/Field/ScalarField.hpp>

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

    explicit ConstantScalarField(double value);

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

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

    static Builder GetBuilder();

 private:
    double m_value = 0.0;
};

using ConstantScalarField2 = ConstantScalarField<2>;

using ConstantScalarField3 = ConstantScalarField<3>;

using ConstantScalarField2Ptr = std::shared_ptr<ConstantScalarField2>;

using ConstantScalarField3Ptr = std::shared_ptr<ConstantScalarField3>;

template <size_t N>
class ConstantScalarField<N>::Builder final
{
 public:
    Builder& WithValue(double value);

    ConstantScalarField Build() const;

    std::shared_ptr<ConstantScalarField> MakeShared() const;

 private:
    double m_value = 0.0;
};
}  // namespace CubbyFlow

#endif