vertex_centered_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_VERTEX_CENTERED_VECTOR_GRID2_H_
#define INCLUDE_JET_VERTEX_CENTERED_VECTOR_GRID2_H_
 
#include <jet/collocated_vector_grid2.h>
#include <utility>  // just make cpplint happy..
 
namespace jet {
 
class VertexCenteredVectorGrid2 final : public CollocatedVectorGrid2 {
 public:
    JET_GRID2_TYPE_NAME(VertexCenteredVectorGrid2)
 
    class Builder;
 
    VertexCenteredVectorGrid2();
 
    VertexCenteredVectorGrid2(
        size_t resolutionX,
        size_t resolutionY,
        double gridSpacingX = 1.0,
        double gridSpacingY = 1.0,
        double originX = 0.0,
        double originY = 0.0,
        double initialValueU = 0.0,
        double initialValueV = 0.0);
 
    VertexCenteredVectorGrid2(
        const Size2& resolution,
        const Vector2D& gridSpacing = Vector2D(1.0, 1.0),
        const Vector2D& origin = Vector2D(),
        const Vector2D& initialValue = Vector2D());
 
    VertexCenteredVectorGrid2(const VertexCenteredVectorGrid2& other);
 
    Size2 dataSize() const override;
 
    Vector2D dataOrigin() const override;
 
    void swap(Grid2* other) override;
 
    void set(const VertexCenteredVectorGrid2& other);
 
    VertexCenteredVectorGrid2& operator=(
        const VertexCenteredVectorGrid2& other);
 
    void fill(const Vector2D& value,
              ExecutionPolicy policy = ExecutionPolicy::kParallel) override;
 
    void fill(const std::function<Vector2D(const Vector2D&)>& func,
              ExecutionPolicy policy = ExecutionPolicy::kParallel) override;
 
    std::shared_ptr<VectorGrid2> clone() const override;
 
    static Builder builder();
};
 
typedef std::shared_ptr<VertexCenteredVectorGrid2> VertexCenteredVectorGrid2Ptr;
 
 
class VertexCenteredVectorGrid2::Builder final : public VectorGridBuilder2 {
 public:
    Builder& withResolution(const Size2& resolution);
 
    Builder& withResolution(size_t resolutionX, size_t resolutionY);
 
    Builder& withGridSpacing(const Vector2D& gridSpacing);
 
    Builder& withGridSpacing(double gridSpacingX, double gridSpacingY);
 
    Builder& withOrigin(const Vector2D& gridOrigin);
 
    Builder& withOrigin(double gridOriginX, double gridOriginY);
 
    Builder& withInitialValue(const Vector2D& initialVal);
 
    Builder& withInitialValue(double initialValX, double initialValY);
 
    VertexCenteredVectorGrid2 build() const;
 
    VertexCenteredVectorGrid2Ptr makeShared() const;
 
    VectorGrid2Ptr build(
        const Size2& resolution,
        const Vector2D& gridSpacing,
        const Vector2D& gridOrigin,
        const Vector2D& initialVal) const override;
 
 private:
    Size2 _resolution{1, 1};
    Vector2D _gridSpacing{1, 1};
    Vector2D _gridOrigin{0, 0};
    Vector2D _initialVal{0, 0};
};
 
}  // namespace jet
 
#endif  // INCLUDE_JET_VERTEX_CENTERED_VECTOR_GRID2_H_