GridDiffusionSolver3.h

Go to the documentation of this file.

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

#include <Core/Field/ConstantScalarField3.h>
#include <Core/Grid/CollocatedVectorGrid3.h>
#include <Core/Grid/FaceCenteredGrid3.h>
#include <Core/Grid/ScalarGrid3.h>

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

        virtual ~GridDiffusionSolver3();

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

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

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

    using GridDiffusionSolver3Ptr = std::shared_ptr<GridDiffusionSolver3>;
}

#endif