Commit fb30bbaf authored by PIACIBELLO Cyrille's avatar PIACIBELLO Cyrille

should work better

parent bce59017
/*! \page contacts Contacts
*
* \section authors Authors
* ScalFmm is a library for the Fast Multipole Method (FMM). It is
* written in C++ and use OpenMP and MPI to support parallel
* execution. It is developed by the HiePACS team at the INRIA.
* You can contact the development team for any questions at
* <ul>
* <li> scalfmm-public-support@lists.gforge.inria.fr</li>
* </ul>
* If you want to see others projects of HiePACS Inria teams, please
* see : https://team.inria.fr/hiepacs/ .
* \section contributors Contributors
*
* <ul>
* <li> Olivier Coulaud </li>
* <li> Bérenger Bramas </li>
* <li> Cyrille Piacibello </li>
* </ul>
*/
/*! \page install Downloading, Building and Installing ScalFMM
*
* \section download Download ScalFMM
*
* To download ScalFmm go on http://scalfmm-public.gforge.inria.fr/download.html.
*
* You can stay in touch of the updates and new version by registering
* to the users mailing list
* (scalfmm-public-users@lists.gforge.inria.fr) which has a very low
* traffic (one email per month) at :
* http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/scalfmm-public-users.
*
* \section secNecessary Require
*
* <ul>
* <li> CMake for compiling, ccmake for configuring the build </li>
* <li> Open MP </li>
* <li> MPI, if you want to use distributed version of the algorithm </li>
* <li> A compiler supporting C++ 2011 </li>
* </ul>
*
* \section build Build
* How to build ScalFMM
* <ul>
* <li> Go to scalfmm/Build directory </li>
* <li> type <b> $> cmake .. </b>
* <ul>
* <li> If you want to enable MPI, use <b> $> cmake .. -DSCALFMM_USE_MPI=ON </b> </li>
* </ul>
* </li>
* <li> then configure your build with <b> $> ccmake .. </b> if needed </li>
* <li> then type <b> $> make name_of_exec </b> </li>
* </ul>
*
* \subsection conf Configuration of the build
*
* This is all the build options you can modify.
*
* <ul>
* <li> CMAKE_INSTALL_PREFIX : to choose where to install ScalFmm </li>
* <li> DSCALFMM_USE_MPI : to use and enable MPI. Warning, you need to use this parameter at the first cmake command you write. </li>
* <li> SCALFMM_ATTACHE_SOURCE : to build with -g </li>
* <li> SCALFMM_BUILD_DEBUG : to build in debug mode of cmake (with -O0) </li>
* <li> SCALFMM_BUILD_TESTS : to build the text and the examples </li>
* <li> SCALFMM_BUILD_UTESTS : to build the unit tests </li>
* <li> SCALFMM_USE_ADDONS : to activate add ons </li>
* <ul>
* <li> SCALFMM_ADDON_FMMAPI : to build Fmm Api </li>
* </ul>
* <li> SCALFMM_USE_DOUBLE_PRECISION : to build in double precision </li>
* <li> SCALFMM_USE_MEM_STATS : to use memory stats (which count any new/delete done during a simulation) </li>
* <li> SCALFMM_USE_BLAS : to enable blas (needed by most of the kernel) </li>
* <ul>
* <li> SCALFMM_USE_MKL_AS_BLAS : to use MKL as blas </li>
* </ul>
* <li> SCALFMM_USE_TRACE : to create trace </li>
* <ul>
* <li> SCALFMM_USE_ITAC : to use Intel ITAC tool as trace generator </li>
* </ul>
* </ul>
*
* Once the library is built, you may want to install it : <b> $> make
* install </b>. Note that it is not an obligation to install ScalFmm
* to use it. You can build it and use it from the Build directory.
* The whole project is documented using Doxygen. You can build the doc
* by typing <b> $> make doc </b> in the Build directory.
*
*
*/
/*! \page License License information
*
*
* The library is under LGPL + CeCILL-C licenses. In case of conflict
* the more restrictive has to be used. We encourage users to have a
* look to the official license websites in case of doubts.
*
* See the GNU General Public and CeCILL-C Licenses for more details.
* "http://www.cecill.info". "http://www.gnu.org/licenses".
*
* ScalFmm is under software patent number
* IDDN.FR.001.100030.000.S.P.2012.000.31235. If you need a more
* flexible license, please do not hesitate to contact us.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
*
*/
This diff is collapsed.
// This page contains the special doxygen pages and mainpage.
/*!
* @mainpage ScalFmm
*
* \section overV Overview
*
* ScalFMM is a software library to simulate N-body interactions using
* the Fast Multipole Method.
*
* The library offers two methods to compute interactions between
* bodies when the potential decays like 1/r. The first method is the
* classical FMM based on spherical harmonic expansions and the second is
* the Black-Box method which is an independent kernel formulation
* (introduced by E. Darve @ Stanford). With this method, we can now
* easily add new non oscillatory kernels in our library. For the
* classical method, two approaches are used to decrease the complexity
* of the operators. We consider either matrix formulation that allows us
* to use BLAS routines or rotation matrices to speed up the M2L
* operator.
*
* ScalFMM intends to offer all the functionalities needed to perform
* large parallel simulations while enabling an easy customization of
* the simulation components: kernels, particles and cells. It works
* in parallel in a shared/distributed memory model using OpenMP and
* MPI. The software architecture has been designed with two major
* objectives: being easy to maintain and easy to understand. There is
* two main parts:
* <ul>
* <li> the management of the octree and the
* parallelization of the method; </li>
* <li> The kernels. This new
* architecture allow us to easily add new FMM algorithm or kernels
* and new paradigm of parallelization. </li>
* </ul>
*
*
* To download build and install the application, please see \ref
* install.
*
* The \ref quick can help you to understand the architectur of the
* library.
*
* This software is distributed under a specific License. For more
* informations, see \ref License.
*
* If you want to cite the project and/or the team, please contact
* us. See \ref contacts page.
*
*/
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment