CustomScalarField3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: CustomScalarField3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D scalar field with custom field function.
> Created Time: 2017/03/15
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_CUSTOM_SCALAR_FIELD3_H
#define CUBBYFLOW_CUSTOM_SCALAR_FIELD3_H

#include <Core/Field/ScalarField3.h>

namespace CubbyFlow
{
    class CustomScalarField3 final : public ScalarField3
    {
    public:
        class Builder;

        CustomScalarField3(
            const std::function<double(const Vector3D&)>& customFunction,
            double derivativeResolution = 1e-3);

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

        CustomScalarField3(
            const std::function<double(const Vector3D&)>& customFunction,
            const std::function<Vector3D(const Vector3D&)>& customGradientFunction,
            const std::function<double(const Vector3D&)>& customLaplacianFunction);

        double Sample(const Vector3D& x) const override;

        std::function<double(const Vector3D&)> Sampler() const override;

        Vector3D Gradient(const Vector3D& x) const override;

        double Laplacian(const Vector3D& x) const override;

        static Builder GetBuilder();

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

    using CustomScalarField3Ptr = std::shared_ptr<CustomScalarField3>;

    class CustomScalarField3::Builder final
    {
    public:
        Builder& WithFunction(const std::function<double(const Vector3D&)>& func);

        Builder& WithGradientFunction(const std::function<Vector3D(const Vector3D&)>& func);

        Builder& WithLaplacianFunction(const std::function<double(const Vector3D&)>& func);

        Builder& WithDerivativeResolution(double resolution);

        CustomScalarField3 Build() const;

        CustomScalarField3Ptr MakeShared() const;

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

#endif