collocated_vector_grid2.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_COLLOCATED_VECTOR_GRID2_H_
#define INCLUDE_JET_COLLOCATED_VECTOR_GRID2_H_
 
#include <jet/array2.h>
#include <jet/array_samplers2.h>
#include <jet/vector_grid2.h>
#include <vector>
 
namespace jet {
 
class CollocatedVectorGrid2 : public VectorGrid2 {
 public:
    CollocatedVectorGrid2();
 
    virtual ~CollocatedVectorGrid2();
 
    virtual Size2 dataSize() const = 0;
 
    virtual Vector2D dataOrigin() const = 0;
 
    const Vector2D& operator()(size_t i, size_t j) const;
 
    Vector2D& operator()(size_t i, size_t j);
 
    double divergenceAtDataPoint(size_t i, size_t j) const;
 
    double curlAtDataPoint(size_t i, size_t j) const;
 
    VectorDataAccessor dataAccessor();
 
    ConstVectorDataAccessor constDataAccessor() const;
 
    DataPositionFunc dataPosition() const;
 
    void forEachDataPointIndex(
        const std::function<void(size_t, size_t)>& func) const;
 
    void parallelForEachDataPointIndex(
        const std::function<void(size_t, size_t)>& func) const;
 
    // VectorField2 implementations
 
    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;
 
 protected:
    void swapCollocatedVectorGrid(CollocatedVectorGrid2* other);
 
    void setCollocatedVectorGrid(const CollocatedVectorGrid2& other);
 
    void getData(std::vector<double>* data) const override;
 
    void setData(const std::vector<double>& data) override;
 
 private:
    Array2<Vector2D> _data;
    LinearArraySampler2<Vector2D, double> _linearSampler;
    std::function<Vector2D(const Vector2D&)> _sampler;
 
    void onResize(
        const Size2& resolution,
        const Vector2D& gridSpacing,
        const Vector2D& origin,
        const Vector2D& initialValue) final;
 
    void resetSampler();
};
 
typedef std::shared_ptr<CollocatedVectorGrid2> CollocatedVectorGrid2Ptr;
 
}  // namespace jet
 
#endif  // INCLUDE_JET_COLLOCATED_VECTOR_GRID2_H_