Itasca C++ Interface
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
itascaxd::IContact Class Referenceabstract

Contact class. More...

#include <icontact.h>

Public Member Functions

virtual TType getContainerType () const =0
 Get the terminal interface TType of the instantiated contact.
 
virtual IThinggetIThing ()=0
 returns a IThing pointer
 
virtual const IThinggetIThing () const =0
 
virtual IContainergetContainer ()=0
 
virtual const IContainergetContainer () const =0
 
virtual QString getClassName () const =0
 returns a string describing the contact class (eg. "mechanical")
 
virtual IString getTypeName () const =0
 returns a string describing the contact class (eg. "mechanical")
 
virtual bool getActive () const =0
 returns true if the contact object is active
 
virtual IPiecegetEnd1 ()=0
 returns a pointer to the contact first IPiece object (e.g. a ball)

 
virtual const IPiecegetEnd1 () const =0
 
virtual IPiecegetEnd2 ()=0
 returns a pointer to the contact second IPiece object (e.g. a wall)
 
virtual const IPiecegetEnd2 () const =0
 
virtual bool withWall () const =0
 returns whether or not a contact is with a wall
 
virtual CAxes getLocalSystem () const =0
 returns the contact local system axes
 
virtual DVect getPosition () const =0
 returns the contact position
 
virtual DVect3 getNormal () const =0
 returns a normal vector to the contact
 
virtual double getGap () const =0
 returns the gap where, for a mechanical contact, negative gap corresponds to physical overlap.
 
virtual double getArea () const =0
 returns the area which is 0 for non-mechanical contacts and 0 if no area is used
 
virtual DVect2 getCharacteristicLength () const =0
 Returns the length from getPosition() in the normal direction that is generally representative of the contact (for plotting).
 
virtual bool getInhibit () const =0
 returns true to indicate inhibit condition
 
virtual bool getAlwaysActive () const =0
 returns true to indicate always active condition
 
virtual bool getNeverDelete () const =0
 returns true to indicate never delete condition
 
virtual bool canDelete () const =0
 
virtual IContactModel * getModel ()=0
 returns contact model
 
virtual const IContactModel * getModel () const =0
 
virtual QString getModelName () const =0
 returns the name of the contact model present at this mechanical contact

 
virtual IContactModel * setModelName (const QString &name)=0
 assigns the contact model based on a name

 
virtual IContactModel * setModel (const IContactModel *toClone, bool validate=true)=0
 
virtual bool isMechanical () const =0
 Returns TRUE if the contact is a mechanical contact - meaning it is derived from IContactMechanical.
 
virtual bool isThermal () const =0
 Returns TRUE if the contact is a thermal contact - meaning it is derived from IContactThermal.
 
virtual IContactgetParent ()=0
 
virtual const IContactgetParent () const =0
 
virtual void setInhibit (bool b)=0
 sets the inhibit condition flag
 
virtual void setAlwaysActive (bool b)=0
 sets the alwaysActive condition flag
 
virtual void setNeverDelete (bool b)=0
 sets the never delete condition flag
 
virtual void setFix (bool b)=0
 sets the fix condition flag
 
virtual uint32 getFID () const =0
 Gets the FID ID number, an integer tag associated with each contact.
 
virtual void setActive (bool b)=0
 Sets the activity flag.
 
virtual void setFID (uint32 i)=0
 Sets the FID ID number, an integer tag associated with each contact.
 
virtual void setOffSet (const DVect &v)=0
 Sets the contact offset (which will be added to position of end2)
 
virtual DVect getOffSet () const =0
 Gets the contact offset (which is added to position of end2)
 
virtual bool getIsWithGhost () const =0
 Gets whether or not the contact is with a ghost.
 
virtual bool amInterestedIn (const QString &cmodel) const =0
 Returns true if the contact model can be assigned to this contact.
 
virtual void clean (bool addStiffness)=0
 Clean the contact, updating activity state.
 
virtual QVariant getProperty (const QString &name) const =0
 returns the value of the property with name name

 
virtual bool setProperty (const QVariant &v, const QString &name)=0
 sets the value of the property with name name

 
virtual uint32 getPropertyIndex (const QString &name) const =0
 returns the index of the property with name name

 
virtual QString getPropertyName (uint32 index) const =0
 returns the name of the property with index index

 
virtual void tagPropertyNotice ()=0
 Tag the contact property notice.
 
virtual IContactgetIContact ()=0
 Return self.
 
virtual TType getDerivedType () const =0
 Get the ultimate derived type.
 
virtual void getAssociatedThingsContact (std::vector< const IThing * > &) const =0
 Get a list of other things associated with contacts, like zone gridpoints.
 

Static Public Attributes

static const TType type_ = 0x4c815b85
 The type identification number for this class, for use in convert_cast() and convert_getcast().
 

Detailed Description

Contact class.

Contacts may exist between two IPiece objects (e.g. between two balls or between a ball and a wall). They are formed and broken automatically during the course of a simulation.

The behavior of a material is simulated by associating a constitutive model with each contact.

Member Function Documentation

◆ canDelete()

virtual bool itascaxd::IContact::canDelete ( ) const
pure virtual

Returns TRUE to indicate that it is OK to delete the contact It is expected that CELL SPACE checking occurs here! Note: Criteria should match that used by contact detection, or you can create a situation where contacts are detroyed/created constantly.

◆ getParent()

virtual IContact * itascaxd::IContact::getParent ( )
pure virtual

Return a pointer to the parent contact, i.e. the contact that this one has been slaved to upon creation and destruction.


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