%
% API Documentation for nMOLDYN
% Module nMOLDYN.Core.Misc
%
% Generated by epydoc 3.0.1
% [Thu Oct  8 17:00:00 2009]
%

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

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Misc \textit{(module)}|(}
\section{Module nMOLDYN.Core.Misc}

    \label{nMOLDYN:Core:Misc}
\begin{alltt}
This modules implements the functions and procedures that can not be classified anywhere else in 
the library.

There should not be too much stuff here in order to not mess up the code.

Functions:
    * findNestedDirectories : parses recursively a directory tree appending each nested subdirectory found in a list.
    * findExecutable        : searches for an executable in OS dependant classical paths.
\end{alltt}


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

  \subsection{Functions}

    \label{nMOLDYN:Core:Misc:findNestedDirectories}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Misc \textit{(module)}!nMOLDYN.Core.Misc.findNestedDirectories \textit{(function)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{findNestedDirectories}(\textit{root}, \textit{dirList})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Parses recursively the directory tree starting from directory 
    {\textbar}rootDir{\textbar} appending all the subdirectories found in 
    {\textbar}dirList{\textbar} list.

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

      \begin{quote}
        \begin{Ventry}{xxxxxxx}

          \item[root]

          a string specifying the directory from which the directory tree 
          will be generated.

            {\it (type=string)}

          \item[dirList]

          a complete list of all the subdirectories found starting from 
          directory {\textbar}rootDir{\textbar}.

            {\it (type=list)}

        \end{Ventry}

      \end{quote}

\textbf{Note:} take care this is a recursive function.



    \end{boxedminipage}

    \label{nMOLDYN:Core:Misc:findExecutable}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Misc \textit{(module)}!nMOLDYN.Core.Misc.findExecutable \textit{(function)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{findExecutable}(\textit{name})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Searches for an executable in OS dependant classical paths.

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

      \begin{quote}
        \begin{Ventry}{xxxx}

          \item[name]

          a string specifying the name of the executable.

            {\it (type=string)}

        \end{Ventry}

      \end{quote}

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

      \begin{quote}
      a string specifying the absolute name of the executable 
      {\textbar}name] if it could be found an empty string otherwise.

      {\it (type=string)}

      \end{quote}

    \end{boxedminipage}

    \label{nMOLDYN:Core:Misc:determineNumberOfCPUs}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Misc \textit{(module)}!nMOLDYN.Core.Misc.determineNumberOfCPUs \textit{(function)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{determineNumberOfCPUs}()

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Number of virtual or physical CPUs on this system, i.e. user/real as 
    output by time(1) when called with an optimally scaling userspace-only 
    program

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:Core:Misc:cpuInfo}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Misc \textit{(module)}!nMOLDYN.Core.Misc.cpuInfo \textit{(function)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{cpuInfo}()

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Retrieves the total numbers of processors, the number of loaded and 
    free processors on the host machine.

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

      \begin{quote}
      the total number of processors on the host machine.

      {\it (type=integer)}

      \end{quote}

    \end{boxedminipage}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               Variables                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsection{Variables}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\raggedright s\-c\-a\-n\-n\-e\-d\-D\-i\-r\-e\-c\-t\-o\-r\-i\-e\-s\- & \raggedright \textbf{Value:} 
{\tt [sys.prefix]}&\\
\cline{1-2}
\end{longtable}

    \index{nMOLDYN \textit{(package)}!nMOLDYN.Core \textit{(package)}!nMOLDYN.Core.Misc \textit{(module)}|)}
