TSMonitorSPCtxCreate#

Creates a TSMonitorSPCtx scatter-plot monitor context for use with DMSWARM particle visualizations

Synopsis#

#include "petscts.h"  
PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm, const char host[], const char label[], int x, int y, int m, int n, PetscInt howoften, PetscInt retain, PetscBool phase, PetscBool multispecies, TSMonitorSPCtx *ctx)

Collective

Input Parameters#

comm - the MPI communicator to use
host - the X display to open, or NULL for the local machine
label - the title to put in the title bar
x - the x screen coordinates of the upper left coordinate of the window
y - the y screen coordinates of the upper left coordinate of the window
m - the screen width in pixels
n - the screen height in pixels
howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
retain - the number of old points to retain in the plot, or 0 to clear, or -1 to retain all
phase - PETSC_TRUE to plot in phase space rather than coordinate space
multispecies - PETSC_TRUE to color particles by species

Output Parameter#

ctx - the newly created scatter plot monitor context

Note#

Pass this context and TSMonitorSPCtxDestroy() to TSMonitorSet() with TSMonitorSPSwarmSolution() to display particles during the integration.

Level#

intermediate

Location#

src/ts/interface/tsmon.c

Index of all TS routines
Table of Contents for all manual pages
Index of all manual pages