Skip to content

Commit 926e22a

Browse files
added comments by alberto
1 parent a6560eb commit 926e22a

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ We provide the following capabilities
1313
- Automatic treatment of sharp edges via the double nodes technique.
1414
- Usage of Lagrangian Finite Elements of arbitrary order. We also provide interfaces with discontinuous elements.
1515
- Distributed memory (MPI) parallelisation of the standard collocation BEM for the Laplace equation.
16-
- Coupling with a FMM to get a performance improvement.
17-
- Hybrid Distributed (MPI) - Shared (TBB) memory parallelisation for the BEM-FMM code
16+
- Coupling with a Fast Multiple Method (FMM) to get a performance improvement.
17+
- Hybrid Distributed (MPI) - Shared (Intel Threaded Building Block) memory parallelisation for the BEM-FMM code
1818
- Recovery of both primal (potential) and dual (potential normal derivative) unknowns.
19-
- L2 projection of the full 3D potential gradient for post processing.
19+
- L2 projection of the full 3D potential gradient for post processing.
2020
- Extensive tuning via parameter file using the [deal2lkit](https://github.com/mathLab/deal2lkit) library
2121

2222

2323
## Code Structure
2424
We have subdivided the code in main classes to handle the many different aspects of a complete BEM simulation.
2525

26-
- Driver. 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.
26+
- Driver. This class is in charge of organising the overall BEM simulation. It has interfaces with all the other classes in order to perform a complete simulation.
2727
- ComputationalDomain. This class handles, and provides to the other classes, ONLY the geometry of the problem. In particular
2828
- it handles the domain decomposition using a graph partitioning tool (METIS);
2929
- it reads the domain from an external file.
30-
- BoundaryCondition. The class handling the boundary conditions. In particular
30+
- BoundaryCondition. The class handles the boundary conditions. In particular
3131
- it reads the boundary conditions for the potential and its normal derivative;
32-
- 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;
32+
- given the peculiarities of the BEM, the boundary conditions represent the actual unknowns, thus it creates the vectors containing the two variables and fills them with the proper data;
3333
- it performs the error analysis on both unknowns.
3434

3535
- BEMProblem. This class is the core of the BEM simulation
@@ -39,13 +39,15 @@ We have subdivided the code in main classes to handle the many different aspects
3939
- it eventually interacts with the FMM accelerator.
4040
- BEMFMA. This class handles the accelerator, in particular
4141
- it sets up an hierarchical 3D space subdivision (octree);
42-
- it receives two distributed vectors representinf the unknowns and performs a full FMM matrix vector product.
42+
- it receives two distributed vectors representing the unknowns and performs a full FMM matrix vector product.
4343

4444
## Install Procedure
4545
In order to successfully compile the code you need
4646

47-
- to install the [deal.II](https://github.com/dealii/dealii) library allowing both for multiprocessors and multithreaded environment.
4847
- to install the Trilinos and Metis wrappers of the library, see the official [instructions](https://www.dealii.org/developer/readme.html)
48+
- to install the [deal.II](https://github.com/dealii/dealii) library allowing both for multiprocessors and multithreaded environment.
49+
- to install the [deal2lkit](https://github.com/mathLab/deal2lkit) library allowing both for multiprocessors and multithreaded environment.
50+
4951

5052
Then you can clone the repository and compile it
5153

include/boundary_conditions.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@
7777
#include <deal2lkit/utilities.h>
7878

7979
/**
80-
* - BoundaryCondition. The class handling the boundary conditions. In particular
80+
* - BoundaryCondition. The class handles the boundary conditions. In particular
8181
* - it reads the boundary conditions for the potential and its normal derivative;
82-
* - 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;
82+
* - given the peculiarities of the BEM, the boundary conditions represent the actual unknowns, thus it creates the vectors containing the variables and fills them with the proper data;
8383
* - it performs the error analysis on both unknowns.
8484
*/
8585
template <int dim>

0 commit comments

Comments
 (0)