Commit 3f153170 authored by Andrew Bauer's avatar Andrew Bauer

Small set of fixes for Catalyst UG.

parent 683cf513
include(UseLATEX)
message("dirs are ${CMAKE_CURRENT_SOURCE_DIR} tooo ${CMAKE_CURRENT_BINARY_DIR}")
file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/../ParaView/menukeys.sty DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
add_latex_document(
ParaViewCatalystUsersGuide.tex
INPUTS
......
......@@ -155,6 +155,13 @@ emphstyle={\color{self}\slshape},
% for multi-columns lists and such
\usepackage{multicols}
% Package for menus and keys
\usepackage[os=win]{menukeys}
\copymenustyle{pathswithslash}{paths}
\changemenuelement{pathswithslash}{sep}{/}
\renewmenumacro{\directory}[/]{pathswithslash}
\renewmenumacro{\keys}[+]{shadowedroundedkeys}
\title{\mytitle{}}
\author{Andrew C. Bauer, Berk Geveci, Will Schroeder}
%\date{}
......
% not sure why it's not picking up the icon command from LatexMacros.tex...
\newcommand\icon[1]{\includegraphics[height=1.em]{#1}}
This section describes ParaView Catalyst
from the perspective of the simulation user.
As described in the previous section,
......@@ -199,9 +202,9 @@ to the pvserver where the data will be sent to. After the connection is made, th
will look like Figure~\ref{fig:catalystlivepipeline}. The live connection uses ParaView's concept
of not performing anything computationally expensive without specific prompting by the user.
Thus, by default none of the Catalyst extracts are sent to the server. This is indicated
by the \icon{Images\pqLinkIn16d.png} icon to the left of the pipeline sources. To have the output
from a source sent to the ParaView server, click on the \icon{Images\pqLinkIn16d.png} icon.
It will then change to \icon{Images\pqLinkIn16.png} to indicate that it is available on the
by the \icon{Images/pqLinkIn16d.png} icon to the left of the pipeline sources. To have the output
from a source sent to the ParaView server, click on the \icon{Images/pqLinkIn16d.png} icon.
It will then change to \icon{Images/pqLinkIn16.png} to indicate that it is available on the
ParaView server. This is shown for Contour0 in Figure~\ref{fig:catalystlivepipeline}.
To stop the extract from being sent to the server, just delete the object in the ParaView
server's pipeline (e.g. Extract: Contour0 in Figure~\ref{fig:catalystlivepipeline}).
......@@ -214,7 +217,6 @@ server's pipeline (e.g. Extract: Contour0 in Figure~\ref{fig:catalystlivepipelin
\end{center}
\end{figure}
Beginning in ParaView 4.2, the live functionality was improved to allow the simulation
to also pause the Catalyst enabled simulation run. This is useful for examining the simulation
state at a specific point in time. The design is based up debugging tools such that the
......@@ -222,13 +224,13 @@ simulation can be paused at the next available call to the Catalyst libraries, a
specific time step or when the simulation time passes a specific value.
Additionally, a breakpoint that has not
been reached yet can be removed as well.
These controls are available under the \icon{Catalyst} menu. Note that the Pipeline
These controls are available under the \menu{Catalyst} menu. Note that the Pipeline
Browser shows the simulation run state to signify the status of the simulation. The icons for
this are:
\begin{itemize}
\item \icon{Images\pqInsituServerRunning16.png} indicates the simulation is running with no breakpoint set.
\item \icon{Images\pqInsituBreakpoint16.png} indicates that the simulation has reached a breakpoint.
\item \icon{Images\pqInsituServerPaused16.png} indicates that a breakpoint has been set but not yet reached.
\item \icon{Images/pqInsituServerRunning16.png} indicates the simulation is running with no breakpoint set.
\item \icon{Images/pqInsituBreakpoint16.png} indicates that the simulation has reached a breakpoint.
\item \icon{Images/pqInsituServerPaused16.png} indicates that a breakpoint has been set but not yet reached.
\end{itemize}
A demonstration of this functionality is at \url{www.kitware.com/blog/home/post/722}.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment