MPCDAnalysis.StarPolymersAnalysis.Base.Base Class Reference

Inheritance diagram for MPCDAnalysis.StarPolymersAnalysis.Base.Base:

Collaboration diagram for MPCDAnalysis.StarPolymersAnalysis.Base.Base:

Public Member Functions
def	__init__ (self, run)
def	setWritePath (self, writePath)
def	getRun (self)
def	getValueAsFunctionOfTime (self)
def	updateCache (self, forced=False)

Detailed Description

Definition at line 3 of file Base.py.

Constructor & Destructor Documentation

__init__()

def MPCDAnalysis.StarPolymersAnalysis.Base.Base.__init__	(		self,
			run
	)

    The constructor.

    @param[in] run
               The run in question, which must be an instance of `Run`.

Reimplemented in MPCDAnalysis.StarPolymersAnalysis.EckartAngularVelocityVector.EckartAngularVelocityVector, MPCDAnalysis.StarPolymersAnalysis.OrientationAngles.OrientationAngles, MPCDAnalysis.StarPolymersAnalysis.Acylindricity.Acylindricity, MPCDAnalysis.StarPolymersAnalysis.Asphericity.Asphericity, MPCDAnalysis.StarPolymersAnalysis.GyrationTensor.GyrationTensor, MPCDAnalysis.StarPolymersAnalysis.MagneticClusterCount.MagneticClusterCount, MPCDAnalysis.StarPolymersAnalysis.PotentialEnergy.PotentialEnergy, MPCDAnalysis.StarPolymersAnalysis.RadiusOfGyration.RadiusOfGyration, MPCDAnalysis.StarPolymersAnalysis.RelativeShapeAnisotropy.RelativeShapeAnisotropy, and MPCDAnalysis.StarPolymersAnalysis.RotationFrequencyVector.RotationFrequencyVector.

Definition at line 17 of file Base.py.

Member Function Documentation

getRun()

def MPCDAnalysis.StarPolymersAnalysis.Base.Base.getRun

(

self

)

    Returns the run that is being analyzed.

Definition at line 44 of file Base.py.

getValueAsFunctionOfTime()

def MPCDAnalysis.StarPolymersAnalysis.Base.Base.getValueAsFunctionOfTime

(

self

)

    Returns the asphericity as a function of time, in the form of a
    `collections.OrderedDict`.

    This function will make use of cache results, if available.

Definition at line 56 of file Base.py.

setWritePath()

def MPCDAnalysis.StarPolymersAnalysis.Base.Base.setWritePath	(		self,
			writePath
	)

    Sets the path to the directory that data files are written to.

    @param[in] writePath
               If not `None`, a path used to write data to.

Definition at line 35 of file Base.py.

updateCache()

def MPCDAnalysis.StarPolymersAnalysis.Base.Base.updateCache	(		self,
			forced = False
	)

    Updates the cache, if necessary or if forced.

    @param[in] forced
               Whether to force an update, even if the cache is up to date.

Definition at line 75 of file Base.py.

---

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

• Base.py