GAS/GAS_ParticleToField.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.
 *
 * Produced by:
 *      Jeff Lait
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        GAS_ParticleToField.h ( GAS Library, C++)
 *
 * COMMENTS:
 */

#ifndef __GAS_ParticleToField__
#define __GAS_ParticleToField__

#include "GAS_API.h"

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

#include <SIM/SIM_RawField.h>

#include <UT/UT_ThreadedAlgorithm.h>

class GEO_PointTree;

class GAS_API GAS_ParticleToField : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_FIELD, FieldName);
    GET_DATA_FUNC_S(GAS_NAME_GEOMETRY, GeometryName);

    GET_DATA_FUNC_S("attrib", Attribute);
    GET_DATA_FUNC_F("threshold", Threshold);
    GET_DATA_FUNC_B("accumulate", Accumulate);
    GET_DATA_FUNC_B("scalebyvolume", ScaleByVoxelVolume);
    GET_DATA_FUNC_B("extrapolate", Extrapolate);
    GET_DATA_FUNC_B("usemaxextrapolate", UseMaxExtrapolate);
    GET_DATA_FUNC_F("maxextrapolate", MaxExtrapolate);
    GET_DATA_FUNC_B("usemaxextrapolatedist", UseMaxExtrapolateDist);
    GET_DATA_FUNC_F("maxextrapolatedist", MaxExtrapolateDist);
    GET_DATA_FUNC_F("bandwidth", Bandwidth);
    
    GET_DATA_FUNC_I("calculationtype", CalculationType);
    GET_DATA_FUNC_F("dstpreadd", DstPreAdd);
    GET_DATA_FUNC_F("dstpremul", DstPreMul);
    GET_DATA_FUNC_F("srcpreadd", SrcPreAdd);
    GET_DATA_FUNC_F("srcpremul", SrcPreMul);
    GET_DATA_FUNC_F("postadd", PostAdd);
    GET_DATA_FUNC_F("postmul", PostMul);

    GET_DATA_FUNC_I("srctimescale", SrcTimeScale);
    GET_DATA_FUNC_I("dsttimescale", DstTimeScale);
    GET_DATA_FUNC_I("posttimescale", PostTimeScale);

protected:
    explicit             GAS_ParticleToField(const SIM_DataFactory *factory);
    virtual             ~GAS_ParticleToField();

    /// Transfers the values of an attribute from the particle
    /// geoemtry onto the field.
    virtual bool         solveGasSubclass(SIM_Engine &engine,
                                SIM_Object *obj,
                                SIM_Time time,
                                SIM_Time timestep);

    void                 particleToField(SIM_Object *obj, 
                                    SIM_RawField *destfield,
                                    const GU_Detail *particles,
                                    fpreal timestep,
                                    const char *attributename,
                                    int offset,
                                    const UT_DMatrix4 &xform);

    struct gas_particleToFieldParms
    {
        fpreal          threshold, bandwidth;
        bool            extrapolate, usemaxextrapolate;
        fpreal          maxextrapolatedist;
        fpreal          d_preadd, d_premul;
        fpreal          s_preadd, s_premul;
        fpreal          postadd, postmul;
        MIX_NAMES       calctype;

        const char      *attribname;
        int             offset;
        UT_DMatrix4     xform;
    };

    THREADED_METHOD4(GAS_ParticleToField, destfield->shouldMultiThread(),
                            applyParticleToField,
                            SIM_RawField *, destfield,
                            const GU_Detail *, particles,
                            GEO_PointTree *, pttree,
                            gas_particleToFieldParms &, parms)
    void                 applyParticleToFieldPartial(
                                    SIM_RawField *destfield,
                                    const GU_Detail *particles,
                                    GEO_PointTree *pttree,
                                    gas_particleToFieldParms &parms,
                                    const UT_JobInfo &info);



private:
    static const SIM_DopDescription     *getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_ParticleToField,
                        GAS_SubSolver,
                        "Gas Particle To Field",
                        getDopDescription());
};

#endif

---