GAS_BuildOccupancyMask.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_BuildOccupancyMask.h ( GAS Library, C++)
 *
 * COMMENTS:
 */

#ifndef __GAS_BuildOccupancyMask__
#define __GAS_BuildOccupancyMask__

#include "GAS_SubSolver.h"
#include "GAS_Utils.h"

/// Builds an occupancy mask out of a set of fields. Voxel is considered
/// occupied if its value is larger than 0 for at least one of the source
/// fields. Output field's voxels are set to 1 if occupied and 0 otherwise.
class GAS_API GAS_BuildOccupancyMask : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S("mask", MaskField);
    
    GET_DATA_FUNC_S("resetfields", FieldsToReset);
    GET_DATA_FUNC_I("resetrule", ResetRule);

    GET_DATA_FUNC_B("fulltiles", FillTiles);
    GET_DATA_FUNC_I("expansionpasses", ExpansionPasses);

    GET_DATA_FUNC_S(GAS_NAME_VELOCITY, VelocityName);

    GET_DATA_FUNC_B("directional", DirectionalExpansions);
    GET_DATA_FUNC_F("padding", Padding);
    GET_DATA_FUNC_B("enablemaxpadding", ClampPadding);
    GET_DATA_FUNC_F("maxpadding", MaxPadding);
    GET_DATA_FUNC_F("dirrate", DirectionalRate);
    GET_DATA_FUNC_F("tangrate", TangentialRate);

    GET_DATA_FUNC_B("streakvel", StreakVelocity);
    GET_DATA_FUNC_F("streakfalloff", StreakFalloff);
    GET_DATA_FUNC_F("streakwidth", StreakBlendwidth);

protected:
    explicit GAS_BuildOccupancyMask(const SIM_DataFactory* factory);
            ~GAS_BuildOccupancyMask() override;

    /// Builds the occupancy field for the given source fields.
    bool         solveGasSubclass(SIM_Engine& engine,
                                  SIM_Object* obj,
                                  SIM_Time time,
                                  SIM_Time timestep) override;

    /// Given two matching stencil, finds the areas that need to be reset in
    /// accordance to the given rule.
    THREADED_METHOD3_CONST(GAS_BuildOccupancyMask, src1->numTiles() > 64,
                           findResetAreas,
                           UT_VoxelArrayF*, src1,
                           const UT_VoxelArrayF*, src0,
                           int, rule);
    void findResetAreasPartial(UT_VoxelArrayF* src1,
                               const UT_VoxelArrayF* src0,
                               int resetRule,
                               const UT_JobInfo& info) const;

    /// Resets the values of all aligned and unaligned fields to their border
    /// value in the areas where the mask is greater than a half.
    THREADED_METHOD3_CONST(GAS_BuildOccupancyMask, mask->shouldMultiThread(),
                           resetFields,
                           const SIM_RawField*, mask,
                           const UT_Array<const SIM_RawField*>&, aligned,
                           const UT_Array<const SIM_RawField*>&, unaligned);
    void resetFieldsPartial(const SIM_RawField* mask,
                            const UT_Array<const SIM_RawField*>& aligned,
                            const UT_Array<const SIM_RawField*>& unaligned,
                            const UT_JobInfo& info) const;

    /// Performs the work of finding occupied voxels in fine mode (voxels can
    /// be individually occupied).
    THREADED_METHOD5_CONST(GAS_BuildOccupancyMask, mask->shouldMultiThread(),
                           calculateMaskFine,
                           UT_VoxelArrayF*, destination,
                           const SIM_RawField*, mask,
                           const UT_Array<const SIM_RawField*>&, aligned,
                           const UT_Array<const SIM_RawField*>&, unaligned,
                           bool, compress);
    void calculateMaskFinePartial(UT_VoxelArrayF* destination,
                                  const SIM_RawField* maskField,
                                  const UT_Array<const SIM_RawField*>& aligned,
                                  const UT_Array<const SIM_RawField*>& unaligned,
                                  bool compress,
                                  const UT_JobInfo& info) const;

    /// Performs the work of finding occupied voxels in tiled mode (the entire
    /// tile is set to active if one of its voxels is occupied).
    THREADED_METHOD4_CONST(GAS_BuildOccupancyMask, mask->shouldMultiThread(),
                           calculateMaskFilled,
                           UT_VoxelArrayF*, destination,
                           const SIM_RawField*, mask,
                           const UT_Array<const SIM_RawField*>&, aligned,
                           const UT_Array<const SIM_RawField*>&, unaligned);
    void calculateMaskFilledPartial(UT_VoxelArrayF* destination,
                                    const SIM_RawField* mask,
                                    const UT_Array<const SIM_RawField*>& aligned,
                                    const UT_Array<const SIM_RawField*>& unaligned,
                                    const UT_JobInfo& info) const;

    /// Does a single step of expansion on the given source field, putting the
    /// results into the destination field. Can also shrink the occupied area.
    /// This version works in fine mode.
    THREADED_METHOD4_CONST(GAS_BuildOccupancyMask, dst->numTiles() > 32,
                           expandFine,
                           UT_VoxelArrayF*, dst,
                           const UT_VoxelArrayF*, src,
                           bool, shrink,
                           bool, compress);
    void expandFinePartial(UT_VoxelArrayF* dst, const UT_VoxelArrayF* src,
                           bool shrink, bool compress,
                           const UT_JobInfo& info) const;

    /// Does a single step of expansion on the given source field, putting the
    /// results into the destination field. Can also shrink the occupied area.
    /// This version works in tiled mode.
    THREADED_METHOD3_CONST(GAS_BuildOccupancyMask, dst->numTiles() > 512,
                           expandFilled,
                           UT_VoxelArrayF*, dst,
                           const UT_VoxelArrayF*, src,
                           bool, shrink);
    void expandFilledPartial(UT_VoxelArrayF* dst, const UT_VoxelArrayF* src,
                             bool shrink, const UT_JobInfo& info) const;

private:
    static const SIM_DopDescription* getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_BuildOccupancyMask,
                        GAS_SubSolver,
                        "Gas Occupancy Mask",
                        getDopDescription());
};

#endif