GridBoundaryConditionSolver3.h

Go to the documentation of this file.

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

#include <Core/Collider/Collider3.h>
#include <Core/Field/ScalarField3.h>
#include <Core/Grid/FaceCenteredGrid3.h>
#include <Core/Size/Size3.h>

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

        virtual ~GridBoundaryConditionSolver3();

        const Collider3Ptr& GetCollider() const;

        void UpdateCollider(
            const Collider3Ptr& newCollider,
            const Size3& gridSize,
            const Vector3D& gridSpacing,
            const Vector3D& gridOrigin);

        int GetClosedDomainBoundaryFlag() const;

        void SetClosedDomainBoundaryFlag(int flag);

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

        virtual ScalarField3Ptr GetColliderSDF() const = 0;

        virtual VectorField3Ptr GetColliderVelocityField() const = 0;

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

        const Size3& GetGridSize() const;

        const Vector3D& GetGridSpacing() const;

        const Vector3D& GetGridOrigin() const;

    private:
        Collider3Ptr m_collider;
        Size3 m_gridSize;
        Vector3D m_gridSpacing;
        Vector3D m_gridOrigin;
        int m_closedDomainBoundaryFlag = DIRECTION_ALL;
    };

    using GridBoundaryConditionSolver3Ptr = std::shared_ptr<GridBoundaryConditionSolver3>;
}

#endif