include/PxMPMMaterial.h

File members: include/PxMPMMaterial.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2023 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.

#ifndef PX_MPM_MATERIAL_H
#define PX_MPM_MATERIAL_H
#include "PxParticleMaterial.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

    struct PxMPMMaterialModel
    {
        enum Enum
        {
            eATTACHED = 1 << 0,
            eNEO_HOOKEAN = 1 << 1,
            eELASTIC = 1 << 2,
            eSNOW = 1 << 3,
            eSAND = 1 << 4,
            eVON_MISES = 1 << 5
        };
    };

    struct PxMPMSurfaceType
    {
        enum Enum
        {
            eDEFAULT = 0,
            eSTICKY = 1 << 0,
            eSLIPPERY = 1 << 1
        };
    };

    struct PxMPMCuttingFlag
    {
        enum Enum
        {
            eNONE = 0,
            eSUPPORT_THIN_BLADES = 1 << 0,
            eENABLE_DAMAGE_TRACKING = 1 << 1
        };
    };
    typedef PxFlags<PxMPMCuttingFlag::Enum,PxU16> PxMPMCuttingFlags;
    PX_FLAGS_OPERATORS(PxMPMCuttingFlag::Enum,PxU16)

    class PxScene;

    class PxMPMMaterial : public PxParticleMaterial
    {
    public:
        virtual     void    setStretchAndShearDamping(PxReal stretchAndShearDamping) = 0;

        virtual PxReal getStretchAndShearDamping() const = 0;

        virtual     void    setRotationalDamping(PxReal rotationalDamping) = 0;

        virtual PxReal getRotationalDamping() const = 0;

        virtual     void    setDensity(PxReal density) = 0;

        virtual PxReal getDensity() const = 0;

        virtual     void    setMaterialModel(PxMPMMaterialModel::Enum materialModel) = 0;

        virtual PxMPMMaterialModel::Enum getMaterialModel() const = 0;

        virtual     void    setCuttingFlags(PxMPMCuttingFlags cuttingFlags) = 0;

        virtual PxMPMCuttingFlags getCuttingFlags() const = 0;

        virtual     void    setSandFrictionAngle(PxReal sandFrictionAngle) = 0;

        virtual PxReal  getSandFrictionAngle() const = 0;

        virtual     void    setYieldStress(PxReal yieldStress) = 0;

        virtual PxReal getYieldStress() const = 0;

        virtual     void    setIsPlastic(bool isPlastic) = 0;

        virtual     bool    getIsPlastic() const = 0;

        virtual     void    setYoungsModulus(PxReal young) = 0;

        virtual     PxReal  getYoungsModulus() const = 0;

        virtual     void    setPoissons(PxReal poisson) = 0;

        virtual     PxReal  getPoissons() const = 0;

        virtual     void    setHardening(PxReal hardening) = 0;

        virtual     PxReal  getHardening() const = 0;

        virtual     void    setCriticalCompression(PxReal criticalCompression) = 0;

        virtual     PxReal  getCriticalCompression() const = 0;

        virtual     void    setCriticalStretch(PxReal criticalStretch) = 0;

        virtual     PxReal  getCriticalStretch() const = 0;

        virtual     void    setTensileDamageSensitivity(PxReal tensileDamageSensitivity) = 0;

        virtual     PxReal  getTensileDamageSensitivity() const = 0;

        virtual     void    setCompressiveDamageSensitivity(PxReal compressiveDamageSensitivity) = 0;

        virtual     PxReal  getCompressiveDamageSensitivity() const = 0;

        virtual     void    setAttractiveForceResidual(PxReal attractiveForceResidual) = 0;

        virtual     PxReal  getAttractiveForceResidual() const = 0;

        virtual     const char*     getConcreteTypeName() const { return "PxMPMMaterial"; }

    protected:
        PX_INLINE           PxMPMMaterial(PxType concreteType, PxBaseFlags baseFlags) : PxParticleMaterial(concreteType, baseFlags) {}
        PX_INLINE           PxMPMMaterial(PxBaseFlags baseFlags) : PxParticleMaterial(baseFlags) {}
        virtual             ~PxMPMMaterial() {}
        virtual     bool    isKindOf(const char* name) const { PX_IS_KIND_OF(name, "PxMPMMaterial", PxParticleMaterial); }
    };

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif