Contact model implementation. More...

#include <contactmodel.h>

Inheritance diagram for cmodelsxd::ContactModel:

Public Types
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

Public Member Functions
	ContactModel ()
	Constructor.

virtual	~ContactModel ()
	Destructor.

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

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

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 IContactModel *	getContactModel ()
	Return the IContactModel pointer.

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

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 void	getSphereList (const IContact con, std::vector< DVect > pos, std::vector< double > rad, std::vector< double > val)=0
	For contact specific plotting.

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)=0
	For contact specific plotting.

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 UInt	getMajorVersion ()

static AllocFunctions	setAllocFunctions (AllocFunctions afunc)

static AllocFunctions	getDefaultAllocFunctions ()

static AllocFunctions	getAllocFunctions ()

Protected Attributes
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
static NewFunction	newFunc_ = defaultNewFunction

static DeleteFunction	deleteFunc_ = defaultDeleteFunction

Detailed Description

Contact model implementation.

Member Function Documentation

◆ getProperty()

virtual QVariant cmodelsxd::ContactModel::getProperty	(	uint	i,
		const IContact *	con = `0`
	)		const

pure virtual

Returns a QVariant corresponding to the property with position i in the string returned by getProperties(). Must be implemented in derived classes.

Parameters

i	Position index in the comma-delimited property list string.
con	Optional contact pointer. This pointer is null if the contact model instance is not assigned to any contact.

◆ getPropertyGlobal()

virtual bool cmodelsxd::ContactModel::getPropertyGlobal ( uint ) const

inlinevirtual

Returns a boolean indicating whether the property with a given index (see the getProperty() method description) is expressed in the global coordinate system or in the contact local coordinate system. This is important for vectors. Must be overridden in derived classes.

◆ getPropertyIndex()

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

Utility function that returns the property index based on its name, or 0 if property doesn't exist. Case insensitive by default.

◆ isProperty()

int cmodelsxd::ContactModel::isProperty	(	const QString &	c,
		Qt::CaseSensitivity	cs = `Qt::CaseInsensitive`
	)		const

virtual

Returns the integer index of a property based on the property list returned by getProperties, starting at 1. This method overrides the IContactModel pure virtual method, and should not be overridden by derived classes.

◆ setNonForcePropsFrom()

virtual void cmodelsxd::ContactModel::setNonForcePropsFrom ( IContactModel * )

inlinevirtual

For setting the contact model properties from another contact model but without changing the forces - just the properties.

◆ setProperty()

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

pure virtual

Set the value of the property at position i in the string returned by getProperties(). Must be implemented in derived classes.

Parameters

i	Position index in the comma-delimited property list string.
v	QVariant holding the value to be set.
con	Optional contact pointer. This pointer is null if the contact model instance is not assigned to any contact.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes