VectorField3.h

Go to the documentation of this file.

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

#include <Core/Field/Field3.h>
#include <Core/Vector/Vector3.h>

#include <functional>
#include <memory>

namespace CubbyFlow
{
    class VectorField3 : public Field3
    {
    public:
        VectorField3();

        virtual ~VectorField3();

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

        virtual double Divergence(const Vector3D& x) const;

        virtual Vector3D Curl(const Vector3D& x) const;

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

    using VectorField3Ptr = std::shared_ptr<VectorField3>;
}

#endif