Update documentation

parent f48ed3a4
build/build_SWE_* build/build_SWE_*
build/SWE_* build/SWE_*
documentation/doxy/
*.pyc *.pyc
.sconsign.dblite .sconsign.dblite
*~ *~
......
...@@ -458,7 +458,7 @@ SORT_GROUP_NAMES = NO ...@@ -458,7 +458,7 @@ SORT_GROUP_NAMES = NO
# Note: This option applies only to the class list, not to the # Note: This option applies only to the class list, not to the
# alphabetical list. # alphabetical list.
SORT_BY_SCOPE_NAME = NO SORT_BY_SCOPE_NAME = YES
# The GENERATE_TODOLIST tag can be used to enable (YES) or # The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo # disable (NO) the todo list. This list is created by putting \todo
...@@ -603,7 +603,8 @@ WARN_LOGFILE = ...@@ -603,7 +603,8 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = . ../src ../src/examples ../src/scenarios ../src/solvers ../src/tools INPUT = . \
../src
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
...@@ -626,7 +627,7 @@ FILE_PATTERNS = *.txt *.h *.hh *.hpp *.cpp *.cu ...@@ -626,7 +627,7 @@ FILE_PATTERNS = *.txt *.h *.hh *.hpp *.cpp *.cu
# should be searched for input files as well. Possible values are YES and NO. # should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used. # If left blank NO is used.
RECURSIVE = NO RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should # The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
......
...@@ -156,7 +156,7 @@ We will model three different situations: ...@@ -156,7 +156,7 @@ We will model three different situations:
To implement the boundary conditions, the class \texttt{SWE\_Block} contains an To implement the boundary conditions, the class \texttt{SWE\_Block} contains an
array of four enum variables, \texttt{boundary[4]} (for left/right/bottom/top array of four enum variables, \texttt{boundary[4]} (for left/right/bottom/top
boundary), that can take the values boundary), that can take the values
\texttt{OUTFLOW}, \texttt{WALL}, and \texttt{CONNECT}. <code>OUTFLOW</code>, <code>WALL</code>, and <code>CONNECT</code>.
\subsection multblocks Multiple Blocks \subsection multblocks Multiple Blocks
...@@ -165,6 +165,8 @@ Via the connect boundary condition, it is also possible to connect several ...@@ -165,6 +165,8 @@ Via the connect boundary condition, it is also possible to connect several
Cartesian grid blocks to build a more complicated domain. Figure \ref{fig:connect} Cartesian grid blocks to build a more complicated domain. Figure \ref{fig:connect}
illustrates the exchange of ghost values for two connected blocks. illustrates the exchange of ghost values for two connected blocks.
\image html connect.gif
\latexonly
\begin{figure} \begin{figure}
\begin{center} \begin{center}
\includegraphics[width=0.8\textwidth]{pics/connect.pdf} \includegraphics[width=0.8\textwidth]{pics/connect.pdf}
...@@ -172,10 +174,11 @@ illustrates the exchange of ghost values for two connected blocks. ...@@ -172,10 +174,11 @@ illustrates the exchange of ghost values for two connected blocks.
\caption{Exchange of values in ghost layers between two connected \texttt{SWE\_Block}s.} \caption{Exchange of values in ghost layers between two connected \texttt{SWE\_Block}s.}
\label{fig:connect} \label{fig:connect}
\end{figure} \end{figure}
\endlatexonly
To store the neighbour block in case of a \texttt{CONNECT} boundary, \texttt{SWE\_Block} To store the neighbour block in case of a <code>CONNECT</code> boundary, <code>SWE_Block</code>
contains a further array of four pointers, \texttt{neighbour[4]} (for left/right/bottom/top contains a further array of four pointers, <code>neighbour[4]</code> (for left/right/bottom/top
boundary), that will store a pointer to the connected adjacent \texttt{SWE\_Block}. boundary), that will store a pointer to the connected adjacent <code>SWE_Block</code>.
The respective block approach can also be exploited for parallelisation: The respective block approach can also be exploited for parallelisation:
the different blocks would then be assigned to the available processors the different blocks would then be assigned to the available processors
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment