%
% API Documentation for nMOLDYN
% Module nMOLDYN.Analysis.Slave
%
% Generated by epydoc 3.0.1
% [Thu Oct  8 16:59:58 2009]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Analysis \textit{(package)}!nMOLDYN.Analysis.Slave \textit{(module)}|(}
\section{Module nMOLDYN.Analysis.Slave}

    \label{nMOLDYN:Analysis:Slave}
\begin{alltt}
This modules contains the functions used by Pyro slave to perform analysis remotely.

Functions:
    * do\_analysisPerElement: performs an analysis element-by-element.
\end{alltt}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               Functions                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsection{Functions}

    \label{nMOLDYN:Analysis:Slave:do_analysisPerElement}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Analysis \textit{(package)}!nMOLDYN.Analysis.Slave \textit{(module)}!nMOLDYN.Analysis.Slave.do\_analysisPerElement \textit{(function)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{do\_analysisPerElement}(\textit{analysis}, \textit{element}, \textit{trajname})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Performs the analysis element-by-element, the element being either an 
    atom (atom-by-atom analysis), a frame index (frame-by-frame analysis), 
    a group of atom (group-by-group analysis) or a set of q vectors.

\setlength{\parskip}{1ex}
      \textbf{Parameters}
      \vspace{-1ex}

      \begin{quote}
        \begin{Ventry}{xxxxxxxx}

          \item[analysis]

          the selected analysis.

            {\it (type=a subclass of nMOLDYN.Analysis.Analysis.Analysis class)}

          \item[element]

          the element on which the analysis is based.

            {\it (type=MMTK.Atom{\textbar}integer{\textbar}MMTK.Collections.Collection{\textbar}nMOLDYN.Mathematics.QVectors)}

          \item[trajname]

          a string specifying the name of the trajectory.

            {\it (type=string)}

        \end{Ventry}

      \end{quote}

      \textbf{Return Value}
    \vspace{-1ex}

      \begin{quote}
      the results of the analysis performed on one element.

      {\it (type=depends on the analysis)}

      \end{quote}

    \end{boxedminipage}

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Analysis \textit{(package)}!nMOLDYN.Analysis.Slave \textit{(module)}|)}
