diff --git a/doc/user-manual/fpakc_UserManual.pdf b/doc/user-manual/fpakc_UserManual.pdf index 8af12d5..5321ba4 100644 Binary files a/doc/user-manual/fpakc_UserManual.pdf and b/doc/user-manual/fpakc_UserManual.pdf differ diff --git a/doc/user-manual/fpakc_UserManual.tex b/doc/user-manual/fpakc_UserManual.tex index 7a17942..845cc9a 100644 --- a/doc/user-manual/fpakc_UserManual.tex +++ b/doc/user-manual/fpakc_UserManual.tex @@ -502,132 +502,109 @@ make \end{itemize} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - \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. + \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: \begin{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{type}: Character. - Model for the interaction between particles and the edge. - Available options 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{axis}: Identifies the symmetry axis for 2D cylindrical simulations. - If , for some reason, a particle interacts with this axis, it is reflected. - \item \textbf{wallTemperature}: Reflective wall with constant temperature that exchange heat with particles. - Required parameters are: - - \textbf{temperature}: Real. - Units of $\unit{K}$. - Temperature wall. - - \textbf{specificHeat}: Real. - Units of $\unit{J kg^{-1} K^{-1}}$. - Specific heat capacity of the material. - - \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 available input is: - - \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} - - \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. - - \textbf{energyThreashold}: Real. - Units in $\unit{eV}$. - Ionization energy threshold for the simulated process. - Required parameter. - - \textbf{electronSecondary}. Character. - Name of the species for the secondary electrons produced. - I none is provided, the input species is used. - - \textbf{crossSection}: Character. - Complete path to the cross-section data for the ionization process. - \end{itemize} - \end{itemize} - \item \textbf{EM}. Array of objects.determines the boundary conditions for the electromagnetic field. - As with the \textbf{boundary} definition, these must be linked to an edge identified in the mesh file. - The variables for each array element are: - \begin{itemize} - \item \textbf{name}: Character. - Name of the boundary. - \item \textbf{type}: Character. - Type of boundary. - Accepted values are: - \begin{itemize} - \item \textbf{dirichlet}: Constant value of electric potential on the surface. - Required values are: - - \textbf{potential}: Real. - Fixed potential for Dirichlet boundary condition. - - \item \textbf{dirichletTime}: Constant value of the electric potential with a time variable profile. - Required values are: - - \textbf{potential}: Real. - Potential for Dirichlet boundary condition. - - \textbf{temporalProfile}: Character. - Filename of the 2 column file containing the time variable profile. - File must be located in \textbf{output.path}. - The first column is the time in $\unit{s}$. - The second column is the factor that will multiply the value set in \textbf{potential}. - - \end{itemize} - - \end{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} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - \subsection{physicalSurfaces} - Array of objects that links the named surfaces of the mesh to the models in \textbf{boundaries.particles} and \textbf{boundaries.EM}. - Each element of the array has the following items: + \subsection{boundaryEM} + The array object \textbf{boundaryEM} determines the boundary conditions for the electromagnetic field. + As with the \textbf{boundary} definition, these must be linked to an edge identified in the mesh file. + The variables for each array element are: \begin{itemize} - \item \textbf{index}. Integer. - Index of the edge surface as defined in the mesh file. - \item \textbf{particles}. Array of characters. - Size equal to the number of species. - Each element of the array is the name of the \textbf{boundaries.particles} that the species will experience when interacting with the edge in this physical surface. - \item \textbf{EM}. Character. - Name of the model in \textbf{boundaries.EM}. - If none is provided, the default reflection boundary condition is applied. + \item \textbf{name}: Character. + Name of the boundary. + \item \textbf{type}: Character. + Type of boundary. + Accepted values are: + \begin{itemize} + \item \textbf{dirichlet}: Constant value of electric potential on the surface. + \item \textbf{dirichletTime}: Constant value of the electric potential with a time variable profile. + The value of \textbf{boundaryEM.potential} will be multiplied for the corresponding value in the file \textbf{boundaryEM.temporalProfile}. + \end{itemize} + \item \textbf{potential}: Real. + Fixed potential for Dirichlet boundary condition. + \item \textbf{physicalSurface}: Integer. + Identification of the edge in the mesh file. + \item \textbf{temporalProfile}: Character. + Filename of the 2 column file containing the time variable profile. + File must be located in \textbf{output.path}. + The first column is the time in $\unit{s}$. + The second column is the factor that will multiply the value of the boundary. + \end{itemize} - + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{inject} The array \textbf{inject} specifies the injection of particles from different surfaces.