Commit 0a3435f4 authored by COULAUD Olivier's avatar COULAUD Olivier

Doc improvement ;)

parent 4941a7b8
......@@ -813,6 +813,7 @@ if (MORSE_DISTRIB_DIR OR EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules/morse/
##################################################################
# Add - doc #
##################################################################
message(STATUS "SCALFMM_BUILD_DOC = ${SCALFMM_BUILD_DOC}" )
if(SCALFMM_BUILD_DOC)
add_subdirectory(Doc)
endif()
......
# add a target to generate API documentation with Doxygen
find_package(Doxygen)
if(DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(
doc
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
......@@ -11,5 +12,5 @@ if(DOXYGEN_FOUND)
# INSTALL(FILES ${SCALFMM_BINARY_DIR}/Doc/scalfmm.tag DESTINATION doc/ )
# INSTALL(DIRECTORY ${SCALFMM_BINARY_DIR}/Doc/html DESTINATION doc/ )
else()
message( WARNING "You ask to enable the doc generation but Doxygen cannot be found." )
message( FATAL_ERROR "You ask to enable the doc generation but Doxygen cannot be found." )
endif(DOXYGEN_FOUND)
/*! \page interFMM Kernel Independent FMM
* In this section, we briefly discuss the
* \section general
* \section MatrixKernel
*
* \subsection AddKernel How add a new Matrix Kernel
* \subsection predKernel predefined Matrix Kernel
* Different kernels are predefined in ScalFMM. The kernels are in located
* in FInterpMatrixKernel.hpp
*<ul>
* <li> Laplacian kernel K(x,y)= 1/r with r=|x-y| <--> class FInterpMatrixKernelR
* <li> Laplacian kernel K(x,y)=1/rh with rh=sqrt(L_i*(x_i-y_i)^2) <--> class FInterpMatrixKernelRH
* <li> K(x,y)=1/r^2 with r=|x-y| <--> class FInterpMatrixKernelRR
* <li> Lennard Jones K(x,y)=1/r^12 - 1/r^6 with r=|x-y|" <--> class FInterpMatrixKernelLJ
* <li>Modified Laplacian kernel K(x,y)=1/r exp(-lambda r) with r=|x-y| <--> FInterpMatrixKernelML
* <li> K(x,y)=1/(r^2 + coreWidth) with r=|x-y| <--> FInterpMatrixKernelAPLUSRR
* </ul>
*/
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