GteFluid3ComputeDivergence.h

Go to the documentation of this file.

// David Eberly, Geometric Tools, Redmond WA 98052
// Copyright (c) 1998-2017
// Distributed under the Boost Software License, Version 1.0.
// http://www.boost.org/LICENSE_1_0.txt
// http://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
// File Version: 3.0.0 (2016/06/19)

#pragma once

#include <Physics/GteFluid3Parameters.h>
#include <Graphics/GteConstantBuffer.h>
#include <Graphics/GteProgramFactory.h>
#include <Graphics/GteTexture3.h>

namespace gte
{

class GraphicsEngine;

class GTE_IMPEXP Fluid3ComputeDivergence
{
public:
    // Construction.  Compute the divergence of the velocity vector field:
    // Divergence(V(x,y,z)) = dV/dx + dV/dy + dV/dz.  The derivatives are
    // estimated using centered finite differences,
    //   dV/dx = (V(x+dx,y,z) - V(x-dx,y,z))/(2*dx)
    //   dV/dy = (V(x,y+dy,z) - V(x,y-dy,z))/(2*dy)
    //   dV/dz = (V(x,y,z+dz) - V(x,y,z-dz))/(2*dz)
    Fluid3ComputeDivergence(std::shared_ptr<ProgramFactory> const& factory,
        int xSize, int ySize, int zSize, int numXThreads, int numYThreads, int numZThreads,
        std::shared_ptr<ConstantBuffer> const& parameters);

    // Member access.
    inline std::shared_ptr<Texture3> const& GetDivergence() const;

    // Compute the divergence of the velocity vector field for the input
    // state.
    void Execute(std::shared_ptr<GraphicsEngine> const& engine,
        std::shared_ptr<Texture3> const& state);

private:
    int mNumXGroups, mNumYGroups, mNumZGroups;
    std::shared_ptr<ComputeProgram> mComputeDivergence;
    std::shared_ptr<Texture3> mDivergence;

    // Shader source code as strings.
    static std::string const msGLSLSource;
    static std::string const msHLSLSource;
    static std::string const* msSource[ProgramFactory::PF_NUM_API];
};

inline std::shared_ptr<Texture3> const& Fluid3ComputeDivergence::GetDivergence() const
{
    return mDivergence;
}

}