Mechanical contact model implementation. More...

#include <contactmodelmechanical.h>

Inheritance diagram for cmodelsxd::ContactModelMechanical:

Public Member Functions
	ContactModelMechanical ()
	Constructor.

virtual	~ContactModelMechanical ()
	Destructor.

virtual bool	isOKToDelete () const
	Generic implementation - by default it is always OK to delete a contact.

virtual ContactModel *	getContactModel ()
	Return the IContactModel pointer.

virtual const ContactModel *	getContactModel () const
	Return the const IContactModel pointer.

virtual bool	checkActivity (const double &)
	Default implementation - the contact is not active.

virtual bool	isSliding () const
	Default implementation - the contact model is not sliding.

virtual bool	isBonded () const
	Default implementation - the contact model is not bonded.

virtual void	unbond ()
	Default implementation - the contact model is not bonded.

virtual bool	hasNormal () const
	Default implementation - the contact model has no normal.

virtual DVect3	getNormal () const
	Default implementation - the contact model normal is the 0 vector.

virtual void	propagateStateInformation (IContactModelMechanical *, const CAxes &n=CAxes(), const CAxes &l=CAxes())
	Default implementation - state information is not propagated.

virtual bool	endPropertyUpdated (const QString &name, const IContactMechanical *c)=0

virtual bool	validate (ContactModelMechanicalState *state, const double &timestep)=0
	Returns true if contact is valid. Must be implemented.

virtual bool	forceDisplacementLaw (ContactModelMechanicalState *state, const double &timestep)=0

virtual bool	thermalCoupling (ContactModelMechanicalState , ContactModelThermalState , IContactThermal *, const double &)
	Used for explicit mechanical/thermal coupling. Returns true if anything changed.

virtual DVect2	getTimestepLimits (ContactModelMechanicalState *, const double &) const

virtual DVect2	getEffectiveTranslationalStiffness () const
	Return the effective translational stiffness - used for timestep calculation.

virtual DAVect	getEffectiveRotationalStiffness () const
	Return the effective rotational stiffness - used for timestep calculation.

virtual void	getSphereList (const IContact con, std::vector< DVect > pos, std::vector< double > rad, std::vector< double > val)
	Default implementation so that no sphere list must be defined.

virtual void	getCylinderList (const IContact con, std::vector< DVect > bot, std::vector< DVect > top, std::vector< double > radlow, std::vector< double > radhi, std::vector< double > val)
	Default implementation so that no cylinder list must be defined.

virtual DVect	getForce (const IContactMechanical *) const
	Return the total force that the contact model holds.

virtual DAVect	getMomentOn1 (const IContactMechanical *) const
	Return the total moment on 1 that the contact model holds.

virtual DAVect	getMomentOn2 (const IContactMechanical *c) const
	Return the total moment on 2 that the contact model holds.

virtual ContactModelMechanical *	clone () const
	Make a clone of this contact model. Must be implemeted.

Public Member Functions inherited from cmodelsxd::ContactModel
	ContactModel ()
	Constructor.

virtual	~ContactModel ()
	Destructor.

virtual void	archive (ArchiveStream &)
	Used for save/restore. Important to implement.

virtual void	copy (const ContactModel *cm)
	Copy the contact model from cm. Must be overridden in derived classes.

virtual QString	getName () const =0

virtual QString	getPluginName () const
	By default, the plugin name is the contact model name. Must be implemented in derived class.

virtual QString	getProperties () const =0
	Returns a comma delimited string that lists the contact model properies. Must be implemented in derived classes.

virtual QVariant	getProperty (uint i, const IContact *con=0) const =0

virtual bool	getPropertyGlobal (uint) const

virtual int	isProperty (const QString &c, Qt::CaseSensitivity cs=Qt::CaseInsensitive) const

virtual bool	setProperty (uint i, const QVariant &v, IContact *con=0)=0

virtual bool	getPropertyReadOnly (uint) const

virtual bool	supportsInheritance (uint) const

virtual bool	getInheritance (uint) const

virtual void	setInheritance (uint, bool)

virtual QString	getMethods () const

virtual int	isMethod (const QString &c, Qt::CaseSensitivity cs=Qt::CaseInsensitive) const
	Processing of a methods based on the method list returned by getMehtods.

virtual QString	getMethodArguments (uint) const
	Default implementation so that no methods must be defined.

virtual bool	setMethod (uint, const QVector< QVariant > &, IContact *c=0)
	By default, no methods must be defined.

virtual QString	getEnergies () const
	Default implementation so that no energies must be defined.

virtual int	isEnergy (const QString &c, Qt::CaseSensitivity cs=Qt::CaseInsensitive) const
	Default implementation so that no energies must be defined.

virtual double	getEnergy (uint) const
	Default implementation so that no energies must be defined.

virtual bool	getEnergyAccumulate (uint) const
	Default implementation so that no energies must be defined.

virtual void	setEnergy (uint, const double &)
	Default implementation so that no energies must be defined.

virtual void	activateEnergy ()
	Default implementation so that no energies must be defined.

virtual bool	getEnergyActivated () const
	Default implementation so that no energies must be defined.

virtual uint	getMinorVersion () const =0

virtual void	destroy ()

virtual QString	getFishCallEvents () const
	Return a comma delimited liest of FISH callback events.

void	setEventVal (int i, int j)
	Set the order of the contact model events as stored in the ContactModelList.

void	setFromParent (const ContactModel *cm)
	For executing events within the contact model.

virtual void	setNonForcePropsFrom (IContactModel *)

uint	getPropertyIndex (const QString &name, Qt::CaseSensitivity cs=Qt::CaseInsensitive) const

QString	getPropertyName (uint index) const
	Utility function that returns the property name given it's index.

void *	operator new (size_t size)

void *	operator new (size_t size, const char name, const char file, unsigned line)

void	operator delete (void *v)

void	operator delete (void v, const char name, const char *file, unsigned line)

Static Public Member Functions
static const char *	getPluginPrefix ()
	Prefix for this type of plugin.

static const char *	getPluginDirectory ()
	Directory for this type of plugin.

Static Public Member Functions inherited from cmodelsxd::ContactModel
static UInt	getMajorVersion ()

static AllocFunctions	setAllocFunctions (AllocFunctions afunc)

static AllocFunctions	getDefaultAllocFunctions ()

static AllocFunctions	getAllocFunctions ()

Additional Inherited Members
Public Types inherited from cmodelsxd::ContactModel
typedef void (	NewFunction) (size_t, const char , const char , unsigned)

typedef void(*	DeleteFunction) (void , const char , const char *, unsigned)

typedef std::pair< NewFunction, DeleteFunction >	AllocFunctions

Protected Attributes inherited from cmodelsxd::ContactModel
FArray< int, 5 >	cmEvents_
	Set of events as defined in a specified order. The int refers to the location of the event in the ContactModelMechanicalList.

Static Protected Attributes inherited from cmodelsxd::ContactModel
static NewFunction	newFunc_ = defaultNewFunction

static DeleteFunction	deleteFunc_ = defaultDeleteFunction

Detailed Description

Mechanical contact model implementation.

Member Function Documentation

◆ endPropertyUpdated()

virtual bool cmodelsxd::ContactModelMechanical::endPropertyUpdated	(	const QString &	name,
		const IContactMechanical *	c
	)

pure virtual

Returns true if the property was actually updated in the contact model. Used for inheritance of properties from piece. Must be implemented.

◆ forceDisplacementLaw()

virtual bool cmodelsxd::ContactModelMechanical::forceDisplacementLaw	(	ContactModelMechanicalState *	state,
		const double &	timestep
	)

pure virtual

Updates force acting on end2 and moments acting on end1 and end2. Returns true if contact is active. Must be implemented.

◆ getTimestepLimits()

virtual DVect2 cmodelsxd::ContactModelMechanical::getTimestepLimits	(	ContactModelMechanicalState *	,
		const double &
	)		const

inlinevirtual

Returns timestep limits (defaults to (0.0,infinity)). These are further timestep restrictions that the contact model can place on the simulation, over and above those implied by stiffness.

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

C:/Source/itasca-suite/common/contactmodel/src/contactmodelmechanical.h
C:/Source/itasca-suite/common/contactmodel/src/contactmodelmechanical.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ endPropertyUpdated()

◆ forceDisplacementLaw()

◆ getTimestepLimits()