custom_vector_field2.h

Go to the documentation of this file.

// Copyright (c) 2018 Doyub Kim
//
// I am making my contributions/submissions to this project solely in my
// personal capacity and am not conveying any rights to any intellectual
// property of any third parties.
 
#ifndef INCLUDE_JET_CUSTOM_VECTOR_FIELD2_H_
#define INCLUDE_JET_CUSTOM_VECTOR_FIELD2_H_
 
#include <jet/vector_field2.h>
 
namespace jet {
 
class CustomVectorField2 final : public VectorField2 {
 public:
    class Builder;
 
    CustomVectorField2(
        const std::function<Vector2D(const Vector2D&)>& customFunction,
        double derivativeResolution = 1e-3);
 
    CustomVectorField2(
        const std::function<Vector2D(const Vector2D&)>& customFunction,
        const std::function<double(const Vector2D&)>& customDivergenceFunction,
        double derivativeResolution = 1e-3);
 
    CustomVectorField2(
        const std::function<Vector2D(const Vector2D&)>& customFunction,
        const std::function<double(const Vector2D&)>& customDivergenceFunction,
        const std::function<double(const Vector2D&)>& customCurlFunction);
 
    Vector2D sample(const Vector2D& x) const override;
 
    double divergence(const Vector2D& x) const override;
 
    double curl(const Vector2D& x) const override;
 
    std::function<Vector2D(const Vector2D&)> sampler() const override;
 
    static Builder builder();
 
 private:
    std::function<Vector2D(const Vector2D&)> _customFunction;
    std::function<double(const Vector2D&)> _customDivergenceFunction;
    std::function<double(const Vector2D&)> _customCurlFunction;
    double _resolution = 1e-3;
};
 
typedef std::shared_ptr<CustomVectorField2> CustomVectorField2Ptr;
 
 
class CustomVectorField2::Builder final {
 public:
    Builder& withFunction(
        const std::function<Vector2D(const Vector2D&)>& func);
 
    Builder& withDivergenceFunction(
        const std::function<double(const Vector2D&)>& func);
 
    Builder& withCurlFunction(
        const std::function<double(const Vector2D&)>& func);
 
    Builder& withDerivativeResolution(double resolution);
 
    CustomVectorField2 build() const;
 
    CustomVectorField2Ptr makeShared() const;
 
 private:
    double _resolution = 1e-3;
    std::function<Vector2D(const Vector2D&)> _customFunction;
    std::function<double(const Vector2D&)> _customDivergenceFunction;
    std::function<double(const Vector2D&)> _customCurlFunction;
};
 
}  // namespace jet
 
#endif  // INCLUDE_JET_CUSTOM_VECTOR_FIELD2_H_