MPCDAnalysis.StarPolymersAnalysis.PotentialEnergy.PotentialEnergy Class Reference

Inheritance diagram for MPCDAnalysis.StarPolymersAnalysis.PotentialEnergy.PotentialEnergy:

Collaboration diagram for MPCDAnalysis.StarPolymersAnalysis.PotentialEnergy.PotentialEnergy:

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

Detailed Description

Class for analysis of potential energies.

Definition at line 7 of file PotentialEnergy.py.

Constructor & Destructor Documentation

__init__()

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

    The constructor.

    @param[in] run
               The run to analyze, as an instance of `Run`.

Reimplemented from MPCDAnalysis.StarPolymersAnalysis.Base.Base.

Definition at line 16 of file PotentialEnergy.py.

Member Function Documentation

getMPLAxesForValueAsFunctionOfTime()

def MPCDAnalysis.StarPolymersAnalysis.PotentialEnergy.PotentialEnergy.getMPLAxesForValueAsFunctionOfTime

(

self

)

    Returns a `matplotlib.axes.Axes` object that contains a plot of the
    potential energy, with the horizontal axis showing the simulation
    time `t`, and the vertical axis showing the potential energy at that
    point in time.

Definition at line 28 of file PotentialEnergy.py.

getRun()

def MPCDAnalysis.StarPolymersAnalysis.Base.Base.getRun (   self )

inherited

    Returns the run that is being analyzed.

Definition at line 44 of file Base.py.

getValueAsFunctionOfTime()

def MPCDAnalysis.StarPolymersAnalysis.Base.Base.getValueAsFunctionOfTime (   self )

inherited

    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  )

inherited

    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  )

inherited

    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:

• PotentialEnergy.py