Skip to content

Commit

Permalink
Added structuring the input file subsection in the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
dsambit committed Jun 24, 2018
1 parent 0f815c5 commit 01c1566
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
3 changes: 2 additions & 1 deletion doc/manual/manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,8 @@ \section{Run-time input parameters}
\label{sec:parameters}
The underlying description of the input parameters also includes a Standard/Developer label, which signifies whether an input parameter is
a standard one, or is an expert level one for development purposes. The default values of the development level parameters are good enough
for almost all cases. Please contact the developers if just using standard parameters did not work for your problem.
for almost all cases. Please contact the developers if just using standard parameters did not work for your problem. For user convenience,
all input parameters are also indexed at the end of this manual in Section~\ref{sec:runtime-parameter-index-full}.
% now include a file that describes all currently available run-time parameters
\input{parameters}

Expand Down
36 changes: 35 additions & 1 deletion doc/manual/rundftfe.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,38 @@
\begin{verbatim}
mpirun -n N ./main parameterFile.prm
\end{verbatim}
to run with N processors. In the above, an input file with \verb|.prm| extension is used. This file contains user-defined parameters as described in Section~\ref{sec:parameters}. For the structure of the input \verb|.prm| file, please follow the examples in the \verb|/dftfe/demo/| folder.
to run with N processors.
\subsection{Structuring the input file}
In the above, an input file with \verb|.prm| extension is used. This file contains input parameters as described in Section~\ref{sec:parameters}. All input parameters are also conveniently indexed at the end of this manual in Section~\ref{sec:runtime-parameter-index-full}. There are two types of parameters: ``{\it Global parameters}" and ``{\it Parameters in section A/B/..}". This can be seen directly in Section~\ref{sec:parameters}, where each parameter belongs to a group of parameters under the headings: ``{\it Global parameters}" or ``{\it Parameters in section A/B/..}". In ``{\it Parameters in section A/B/..}", {\it A} refers to the primary subsection name, {\it B} if present refers to a subsection inside {\it A}, and so on.

First, lets consider how to use a parameter named \verb|PARAMETER GLOBAL| under the heading ``{\it Global parameters}". To set it to a value, say \verb|value| in the \verb|.prm| file, directly use
\begin{verbatim}
set PARAMETER GLOBAL=value
\end{verbatim}
Next consider a parameter named \verb|PARAMETER SUBSECTION| under the heading ``{\it Parameters in section A}". To set it to a value, say \verb|value| in the \verb|.prm| file, use
\begin{verbatim}
subsection A
set PARAMETER SUBSECTION=value
end
\end{verbatim}
Finally, consider a nested parameter named \verb|PARAMETER SUBSUBSECTION| under the heading ``{\it Parameters in section A/B}". To set it to a value, say \verb|value| in the \verb|.prm| file, use
\begin{verbatim}
subsection A
subsection B
set PARAMETER SUBSUBSECTION=value
end
end
\end{verbatim}
One final note- more than one parameter could be used inside the same \verb|subsection|. For example
\begin{verbatim}
subsection A
set PARAMETER SUBSECTION 1=value1
set PARAMETER SUBSECTION 2=value2
subsection B
set PARAMETER SUBSUBSECTION 1=value1
set PARAMETER SUBSUBSECTION 2=value2
end
end
\end{verbatim}
\subsection{Running a demo example}
Please follow the examples in the \verb|/dftfe/demo/| folder.

0 comments on commit 01c1566

Please sign in to comment.