CustomVectorField3.h

Go to the documentation of this file.

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

#include <Core/Field/VectorField3.h>

namespace CubbyFlow
{
    class CustomVectorField3 final : public VectorField3
    {
    public:
        class Builder;

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

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

        CustomVectorField3(
            const std::function<Vector3D(const Vector3D&)>& customFunction,
            const std::function<double(const Vector3D&)>& customDivergenceFunction,
            const std::function<Vector3D(const Vector3D&)>& customCurlFunction);

        Vector3D Sample(const Vector3D& x) const override;

        double Divergence(const Vector3D& x) const override;

        Vector3D Curl(const Vector3D& x) const override;

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

        static Builder GetBuilder();

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

    using CustomVectorField3Ptr = std::shared_ptr<CustomVectorField3>;

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

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

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

        Builder& WithDerivativeResolution(double resolution);

        CustomVectorField3 Build() const;

        CustomVectorField3Ptr MakeShared() const;

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

#endif