GAS_SeedFluidParticles.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 *
 * NAME:        GAS_SeedFluidParticles.h ( GAS Library, C++)
 *
 * COMMENTS:
 */

#ifndef __GAS_SeedFluidParticles__
#define __GAS_SeedFluidParticles__

#include <GAS/GAS_API.h>

#include <GAS/GAS_SubSolver.h>
#include <GAS/GAS_Utils.h>

#include <GU/GU_Detail.h>

#include <GA/GA_PageHandle.h>
#include <GA/GA_PageIterator.h>
#include <GA/GA_SplittableRange.h>

#include <SIM/SIM_GeometryCopy.h>
#include <SIM/SIM_IndexField.h>
#include <UT/UT_ThreadedAlgorithm.h>
#include <UT/UT_UniquePtr.h>

#include <openvdb/tools/PointIndexGrid.h>

class GU_Detail;
class SIM_ScalarField;
class GU_PrimParticle;

class GAS_API GAS_SeedFluidParticles : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_GEOMETRY, GeometryName);

    GET_DATA_FUNC_S(GAS_NAME_SURFACE, SurfaceName);
    GET_DATA_FUNC_S(GAS_NAME_SOURCE, SourceName);
    GET_DATA_FUNC_S(GAS_NAME_COLLISION, CollisionName);
    GET_DATA_FUNC_S(GAS_NAME_SINK, SinkName);

    GETSET_DATA_FUNCS_B("onlysourcing", OnlySourcing);

    GET_DATA_FUNC_S("newpointattrib", NewPointAttrib);
    GET_DATA_FUNC_S("posinitialized", PosInitialized);

    GETSET_DATA_FUNCS_I("partpervoxel", ParticlesPerVoxel);
    GETSET_DATA_FUNCS_F("birththreshold", BirthThreshold);
    GETSET_DATA_FUNCS_F("deaththreshold", DeathThreshold);

    GETSET_DATA_FUNCS_B("donarrowband", DoNarrowband);
    GETSET_DATA_FUNCS_F("narrowbandwidth", NarrowBandwidth);

    GETSET_DATA_FUNCS_F("domainbandwidth", DomainBandwidth);

    GETSET_DATA_FUNCS_B("oversamplebounds", OversampleBounds);
    GETSET_DATA_FUNCS_F("oversampling", Oversampling);
    GETSET_DATA_FUNCS_F("oversamplingbandwidth", OversamplingBandwidth);

    GETSET_DATA_FUNCS_B("dosourcescatter", DoSourceScatter);
    GETSET_DATA_FUNCS_F("scatterdensity", ScatterDensity);

    GETSET_DATA_FUNCS_F(SIM_NAME_SEED, Seed);

    GETSET_DATA_FUNCS_I("slice", Slice);

public:
    explicit GAS_SeedFluidParticles(const SIM_DataFactory *factory);
    ~GAS_SeedFluidParticles() override;

    bool solveGasSubclass(
            SIM_Engine &engine,
            SIM_Object *obj,
            SIM_Time time,
            SIM_Time timestep) override;

    // Stores all input parameters
    struct ReseedingParms
    {
        ReseedingParms() = default;
        ReseedingParms(ReseedingParms &&) = default;
        ReseedingParms(const ReseedingParms &) = delete;

        GU_Detail *gdp = nullptr;

        openvdb::math::Transform::Ptr xform = nullptr;
        openvdb::tools::PointIndexGrid::ConstPtr ptgrid = nullptr;

        const SIM_RawField *surface = nullptr;
        const SIM_RawField *source = nullptr;
        const SIM_RawField *collision = nullptr;
        const SIM_RawField *sink = nullptr;
        const SIM_RawField *domain = nullptr;

        bool onlysourcing = false;

        UT_String newpointattrib = "";
        UT_String posinitialized = "";

        fpreal density = -1;
        fpreal birththreshold = -1;
        fpreal deaththreshold = -1;

        fpreal pscale = -1;

        bool donarrowband = false;
        fpreal bandwidth = -1;

        fpreal domainbandwidth = 2;

        bool dooversample = false;
        fpreal oversamplescale = -1;
        fpreal oversamplebandwidth = -1;

        bool dosourcescatter = false;
        fpreal scatterdensity = -1;

        fpreal seed = 0;

        const SIM_IndexField *slice = nullptr;
        exint thisslice = -1;
    };

    // Structure that stores points to be created and deleted in temporary
    // buffers. Points can be added and deleted asynchornously.
    struct ReseedingWrangler
    {
    public:
        ReseedingWrangler(int numtiles);

        // remove copy constructor to make sure we don't make a copy
        ReseedingWrangler(const ReseedingWrangler &) = delete;

        void addPoint(UT_Vector3F p, int tileid);
        void addSourcedPoint(UT_Vector3F p, int tileid);
        void delPoint(GA_Offset p, int tileid);

        void apply(const ReseedingParms &parms);
        
    private:
        UT_Array<UT_UniquePtr<UT_Vector3Array>> new_points;
        UT_Array<UT_UniquePtr<UT_Vector3Array>> new_sourced_points;
        UT_Array<UT_UniquePtr<GA_OffsetArray>> del_points;
    };

    THREADED_METHOD2_CONST(
            GAS_SeedFluidParticles,
            parms.surface->shouldMultiThread(),
            reseedParticles,
            const ReseedingParms &,
            parms,
            ReseedingWrangler &,
            wrangler)

    void reseedParticlesPartial(
            const ReseedingParms &parms,
            ReseedingWrangler &wrangler,
            const UT_JobInfo &info) const;

private:
    static const SIM_DopDescription *getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(
            GAS_SeedFluidParticles,
            GAS_SubSolver,
            "Gas Seed Fluid Particles",
            getDopDescription());
};

#endif