Simple2DModel Class Reference

A base interfacing class that defines common operations. More...

#include <Simple2DModel.h>

Inheritance diagram for Simple2DModel:

Public Member Functions
virtual void	setGPU ()=0
	Enforce GPU-only operation. This is the default mode, so this method need not be called most of the time.
virtual void	setCPU ()=0
	Enforce CPU-only operation. Derived classes might have to do more work when the CPU mode is invoked.
virtual int	getNumberOfDegreesOfFreedom ()=0
	get the number of degrees of freedom, defaulting to the number of cells
virtual void	computeForces ()=0
	do everything necessary to compute forces in the current model
virtual void	getDynMatEntries (vector< int2 > &rcs, vector< Dscalar > &vals, Dscalar unstress=1.0, Dscalar stress=1.0)
	Do whatever is necessary to get lists of dynamical matrix elements.
virtual void	spatialSorting ()
	do everything necessary to perform a Hilbert sort
virtual void	enforceTopology ()
	do everything necessary to enforce the topology of the system
virtual void	getForces (GPUArray< Dscalar2 > &forces)=0
	copy the models current set of forces to the variable
virtual Dscalar	getMaxForce ()
	Return the maximum force.
virtual GPUArray< Dscalar2 > &	returnPositions ()=0
	return a reference to the GPUArray of positions
virtual GPUArray< Dscalar > &	returnMasses ()=0
	return a reference to the GPUArray of the masses
virtual GPUArray< Dscalar > &	returnOtherData ()=0
	return a reference to the GPUArray of other data (definable as needed in child classes)
virtual GPUArray< Dscalar2 > &	returnVelocities ()=0
	return a reference to the GPUArray of the current velocities
virtual GPUArray< Dscalar2 > &	returnForces ()=0
	return a reference to the GPUArray of the current forces
virtual void	moveDegreesOfFreedom (GPUArray< Dscalar2 > &displacements, Dscalar scale=1.)=0
	move the degrees of freedom
virtual Dscalar	reportq ()=0
	reporting function (remove later...)
virtual void	reportMeanCellForce (bool a)=0
	reporting function (remove later...)
virtual void	setTime (Dscalar time)
	set the time

Public Attributes
Dscalar	currentTime
	a time variable for keeping track of the simulation variable (for databases)

Detailed Description

A base interfacing class that defines common operations.

This provides an interface, guaranteeing that SimpleModel S will provide access to S.getNumberOfDegreesOfFreedom(); S.computeForces(); S.getMaxForce(); S.getDynMatEntries(); S.getForces(); S.moveDegreesOfFreedom(); S.enforceTopology(); S.spatialSorting(); S.returnVelocities(); S.returnMasses(); S.returnOtherData(); //this last will be a flat GPUArray of Dscalars...

---

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

• Simple2DModel.h