vertex_centered_vector_grid3.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_GRID3_H_
#define INCLUDE_JET_VERTEX_CENTERED_VECTOR_GRID3_H_
 
#include <jet/collocated_vector_grid3.h>
#include <utility>  // just make cpplint happy..
 
namespace jet {
 
class VertexCenteredVectorGrid3 final : public CollocatedVectorGrid3 {
 public:
    JET_GRID3_TYPE_NAME(VertexCenteredVectorGrid3)
 
    class Builder;
 
    VertexCenteredVectorGrid3();
 
    VertexCenteredVectorGrid3(
        size_t resolutionX,
        size_t resolutionY,
        size_t resolutionZ,
        double gridSpacingX = 1.0,
        double gridSpacingY = 1.0,
        double gridSpacingZ = 1.0,
        double originX = 0.0,
        double originY = 0.0,
        double originZ = 0.0,
        double initialValueU = 0.0,
        double initialValueV = 0.0,
        double initialValueW = 0.0);
 
    VertexCenteredVectorGrid3(
        const Size3& resolution,
        const Vector3D& gridSpacing = Vector3D(1.0, 1.0, 1.0),
        const Vector3D& origin = Vector3D(),
        const Vector3D& initialValue = Vector3D());
 
    Size3 dataSize() const override;
 
    Vector3D dataOrigin() const override;
 
    void swap(Grid3* other) override;
 
    void fill(const Vector3D& value,
              ExecutionPolicy policy = ExecutionPolicy::kParallel) override;
 
    void fill(const std::function<Vector3D(const Vector3D&)>& func,
              ExecutionPolicy policy = ExecutionPolicy::kParallel) override;
 
    std::shared_ptr<VectorGrid3> clone() const override;
 
    void set(const VertexCenteredVectorGrid3& other);
 
    VertexCenteredVectorGrid3& operator=(
        const VertexCenteredVectorGrid3& other);
 
    static Builder builder();
};
 
typedef std::shared_ptr<VertexCenteredVectorGrid3> VertexCenteredVectorGrid3Ptr;
 
 
class VertexCenteredVectorGrid3::Builder final : public VectorGridBuilder3 {
 public:
    Builder& withResolution(const Size3& resolution);
 
    Builder& withResolution(
        size_t resolutionX, size_t resolutionY, size_t resolutionZ);
 
    Builder& withGridSpacing(const Vector3D& gridSpacing);
 
    Builder& withGridSpacing(
        double gridSpacingX, double gridSpacingY, double gridSpacingZ);
 
    Builder& withOrigin(const Vector3D& gridOrigin);
 
    Builder& withOrigin(
        double gridOriginX, double gridOriginY, double gridOriginZ);
 
    Builder& withInitialValue(const Vector3D& initialVal);
 
    Builder& withInitialValue(
        double initialValX, double initialValY, double initialValZ);
 
    VertexCenteredVectorGrid3 build() const;
 
    VertexCenteredVectorGrid3Ptr makeShared() const;
 
    VectorGrid3Ptr build(
        const Size3& resolution,
        const Vector3D& gridSpacing,
        const Vector3D& gridOrigin,
        const Vector3D& initialVal) const override;
 
 private:
    Size3 _resolution{1, 1, 1};
    Vector3D _gridSpacing{1, 1, 1};
    Vector3D _gridOrigin{0, 0, 0};
    Vector3D _initialVal{0, 0, 0};
};
 
}  // namespace jet
 
#endif  // INCLUDE_JET_VERTEX_CENTERED_VECTOR_GRID3_H_