simulation_object.h

Go to the documentation of this file.

/******************************************************************************
 *
 * El'Beem - Free Surface Fluid Simulation with the Lattice Boltzmann Method
 * Copyright 2003-2006 Nils Thuerey
 *
 * Basic interface for all simulation modules
 *
 *****************************************************************************/

#ifndef SIMULATION_OBJECT_H
#define SIMULATION_OBJECT_H


#define USE_GLUTILITIES
#include "ntl_geometryshader.h"
#include "parametrizer.h"

class LbmSolverInterface;
class CellIdentifierInterface;
class ntlTree;
class ntlRenderGlobals;
class ntlRenderGlobals;
class ParticleTracer;
struct elbeemSimulationSettings;


//  warning : should match typeslbm.h values!
const int cFgiFlagstart = 16;
typedef enum {
    fgiFluid     = (1<<(cFgiFlagstart+0)),
    fgiNoFluid   = (1<<(cFgiFlagstart+1)),
    fgiSlipNo    = (1<<(cFgiFlagstart+2)),
    fgiSlipFree  = (1<<(cFgiFlagstart+3)),
    fgiNoBnd     = (1<<(cFgiFlagstart+4)),
    fgiAcc       = (1<<(cFgiFlagstart+5)),
    fgiNoAcc     = (1<<(cFgiFlagstart+6)),

    fgiBndAll    = (fgiSlipNo | fgiSlipFree)
} FgiFlagType;


class SimulationObject :
    public ntlGeometryShader {

    public:

        SimulationObject();
        virtual ~SimulationObject();
        void copyElbeemSettings(elbeemSimulationSettings *settings);


        void initGeoTree();
        void freeGeoTree();
        int geoInitGetPointType(ntlVec3Gfx org, int &OId);
        bool geoInitCheckPointInside(ntlVec3Gfx org, int flags, int &OId);

        // access functions

        double getCurrentTime( void ) { return mTime; }
        virtual void setGeoStart(ntlVec3Gfx set) { mGeoStart = set; }
        virtual void setGeoEnd(ntlVec3Gfx set) { mGeoEnd = set; }

        void setPanic(bool set) { mPanic = set; }
        bool getPanic( void ) { return mPanic; }

        int initializeLbmSimulation(ntlRenderGlobals *glob);

        void setFrameNum(int num);

        virtual int postGeoConstrInit(ntlRenderGlobals *glob) { return initializeLbmSimulation(glob); };
        virtual int initializeShader() { /* ... */ return true; };
        virtual void notifyShaderOfDump(int dumptype, int frameNr,char *frameNrStr,string outfilename);
        virtual void draw( void ) {};
        virtual vector<ntlGeometryObject *>::iterator getObjectsBegin();
        virtual vector<ntlGeometryObject *>::iterator getObjectsEnd();


        virtual void step( void );
        virtual void prepareVisualization( void );

        virtual void drawDebugDisplay();
        virtual void drawInteractiveDisplay();
        virtual void setMousePos(int x,int y, ntlVec3Gfx org, ntlVec3Gfx dir);
        virtual void setMouseClick();

        double getStartTime( void );
        double getFrameTime( int frame );
        double getTimestep( void );

        LbmSolverInterface *getSolver(){ return mpLbm; }

    protected:

        double mTime;

        ntlVec3Gfx mGeoStart, mGeoEnd;

        //? int mGeoInitId;
        ntlTree *mpGiTree;
        vector<ntlGeometryObject*> *mpGiObjects;
        ntlRenderGlobals *mpGlob;
        
        bool mPanic;

        int mDebugType;

        LbmSolverInterface *mpLbm;

        Parametrizer *mpParam;

        ParticleTracer *mpParts;

        bool mShowSurface;
        bool mShowParticles;

        int mDebDispSetting;

        CellIdentifierInterface *mSelectedCid;

        elbeemSimulationSettings *mpElbeemSettings;

    public:

        // debug display setting funtions

        inline void setDebugDisplay(int disp) { mDebugType = disp; }
        inline int getDebugDisplay() { return mDebugType; }

        /* miscelleanous access functions */

        void initParametrizer(Parametrizer *set) { mpParam = set; }
        Parametrizer *getParametrizer() { return mpParam; }

        // parameters same as elbeem runsimCallback
        int checkCallerStatus(int status, int frame);

        virtual inline ntlVec3Gfx *getBBStart()     { return &mGeoStart; }
        virtual inline ntlVec3Gfx *getBBEnd()       { return &mGeoEnd; }

};


#endif