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

#ifndef __GAS_ExternalForces__
#define __GAS_ExternalForces__

#include "GAS_API.h"

#include <SIM/SIM_VectorField.h>
#include "GAS_SubSolver.h"
#include "GAS_Utils.h"

class SIM_ForceResolver;

class GAS_API GAS_ExternalForces : public GAS_SubSolver
{
public:
    GET_DATA_FUNC_S(GAS_NAME_SURFACE, SurfaceName);
    GET_DATA_FUNC_S(GAS_NAME_DENSITY, DensityName);
    GET_DATA_FUNC_S(GAS_NAME_VELOCITY, VelocityName);
    GET_DATA_FUNC_S(GAS_NAME_GEOMETRY, GeometryName);
    GET_DATA_FUNC_S("forcenames", ForceNames);
    GET_DATA_FUNC_B("scalebysurface", ScaleBySurface);
    GET_DATA_FUNC_B("scalebydensity", ScaleByDensity);
    GET_DATA_FUNC_I("scaletype", ScaleType);
    GET_DATA_FUNC_B("computev", ComputeVelocity);
    GET_DATA_FUNC_B("stabledrag", StableDrag);

    GET_DATA_FUNC_B(GAS_NAME_USETIMESTEP, UseTimeStep);
    GET_DATA_FUNC_F(GAS_NAME_TIMESCALE, TimeScale);

    // Different ways of scaling the forces.  Needed so that forces
    // can be scaled using density rather than mass in SPH simulations.
    enum ScaleMethod {
        MASS,
        DENSITY
    };

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

    /// Adds to the velocity field the effect of all forces at that point.
    /// Unit density is currently assumed.
    /// Only incorpreates the external simulation forces.  Internal
    /// gas forces are handled elsewher.
    virtual bool         solveGasSubclass(SIM_Engine &engine,
                                SIM_Object *obj,
                                SIM_Time time,
                                SIM_Time timestep);

protected:
    void                 applyForcesToField(SIM_Object *obj,
                                SIM_VectorField *velocity,
                                SIM_ScalarField *surface,
                                SIM_ScalarField *density,
                                SIM_Time timestep);

    THREADED_METHOD6(GAS_ExternalForces, velocity->getXField()->shouldMultiThread(),
                    applyForceResolversToField,
                    SIM_Object *, obj,
                    SIM_VectorField *, velocity,
                    SIM_RawField *, surface,
                    SIM_RawField *, density,
                    SIM_Time, timestep,
                    const UT_PtrArray<SIM_ForceResolver *> &, forceresolvers)
    void                 applyForceResolversToFieldPartial(SIM_Object *obj,
                                SIM_VectorField *velocity,
                                SIM_RawField *surface,
                                SIM_RawField *density,
                                SIM_Time timestep,
                                const UT_PtrArray<SIM_ForceResolver *> &forceresolvers,
                                const UT_JobInfo &info);


    void                 applyForcesToGeo(SIM_Object *obj,
                                GU_Detail *gdp,
                                SIM_Time timestep);
    
private:
    static const SIM_DopDescription     *getDopDescription();

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(GAS_ExternalForces,
                        GAS_SubSolver,
                        "Gas External Forces",
                        getDopDescription());
};

#endif

---