TSMonitorHGCtxCreate#

Creates a TSMonitorHGCtx histogram monitor context for use with DMSWARM particle visualizations

Synopsis#

#include "petscts.h"  
PetscErrorCode TSMonitorHGCtxCreate(MPI_Comm comm, const char host[], const char label[], int x, int y, int m, int n, PetscInt howoften, PetscInt Ns, PetscInt Nb, PetscBool velocity, TSMonitorHGCtx *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
Ns - the number of species to histogram
Nb - the number of histogram bins
velocity - PETSC_TRUE to plot histograms in velocity space, PETSC_FALSE for coordinate space

Output Parameter#

ctx - the newly created histogram monitor context

Note#

Pass this context and TSMonitorHGCtxDestroy() to TSMonitorSet() with TSMonitorHGSwarmSolution() to display particle histograms during 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