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

#ifndef __GAS_FieldToParticle__
#define __GAS_FieldToParticle__

#include "GAS_API.h"

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

class SIM_RawField;

class GAS_API GAS_FieldToParticle : 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_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_FieldToParticle(const SIM_DataFactory *factory);
    virtual             ~GAS_FieldToParticle();

    /// 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                 fieldToParticle(SIM_Object *obj,
                                    SIM_RawField *srcfield,
                                    GU_Detail *particles,
                                    fpreal timestep,
                                    const char *attributename,
                                    int offset);

private:
    static const SIM_DopDescription     *getDopDescription();

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

#endif

---