custom_vector_field3.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_FIELD3_H_
#define INCLUDE_JET_CUSTOM_VECTOR_FIELD3_H_
 
#include <jet/vector_field3.h>
 
namespace jet {
 
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 builder();
 
 private:
    std::function<Vector3D(const Vector3D&)> _customFunction;
    std::function<double(const Vector3D&)> _customDivergenceFunction;
    std::function<Vector3D(const Vector3D&)> _customCurlFunction;
    double _resolution = 1e-3;
};
 
typedef std::shared_ptr<CustomVectorField3> CustomVectorField3Ptr;
 
 
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 _resolution = 1e-3;
    std::function<Vector3D(const Vector3D&)> _customFunction;
    std::function<double(const Vector3D&)> _customDivergenceFunction;
    std::function<Vector3D(const Vector3D&)> _customCurlFunction;
};
 
}  // namespace jet
 
#endif  // INCLUDE_JET_CUSTOM_VECTOR_FIELD3_H_