Program Listing for File FluidModel.h

↰ Return to documentation for file (SPlisHSPlasH/FluidModel.h)

#ifndef __FluidModel_h__
#define __FluidModel_h__

#include "Common.h"
#include <vector>

#include "RigidBodyObject.h"
#include "SPHKernels.h"
#include "ParameterObject.h"
#ifdef USE_AVX
#include "SPlisHSPlasH/Utilities/AVX_math.h"
#endif
#include "Utilities/BinaryFileReaderWriter.h"


#ifdef USE_PERFORMANCE_OPTIMIZATION
    // compute the value xj (empty in the optimized version)
    #define compute_xj(fm_neighbor, pid)

    // compute the value Vj (empty in the optimized version)
    #define compute_Vj(fm_neighbor)

    // compute the value Vj * gradW
    #define compute_Vj_gradW() \
        const Vector3f8& V_gradW = model->get_precomputed_V_gradW()[model->get_precomputed_indices()[i] + idx];

    // compute the value Vj * gradW
    #define compute_Vj_gradW_samephase() \
        const Vector3f8& V_gradW = model->get_precomputed_V_gradW()[model->get_precomputed_indices_same_phase()[i] + j / 8];
#else
    // compute the value xj
    #define compute_xj(fm_neighbor, pid) \
        const Vector3f8 xj_avx = convertVec_zero(&sim->getNeighborList(fluidModelIndex, pid, i)[j], &fm_neighbor->getPosition(0), count);

    // compute the value Vj
    #define compute_Vj(fm_neighbor) \
        const Scalarf8 Vj_avx = convert_zero(fm_neighbor->getVolume(0), count);

    // compute the value Vj * gradW assuming that xj and Vj are already available
    #define compute_Vj_gradW() \
        const Vector3f8 &V_gradW = CubicKernel_AVX::gradW(xi_avx - xj_avx) * Vj_avx;

    // compute the value Vj * gradW assuming that xj and Vj are already available
    #define compute_Vj_gradW_samephase() \
        const Vector3f8 &V_gradW = CubicKernel_AVX::gradW(xi_avx - xj_avx) * Vj_avx;
#endif


namespace SPH
{
    class TimeStep;
    class NonPressureForceBase;
    class XSPH;
    class EmitterSystem;

    enum FieldType { Scalar = 0, Vector3, Vector6, Matrix3, Matrix6, UInt };
    struct FieldDescription
    {
        std::string name;
        std::string methodName;         // name of the method that added this field
        FieldType type;
        // getFct(particleIndex)
        std::function<void*(const unsigned int)> getFct;
        bool storeData;

        FieldDescription(const std::string& n, const FieldType& t,
            const std::function<void* (const unsigned int)>& fct, const bool s = false) :
            name(n), methodName(""), type(t), getFct(fct), storeData(s) { }

        FieldDescription(const std::string &n, const std::string& mn, const FieldType &t,
            const std::function<void*(const unsigned int)> &fct, const bool s = false) :
            name(n), methodName(mn), type(t), getFct(fct), storeData(s) { }
    };

    enum class ParticleState { Active = 0, AnimatedByEmitter, Fixed };

    class FluidModel : public GenParam::ParameterObject
    {
        public:
            static int NUM_PARTICLES;
            static int NUM_REUSED_PARTICLES;
            static int DENSITY0;

            static int DRAG_METHOD;
            static int SURFACE_TENSION_METHOD;
            static int VISCOSITY_METHOD;
            static int VORTICITY_METHOD;
            static int ELASTICITY_METHOD;

            FluidModel();
            FluidModel(const FluidModel&) = delete;
            FluidModel& operator=(const FluidModel&) = delete;
            virtual ~FluidModel();

            void init();
            void deferredInit();

            std::string getId() const { return m_id; }

        protected:
            std::string m_id;
            EmitterSystem *m_emitterSystem;

            // Mass
            // If the mass is zero, the particle is static
            std::vector<Real> m_masses;
            std::vector<Vector3r> m_a;
            std::vector<Vector3r> m_v0;
            std::vector<Vector3r> m_x0;
            std::vector<Vector3r> m_x;
            std::vector<Vector3r> m_v;
            std::vector<Real> m_density;
            std::vector<unsigned int> m_particleId;
            std::vector<unsigned int> m_objectId;
            std::vector<unsigned int> m_objectId0;
            std::vector<ParticleState> m_particleState;
            Real m_V;

#ifdef USE_PERFORMANCE_OPTIMIZATION
            std::vector<Vector3f8, Eigen::aligned_allocator<Vector3f8>> m_precomp_V_gradW;
            std::vector<unsigned int> m_precompIndices;
            std::vector<unsigned int> m_precompIndicesSamePhase;
#endif

            XSPH* m_xsph;
            unsigned int m_surfaceTensionMethod;
            NonPressureForceBase*m_surfaceTension;
            unsigned int m_viscosityMethod;
            NonPressureForceBase*m_viscosity;
            unsigned int m_vorticityMethod;
            NonPressureForceBase *m_vorticity;
            unsigned int m_dragMethod;
            NonPressureForceBase *m_drag;
            unsigned int m_elasticityMethod;
            NonPressureForceBase *m_elasticity;
            std::vector<FieldDescription> m_fields;

            std::function<void()> m_dragMethodChanged;
            std::function<void()> m_surfaceTensionMethodChanged;
            std::function<void()> m_viscosityMethodChanged;
            std::function<void()> m_vorticityMethodChanged;
            std::function<void()> m_elasticityMethodChanged;

            Real m_density0;
            unsigned int m_pointSetIndex;

            unsigned int m_numActiveParticles;
            unsigned int m_numActiveParticles0;

            virtual void initParameters();

            void initMasses();

            virtual void resizeFluidParticles(const unsigned int newSize);

            virtual void releaseFluidParticles();


        public:
            FORCE_INLINE Real getDensity0() const { return m_density0; }
            void setDensity0(const Real v);

            unsigned int getPointSetIndex() const { return m_pointSetIndex; }

            void addField(const FieldDescription &field);
            const std::vector<FieldDescription> &getFields() { return m_fields; }
            const FieldDescription &getField(const unsigned int i) { return m_fields[i]; }
            const FieldDescription &getField(const std::string &name);
            const unsigned int numberOfFields() { return static_cast<unsigned int>(m_fields.size()); }
            void removeFieldByName(const std::string &fieldName);

            void setNumActiveParticles(const unsigned int num);
            unsigned int numberOfParticles() const { return static_cast<unsigned int>(m_x.size()); }

            EmitterSystem* getEmitterSystem() { return m_emitterSystem; }

            virtual void reset();

            void performNeighborhoodSearchSort();

            void initModel(const std::string &id, const unsigned int nFluidParticles, Vector3r* fluidParticles, Vector3r* fluidVelocities, unsigned int* fluidObjectIds, const unsigned int nMaxEmitterParticles);

            const unsigned int numParticles() const { return static_cast<unsigned int>(m_masses.size()); }
            unsigned int numActiveParticles() const;

            unsigned int getNumActiveParticles0() const { return m_numActiveParticles0; }
            void setNumActiveParticles0(unsigned int val) { m_numActiveParticles0 = val; }

            void emittedParticles(const unsigned int startIndex);

            unsigned int getSurfaceTensionMethod() const { return m_surfaceTensionMethod; }
            void setSurfaceTensionMethod(const std::string& val);
            void setSurfaceTensionMethod(const unsigned int val);
            unsigned int getViscosityMethod() const { return m_viscosityMethod; }
            void setViscosityMethod(const std::string &val);
            void setViscosityMethod(const unsigned int val);
            unsigned int getVorticityMethod() const { return m_vorticityMethod; }
            void setVorticityMethod(const std::string& val);
            void setVorticityMethod(const unsigned int val);
            unsigned int getDragMethod() const { return m_dragMethod; }
            void setDragMethod(const std::string& val);
            void setDragMethod(const unsigned int val);
            unsigned int getElasticityMethod() const { return m_elasticityMethod; }
            void setElasticityMethod(const std::string& val);
            void setElasticityMethod(const unsigned int val);

            NonPressureForceBase *getSurfaceTensionBase() { return m_surfaceTension; }
            NonPressureForceBase *getViscosityBase() { return m_viscosity; }
            NonPressureForceBase *getVorticityBase() { return m_vorticity; }
            NonPressureForceBase *getDragBase() { return m_drag; }
            NonPressureForceBase *getElasticityBase() { return m_elasticity; }
            XSPH* getXSPH() { return m_xsph; }

            void setDragMethodChangedCallback(std::function<void()> const& callBackFct);
            void setSurfaceMethodChangedCallback(std::function<void()> const& callBackFct);
            void setViscosityMethodChangedCallback(std::function<void()> const& callBackFct);
            void setVorticityMethodChangedCallback(std::function<void()> const& callBackFct);
            void setElasticityMethodChangedCallback(std::function<void()> const& callBackFct);

            void computeSurfaceTension();
            void computeViscosity();
            void computeVorticity();
            void computeDragForce();
            void computeElasticity();
            void computeXSPH();

            void saveState(BinaryFileWriter &binWriter);
            void loadState(BinaryFileReader &binReader);

#ifdef USE_PERFORMANCE_OPTIMIZATION
            inline std::vector<Vector3f8, Eigen::aligned_allocator<Vector3f8>> & get_precomputed_V_gradW() { return m_precomp_V_gradW; }
            inline std::vector<unsigned int>& get_precomputed_indices() { return m_precompIndices; }
            inline std::vector<unsigned int>& get_precomputed_indices_same_phase() { return m_precompIndicesSamePhase; }
#endif

            FORCE_INLINE Vector3r &getPosition0(const unsigned int i)
            {
                return m_x0[i];
            }

            FORCE_INLINE const Vector3r &getPosition0(const unsigned int i) const
            {
                return m_x0[i];
            }

            FORCE_INLINE void setPosition0(const unsigned int i, const Vector3r &pos)
            {
                m_x0[i] = pos;
            }

            FORCE_INLINE Vector3r &getPosition(const unsigned int i)
            {
                return m_x[i];
            }

            FORCE_INLINE const Vector3r &getPosition(const unsigned int i) const
            {
                return m_x[i];
            }

            FORCE_INLINE void setPosition(const unsigned int i, const Vector3r &pos)
            {
                m_x[i] = pos;
            }

            FORCE_INLINE Vector3r &getVelocity(const unsigned int i)
            {
                return m_v[i];
            }

            FORCE_INLINE const Vector3r &getVelocity(const unsigned int i) const
            {
                return m_v[i];
            }

            FORCE_INLINE void setVelocity(const unsigned int i, const Vector3r &vel)
            {
                m_v[i] = vel;
            }

            FORCE_INLINE Vector3r &getVelocity0(const unsigned int i)
            {
                return m_v0[i];
            }

            FORCE_INLINE const Vector3r &getVelocity0(const unsigned int i) const
            {
                return m_v0[i];
            }

            FORCE_INLINE void setVelocity0(const unsigned int i, const Vector3r &vel)
            {
                m_v0[i] = vel;
            }

            FORCE_INLINE Vector3r &getAcceleration(const unsigned int i)
            {
                return m_a[i];
            }

            FORCE_INLINE const Vector3r &getAcceleration(const unsigned int i) const
            {
                return m_a[i];
            }

            FORCE_INLINE void setAcceleration(const unsigned int i, const Vector3r &accel)
            {
                m_a[i] = accel;
            }

            FORCE_INLINE const Real getMass(const unsigned int i) const
            {
                return m_masses[i];
            }

            FORCE_INLINE Real& getMass(const unsigned int i)
            {
                return m_masses[i];
            }

            FORCE_INLINE void setMass(const unsigned int i, const Real mass)
            {
                m_masses[i] = mass;
            }

            FORCE_INLINE const Real& getDensity(const unsigned int i) const
            {
                return m_density[i];
            }

            FORCE_INLINE Real& getDensity(const unsigned int i)
            {
                return m_density[i];
            }

            FORCE_INLINE void setDensity(const unsigned int i, const Real &val)
            {
                m_density[i] = val;
            }

            FORCE_INLINE unsigned int& getParticleId(const unsigned int i)
            {
                return m_particleId[i];
            }

            FORCE_INLINE const unsigned int& getParticleId(const unsigned int i) const
            {
                return m_particleId[i];
            }

            FORCE_INLINE unsigned int& getObjectId(const unsigned int i)
            {
                return m_objectId[i];
            }

            FORCE_INLINE const unsigned int& getObjectId(const unsigned int i) const
            {
                return m_objectId[i];
            }

            FORCE_INLINE void setObjectId(const unsigned int i, const unsigned int val)
            {
                m_objectId[i] = val;
            }

            FORCE_INLINE const ParticleState& getParticleState(const unsigned int i) const
            {
                return m_particleState[i];
            }

            FORCE_INLINE ParticleState& getParticleState(const unsigned int i)
            {
                return m_particleState[i];
            }

            FORCE_INLINE void setParticleState(const unsigned int i, const ParticleState &val)
            {
                m_particleState[i] = val;
            }

            FORCE_INLINE const Real getVolume(const unsigned int i) const
            {
                return m_V;
            }

            FORCE_INLINE Real& getVolume(const unsigned int i)
            {
                return m_V;
            }
    };
}

#endif