New input file sections in the user manual

doc/user-manual/fpakc_UserManual.tex

@@ -502,107 +502,130 @@ make
         \end{itemize}
       
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-      \subsection{boundary}
+      \subsection{boundaries}
-        The array object \textbf{boundary} determines the interaction between surfaces and particles.
+        The object \textbf{boundaries} has two main arrays that define the particle boundaries and the ones that must be applied to the electromagnetic field.
-        These boundaries need to be linked to a specific edge in the mesh.
-        The accepted variables are:
         \begin{itemize}
-          \item \textbf{name}: Character.
+        \item \textbf{particles}. Array of objects.
-                               Name of the boundary.
+          Different models for interaction between particles and edges.
-          \item \textbf{physicalSurface}: Integer.
+          \begin{itemize}
-                                          Identification of the surface in the mesh file.
+            \item \textbf{name}: Character.
-          \item \textbf{bType}: Array of objects of dimension 'number of species'.
+              Name of the boundary.
-                                Per each species defined in the case, a boundary \textbf{type} needs to be provided.
+            \item \textbf{type}: Character.
-                                Accepted values for \textbf{type} are:
+              Model for the interaction between particles and the edge.
-                                \begin{itemize}
+              Available options are:
-                                  \item \textbf{reflection}: Elastic reflection of particles.
+              \begin{itemize}
-                                  \item \textbf{absorption}: Particle is eliminated from the domain.
+                \item \textbf{reflection}: Elastic reflection of particles.
-                                                             The particle is first moved into the edge and its properties are scattered among the edge nodes.
+                \item \textbf{absorption}: Particle is eliminated from the domain.
-                                  \item \textbf{transparent}: Particle abandon the numerical domain.
+                  The particle is first moved into the edge and its properties are scattered among the edge nodes.
-                                  \item \textbf{wallTemperature}: Reflective wall with constant temperature that exchange heat with particles.
+                \item \textbf{transparent}: Particle abandon the numerical domain.                  
-                                                                  Required parameters are:
+                \item \textbf{axis}: Identifies the symmetry axis for 2D cylindrical simulations.
-                                                                  \begin{itemize}
+                  If , for some reason, a particle interacts with this axis, it is reflected.
-                                                                    \item \textbf{temperature}: Real.
+                \item \textbf{wallTemperature}: Reflective wall with constant temperature that exchange heat with particles.
-                                                                                                Units of $\unit{K}$.
+                Required parameters are:
-                                                                                                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}
+                \textbf{temperature}: Real.
-                                                               \item \textbf{effectiveTime}: Real.
+                  Units of $\unit{K}$.
-                                                                                             Units in $\unit{s}$.
+                  Temperature wall.
-                                                                                             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{specificHeat}: Real.
-                                                               \item \textbf{energyThreashold}: Real.
+                   Units of $\unit{J kg^{-1} K^{-1}}$.
-                                                                                                Units in $\unit{eV}$.
+                   Specific heat capacity of the material.
-                                                                                                Ionization energy threshold for the simulated process.
+                   
-                                                                                                Required parameter.
+                \item \textbf{ionization}: Per each particle crossing the surface with this type of boundary, a number of ionization events are calculated.
-                                                               \item \textbf{crossSection}: Character.
+                  A pair of ion-electron is generated for each ionization event, taking as a reference a neutral background.
-                                                                                            Complete path to the cross-section data for the ionization process.
+                  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}
           
-                                                             \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{boundaryEM}
+      \subsection{physicalSurfaces}
-        The array object \textbf{boundaryEM} determines the boundary conditions for the electromagnetic field.
+        Array of objects that links the named surfaces of the mesh to the models in \textbf{boundaries.particles} and \textbf{boundaries.EM}.
-        As with the \textbf{boundary} definition, these must be linked to an edge identified in the mesh file.
+        Each element of the array has the following items:
-        The variables for each array element are:
         \begin{itemize}
-          \item \textbf{name}: Character.
+          \item \textbf{index}. Integer.
-                               Name of the boundary.
+            Index of the edge surface as defined in the mesh file.
-          \item \textbf{type}: Character.
+          \item \textbf{particles}. Array of characters.
-                               Type of boundary.
+            Size equal to the number of species.
-                                Accepted values are:
+            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.
-                               \begin{itemize}
+          \item \textbf{EM}. Character.
-                                 \item \textbf{dirichlet}: Constant value of electric potential on the surface.
+            Name of the model in \textbf{boundaries.EM}.
-                                 \item \textbf{dirichletTime}: Constant value of the electric potential with a time variable profile.
+            If none is provided, the default reflection boundary condition is applied.
-                                                               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}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%