JGonzalez/fpakc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update to the manual for .vtu

Browse source 
Manual has been updated to account for new vtu option in the mesh
format.
This commit is contained in:
Jorge Gonzalez 2023-02-05 21:44:09 +01:00
commit 402dac9068
2 changed files with 10 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
doc/user-manual/fpakc_UserManual.pdf
View file

Binary file not shown.

16
doc/user-manual/fpakc_UserManual.tex
View file

@ -38,6 +38,7 @@
\newacronym{io}{I/O}{input/output} \newacronym{io}{I/O}{input/output}
\newacronym{mcc}{MCC}{Monte-Carlo Collisions} \newacronym{mcc}{MCC}{Monte-Carlo Collisions}
\newacronym{cs}{CS}{Coulomb Scattering} \newacronym{cs}{CS}{Coulomb Scattering}
\newacronym{vtu}{VTU}{Visualization Toolkit for unstructured grids}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newglossaryentry{openmp}{name={OpenMP},description={Shared-memory parallelization}} \newglossaryentry{openmp}{name={OpenMP},description={Shared-memory parallelization}}
@ -437,25 +438,26 @@ make
\begin{itemize} \begin{itemize}
\item \textbf{Cart}: Cartesian coordinates. \item \textbf{Cart}: Cartesian coordinates.
Available for \textbf{geometry.dimension} $1$, $2$ and $3$. Available for \textbf{geometry.dimension} $1$, $2$ and $3$.
For \Gls{gmsh} mesh format, the coordinates $x$, $y$ and $z$ correspond to $x$, $y$ and $z$ respectively. The coordinates $x$, $y$ and $z$ correspond to $x$, $y$ and $z$ respectively.
\item \textbf{Cyl}: Cylindrical coordinates ($z \hyphen r$) with symmetry axis at $r = 0$. \item \textbf{Cyl}: Cylindrical coordinates ($z \hyphen r$) with symmetry axis at $r = 0$.
Only available for \textbf{geometry.dimension} $2$. Only available for \textbf{geometry.dimension} $2$.
For \Gls{gmsh} mesh format, the coordinates $x$ and $y$ correspond to $z$ and $r$ respectively. The coordinates $x$ and $y$ correspond to $z$ and $r$ respectively.
\item \textbf{Rad}: One-dimensional radial space ($r$). \item \textbf{Rad}: One-dimensional radial space ($r$).
Only available for \textbf{geometry.dimension} $1$. Only available for \textbf{geometry.dimension} $1$.
For \Gls{gmsh} mesh format, the coordinates $x$ corresponds to $r$. The coordinates $x$ corresponds to $r$.
\end{itemize} \end{itemize}
\item \textbf{meshType}: Character. \item \textbf{meshType}: Character.
Format of mesh file. Format of mesh file.
Accepted formats are: Accepted formats are:
\begin{itemize} \begin{itemize}
\item \textbf{gmsh2}: \Gls{gmsh} file format in version 2.0. \item \textbf{gmsh2}: \Gls{gmsh} file format in version 2.0.
\item \textbf{vtu}: \Gls{vtu} file format.
\end{itemize} \end{itemize}
\item \textbf{meshFile}: Character. \item \textbf{meshFile}: Character.
Mesh filename. Mesh filename.
This file is searched in the path \textbf{output.path} and must contain the file extension. This file is searched in the path \textbf{output.path} and must contain the file extension.
\item \textbf{volume}: Real. \item \textbf{volume}: Real.
Units of $\unit{m^-3}$. Units of $\unit{m^{-3}}$.
Used to set a fictitious volume for the $0$ dimension. Used to set a fictitious volume for the $0$ dimension.
Ignored in the other cases. Ignored in the other cases.
\end{itemize} \end{itemize}
@ -536,7 +538,7 @@ make
Density of neutral background. Density of neutral background.
Required parameter. Required parameter.
\item \textbf{velocity}: Real. \item \textbf{velocity}: Real.
Units in $\unit{m^{-3}}$. Units in $\unit{m s^{-1}}$.
Array of dimension $3$. Array of dimension $3$.
Mean velocity of neutral background. Mean velocity of neutral background.
Required parameter. Required parameter.
@ -604,7 +606,8 @@ make
\item \textbf{part/s}: Particles (real) per second. \item \textbf{part/s}: Particles (real) per second.
\end{itemize} \end{itemize}
\item \textbf{v}: Real. \item \textbf{v}: Real.
Module of velocity vector, in $\unitfrac{m}{s}$. Units of $\unit{m s^{-1}}$.
Module of velocity vector.
\item \textbf{n}: Real. \item \textbf{n}: Real.
Array dimension $3$. Array dimension $3$.
Direction of injection. Direction of injection.
@ -618,6 +621,7 @@ make
\item \textbf{Delta}: Dirac's delta distribution function. All particles are injected with velocity \textbf{v} times the value of \textbf{n} in the specified direction. \item \textbf{Delta}: Dirac's delta distribution function. All particles are injected with velocity \textbf{v} times the value of \textbf{n} in the specified direction.
\end{itemize} \end{itemize}
\item \textbf{T}: Real. \item \textbf{T}: Real.
Units of $\unit{K}$
Array dimension $3$. Array dimension $3$.
Temperature in each direction. Temperature in each direction.
\item \textbf{physicalSurface}: Integer. \item \textbf{physicalSurface}: Integer.