setplot.py.html
Source file:   setplot.py
Directory:   /Users/rjl/Dropbox/ggsss-pages/claw-apps/shallow-1d-1
Converted:   Wed Aug 1 2012 at 10:26:42   using clawcode2html
This documentation file will not reflect any later changes in the source file.

 

""" 
Set up the plot figures, axes, and items to be done for each frame.

This module is imported by the plotting routines and then the
function setplot is called to set the plot parameters.
    
""" 

#--------------------------
def setplot(plotdata):
#--------------------------
    
    """ 
    Specify what is to be plotted at each frame.
    Input:  plotdata, an instance of pyclaw.plotters.data.ClawPlotData.
    Output: a modified version of plotdata.
    
    """ 

    plotdata.clearfigures()  # clear any old figures,axes,items data

    

    # Figure for h and hu
    plotfigure = plotdata.new_plotfigure(name='h and u', figno=0)

    # Set up for axes for h:
    plotaxes = plotfigure.new_plotaxes()
    plotaxes.axescmd = 'subplot(2,1,1)'   # top figure
    plotaxes.xlimits = [-5,5]
    plotaxes.ylimits = [9.5,11.5]
    plotaxes.title = 'depth'

    # Set up for item on these axes:
    plotitem = plotaxes.new_plotitem(plot_type='1d')
    plotitem.plot_var = 0
    plotitem.plotstyle = '-o'
    plotitem.color = 'b'
    plotitem.show = True       # show on plot?
    


    # Set up for axes for velocity
    plotaxes = plotfigure.new_plotaxes()

    plotaxes.xlimits = [-5,5]
    plotaxes.axescmd = 'subplot(2,1,2)'   # bottom figure
    plotaxes.ylimits = [-1,1]
    plotaxes.title = 'velocity'

    # Set up for item on these axes:
    plotitem = plotaxes.new_plotitem(plot_type='1d')
    def velocity(current_data):
        from numpy import where
        q = current_data.q
        h = q[:,0]
        u = where(h>0, q[:,1] / h, 0.)
        return u
    plotitem.plot_var = velocity

    plotitem.plotstyle = '-o'
    plotitem.color = 'b'
    plotitem.show = True       # show on plot?
    

    # Parameters used only when creating html and/or latex hardcopy
    # e.g., via pyclaw.plotters.frametools.printframes:

    plotdata.printfigs = True                # print figures
    plotdata.print_format = 'png'            # file format
    plotdata.print_framenos = 'all'          # list of frames to print
    plotdata.print_fignos = 'all'            # list of figures to print
    plotdata.html = True                     # create html files of plots?
    plotdata.html_homelink = '../README.html'   # pointer for top of index
    plotdata.latex = True                    # create latex file of plots?
    plotdata.latex_figsperline = 2           # layout of plots
    plotdata.latex_framesperline = 1         # layout of plots
    plotdata.latex_makepdf = False           # also run pdflatex?

    return plotdata