GAS_ResetInactive.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_ResetInactive.h ( GAS Library, C++)
 *
 * COMMENTS:
 *  This operator resets fields to their background value in areas that are
 *  masked out by the stencil field.
 */

#ifndef __GAS_ResetInactive__
#define __GAS_ResetInactive__

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

class GAS_API GAS_ResetInactive : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S("resetfields", FieldsToReset);
    GET_DATA_FUNC_S(GAS_NAME_STENCIL, StencilField);

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

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

    THREADED_METHOD2(GAS_ResetInactive, field->field()->numTiles() > 64,
                     resetField,
                     SIM_RawField*, field,
                     const SIM_RawField*, stencil);
    void         resetFieldPartial(SIM_RawField* field,
                                   const SIM_RawField* stencil,
                                   const UT_JobInfo& info);
                     
    THREADED_METHOD3(GAS_ResetInactive, stencil->numTiles() > 64,
                     resetAlignedFields,
                     const UT_Array<UT_VoxelArrayF*>&, fields,
                     const UT_Array<float>&, bvals,
                     const UT_VoxelArrayF*, stencil);
    void         resetAlignedFieldsPartial(
                     const UT_Array<UT_VoxelArrayF*>& fields,
                     const UT_Array<float>& bvals,
                     const UT_VoxelArrayF* stencil,
                     const UT_JobInfo& info);

private:
    static const SIM_DopDescription* getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_ResetInactive,
                        GAS_SubSolver,
                        "Gas Reset Inactive",
                        getDopDescription());
};

#endif