GridDiffusionSolver2.h

Go to the documentation of this file.

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

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

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

        virtual ~GridDiffusionSolver2();

        virtual void Solve(
            const ScalarGrid2& source,
            double diffusionCoefficient,
            double timeIntervalInSeconds,
            ScalarGrid2* dest,
            const ScalarField2& boundarySDF = ConstantScalarField2(std::numeric_limits<double>::max()),
            const ScalarField2& fluidSDF = ConstantScalarField2(-std::numeric_limits<double>::max())) = 0;

        virtual void Solve(
            const CollocatedVectorGrid2& source,
            double diffusionCoefficient,
            double timeIntervalInSeconds,
            CollocatedVectorGrid2* dest,
            const ScalarField2& boundarySDF = ConstantScalarField2(std::numeric_limits<double>::max()),
            const ScalarField2& fluidSDF = ConstantScalarField2(-std::numeric_limits<double>::max())) = 0;

        virtual void Solve(
            const FaceCenteredGrid2& source,
            double diffusionCoefficient,
            double timeIntervalInSeconds,
            FaceCenteredGrid2* dest,
            const ScalarField2& boundarySDF = ConstantScalarField2(std::numeric_limits<double>::max()),
            const ScalarField2& fluidSDF = ConstantScalarField2(-std::numeric_limits<double>::max())) = 0;
    };

    using GridDiffusionSolver2Ptr = std::shared_ptr<GridDiffusionSolver2>;
}

#endif