include/FluidParticle.h

Go to the documentation of this file.

#ifndef FLUIDPARTICLE_H
#define FLUIDPARTICLE_H

#include "Particle.h"


class FluidParticle : public Particle
{
public:
    FluidParticle();

    FluidParticle(const FluidParticle& _fluidParticle);

    FluidParticle
        (
            const int _id,
            const ngl::Real _mass = 0,
            const ngl::Real _density = 0,
            const ngl::Vector _position = 0,
            const ngl::Vector _velocity = 0,
            const ngl::Real _viscosityConstant = 0,
            const ngl::Real _gasConstant = 0,
            const ngl::Real _surfaceTensionCoefficient = 0,
            const ngl::Real _surfaceTensionThreshold = 0,
            const ngl::Real _surfaceColorCoefficient = 0,
            const ngl::Real _interfaceTensionCoefficient = 0,
            const ngl::Real _interfaceTensionThreshold = 0,
            const ngl::Real _interfaceColorCoefficient = 0,
            const ngl::Colour _colour = 0,
            const ngl::Real _radius = 0,
            const std::string _name = "na",
            const bool _waitUntilFirstHitBoundary = false,
            const bool _waitUntilFirstHitRBD = false
        );

    ~FluidParticle();

    void calculatePressure();

    void resetForce();

    inline std::string getName() const { return m_name; }

    inline ngl::Vector getPressureForce() const { return m_pressureForce; }

    inline void setPressureForce(const ngl::Vector _f) { m_pressureForce = _f; }

    inline ngl::Vector getViscosityForce() const { return m_viscosityForce; }

    inline void setViscosityForce(const ngl::Vector _f) { m_viscosityForce = _f; }

    inline ngl::Vector getSurfaceTensionForce() const { return m_surfaceTensionForce; }

    inline void setSurfaceTensionForce(const ngl::Vector _f) { m_surfaceTensionForce = _f; }

    inline ngl::Vector getInterfaceTensionForce() const { return m_interfaceTensionForce; }

    inline void setInterfaceTensionForce(const ngl::Vector _f) { m_interfaceTensionForce = _f; }

    inline ngl::Vector getGravityForce() const { return m_gravityForce; }

    inline void setGravityForce(const ngl::Vector _f) { m_gravityForce = _f; }

    inline ngl::Real getPressure() const { return m_pressure; }

    inline ngl::Real getDensity() const { return m_density; }

    inline void setDensity(const ngl::Real _d) { m_density = _d; }

    inline ngl::Real getMaterialRestDensity() const { return m_materialRestDensity; }

    inline void setMaterialRestDensity(const ngl::Real _v) { m_materialRestDensity = _v; }

    inline ngl::Real getGasConstant() const { return m_gasConstant; }

    inline void setGasConstant(const ngl::Real _c) { m_gasConstant = _c; }

    inline ngl::Real getViscosityConstant() const { return m_viscosityConstant; }

    inline void setViscosityConstant(const ngl::Real _c) { m_viscosityConstant = _c; }

    inline ngl::Real getSurfaceTensionCoefficient() const { return m_surfaceTensionCoefficient; }

    inline void setSurfaceTensionCoefficient(const ngl::Real _c) { m_surfaceTensionCoefficient = _c; }

    inline ngl::Real getSurfaceTensionThreshold() const { return m_surfaceTensionThreshold; }

    inline void setSurfaceTensionThreshold(const ngl::Real _c) { m_surfaceTensionThreshold = _c; }

    inline ngl::Real getSurfaceColorCoefficient() const { return m_surfaceColorCoefficient; }

    inline void setSurfaceColorCoefficient(const ngl::Real _c) { m_surfaceColorCoefficient = _c; }

    inline ngl::Real getInterfaceTensionCoefficient() const { return m_interfaceTensionCoefficient; }

    inline void setInterfaceTensionCoefficient(const ngl::Real _c) { m_interfaceTensionCoefficient = _c; }

    inline ngl::Real getInterfaceTensionThreshold() const { return m_interfaceTensionThreshold; }

    inline void setInterfaceTensionThreshold(const ngl::Real _c) { m_interfaceTensionThreshold = _c; }

    inline ngl::Real getInterfaceColorCoefficient() const { return m_interfaceColorCoefficient; }

    inline void setInterfaceColorCoefficient(const ngl::Real _c) { m_interfaceColorCoefficient = _c; }

    void updateHitForTheFirstTime
                (
                    const bool _hitBoundary,
                    const bool _hitRBD
                );

    inline bool fluidRulesEnabled() const { return (m_waitUntilFirstHitBoundary || m_waitUntilFirstHitRBD) ? m_hasHitEnvironmentYet : true; }

    inline void setWaitUntilFirstHitBoundary(const bool _v) { m_waitUntilFirstHitBoundary = _v; }

    inline void setWaitUntilFirstHitRBD(const bool _v) { m_waitUntilFirstHitRBD = _v; }

private:
    std::string m_name;

    ngl::Vector m_pressureForce;

    ngl::Vector m_viscosityForce;

    ngl::Vector m_surfaceTensionForce;

    ngl::Vector m_interfaceTensionForce;

    ngl::Vector m_gravityForce;

    ngl::Real m_density;

    ngl::Real m_materialRestDensity;

    ngl::Real m_pressure;

    ngl::Real m_viscosityConstant;

    ngl::Real m_gasConstant;

    ngl::Real m_surfaceTensionCoefficient;

    ngl::Real m_surfaceTensionThreshold;

    ngl::Real m_surfaceColorCoefficient;

    ngl::Real m_interfaceTensionCoefficient;

    ngl::Real m_interfaceTensionThreshold;

    ngl::Real m_interfaceColorCoefficient;

    bool m_hasHitEnvironmentYet;

    bool m_waitUntilFirstHitBoundary;

    bool m_waitUntilFirstHitRBD;

};

#endif // FLUIDPARTICLE_H