The base class for joint constitutive model plug-ins. More...

#include <jointmodel.h>

Public Types
enum	EnergyKeys { kwEStrainShear = 1, kwEStrainCompression, kwEStrainTension, kwESlip }
	Default implementation 4 energies should be defined for each model (at least)

Public Member Functions
virtual String	getName () const =0
	Must be unique, used to identify model in save/restore, on command line, filename. More...

virtual String	getPluginName () const
	There should be no reason for an implementation to override the default behavior of this function.

virtual String	getFullName () const =0
	The full name of the model. More...

virtual UInt	getMinorVersion () const
	Returns minor version of base implementation, override for actual model. More...

virtual String	getProperties () const =0
	Returns a string containing the names of model properties. More...

virtual String	getStates () const =0
	Returns a string containing state names. More...

virtual Variant	getProperty (UInt index) const =0
	Return the value of the property of that index (base 1). More...

virtual void	setProperty (UInt index, const Variant &p, UInt restoreVersion=0)
	Sets the value of the property with index i (base 1). More...

virtual void	save (std::ostream &o) const

virtual void	restore (std::istream &i, UInt restoreVersion)
	Allows data other than properties to be restored efficiently.

virtual JointModel *	clone () const =0
	Returns an instance this class. More...

virtual Double	getMaxNormalStiffness () const =0
	This is used by the code to compute the stable timestep or adjust inertial mass. . More...

virtual Double	getMaxShearStiffness () const =0
	This is used by the code to compute the stable timestep or adjust inertial mass. . More...

virtual void	copy (const JointModel *mod)
	Copy property values and state from another constitutive model. More...

virtual void	run (UByte dim, State *s)
	Calculate force increments given a displacement increments. More...

virtual void	initialize (UByte dim, State *s)
	Initializes the constitutive model in preparation for calls to run(). More...

virtual Double	getStressStrengthRatio (const State &) const
	Returns the ratio of the shear force to the current yield strength. More...

virtual void	scaleProperties (const Double &, const std::vector< UInt > &)
	Scales failure property indices v by the factor f. More...

virtual bool	supportsStressStrengthRatio () const
	Returns true if strength-stress ratio calculations are supported via getStrengthStressRatio().

virtual bool	supportsPropertyScaling () const
	Returns true if property scaling is supported for factor-of-safety calculations via scaleProperties().

virtual void	destroy ()
	There should be no reason for an implementation to change the default behavior of this function.

virtual bool	isSliding (const State &)
	Return true if subcontact is sliding.

virtual bool	isBonded (const State &)
	Return true if subcontact is bonced. Used in fragment calculations.

virtual String	getEnergies () const

virtual double	getEnergy (UInt) const

virtual bool	getEnergyAccumulate (UInt) const

virtual void	setEnergy (UInt, const double &)

virtual void	activateEnergy ()

virtual bool	getEnergyActivated () const

	JointModel ()
	The joint constitutive model constructor. The model is invald, and canFail is set to true.

virtual	~JointModel ()
	The joint constitutive model destructor.

bool	isValid (UByte dimVal) const
	Indicates whether initializion is necessary - by dimension.

void	setValid (UByte dimVal)
	Sets the current valid state to dimension dim.

bool	canFail () const

void	setIfCanFail (bool b)
	Specifies whether or not "failure" is being allowed for this instanced of the constitutive model.

bool	getPlugIn () const
	Indicates whether the model was loaded as a plugin (defaults to false).

void	setPlugIn (bool b)

Static Public Member Functions
static UInt	getMajorVersion ()
	Major version changes when the interface changes - which is defined here.

static UInt	getLibraryMinorVersion ()
	Returns the minor version number of the constitutive model library. More...

Detailed Description

The base class for joint constitutive model plug-ins.

All joint constitutive models (elastic, mohr-coulomb, etc) are derived from this class.
Any custom joint constitutive model provided as a plug-in must be derived from this class.
Pure virtual methods must be provided by the user - some utility functions are provided.

Note: The file name of the DLL produced must be jmodel|name|###|.dll (in release) and model|name|###|_debug.dll (in debug).
Where |name| is the string returned by getName(), and |###| is the Major version number (3 digits, right justified, filled with zeros).
For instance jmodelelastic001.dll and jmodelelastic001_debug.dll

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

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description