GridPressureSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: GridPressureSolver3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Abstract base class for 3-D grid-based pressure solver.
> Created Time: 2017/08/10
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_GRID_PRESSURE_SOLVER3_H
#define CUBBYFLOW_GRID_PRESSURE_SOLVER3_H

#include <Core/Field/ConstantScalarField3.h>
#include <Core/Field/ConstantVectorField3.h>
#include <Core/Grid/FaceCenteredGrid3.h>
#include <Core/Solver/Grid/GridBoundaryConditionSolver3.h>

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

        virtual ~GridPressureSolver3();

        virtual void Solve(
            const FaceCenteredGrid3& input,
            double timeIntervalInSeconds,
            FaceCenteredGrid3* output,
            const ScalarField3& boundarySDF = ConstantScalarField3(std::numeric_limits<double>::max()),
            const VectorField3& boundaryVelocity = ConstantVectorField3({ 0, 0, 0 }),
            const ScalarField3& fluidSDF = ConstantScalarField3(-std::numeric_limits<double>::max()),
            bool useCompressed = false) = 0;

        virtual GridBoundaryConditionSolver3Ptr SuggestedBoundaryConditionSolver() const = 0;
    };

    using GridPressureSolver3Ptr = std::shared_ptr<GridPressureSolver3>;
}

#endif