Skip to content

Commit

Permalink
Updated manual
Browse files Browse the repository at this point in the history
  • Loading branch information
dsambit committed Jun 24, 2018
1 parent 84e2bfe commit d4d26d5
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 6 deletions.
18 changes: 15 additions & 3 deletions doc/manual/installation.tex
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ \subsection{Obtaining \dftfe{}}
\begin{verbatim}
git clone https://[email protected]/dftfedevelopers/dftfe.git
\end{verbatim}
For internal group testing, use the internalGroupTesting
For internal group testing, use the \verb|internalGroupTesting| branch.
\begin{verbatim}
git checkout internalGroupTesting
\end{verbatim}
Expand All @@ -12,6 +12,7 @@ \subsection{Compiling required external libraries}
Not required for internal group testing if trying to run \dftfe{} on flux.

\subsection{Compiling \dftfe{}}
Following are the steps to compile DFT-FE (only for flux)
\begin{enumerate}
\item \begin{verbatim}
cd dftfe
Expand All @@ -31,11 +32,22 @@ \subsection{Compiling \dftfe{}}
./setup.sh
\end{verbatim}
\end{enumerate}
If \dftfe{} compiled successfully, the following executables will be created in the \verb|build| directory:
, which by default compiles in the release mode (the fast version). If \dftfe{} compiled successfully, the following executables will be created in the \verb|build| directory:
\begin{verbatim}
/build/release/real/main
/build/release/complex/main
\end{verbatim}
One could also set
\begin{verbatim}
optimizedFlag=1
\end{verbatim}
inside \verb|setup.sh|, and run
\begin{verbatim}
./setup.sh
\end{verbatim}
, which will create debug mode executables (useful for debugging purposes but much slower than the release mode executable) in the folders
\begin{verbatim}
/build/debug/real/main
/build/debug/complex/main
\end{verbatim}
Among the above executables, the ones in the \verb|build/release/| folder are the fast version, which are meant for production runs. For debugging crashes and bugs, use the executables in the \verb|build/debug/| folder.

4 changes: 2 additions & 2 deletions doc/manual/parameters.tex
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ \subsection{Parameters in section \tt Geometry/Optimization}
\index[prmindexfull]{Geometry!Optimization!FORCE TOL}


{\it Default:} 5e-5
{\it Default:} 1e-4


{\it Description:} [Standard] Sets the tolerance of the maximum force (in a.u.) on an ion when forces are considered to be relaxed.
Expand Down Expand Up @@ -745,7 +745,7 @@ \subsection{Parameters in section \tt Geometry/Optimization}
\index[prmindexfull]{Geometry!Optimization!STRESS TOL}


{\it Default:} 5e-7
{\it Default:} 1e-6


{\it Description:} [Standard] Sets the tolerance of the cell stress (in a.u.) when cell stress is considered to be relaxed.
Expand Down
10 changes: 9 additions & 1 deletion doc/manual/rundftfe.tex
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
The \verb|real/main| executable uses only real data-structures, which are sufficient for fully non-periodic problems, and periodic and semi-periodic problems with only one Brillouin zone sampling point at the origin. The \verb|complex/main| executable uses complex data-structrues which are required for periodic and semi-periodic problems with multiple Brillouin zone sampling points.
After compiling \dftfe{} as described above, we have now the \verb|real/main| executable, which uses real data-structures for the Kohn-Sham DFT eigen solve. This is sufficient for fully non-periodic problems, and periodic and semi-periodic problems with only one Brillouin zone sampling point at the origin. The other executable is \verb|complex/main|, which uses complex data-structrues for the Kohn-Sham DFT eigen solve. This is required for periodic and semi-periodic problems with multiple Brillouin zone sampling points. These executables are to be used as follows:
\begin{verbatim}
./main parameterFile.prm
\end{verbatim}
or, for a parallel program:
\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.

0 comments on commit d4d26d5

Please sign in to comment.