doxygen/html/icontact_8h_source.html

#pragma once

// icontact.h


#include "dim.h"


namespace itasca {

    class IFishParam;

    class IThing;

    class IContainer;

}


namespace itascaxd {

    class IPiece;

    class IContactModel;

    using namespace itasca;


    class IContact {

    public:

        inline static const TType type_ = 0x4c815b85;


        virtual TType getContainerType() const=0;


        virtual IThing *              getIThing()=0;

        virtual const IThing *        getIThing() const=0;

        // Get the IContainer of the contact.

        virtual IContainer *          getContainer()=0;

        virtual const IContainer *    getContainer() const=0;


        virtual QString               getClassName() const=0;

        virtual IString               getTypeName() const=0;

        virtual bool                  getActive() const=0;

        virtual IPiece *              getEnd1()=0;

        virtual const IPiece *        getEnd1() const=0;

        virtual IPiece *              getEnd2()=0;

        virtual const IPiece *        getEnd2() const=0;

        virtual bool                  withWall() const=0;

        virtual CAxes                 getLocalSystem() const=0;

        virtual DVect                 getPosition() const=0;

        virtual DVect3                getNormal() const=0;

        virtual double                getGap() const=0;

        virtual double                getArea() const=0;

        virtual DVect2                getCharacteristicLength() const=0;

        virtual bool                  getInhibit() const=0;

        virtual bool                  getAlwaysActive() const=0;

        virtual bool                  getNeverDelete() const=0;

        virtual bool                  canDelete() const=0;

        virtual IContactModel *       getModel() =0;

        virtual const IContactModel * getModel() const=0;

        virtual QString               getModelName() const=0;

        virtual IContactModel        *setModelName(const QString &name)=0;

        virtual IContactModel        *setModel(const IContactModel *toClone,bool validate=true)=0;


        virtual bool                  isMechanical() const=0;

        virtual bool                  isThermal() const=0;

        virtual IContact *            getParent() =0;

        virtual const IContact *      getParent() const =0;

        virtual void                  setInhibit(bool b)=0;

        virtual void                  setAlwaysActive(bool b)=0;

        virtual void                  setNeverDelete(bool b)=0;

        virtual void                  setFix(bool b)=0;

        virtual uint32                  getFID() const=0;

        virtual void                  setActive(bool b)=0;

        virtual void                  setFID(uint32 i)=0;

        virtual void                  setOffSet(const DVect &v)=0;

        virtual DVect                 getOffSet() const =0;

        virtual bool                  getIsWithGhost() const=0;

        // Extra Variable Section

        virtual bool                  amInterestedIn(const QString &cmodel) const=0;

        virtual void                  clean(bool addStiffness)=0;

        virtual QVariant              getProperty(const QString &name) const=0;

        virtual bool                  setProperty(const QVariant &v,const QString &name)=0;

        virtual uint32                  getPropertyIndex(const QString &name) const=0;

        virtual QString               getPropertyName(uint32 index) const=0;

        virtual void                  tagPropertyNotice()=0;

        virtual IContact *            getIContact()=0;

        virtual TType                 getDerivedType() const=0;

        virtual void                  getAssociatedThingsContact(std::vector<const IThing*> &) const=0;


    };


} // namespace itasca


// EoF

CAxes3D
Class for specifying a particular 3D cartesian axes system, and converting to and from it.
Definition caxes.h:103

IString
Definition istring.h:14

itasca::IContainer
Interface for containers of IThings.
Definition icontainer.h:21

itasca::IThing
Base class for items that will be stored in containers.
Definition ithing.h:30

itascaxd::IContact
Contact class.
Definition icontact.h:33

itascaxd::IContact::getParent
virtual IContact * getParent()=0

itascaxd::IContact::type_
static const TType type_
The type identification number for this class, for use in convert_cast() and convert_getcast().
Definition icontact.h:36

itascaxd::IContact::canDelete
virtual bool canDelete() const =0

itascaxd::IContact::setNeverDelete
virtual void setNeverDelete(bool b)=0
sets the never delete condition flag

itascaxd::IContact::getIsWithGhost
virtual bool getIsWithGhost() const =0
Gets whether or not the contact is with a ghost.

itascaxd::IContact::withWall
virtual bool withWall() const =0
returns whether or not a contact is with a wall

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

itascaxd::IContact::getIThing
virtual IThing * getIThing()=0
returns a IThing pointer

itascaxd::IContact::getGap
virtual double getGap() const =0
returns the gap where, for a mechanical contact, negative gap corresponds to physical overlap.

itascaxd::IContact::isMechanical
virtual bool isMechanical() const =0
Returns TRUE if the contact is a mechanical contact - meaning it is derived from IContactMechanical.

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

itascaxd::IContact::isThermal
virtual bool isThermal() const =0
Returns TRUE if the contact is a thermal contact - meaning it is derived from IContactThermal.

itascaxd::IContact::setFID
virtual void setFID(uint32 i)=0
Sets the FID ID number, an integer tag associated with each contact.

itascaxd::IContact::getEnd1
virtual IPiece * getEnd1()=0
returns a pointer to the contact first IPiece object (e.g. a ball)

itascaxd::IContact::setFix
virtual void setFix(bool b)=0
sets the fix condition flag

itascaxd::IContact::getContainerType
virtual TType getContainerType() const =0
Get the terminal interface TType of the instantiated contact.

itascaxd::IContact::getLocalSystem
virtual CAxes getLocalSystem() const =0
returns the contact local system axes

itascaxd::IContact::getAssociatedThingsContact
virtual void getAssociatedThingsContact(std::vector< const IThing * > &) const =0
Get a list of other things associated with contacts, like zone gridpoints.

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

itascaxd::IContact::setActive
virtual void setActive(bool b)=0
Sets the activity flag.

itascaxd::IContact::getArea
virtual double getArea() const =0
returns the area which is 0 for non-mechanical contacts and 0 if no area is used

itascaxd::IContact::amInterestedIn
virtual bool amInterestedIn(const QString &cmodel) const =0
Returns true if the contact model can be assigned to this contact.

itascaxd::IContact::getAlwaysActive
virtual bool getAlwaysActive() const =0
returns true to indicate always active condition

itascaxd::IContact::setAlwaysActive
virtual void setAlwaysActive(bool b)=0
sets the alwaysActive condition flag

itascaxd::IContact::getEnd2
virtual IPiece * getEnd2()=0
returns a pointer to the contact second IPiece object (e.g. a wall)

itascaxd::IContact::getNeverDelete
virtual bool getNeverDelete() const =0
returns true to indicate never delete condition

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

itascaxd::IContact::clean
virtual void clean(bool addStiffness)=0
Clean the contact, updating activity state.

itascaxd::IContact::getOffSet
virtual DVect getOffSet() const =0
Gets the contact offset (which is added to position of end2)

itascaxd::IContact::getIContact
virtual IContact * getIContact()=0
Return self.

itascaxd::IContact::getNormal
virtual DVect3 getNormal() const =0
returns a normal vector to the contact

itascaxd::IContact::getModel
virtual IContactModel * getModel()=0
returns contact model

itascaxd::IContact::getClassName
virtual QString getClassName() const =0
returns a string describing the contact class (eg. "mechanical")

itascaxd::IContact::getProperty
virtual QVariant getProperty(const QString &name) const =0
returns the value of the property with name name

itascaxd::IContact::getTypeName
virtual IString getTypeName() const =0
returns a string describing the contact class (eg. "mechanical")

itascaxd::IContact::getPosition
virtual DVect getPosition() const =0
returns the contact position

itascaxd::IContact::getActive
virtual bool getActive() const =0
returns true if the contact object is active

itascaxd::IContact::getModelName
virtual QString getModelName() const =0
returns the name of the contact model present at this mechanical contact

itascaxd::IContact::setOffSet
virtual void setOffSet(const DVect &v)=0
Sets the contact offset (which will be added to position of end2)

itascaxd::IContact::getCharacteristicLength
virtual DVect2 getCharacteristicLength() const =0
Returns the length from getPosition() in the normal direction that is generally representative of the...

itascaxd::IContact::setInhibit
virtual void setInhibit(bool b)=0
sets the inhibit condition flag

itascaxd::IContact::getFID
virtual uint32 getFID() const =0
Gets the FID ID number, an integer tag associated with each contact.

itascaxd::IContact::getInhibit
virtual bool getInhibit() const =0
returns true to indicate inhibit condition

itascaxd::IContact::tagPropertyNotice
virtual void tagPropertyNotice()=0
Tag the contact property notice.

itascaxd::IContact::getDerivedType
virtual TType getDerivedType() const =0
Get the ultimate derived type.

itascaxd::IPiece
Definition ipiece.h:15

dim.h
DIM - Provides code portability between 2D and 3D codes.

TType
uint32 TType
class type indicator
Definition basedef.h:46

DVect
DVect3 DVect
Vector of doubles, either 2D or 3D.
Definition dim.h:154

itasca
namespace Itasca
Definition basememory.cpp:14

itascaxd
Itasca Library standard namespace, specific to 2D or 3D.
Definition icontactmodule.h:4