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

#ifndef __GAS_AdvectField_2_0__
#define __GAS_AdvectField_2_0__

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

/// Tracing methods supported by this operator.
enum GAS_TraceMethod
{
    FORWARD_EULER = 0,
    EXPLICIT_MIDPOINT = 1,
    RUNGE_KUTTA_3 = 2,
    RUNGE_KUTTA_4 = 3
};
/// Captures the sampling pattern of a velocity field, as well as its
/// relationship to the advected field.
enum GAS_VectorSampling
{
    NON_MATCHING,       // Velocity and advected fields do not match.
    GENERIC_MATCHING,   // Velocity and advected fields match, but not one of
                        // the cases below.
    FACE_MATCHING,      // Velocity field is center sampled, and advected field
                        // is face or center sampled.
    CENTER_MATCHING     // All velocity field components and the advected field
                        // are aligned.
};

class GAS_API GAS_AdvectField2 : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_FIELDDEST, FieldDstName);
    GET_DATA_FUNC_S(GAS_NAME_STENCIL, StencilName);
    GET_DATA_FUNC_S(GAS_NAME_VELOCITY, VelocityName);
    GET_DATA_FUNC_I("advectscheme", AdvectScheme);
    GET_DATA_FUNC_I("clampvalues", ClampingMode);
    GET_DATA_FUNC_F("blendwidth", Blendwidth);
    GET_DATA_FUNC_I("tracemethod", TraceMethod);
    GET_DATA_FUNC_B("usecfl", UseCFL);
    GET_DATA_FUNC_F("cflcond", CFLCond);
    GET_DATA_FUNC_B("limitsteps", LimitSteps);
    GET_DATA_FUNC_I("maxsteps", MaxSteps);
    GET_DATA_FUNC_B("limitbatch", LimitBatchSize);
    GET_DATA_FUNC_I("maxbatchsize", MaxBatchSize);
    GET_DATA_FUNC_B(GAS_NAME_USETIMESTEP, UseTimestep);
    GET_DATA_FUNC_F(GAS_NAME_TIMESCALE, TimeScale);
    GET_DATA_FUNC_B("opencl", OpenCL);
    GET_DATA_FUNC_V3("wind", Wind);

protected:
    struct gas_AdvectParms
    {
        GAS_TraceMethod         TraceMethod;
        float                   CFLCondition;
        float                   Timestep;
        float                   MaxSteps;
        const SIM_VectorField*  Velocity;
    };

    enum GAS_ClampingMode
    {
        NONE = 0,
        CLAMP_MIN_MAX = 1,
        REVERT_MIN_MAX = 2,
        CALCULATE_MIN_MAX = 3
    };
    struct gas_ClampingParms
    {
        GAS_ClampingMode        Mode;
        float                   Blendwidth;
    };

    THREADED_METHOD10_CONST(GAS_AdvectField2, field->shouldMultiThread(),
                            advectBatch,
                           const UT_Array<UT_VoxelArrayF*>&, dest,
                           const UT_Array<UT_VoxelArrayF*>&, mina,
                           const UT_Array<UT_VoxelArrayF*>&, maxa,
                           const UT_Array<UT_VoxelArrayF*>&, src,
                           const SIM_RawField*, field,
                           const SIM_RawField*, stencil,
                           const gas_AdvectParms&, parms,
                           bool, forward,
                           const UT_Vector3&, wind,
                           const gas_ClampingParms&, clampParms);
    void advectBatchPartial(const UT_Array<UT_VoxelArrayF*>& dest,
                            const UT_Array<UT_VoxelArrayF*>& mina,
                            const UT_Array<UT_VoxelArrayF*>& maxa,
                            const UT_Array<UT_VoxelArrayF*>& src,
                            const SIM_RawField* field,
                            const SIM_RawField* stencil,
                            const gas_AdvectParms& parms,
                            bool forward,
                            const UT_Vector3& wind,
                            const gas_ClampingParms& clampParms,
                            const UT_JobInfo& info) const;

    THREADED_METHOD7_CONST(GAS_AdvectField2, dest->numTiles() > 1,
                           clampValues,
                           UT_VoxelArrayF*, dest,
                           const UT_VoxelArrayF*, revert,
                           const UT_VoxelArrayF*, minf,
                           const UT_VoxelArrayF*, maxf,
                           const SIM_RawField*, field,
                           const SIM_RawField*, stencil,
                           const gas_ClampingParms&, parms);
    void clampValuesPartial(UT_VoxelArrayF* dest,
                            const UT_VoxelArrayF* revert,
                            const UT_VoxelArrayF* minf,
                            const UT_VoxelArrayF* maxf,
                            const SIM_RawField* field,
                            const SIM_RawField* stencil,
                            const gas_ClampingParms& parms,
                            const UT_JobInfo& info) const;

    /// Performs the necessary error correction for the given advection scheme,
    /// putting the final results in a2.
    /// a0 should be the advected array, a1 is the original array, and a2 is
    /// un-advected a0.
    /// If a stencil field is provided, it's expected to match the three operand
    /// arrays.
    THREADED_METHOD5_CONST(GAS_AdvectField2, a0->numTiles() > 1,
                           compensateForError,
                           const UT_VoxelArrayF*, a0,
                           const UT_VoxelArrayF*, a1,
                           UT_VoxelArrayF*, a2,
                           const SIM_RawField*, stencil,
                           int, scheme);
    void compensateForErrorPartial(const UT_VoxelArrayF* a0,
                                   const UT_VoxelArrayF* a1,
                                   UT_VoxelArrayF* a2,
                                   const SIM_RawField* stencil,
                                   int scheme,
                                   const UT_JobInfo& info) const;

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

    explicit GAS_AdvectField2(const SIM_DataFactory* factory);
            ~GAS_AdvectField2() override;

private:
    static const SIM_DopDescription* getDopDescription();

    template<GAS_TraceMethod METHOD, int AXIS_2D, GAS_ClampingMode CLAMPING_MODE>
    inline void advectBatchHelper(const UT_Array<UT_VoxelArrayF*>& dest,
                                  const UT_Array<UT_VoxelArrayF*>& mina,
                                  const UT_Array<UT_VoxelArrayF*>& maxa,
                                  const UT_Array<UT_VoxelArrayF*>& src,
                                  const SIM_RawField* field,
                                  const SIM_RawField* stencil,
                                  const gas_AdvectParms& parms,
                                  bool forward,
                                  float blendwidth,
                                  const UT_Vector3& wind,
                                  const UT_JobInfo& info) const;

    template<bool REVERT>
    inline void clampValuesHelper(UT_VoxelArrayF* dest,
                                  const UT_VoxelArrayF* revert,
                                  const UT_VoxelArrayF* minf,
                                  const UT_VoxelArrayF* maxf,
                                  const SIM_RawField* field,
                                  const SIM_RawField* stencil,
                                  float blendwidth,
                                  const UT_JobInfo& info) const;

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_AdvectField2,
                        GAS_SubSolver,
                        "Gas Advect Field",
                        getDopDescription());
};

#endif