|
OpenMPCD
|
Public Member Functions | |
| def | __init__ (self, rundir) |
| def | addRun (self, rundir) |
| def | getMPLAxesForFlowAlongXAsFunctionOfY (self, standardError=1, theory=True, shift=True) |
| def | getFlowProfileAsFunctionOfY (self, shift=True) |
| def | getGlobalFlowStatistics (self) |
| def | getAnalyticShearFlowProfileAsFunctionOfY (self, shearRate=None, shift=True) |
| def | showVectorFieldGUI (self) |
Represents a flow profile, as created by `OpenMPCD::FlowProfile`.
Definition at line 5 of file FlowProfile.py.
| def MPCDAnalysis.FlowProfile.FlowProfile.__init__ | ( | self, | |
| rundir | |||
| ) |
The constructor.
Definition at line 11 of file FlowProfile.py.
| def MPCDAnalysis.FlowProfile.FlowProfile.addRun | ( | self, | |
| rundir | |||
| ) |
Adds the flow profile data in the given `rundir` to the data gathered so
far.
Definition at line 28 of file FlowProfile.py.
| def MPCDAnalysis.FlowProfile.FlowProfile.getAnalyticShearFlowProfileAsFunctionOfY | ( | self, | |
shearRate = None, |
|||
shift = True |
|||
| ) |
Returns the analytic flow profile of a shear flow as a function of `y`.
The shear flow is assumed to have the flow direction along the positive
`x` direction, and the gradient direction is assumed to be the `y`
direction.
The value returned is a dictionary, with the keys being `y` coordinates
in simulation space, and the values being the mean flow speed along the
`x` direction.
@param[in] shearRate
Sets the shear rate. If `None`, and a run has been added
which does specify a shear rate, that value is assumed.
Otherwise, an exception is thrown.
@param[in] shift
Set to `True` to shift the data points along the `y`
direction in such a way that a data point lies not at the
beginning of the `y` segment it describes, but rather at its
center.
Definition at line 233 of file FlowProfile.py.
| def MPCDAnalysis.FlowProfile.FlowProfile.getFlowProfileAsFunctionOfY | ( | self, | |
shift = True |
|||
| ) |
Returns the flow profile as a function of `y`.
The value returned is a dictionary, with the keys being `y` coordinates
in simulation space, and the values being a lists of three
`OnTheFlyStatistics` instances, for the flow velocities along the `x`,
`y`, and `z` direction, respectively.
@param[in] shift
Set to `True` to shift the data points along the `y`
direction in such a way that a data point lies not at the
beginning of the `y` segment it describes, but rather at its
center.
Definition at line 160 of file FlowProfile.py.
| def MPCDAnalysis.FlowProfile.FlowProfile.getGlobalFlowStatistics | ( | self | ) |
Returns a list of three `OnTheFlyStatistics` objects that combine, one
for each of the three Cartesian coordinates, that combines all samples
of particle velocities across the simulation volume.
Definition at line 194 of file FlowProfile.py.
| def MPCDAnalysis.FlowProfile.FlowProfile.getMPLAxesForFlowAlongXAsFunctionOfY | ( | self, | |
standardError = 1, |
|||
theory = True, |
|||
shift = True |
|||
| ) |
Returns a `matplotlib.axes.Axes` object that contains a plot of the
flow profile, with the horizontal axis showing the simulation `y`
coordinate, and the vertical axis showing the average flow velocity in
`x` direction (along with its standard deviation) at that point.
@param[in] standardError
Include a shaded region around the mean that corresponds to
`standardError` times the standard error. Set to `0` to omit
this shaded region altogether.
@param[in] theory
Set to `True` to also include a plot of the theoretical shear
flow profile.
@param[in] shift
Set to `True` to shift the data points along the `y`
direction in such a way that a data point lies not at the
beginning of the `y` segment it describes, but rather at its
center.
Definition at line 92 of file FlowProfile.py.
1.8.17