AdvectionSolver2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: AdvectionSolver2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Abstract based class for 2-D grid-based advection solver.
> Created Time: 2017/08/07
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_ADVECTION_SOLVER2_H
#define CUBBYFLOW_ADVECTION_SOLVER2_H

#include <Core/Field/ConstantScalarField2.h>
#include <Core/Field/VectorField2.h>
#include <Core/Grid/CollocatedVectorGrid2.h>
#include <Core/Grid/FaceCenteredGrid2.h>
#include <Core/Grid/ScalarGrid2.h>

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

        virtual ~AdvectionSolver2();

        virtual void Advect(
            const ScalarGrid2& input,
            const VectorField2& flow,
            double dt,
            ScalarGrid2* output,
            const ScalarField2& boundarySDF = ConstantScalarField2(std::numeric_limits<double>::max())) = 0;

        virtual void Advect(
            const CollocatedVectorGrid2& input,
            const VectorField2& flow,
            double dt,
            CollocatedVectorGrid2* output,
            const ScalarField2& boundarySDF = ConstantScalarField2(std::numeric_limits<double>::max()));

        virtual void Advect(
            const FaceCenteredGrid2& input,
            const VectorField2& flow,
            double dt,
            FaceCenteredGrid2* output,
            const ScalarField2& boundarySDF = ConstantScalarField2(std::numeric_limits<double>::max()));
    };

    using AdvectionSolver2Ptr = std::shared_ptr<AdvectionSolver2>;
}

#endif