added some documentation for the classes

Author: nicola-giuliani

Doxyfile.in

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Parallel BEM Solver for deal.II"
+PROJECT_NAME           = "pi-BEM: a parallel BEM solver for deal.II"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

include/bem_fma.h

@@ -40,6 +40,13 @@ namespace Operator
 using namespace dealii;
 using namespace deal2lkit;
 
+/**
+* A class for the handling of the Fast Multiple Method coupled with the Bundary Element Method.
+* It is derived from ParameterAcceptor to have a common interface with parameter files. In
+* particular this class performs the matrix vector products approximating long range interactions
+* via Multipole and Local Expansions that are contained in dedicated classes.
+
+*/
 template <int dim>//, Type V>
 class BEMFMA : public ParameterAcceptor
 {

include/bem_problem.h

@@ -101,6 +101,13 @@ using namespace deal2lkit;
 //using namespace TrilinosWrappers;
 //using namespace TrilinosWrappers::MPI;
 
+/**
+* - BEMProblem. This class is the core of the BEM simulation
+*   - it receives the variables vector filled in with the proper boundary condition;
+*   - it creates the codimension 1 functional space setting up the BEM;
+*   - it solves the system using a preconditioned parallel GMRES solver;
+*   - it eventually interacts with the FMM accelerator.
+*/
 template <int dim>
 class BEMProblem : public ParameterAcceptor
 {

include/boundary_conditions.h

@@ -76,6 +76,12 @@
 #include <deal2lkit/parsed_data_out.h>
 #include <deal2lkit/utilities.h>
 
+/**
+* - BoundaryCondition. The class handling the boundary conditions. In particular
+*   - it reads the boundary conditions for the potential and its normal derivative;
+*   - given the peculiarities of the BEM the boundary conditions represent the actual unknowns, thus it creates the vector containing the variables and fills them with the proper data;
+*   - it performs the error analysis on both unknowns.
+*/
 template <int dim>
 class BoundaryConditions : public ParameterAcceptor
 {

include/computational_domain.h

@@ -67,6 +67,11 @@
 using namespace dealii;
 using namespace deal2lkit;
 
+/**
+* - ComputationalDomain. This class handles, and provides to the other classes, ONLY the geometry of the problem. In particular
+*  - it handles the domain decomposition using a graph partitioning tool (METIS);
+*  - it reads the domain from an external file.
+*/
 template <int dim>
 class ComputationalDomain : public ParameterAcceptor
 {

include/driver.h

@@ -69,7 +69,9 @@ using namespace dealii;
 //using namespace TrilinosWrappers::MPI::Vector;
 //using namespace TrilinosWrappers::MPI::SparseMatrix;
 
-
+/**
+* This class is in charge of organising the overall BEM simulation. It has interfaces with all the other classes in order to have a complete simulation.
+*/
 template <int dim>
 class Driver : public ParameterAcceptor
 {