AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agx::BulkMaterial Class Reference

Physical properties for the bulk of geometries made up by a Material. More...

#include <Material.h>

+ Inheritance diagram for agx::BulkMaterial:

Public Member Functions

 BulkMaterial ()
 Default constructor.
 
virtual ~BulkMaterial ()
 Destructor.
 
void copy (const BulkMaterial *source)
 Copy all the attributes of copy_material to this.
 
Real getDamping () const
 This is the damping factor that is used by the contact constraint.
 
Real getDensity () const
 Get the density of a material.
 
Real getMaxElasticRestLength () const
 Get the maximum elastic rest length of the bulk material.
 
Real getMinElasticRestLength () const
 Get the minimum elastic rest length of the bulk material.
 
Real getViscosity () const
 
Real getYoungsModulus () const
 
bool isDirty () const
 
void setDamping (Real damping)
 Set the damping factor used by the contact constraint.
 
void setDensity (Real density)
 Set the density of a material.
 
bool setMinMaxElasticRestLength (Real minElasticRestLength, Real maxElasticRestLength)
 Set the minimum and maximum elastic rest length of the bulk material.
 
void setViscosity (Real viscosity)
 Set the bulk viscosity coefficient of the material (1 - restitution coefficient).
 
void setYoungsModulus (Real value)
 Set the Young's modulus of the material, same as spring coefficient k.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
- Public Member Functions inherited from agxStream::Serializable
virtual ~Serializable ()
 Destructor for normal C++ use but hidden from SWIG bindings.
 
virtual const char * getClassName () const
 
bool getEnableSerialization () const
 
bool getEnableUuidGeneration ()
 
agx::UInt32 getIndex () const
 This index is given at creation of this object.
 
virtual StorageAgent * getStorageAgent () const =0
 
agx::Uuid getUuid () const
 
bool isFinished () const
 
void setEnableSerialization (bool flag)
 Set to false to disable serialization of this object.
 
void setFinished ()
 Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
 
void setUuid (const agx::Uuid &uuid)
 Explicitly set a Uuid on a serializable object.
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Static Public Member Functions inherited from agxStream::Serializable
static void setEnableUuidGeneration (bool flag)
 Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Protected Member Functions inherited from agxStream::Serializable
 Serializable ()
 Default constructor.
 
 Serializable (const Serializable &other)
 Copy constructor.
 
void generateUuid ()
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

Physical properties for the bulk of geometries made up by a Material.

Definition at line 70 of file Material.h.

Constructor & Destructor Documentation

◆ BulkMaterial()

agx::BulkMaterial::BulkMaterial ( )

Default constructor.

◆ ~BulkMaterial()

virtual agx::BulkMaterial::~BulkMaterial ( )
virtual

Destructor.

Member Function Documentation

◆ copy()

void agx::BulkMaterial::copy ( const BulkMaterial *  source)

Copy all the attributes of copy_material to this.

◆ getDamping()

Real agx::BulkMaterial::getDamping ( ) const

This is the damping factor that is used by the contact constraint.

The value is the time the contact constraint has to fulfill its violation.

Definition at line 1013 of file Material.h.

◆ getDensity()

Real agx::BulkMaterial::getDensity ( ) const

Get the density of a material.

Returns
The density of the material in SI units.

Definition at line 1023 of file Material.h.

◆ getMaxElasticRestLength()

Real agx::BulkMaterial::getMaxElasticRestLength ( ) const

Get the maximum elastic rest length of the bulk material.

This is only used if the contact area approach is used (getUseContactAreaApproach()==true). For the effect of the elastic rest length, see the user manual.

Return values
maxElasticRestLengthThe max elastic rest length.

◆ getMinElasticRestLength()

Real agx::BulkMaterial::getMinElasticRestLength ( ) const

Get the minimum elastic rest length of the bulk material.

This is only used if the contact area approach is used (getUseContactAreaApproach()==true). For the effect of the elastic rest length, see the user manual.

Return values
minElasticRestLengthThe min elastic rest length.

◆ getViscosity()

Real agx::BulkMaterial::getViscosity ( ) const
Returns
the bulk viscosity coefficient (1 - restitution coefficient) of this material.

Definition at line 1008 of file Material.h.

◆ getYoungsModulus()

Real agx::BulkMaterial::getYoungsModulus ( ) const
Returns
the Young's modulus of the material.

Definition at line 1018 of file Material.h.

◆ isDirty()

bool agx::BulkMaterial::isDirty ( ) const
Returns
true if any of the attributes in the BulkMaterial is changed since last setDirty( false );

Definition at line 1028 of file Material.h.

◆ setDamping()

void agx::BulkMaterial::setDamping ( Real  damping)

Set the damping factor used by the contact constraint.

The value is the time the contact constraint has to fulfill its violation.

Parameters
damping- the new damping.

◆ setDensity()

void agx::BulkMaterial::setDensity ( Real  density)

Set the density of a material.

The density can be used for automatic calculation of massProperties. Observe that changing the density does NOT lead to an automatically new calculated mass/inertia for any RigidBodies that have Geometries with this material. To reflect a change in density, an explicit call to RigidBody::updateMassProperties() has to be done.

◆ setMinMaxElasticRestLength()

bool agx::BulkMaterial::setMinMaxElasticRestLength ( Real  minElasticRestLength,
Real  maxElasticRestLength 
)

Set the minimum and maximum elastic rest length of the bulk material.

This is only used if the contact area approach is used (getUseContactAreaApproach()==true). It sets the minimum and maximum allowed value for the elastic rest length of the material - values below will be clamped to the min, values above will be clamped to the max. In contact between materials m1 and m2, the min elastic rest of the contact material cm(m1, m2) will have the sum of m1's and m2's min elastic rest length, and the max elastic rest length of cm(m1, m2) will be the sum of m1's and m2's max elastic rest length, unless these values are set at the contact material directly. For the effect of the elastic rest length, see the user manual.

Parameters
minElasticRestLengthThe min elastic rest length. Only values > 0 allowed. Has to be <= maxElasticRestLength.
maxElasticRestLengthThe max elastic rest length. Only values > 0 allowed. Has to be >= minElasticRestLength.
Return values
Success- Are the values in the allowed range and have thus been applied?

◆ setViscosity()

void agx::BulkMaterial::setViscosity ( Real  viscosity)

Set the bulk viscosity coefficient of the material (1 - restitution coefficient).

Parameters
viscosity- The new viscosity

◆ setYoungsModulus()

void agx::BulkMaterial::setYoungsModulus ( Real  value)

Set the Young's modulus of the material, same as spring coefficient k.


The documentation for this class was generated from the following file: