plates
Plate analysis.
- stagpy.plates.detect_plates(snap: Step, vz_thres_ratio: float = 0) Tuple[ndarray, ndarray]
Detect plate limits using derivative of horizontal velocity.
This function is cached for convenience.
- Parameters
snap – a
Step
of a StagyyData instance.vz_thres_ratio – if above zero, an additional check based on the vertical velocities is performed. Limits detected above a region where the vertical velocity is below vz_thres_ratio * mean(vzabs) are ignored.
- Returns
tuple (itrenches, iridges). 1D arrays containing phi-index of detected trenches and ridges.
- stagpy.plates.plot_at_surface(snap: Step, names: Sequence[Sequence[Sequence[str]]]) None
Plot surface diagnostics.
- Parameters
snap – a
Step
of a StagyyData instance.names – names of requested surface diagnotics. They are organized by figures, plots and subplots. Surface diagnotics can be valid surface field names, field names, or “dv2” which is d(vphi)/dphi.
- stagpy.plates.plot_scalar_field(snap: Step, fieldname: str) None
Plot scalar field with plate information.
- Parameters
snap – a
Step
of a StagyyData instance.fieldname – name of the field that should be decorated with plate informations.
- stagpy.plates.cmd() None
Implementation of plates subcommand.
- Parameters
conf.plates –
conf.scaling –
conf.plot –
conf.core –