VectorField2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: VectorField2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Abstract base class for 2-D vector field.
> Created Time: 2017/03/14
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_VECTOR_FIELD2_H
#define CUBBYFLOW_VECTOR_FIELD2_H

#include <Core/Field/Field2.h>
#include <Core/Vector/Vector2.h>

#include <functional>
#include <memory>

namespace CubbyFlow
{
    class VectorField2 : public Field2
    {
    public:
        VectorField2();

        virtual ~VectorField2();

        virtual Vector2D Sample(const Vector2D& x) const = 0;

        virtual double Divergence(const Vector2D& x) const;

        virtual double Curl(const Vector2D& x) const;

        virtual std::function<Vector2D(const Vector2D&)> Sampler() const;
    };

    using VectorField2Ptr = std::shared_ptr<VectorField2>;
}

#endif