plates

Plate analysis.

detect_plates `cached`

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:

Name	Type	Description	Default
`snap`	`Step`	a `Step` of a `StagyyData` instance.	required
`vz_thres_ratio`	`float`	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.	`0`

Returns:

Name	Type	Description
`itrenches`	`NDArray`	phi-indices of detected trenches
`iridges`	`NDArray`	phi-indices of detected ridges

plot_at_surface(
    snap: Step,
    names: Sequence[Sequence[Sequence[str]]],
    conf: Optional[Config],
) -> None

Plot surface diagnostics.

Parameters:

Name	Type	Description	Default
`snap`	`Step`	a `Step` of a `StagyyData` instance.	required
`names`	`Sequence[Sequence[Sequence[str]]]`	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.	required
`conf`	`Optional[Config]`	configuration.	required

plot_scalar_field(
    snap: Step,
    fieldname: str,
    conf: Optional[Config] = None,
) -> None

Plot scalar field with plate information.

Parameters:

Name	Type	Description	Default
`snap`	`Step`	a `Step` of a `StagyyData` instance.	required
`fieldname`	`str`	name of the field that should be decorated with plate informations.	required
`conf`	`Optional[Config]`	configuration.	`None`

cmd(conf: Config) -> None

Implementation of plates subcommand.