cmodelsxd::ContactModelFluid Class Reference

Inheritance diagram for cmodelsxd::ContactModelFluid:

Public Member Functions
IContactModel *	getContactModel () override
const IContactModel *	getContactModel () const override
double	getActivityDistance () const override
virtual double	getMassDensity () const
virtual double	getMobilityCoef () const
virtual double	getSpecificStorage () const
void	getSphereList (const IContact *, std::vector< DVect > *, std::vector< double > *, std::vector< double > *) override
void	getCylinderList (const IContact *, std::vector< DVect > *, std::vector< DVect > *, std::vector< double > *, std::vector< double > *, std::vector< double > *) override
Public Member Functions inherited from cmodelsxd::ContactModel
	ContactModel ()
	Constructor.
virtual	~ContactModel ()
	Destructor.
virtual ContactModel *	clone () const
	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.
IContactModel *	getContactModel () override
	Return the IContactModel pointer.
const IContactModel *	getContactModel () const override
	Return the const IContactModel pointer.
string	getName () const override
virtual string	getPluginName () const
	By default, the plugin name is the contact model name. Must be implemented in derived class.
string	getProperties () const override
	Returns a comma delimited string that lists the contact model properies. Must be implemented in derived classes.
base::Property	getProperty (uint32 i, const IContact *con=0) const override
bool	getPropertyGlobal (uint32) const override
int	isProperty (const string &c) const override
bool	setProperty (uint32 i, const base::Property &v, IContact *con=0) override
bool	getPropertyReadOnly (uint32) const override
bool	supportsInheritance (uint32) const override
bool	getInheritance (uint32) const override
void	setInheritance (uint32, bool) override
string	getMethods () const override
int	isMethod (const string &c) const override
	Processing of a methods based on the method list returned by getMehtods.
string	getMethodArguments (uint32) const override
	Default implementation so that no methods must be defined.
bool	setMethod (uint32, const std::vector< base::Property > &, IContact *c=0) override
	By default, no methods must be defined.
string	getEnergies () const override
	Default implementation so that no energies must be defined.
int	isEnergy (const string &c) const override
	Default implementation so that no energies must be defined.
double	getEnergy (uint32) const override
	Default implementation so that no energies must be defined.
bool	getEnergyAccumulate (uint32) const override
	Default implementation so that no energies must be defined.
void	setEnergy (uint32, const double &) override
	Default implementation so that no energies must be defined.
void	activateEnergy () override
	Default implementation so that no energies must be defined.
virtual bool	getEnergyActivated () const
	Default implementation so that no energies must be defined.
uint32	getMinorVersion () const override
void	destroy () override
void	getSphereList (const IContact *, std::vector< DVect > *, std::vector< double > *, std::vector< double > *) override
	For contact specific plotting.
void	getCylinderList (const IContact *, std::vector< DVect > *, std::vector< DVect > *, std::vector< double > *, std::vector< double > *, std::vector< double > *) override
	For contact specific plotting.
virtual string	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.
void	setNonForcePropsFrom (IContactModel *) override
uint32	getPropertyIndex (const string &name) const
string	getPropertyName (uint32 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 *file, unsigned line)
void	operator delete (void *v)
void	operator delete (void *v, const char *file, unsigned line)
virtual void	objectPropsTypes (std::vector< std::pair< string, InfoTypes > > *) const
virtual void	objectPropValues (std::vector< double > *, const IContact *) const

Static Public Member Functions
static const char *	getPluginPrefix ()
static const char *	getPluginDirectory ()
Static Public Member Functions inherited from cmodelsxd::ContactModel
static uint32	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 *, unsigned)
typedef void(*	DeleteFunction) (void *, 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

---

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

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