Jet  v1.3.3
grid_boundary_condition_solver2.h
Go to the documentation of this file.
1 // Copyright (c) 2018 Doyub Kim
2 //
3 // I am making my contributions/submissions to this project solely in my
4 // personal capacity and am not conveying any rights to any intellectual
5 // property of any third parties.
6 
7 #ifndef INCLUDE_JET_GRID_BOUNDARY_CONDITION_SOLVER2_H_
8 #define INCLUDE_JET_GRID_BOUNDARY_CONDITION_SOLVER2_H_
9 
10 #include <jet/collider2.h>
11 #include <jet/constants.h>
13 #include <jet/scalar_field2.h>
14 
15 #include <memory>
16 
17 namespace jet {
18 
27  public:
30 
33 
35  const Collider2Ptr& collider() const;
36 
50  const Collider2Ptr& newCollider,
51  const Size2& gridSize,
52  const Vector2D& gridSpacing,
53  const Vector2D& gridOrigin);
54 
57 
60 
68  virtual void constrainVelocity(
69  FaceCenteredGrid2* velocity,
70  unsigned int extrapolationDepth = 5) = 0;
71 
73  virtual ScalarField2Ptr colliderSdf() const = 0;
74 
77 
78  protected:
80  virtual void onColliderUpdated(
81  const Size2& gridSize,
82  const Vector2D& gridSpacing,
83  const Vector2D& gridOrigin) = 0;
84 
86  const Size2& gridSize() const;
87 
89  const Vector2D& gridSpacing() const;
90 
92  const Vector2D& gridOrigin() const;
93 
94  private:
95  Collider2Ptr _collider;
96  Size2 _gridSize;
97  Vector2D _gridSpacing;
98  Vector2D _gridOrigin;
99  int _closedDomainBoundaryFlag = kDirectionAll;
100 };
101 
103 typedef std::shared_ptr<GridBoundaryConditionSolver2>
105 
106 } // namespace jet
107 
108 #endif // INCLUDE_JET_GRID_BOUNDARY_CONDITION_SOLVER2_H_
jet::GridBoundaryConditionSolver2::gridOrigin
const Vector2D & gridOrigin() const
Returns the origin of the velocity grid to be constrained.
jet::GridBoundaryConditionSolver2
Abstract base class for 2-D boundary condition solver for grids.
Definition: grid_boundary_condition_solver2.h:26
scalar_field2.h
jet::GridBoundaryConditionSolver2::setClosedDomainBoundaryFlag
void setClosedDomainBoundaryFlag(int flag)
Sets the closed domain boundary flag.
jet::GridBoundaryConditionSolver2::collider
const Collider2Ptr & collider() const
Returns associated collider.
jet::kDirectionAll
constexpr int kDirectionAll
All direction.
Definition: constants.h:333
jet::FaceCenteredGrid2
2-D face-centered (a.k.a MAC or staggered) grid.
Definition: face_centered_grid2.h:26
jet::GridBoundaryConditionSolver2::gridSize
const Size2 & gridSize() const
Returns the size of the velocity grid to be constrained.
jet::GridBoundaryConditionSolver2::colliderSdf
virtual ScalarField2Ptr colliderSdf() const =0
Returns the signed distance field of the collider.
jet
Definition: advection_solver2.h:18
jet::ScalarField2Ptr
std::shared_ptr< ScalarField2 > ScalarField2Ptr
Shared pointer for the ScalarField2 type.
Definition: scalar_field2.h:40
jet::GridBoundaryConditionSolver2::gridSpacing
const Vector2D & gridSpacing() const
Returns the spacing of the velocity grid to be constrained.
jet::GridBoundaryConditionSolver2::onColliderUpdated
virtual void onColliderUpdated(const Size2 &gridSize, const Vector2D &gridSpacing, const Vector2D &gridOrigin)=0
Invoked when a new collider is set.
jet::GridBoundaryConditionSolver2::~GridBoundaryConditionSolver2
virtual ~GridBoundaryConditionSolver2()
Default destructor.
jet::Vector< T, 2 >
2-D vector class.
Definition: vector2.h:24
jet::Collider2Ptr
std::shared_ptr< Collider2 > Collider2Ptr
Shared pointer type for the Collider2.
Definition: collider2.h:118
collider2.h
jet::GridBoundaryConditionSolver2::GridBoundaryConditionSolver2
GridBoundaryConditionSolver2()
Default constructor.
face_centered_grid2.h
jet::Size2
2-D size class.
Definition: size2.h:19
jet::GridBoundaryConditionSolver2::closedDomainBoundaryFlag
int closedDomainBoundaryFlag() const
Returns the closed domain boundary flag.
jet::VectorField2Ptr
std::shared_ptr< VectorField2 > VectorField2Ptr
Shared pointer for the VectorField2 type.
Definition: vector_field2.h:40
jet::GridBoundaryConditionSolver2::updateCollider
void updateCollider(const Collider2Ptr &newCollider, const Size2 &gridSize, const Vector2D &gridSpacing, const Vector2D &gridOrigin)
Applies new collider and build the internals.
constants.h
jet::GridBoundaryConditionSolver2::constrainVelocity
virtual void constrainVelocity(FaceCenteredGrid2 *velocity, unsigned int extrapolationDepth=5)=0
jet::GridBoundaryConditionSolver2Ptr
std::shared_ptr< GridBoundaryConditionSolver2 > GridBoundaryConditionSolver2Ptr
Shared pointer type for the GridBoundaryConditionSolver2.
Definition: grid_boundary_condition_solver2.h:104
jet::GridBoundaryConditionSolver2::colliderVelocityField
virtual VectorField2Ptr colliderVelocityField() const =0
Returns the velocity field of the collider.