Skip to content
Snippets Groups Projects
Normal view Permalink
command-line.tex 2.12 KiB
Newer Older
Chris Cantwell's avatar
Added command-line reference chapter.
Chris Cantwell committed
1 2 3 4 5 6 7 8 9 
\chapter{Command-line Options}

%\begin{lstlisting}
%--verbose
%\end{lstlisting}
\lstinline[style=BashInputStyle]{--verbose}\\
\hangindent=1.5cm
Displays extra info.
Dave Moxey's avatar
Fix comment, add command line option to docs  
Dave Moxey committed
10 11 12 13 
\lstinline[style=BashInputStyle]{--version}\\
\hangindent=1.5cm
Displays software version, and source control information if applicable.
Chris Cantwell's avatar
Added command-line reference chapter.
Chris Cantwell committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 
\lstinline[style=BashInputStyle]{--help}\\
\hangindent=1.5cm
Displays help information about the available command-line options for the executable.

\lstinline[style=BashInputStyle]{--parameter [key]=[value]}\\
\hangindent=1.5cm
Override a parameter (or define a new one) specified in the XML file.

\lstinline[style=BashInputStyle]{--solverinfo [key]=[value]}\\
\hangindent=1.5cm
Override a solverinfo (or define a new one) specified in the XML file.

\lstinline[style=BashInputStyle]{--npx [int]}\\
\hangindent=1.5cm
When using a fully-Fourier expansion, specifies the number of processes to use in the x-coordinate direction.

\lstinline[style=BashInputStyle]{--npy [int]}\\
\hangindent=1.5cm
\quad When using a fully-Fourier expansion or 3D expansion with two Fourier directions, specifies the number of processes to use in the y-coordinate direction.

\lstinline[style=BashInputStyle]{--npz [int]}\\
\hangindent=1.5cm
When using Fourier expansions, specifies the number of processes to use in the z-coordinate direction.
Chris Cantwell's avatar
Added some missing documentation for ThresholdMin filter and command-line.  
Chris Cantwell committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 

\lstinline[style=BashInputStyle]{--part-info}\\
\hangindent=1.5cm
Prints detailed information about the generated partitioning, such as number of
elements, number of local degrees of freedom and the number of boundary degrees
of freedom.

\lstinline[style=BashInputStyle]{--part-only [int]}\\
\hangindent=1.5cm
Partition the mesh only into the specified number of partitions, write to file
and exit. This can be used to pre-partition a very large mesh on a single
high-memory node, prior to being executed on a multi-node cluster.

\lstinline[style=BashInputStyle]{--use-metis}\\
\hangindent=1.5cm
Forces the use of METIS for mesh partitioning. If \nekpp{} is compiled with
Scotch support, the default is to use Scotch.

\lstinline[style=BashInputStyle]{--use-scotch}\\
\hangindent=1.5cm
Forces the use of Scotch for mesh partitioning.