GridBoundaryConditionSolver2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: GridBoundaryConditionSolver2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Abstract base class for 2-D boundary condition solver for grids.
> Created Time: 2017/08/09
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_GRID_BOUNDARY_CONDITION_SOLVER2_H
#define CUBBYFLOW_GRID_BOUNDARY_CONDITION_SOLVER2_H

#include <Core/Collider/Collider2.h>
#include <Core/Field/ScalarField2.h>
#include <Core/Grid/FaceCenteredGrid2.h>
#include <Core/Size/Size2.h>

namespace CubbyFlow
{
    class GridBoundaryConditionSolver2 
    {
    public:
        GridBoundaryConditionSolver2();

        virtual ~GridBoundaryConditionSolver2();

        const Collider2Ptr& GetCollider() const;

        void UpdateCollider(
            const Collider2Ptr& newCollider,
            const Size2& gridSize,
            const Vector2D& gridSpacing,
            const Vector2D& gridOrigin);

        int GetClosedDomainBoundaryFlag() const;

        void SetClosedDomainBoundaryFlag(int flag);

        virtual void ConstrainVelocity(
            FaceCenteredGrid2* velocity,
            unsigned int extrapolationDepth = 5) = 0;

        virtual ScalarField2Ptr GetColliderSDF() const = 0;

        virtual VectorField2Ptr GetColliderVelocityField() const = 0;

    protected:
        virtual void OnColliderUpdated(
            const Size2& gridSize,
            const Vector2D& gridSpacing,
            const Vector2D& gridOrigin) = 0;

        const Size2& GetGridSize() const;

        const Vector2D& GetGridSpacing() const;

        const Vector2D& GetGridOrigin() const;

    private:
        Collider2Ptr m_collider;
        Size2 m_gridSize;
        Vector2D m_gridSpacing;
        Vector2D m_gridOrigin;
        int m_closedDomainBoundaryFlag = DIRECTION_ALL;
    };

    using GridBoundaryConditionSolver2Ptr = std::shared_ptr<GridBoundaryConditionSolver2>;
}

#endif