diff --git a/doc/user-manual/fpakc_UserManual.tex b/doc/user-manual/fpakc_UserManual.tex index 845cc9a..5168c67 100644 --- a/doc/user-manual/fpakc_UserManual.tex +++ b/doc/user-manual/fpakc_UserManual.tex @@ -502,79 +502,82 @@ make \end{itemize} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - \subsection{boundary} - The array object \textbf{boundary} determines the interaction between surfaces and particles. - These boundaries need to be linked to a specific edge in the mesh. - The accepted variables are: + \subsection{boundaries} + The object \textbf{boundaries} has two main arrays that define the particle boundaries and the ones that must be applied to the electromagnetic field. \begin{itemize} - \item \textbf{name}: Character. - Name of the boundary. - \item \textbf{physicalSurface}: Integer. - Identification of the surface in the mesh file. - \item \textbf{bType}: Array of objects of dimension 'number of species'. - Per each species defined in the case, a boundary \textbf{type} needs to be provided. - Accepted values for \textbf{type} are: - \begin{itemize} - \item \textbf{reflection}: Elastic reflection of particles. - \item \textbf{absorption}: Particle is eliminated from the domain. - The particle is first moved into the edge and its properties are scattered among the edge nodes. - \item \textbf{transparent}: Particle abandon the numerical domain. - \item \textbf{wallTemperature}: Reflective wall with constant temperature that exchange heat with particles. - Required parameters are: - \begin{itemize} - \item \textbf{temperature}: Real. - Units of $\unit{K}$. - Temperature wall. - \item \textbf{specificHeat}: Real. - Units of $\unit{J kg^{-1} K^{-1}}$. - Specific heat capacity of the material. - \end{itemize} - \item \textbf{ionization}: Per each particle crossing the surface with this type of boundary, a number of ionization events are calculated. - A pair of ion-electron is generated for each ionization event, taking as a reference a neutral background. - The secondary electron is taken as the same type as the incident particle. - The available input is: - \begin{itemize} - \item \textbf{neutral}: Object. - Information about the neutral background. - Required parameters are: - \begin{itemize} - \item \textbf{ion}: Character. - Species name of the ion generated as defined in object \textbf{species}. - Required parameter. - \item \textbf{mass}: Real. - Units in $\unit{kg}$. - Mass of neutral species. - If missing, the mass of the ion is used - \item \textbf{density}: Real. - Units in $\unit{m^{-3}}$. - Density of neutral background. - Required parameter. - \item \textbf{velocity}: Real. - Units in $\unit{m s^{-1}}$. - Array of dimension $3$. - Mean velocity of neutral background. - Required parameter. - \item \textbf{temperature}: Real. - Units in $\unit{K}$. - Temperature of neutral background. - Required parameter. - - \end{itemize} - \item \textbf{effectiveTime}: Real. - Units in $\unit{s}$. - As the particle is no longer simulated once it crossed the boundary, this time represents the effective time in which the particle produces ionization processes in the neutral background. - Required parameter. - \item \textbf{energyThreashold}: Real. - Units in $\unit{eV}$. - Ionization energy threshold for the simulated process. - Required parameter. - \item \textbf{crossSection}: Character. - Complete path to the cross-section data for the ionization process. - - \end{itemize} - \item \textbf{axis}: Identifies the symmetry axis for 2D cylindrical simulations. - If , for some reason, a particle interacts with this axis, it is reflected. - \end{itemize} + \item \textbf{particles}. Array of objects. + Different models for interaction between particles and edges. + \begin{itemize} + \item \textbf{name}: Character. + Name of the boundary. + \item \textbf{physicalSurface}: Integer. + Identification of the surface in the mesh file. + \item \textbf{bType}: Array of objects of dimension 'number of species'. + Per each species defined in the case, a boundary \textbf{type} needs to be provided. + Accepted values for \textbf{type} are: + \begin{itemize} + \item \textbf{reflection}: Elastic reflection of particles. + \item \textbf{absorption}: Particle is eliminated from the domain. + The particle is first moved into the edge and its properties are scattered among the edge nodes. + \item \textbf{transparent}: Particle abandon the numerical domain. + \item \textbf{wallTemperature}: Reflective wall with constant temperature that exchange heat with particles. + Required parameters are: + \begin{itemize} + \item \textbf{temperature}: Real. + Units of $\unit{K}$. + Temperature wall. + \item \textbf{specificHeat}: Real. + Units of $\unit{J kg^{-1} K^{-1}}$. + Specific heat capacity of the material. + \end{itemize} + \item \textbf{ionization}: Per each particle crossing the surface with this type of boundary, a number of ionization events are calculated. + A pair of ion-electron is generated for each ionization event, taking as a reference a neutral background. + The secondary electron is taken as the same type as the incident particle. + The available input is: + \begin{itemize} + \item \textbf{neutral}: Object. + Information about the neutral background. + Required parameters are: + \begin{itemize} + \item \textbf{ion}: Character. + Species name of the ion generated as defined in object \textbf{species}. + Required parameter. + \item \textbf{mass}: Real. + Units in $\unit{kg}$. + Mass of neutral species. + If missing, the mass of the ion is used + \item \textbf{density}: Real. + Units in $\unit{m^{-3}}$. + Density of neutral background. + Required parameter. + \item \textbf{velocity}: Real. + Units in $\unit{m s^{-1}}$. + Array of dimension $3$. + Mean velocity of neutral background. + Required parameter. + \item \textbf{temperature}: Real. + Units in $\unit{K}$. + Temperature of neutral background. + Required parameter. + + \end{itemize} + \item \textbf{effectiveTime}: Real. + Units in $\unit{s}$. + As the particle is no longer simulated once it crossed the boundary, this time represents the effective time in which the particle produces ionization processes in the neutral background. + Required parameter. + \item \textbf{energyThreashold}: Real. + Units in $\unit{eV}$. + Ionization energy threshold for the simulated process. + Required parameter. + \item \textbf{crossSection}: Character. + Complete path to the cross-section data for the ionization process. + + \end{itemize} + \item \textbf{axis}: Identifies the symmetry axis for 2D cylindrical simulations. + If , for some reason, a particle interacts with this axis, it is reflected. + \end{itemize} + \end{itemize} + \item \textbf{EM} \end{itemize} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%