custom_scalar_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_SCALAR_FIELD3_H_
#define INCLUDE_JET_CUSTOM_SCALAR_FIELD3_H_
 
#include <jet/scalar_field3.h>
 
namespace jet {
 
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 builder();
 
 private:
    std::function<double(const Vector3D&)> _customFunction;
    std::function<Vector3D(const Vector3D&)> _customGradientFunction;
    std::function<double(const Vector3D&)> _customLaplacianFunction;
    double _resolution = 1e-3;
};
 
typedef std::shared_ptr<CustomScalarField3> CustomScalarField3Ptr;
 
 
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 _resolution = 1e-3;
    std::function<double(const Vector3D&)> _customFunction;
    std::function<Vector3D(const Vector3D&)> _customGradientFunction;
    std::function<double(const Vector3D&)> _customLaplacianFunction;
};
 
}  // namespace jet
 
#endif  // INCLUDE_JET_CUSTOM_SCALAR_FIELD3_H_