Commit 6ce08af3 authored by LACHAT Cedric's avatar LACHAT Cedric

Get last version of multigrid (which worked), Wed Oct 26 16:07:38 2016 +0000...

Get last version of multigrid (which worked), Wed Oct 26 16:07:38 2016 +0000 (local commit 7beddad5a4b)
parents
This diff is collapsed.
if (NOT ${AEROSOL_PATH} STREQUAL ${AEROSOL_HOME})
set (AEROSOL_IO_LIBRARY "NOTFOUND")
set (AEROSOL_MESH_LIBRARY "NOTFOUND")
set (AEROSOL_COMMON_LIBRARY "NOTFOUND")
set (AEROSOL_INCLUDE_DIR "NOTFOUND")
endif ()
set (AEROSOL_PATH ${AEROSOL_HOME} CACHE INTERNAL "")
find_path (AEROSOL_INCLUDE_DIR common/Defines.hpp HINTS ${AEROSOL_PATH} PATH_SUFFIXES include)
find_library (AEROSOL_IO_LIBRARY NAMES IO HINTS ${AEROSOL_PATH} PATH_SUFFIXES lib)
find_library (AEROSOL_MESH_LIBRARY NAMES Mesh HINTS ${AEROSOL_PATH} PATH_SUFFIXES lib)
find_library (AEROSOL_COMMON_LIBRARY NAMES Common HINTS ${AEROSOL_PATH} PATH_SUFFIXES lib)
if (AEROSOL_INCLUDE_DIR AND AEROSOL_IO_LIBRARY AND AEROSOL_MESH_LIBRARY AND AEROSOL_COMMON_LIBRARY)
set (AEROSOL_FOUND TRUE)
endif ()
if (AEROSOL_FOUND)
if (NOT AEROSOL_FIND_QUIETLY)
message (STATUS "Found AEROSOL : ${AEROSOL_IO_LIBRARY}")
endif (NOT AEROSOL_FIND_QUIETLY)
else (AEROSOL_FOUND)
if (AEROSOL_FIND_REQUIRED)
message (FATAL_ERROR "Could not find AEROSOL. You have to define variable AEROSOL_HOME")
endif (AEROSOL_FIND_REQUIRED)
endif (AEROSOL_FOUND)
mark_as_advanced (AEROSOL_INCLUDE_DIR AEROSOL_IO_LIBRARY AEROSOL_MESH_LIBRARY
AEROSOL_COMMON_LIBRARY)
SET(LIBMESH5_PATH ${LIBMESH5_HOME})
FIND_PATH(LIBMESH5_INCLUDE_DIR libmesh5.h PATHS ${LIBMESH5_PATH} PATH_SUFFIXES include)
FIND_LIBRARY(LIBMESH5_LIBRARY NAMES libmesh5.a PATHS ${LIBMESH5_PATH} PATH_SUFFIXES lib)
IF (LIBMESH5_INCLUDE_DIR AND LIBMESH5_LIBRARY)
SET(LIBMESH5_FOUND TRUE)
ENDIF (LIBMESH5_INCLUDE_DIR AND LIBMESH5_LIBRARY)
IF (LIBMESH5_FOUND)
IF (NOT LIBMESH5_FIND_QUIETLY)
MESSAGE(STATUS "Found LIBMESH5 : ${LIBMESH5_LIBRARY}")
ENDIF (NOT LIBMESH5_FIND_QUIETLY)
ELSE (LIBMESH5_FOUND)
IF (LIBMESH5_FIND_REQUIRED)
MESSAGE(FATAL_ERROR "Could not find LIBMESH5. You have to define variable LIBMESH5_HOME")
ENDIF (LIBMESH5_FIND_REQUIRED)
ENDIF (LIBMESH5_FOUND)
MARK_AS_ADVANCED(LIBMESH5_INCLUDE_DIR LIBMESH5_LIBRARY)
SET(MMG3D_PATH ${MMG3D_HOME})
FIND_PATH(MMG3D_INCLUDE_DIR libmmg3d.h PATHS ${MMG3D_PATH} PATH_SUFFIXES include)
FIND_LIBRARY(MMG3D_LIBRARY NAMES libmmg3d.a PATHS ${MMG3D_PATH} PATH_SUFFIXES lib)
if (PAMPA_MMG3D_SCOTCH)
FIND_LIBRARY(SCOTCH_MMG3D_LIBRARY NAMES libscotch.a PATHS ${MMG3D_PATH} PATH_SUFFIXES lib)
endif (PAMPA_MMG3D_SCOTCH)
IF (MMG3D_INCLUDE_DIR AND MMG3D_LIBRARY)
SET(MMG3D_FOUND TRUE)
ENDIF (MMG3D_INCLUDE_DIR AND MMG3D_LIBRARY)
IF (MMG3D_FOUND)
IF (NOT MMG3D_FIND_QUIETLY)
MESSAGE(STATUS "Found MMG3D : ${MMG3D_LIBRARY}")
ENDIF (NOT MMG3D_FIND_QUIETLY)
ELSE (MMG3D_FOUND)
IF (MMG3D_FIND_REQUIRED)
MESSAGE(FATAL_ERROR "Could not find MMG3D. You have to define variable MMG3D_HOME")
ENDIF (MMG3D_FIND_REQUIRED)
ENDIF (MMG3D_FOUND)
MARK_AS_ADVANCED(MMG3D_INCLUDE_DIR MMG3D_LIBRARY)
set(MMG3D4_PATH ${MMG3D4_HOME})
FIND_PATH(MMG3D4_INCLUDE_DIR libmmg3d4.h PATHS ${MMG3D4_PATH} PATH_SUFFIXES include)
FIND_LIBRARY(MMG3D4_LIBRARY NAMES libmmg3d4.a PATHS ${MMG3D4_PATH} PATH_SUFFIXES lib)
if (PAMPA_MMG3D4_SCOTCH)
FIND_LIBRARY(SCOTCH_MMG3D4_LIBRARY NAMES libscotch.a PATHS ${MMG3D4_PATH} PATH_SUFFIXES lib)
endif (PAMPA_MMG3D4_SCOTCH)
IF (MMG3D4_INCLUDE_DIR AND MMG3D4_LIBRARY)
SET(MMG3D4_FOUND TRUE)
ENDIF (MMG3D4_INCLUDE_DIR AND MMG3D4_LIBRARY)
IF (MMG3D4_FOUND)
IF (NOT MMG3D4_FIND_QUIETLY)
MESSAGE(STATUS "Found MMG3D4 : ${MMG3D4_LIBRARY}")
ENDIF (NOT MMG3D4_FIND_QUIETLY)
ELSE (MMG3D4_FOUND)
IF (MMG3D4_FIND_REQUIRED)
MESSAGE(FATAL_ERROR "Could not find MMG3D4. You have to define variable MMG3D4_HOME")
ENDIF (MMG3D4_FIND_REQUIRED)
ENDIF (MMG3D4_FOUND)
MARK_AS_ADVANCED(MMG3D4_INCLUDE_DIR MMG3D4_LIBRARY)
SET(MMG3D5_PATH ${MMG3D5_HOME})
FIND_PATH(MMG3D5_INCLUDE_DIR libmmg3d5.h PATHS ${MMG3D5_PATH} PATH_SUFFIXES include)
FIND_LIBRARY(MMG3D5_LIBRARY NAMES libmmg3d5.a PATHS ${MMG3D5_PATH} PATH_SUFFIXES lib)
if (PAMPA_MMG3D5_SCOTCH)
FIND_LIBRARY(SCOTCH_MMG3D5_LIBRARY NAMES libscotch.a PATHS ${MMG3D5_PATH} PATH_SUFFIXES lib)
endif (PAMPA_MMG3D5_SCOTCH)
IF (MMG3D5_INCLUDE_DIR AND MMG3D5_LIBRARY)
SET(MMG3D5_FOUND TRUE)
ENDIF (MMG3D5_INCLUDE_DIR AND MMG3D5_LIBRARY)
IF (MMG3D5_FOUND)
IF (NOT MMG3D5_FIND_QUIETLY)
MESSAGE(STATUS "Found MMG3D5 : ${MMG3D5_LIBRARY}")
ENDIF (NOT MMG3D5_FIND_QUIETLY)
ELSE (MMG3D5_FOUND)
IF (MMG3D5_FIND_REQUIRED)
MESSAGE(FATAL_ERROR "Could not find MMG3D5. You have to define variable MMG3D5_HOME")
ENDIF (MMG3D5_FIND_REQUIRED)
ENDIF (MMG3D5_FOUND)
MARK_AS_ADVANCED(MMG3D5_INCLUDE_DIR MMG3D5_LIBRARY)
SET(MSHINT_PATH ${MSHINT_HOME})
FIND_PATH(MSHINT_INCLUDE_DIR mshint.h PATHS ${MSHINT_PATH} PATH_SUFFIXES include)
FIND_LIBRARY(MSHINT_LIBRARY NAMES libmshint.a PATHS ${MSHINT_PATH} PATH_SUFFIXES lib)
IF (MSHINT_INCLUDE_DIR AND MSHINT_LIBRARY)
SET(MSHINT_FOUND TRUE)
ENDIF (MSHINT_INCLUDE_DIR AND MSHINT_LIBRARY)
IF (MSHINT_FOUND)
IF (NOT MSHINT_FIND_QUIETLY)
MESSAGE(STATUS "Found MSHINT : ${MSHINT_LIBRARY}")
ENDIF (NOT MSHINT_FIND_QUIETLY)
ELSE (MSHINT_FOUND)
IF (MSHINT_FIND_REQUIRED)
MESSAGE(FATAL_ERROR "Could not find MSHINT. You have to define variable MSHINT_HOME")
ENDIF (MSHINT_FIND_REQUIRED)
ENDIF (MSHINT_FOUND)
MARK_AS_ADVANCED(MSHINT_INCLUDE_DIR MSHINT_LIBRARY)
if (NOT ${NETLOC_PATH} STREQUAL ${NETLOC_HOME})
set (NETLOC_LIBRARY "NOTFOUND")
set (NETLOC_INCLUDE_DIR "NOTFOUND")
endif ()
set (NETLOC_PATH ${NETLOC_HOME} CACHE INTERNAL "")
find_path (NETLOC_INCLUDE_DIR netlocscotch.h HINTS ${NETLOC_PATH} PATH_SUFFIXES include)
find_library (NETLOC_LIBRARY NAMES netlocscotch HINTS ${NETLOC_PATH} PATH_SUFFIXES lib)
if (NETLOC_INCLUDE_DIR AND NETLOC_LIBRARY)
set (NETLOC_FOUND TRUE)
endif (NETLOC_INCLUDE_DIR AND NETLOC_LIBRARY)
if (NETLOC_FOUND)
if (NOT NETLOC_FIND_QUIETLY)
message (STATUS "Found NETLOC : ${NETLOC_LIBRARY}")
endif (NOT NETLOC_FIND_QUIETLY)
else (NETLOC_FOUND)
if (NETLOC_FIND_REQUIRED)
message (FATAL_ERROR "Could not find NETLOC. You have to define variable NETLOC_HOME")
endif (NETLOC_FIND_REQUIRED)
endif (NETLOC_FOUND)
mark_as_advanced (NETLOC_INCLUDE_DIR NETLOC_LIBRARY SCOTCH_LIBRARY)
if (NOT ${PTSCOTCH_PATH} STREQUAL ${PTSCOTCH_HOME})
set (PTSCOTCH_LIBRARY "NOTFOUND")
set (SCOTCH_LIBRARY "NOTFOUND")
set (PTSCOTCH_EXTRA_LIBRARY "NOTFOUND")
set (PTSCOTCH_INCLUDE_DIR "NOTFOUND")
endif ()
set (PTSCOTCH_PATH ${PTSCOTCH_HOME} CACHE INTERNAL "")
find_path (PTSCOTCH_INCLUDE_DIR ptscotch${PTSCOTCH_SUFFIX}.h HINTS ${PTSCOTCH_PATH} PATH_SUFFIXES include)
find_library (PTSCOTCH_LIBRARY NAMES ptscotch${PTSCOTCH_SUFFIX} HINTS ${PTSCOTCH_PATH} PATH_SUFFIXES lib)
find_library (SCOTCH_LIBRARY NAMES scotch${PTSCOTCH_SUFFIX} HINTS ${PTSCOTCH_PATH} PATH_SUFFIXES lib)
find_library (PTSCOTCH_EXTRA_LIBRARY NAMES ptscotcherr${PTSCOTCH_SUFFIX} HINTS ${PTSCOTCH_PATH} PATH_SUFFIXES lib)
if (PTSCOTCH_INCLUDE_DIR AND PTSCOTCH_LIBRARY AND SCOTCH_LIBRARY AND PTSCOTCH_EXTRA_LIBRARY)
set (PTSCOTCH_FOUND TRUE)
endif (PTSCOTCH_INCLUDE_DIR AND PTSCOTCH_LIBRARY AND SCOTCH_LIBRARY AND
PTSCOTCH_EXTRA_LIBRARY)
if (PTSCOTCH_FOUND)
if (NOT PTSCOTCH_FIND_QUIETLY)
message (STATUS "Found PTSCOTCH : ${PTSCOTCH_LIBRARY}")
endif (NOT PTSCOTCH_FIND_QUIETLY)
else (PTSCOTCH_FOUND)
if (PTSCOTCH_FIND_REQUIRED)
message (FATAL_ERROR "Could not find PTSCOTCH. You have to define variable PTSCOTCH_HOME")
endif (PTSCOTCH_FIND_REQUIRED)
endif (PTSCOTCH_FOUND)
mark_as_advanced (PTSCOTCH_INCLUDE_DIR PTSCOTCH_LIBRARY SCOTCH_LIBRARY
PTSCOTCH_EXTRA_LIBRARY PTSCOTCH_SUFFIX)
SET(TETGEN_PATH ${TETGEN_HOME})
FIND_PATH(TETGEN_INCLUDE_DIR tetgen.h PATHS ${TETGEN_PATH} PATH_SUFFIXES include)
FIND_LIBRARY(TETGEN_LIBRARY NAMES libtet.a PATHS ${TETGEN_PATH} PATH_SUFFIXES lib)
IF (TETGEN_INCLUDE_DIR AND TETGEN_LIBRARY)
SET(TETGEN_FOUND TRUE)
ENDIF (TETGEN_INCLUDE_DIR AND TETGEN_LIBRARY)
IF (TETGEN_FOUND)
IF (NOT TETGEN_FIND_QUIETLY)
MESSAGE(STATUS "Found TETGEN : ${TETGEN_LIBRARY}")
ENDIF (NOT TETGEN_FIND_QUIETLY)
ELSE (TETGEN_FOUND)
IF (TETGEN_FIND_REQUIRED)
MESSAGE(FATAL_ERROR "Could not find TETGEN. You have to define variable TETGEN_HOME")
ENDIF (TETGEN_FIND_REQUIRED)
ENDIF (TETGEN_FOUND)
MARK_AS_ADVANCED(TETGEN_INCLUDE_DIR TETGEN_LIBRARY)
#!/bin/bash
rm -f $4-*
$1 -n $2 $3 $4
cat $4-* > $4
diff $4 $5
#!/bin/bash
rm -f $2
$1 $2
diff $2 $3
#!/bin/bash
#echo $*
opath=$( pwd )
echo "/* Generated file by $0 */" > $opath/versions_ext.h
echo -e "Searching versions for external tools..."
for i in $*; do
prgm=$( echo $i|awk -F: '{print $1}' )
echo -e "\tExternal tool:$prgm"
path=$( echo $i|awk -F: '{print $2}' )
files=$( echo $i|awk -F: '{print $3}'|sed -e 's/,/ /g' )
cd $path
res=$(git rev-parse 2>/dev/null)
if [ $? == 0 ];then
#echo "depot git pour $prgm"
scm="git"
rev=$( git log --pretty=oneline --abbrev-commit --abbrev=10 -1|awk '{print $1}' )
# not commited files
notc=$( git diff HEAD --name-only|wc -l )
else
res=$(svn status 2>&1 |grep -v "not a working copy")
if [ $? == 0 ]; then
#echo "depot svn pour $prgm"
scm="svn"
#rev=$( svn log -l 1|grep "^r"|awk '{print $1}' )
rev=$( svn info|grep Revision|awk '{print $2}' )
# not commited files
notc=$( svn st|grep "^M"|wc -l )
else
#echo "ni git ni svn pour $prgm"
scm="none"
rev="none"
notc="infinity"
fi
fi
echo -e "\t\tFind modified files after last building..."
cmd="find $path -type f"
for file in $files; do
cmd="$cmd -a -cnewer $file"
done
echo -e "\t\tDone"
chgd=$( $cmd | wc -l )
echo "#define ${prgm}_PATH \"$path\"" >> $opath/versions_ext.h
echo "#define ${prgm}_SCM \"$scm\"" >> $opath/versions_ext.h
echo "#define ${prgm}_REV \"$rev\"" >> $opath/versions_ext.h
echo "/* Number of files changed after last building */" >> $opath/versions_ext.h
echo "#define ${prgm}_CHGD \"$chgd\"" >> $opath/versions_ext.h
echo "/* Not commited files */" >> $opath/versions_ext.h
echo "#define ${prgm}_NOTC \"$notc\"" >> $opath/versions_ext.h
echo -e "\tDone"
done
#!/bin/bash
#echo $*
oldfile=$1
newfile=$2
prgm=$3
path=$4
cd $path
res=$(git rev-parse 2>/dev/null)
if [ $? == 0 ];then
#echo "depot git pour $prgm"
scm="git"
rev=$( git log --pretty=oneline --abbrev-commit --abbrev=10 -1|awk '{print $1}' )
# not commited files
notc=$( git diff HEAD --name-only|wc -l )
else
res=$(svn status 2>&1 |grep -v "not a working copy")
if [ $? == 0 ]; then
#echo "depot svn pour $prgm"
scm="svn"
#rev=$( svn log -l 1|grep "^r"|awk '{print $1}' )
rev=$( svn info|grep Revision|awk '{print $2}' )
# not commited files
notc=$( svn st|grep "^M"|wc -l )
else
#echo "ni git ni svn pour $prgm"
scm="none"
rev="none"
notc="infinity"
fi
fi
echo "#define ${prgm}_PATH \"$path\"" >> $oldfile
echo "#define ${prgm}_SCM \"$scm\"" >> $oldfile
echo "#define ${prgm}_REV \"$rev\"" >> $oldfile
echo "/* Number of files changed after last building */" >> $oldfile
echo "/* Not commited files */" >> $oldfile
echo "#define ${prgm}_NOTC \"$notc\"" >> $oldfile
cmd=$( diff -q $oldfile $newfile)
if [ ! $? == 0 ]; then
cp $oldfile $newfile
fi
Cette copie de la distribution logicielle Scotch 5.2 est distribuée
selon les termes de la licence de logiciel libre CeCILL-C.
Une copie du texte de cette licence se trouve dans le sous-répertoire
"doc", dans le fichier appelé "CeCILL-C_V1-fr.txt". Veuillez en lire
attentivement les clauses. Vous ne pourrez utiliser cette copie de la
distribution logicielle Scotch 5.2 que si vous les acceptez.
This copy of the Scotch 5.2 distribution is licensed to you under the
terms of the CeCILL-C free/libre software license.
A copy of this license is available in subdirectory "doc", in file
named "CeCILL-C_V1-en.txt". Please read its terms carefully. Only if
you accept them can you use this copy of the Scotch 5.2 distribution.
The terms under which this copy of the PaMPA 0.0 distribution
is provided to you are described in file "LICENSE_en.txt", located
in the same directory as this file.
If you accept them, please refer to file "docs/user_1.0/doc.pdf" or
"docs/user_0.0/html/index.html", also located in this directory, for
the installation instructions.
########################
# documentation #
########################
find_package (Doxygen)
if (DOXYGEN_FOUND)
if (FORTRAN_INTERFACE)
# Generate pampaf.h
add_custom_command (OUTPUT pampaf_user.h
COMMAND ${CMAKE_COMMAND} -E copy
${PAMPA_BINARY_DIR}/src/libpampa/pampaf.h ${CMAKE_CURRENT_BINARY_DIR}/pampaf_user.h
COMMAND sed -e 's/^!/\\/\\//g' pampaf_user.h > ${PAMPA_SOURCE_DIR}/BUILD/pampaf.h
DEPENDS ${PAMPA_BINARY_DIR}/src/libpampa/pampaf.h)
list (APPEND DOC_DEPENDENCIES pampaf_user.h)
endif (FORTRAN_INTERFACE)
# Api documentation
file (GLOB API_PAGES ${PAMPA_SOURCE_DIR}/docs/api_pages/*.c)
add_custom_command (OUTPUT pampa_api.h
COMMAND ${CMAKE_COMMAND} -E remove
${CMAKE_CURRENT_BINARY_DIR}/pampa_user.h
COMMAND ${CMAKE_COMMAND} -E copy
${PAMPA_BINARY_DIR}/src/libpampa/pampa.h ${CMAKE_CURRENT_BINARY_DIR}/pampa_api.h
COMMAND cat ${PAMPA_SOURCE_DIR}/docs/api_pages/*.c >> ${CMAKE_CURRENT_BINARY_DIR}/pampa_api.h
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_BINARY_DIR}/pampa_api.h ${PAMPA_SOURCE_DIR}/BUILD/pampa.h
DEPENDS ${PAMPA_BINARY_DIR}/src/libpampa/pampa.h ${API_PAGES})
list (APPEND DOC_DEPENDENCIES pampa_api.h)
add_custom_target (apidoc
COMMAND ${CMAKE_COMMAND} -E echo_append "Building API Documentation..."
COMMAND ${DOXYGEN_EXECUTABLE} ${PAMPA_SOURCE_DIR}/docs/ApiDoxyfile
COMMAND ${CMAKE_COMMAND} -E echo "Done."
WORKING_DIRECTORY ${PAMPA_SOURCE_DIR}/docs
DEPENDS ${DOC_DEPENDENCIES})
# User documentation
file (GLOB USER_PAGES ${PAMPA_SOURCE_DIR}/docs/user_pages/*.c)
add_custom_command (OUTPUT pampa_user.h
COMMAND ${CMAKE_COMMAND} -E remove
${CMAKE_CURRENT_BINARY_DIR}/pampa_api.h
COMMAND ${CMAKE_COMMAND} -E copy
${PAMPA_BINARY_DIR}/src/libpampa/pampa.h ${CMAKE_CURRENT_BINARY_DIR}/pampa_user.h
COMMAND cat ${PAMPA_SOURCE_DIR}/docs/user_pages/*.c >> ${CMAKE_CURRENT_BINARY_DIR}/pampa_user.h
COMMAND ${PAMPA_SOURCE_DIR}/docs/list_examples.sh ${PAMPA_SOURCE_DIR}/src/samples ${CMAKE_CURRENT_BINARY_DIR}/pampa_user.h
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_CURRENT_BINARY_DIR}/pampa_user.h ${PAMPA_SOURCE_DIR}/src/libpampa/pampa.h
DEPENDS ${PAMPA_BINARY_DIR}/src/libpampa/pampa.h ${USER_PAGES})
list (APPEND DOC_DEPENDENCIES pampa_user.h)
add_custom_target (userdoc
COMMAND ${CMAKE_COMMAND} -E echo_append "Building User Documentation..."
COMMAND ${DOXYGEN_EXECUTABLE} ${PAMPA_SOURCE_DIR}/docs/UserDoxyfile
COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_CURRENT_BINARY_DIR}/pampa_user.h ${PAMPA_SOURCE_DIR}/src/libpampa/pampa.h
COMMAND ${CMAKE_COMMAND} -E echo "Done."
WORKING_DIRECTORY ${PAMPA_SOURCE_DIR}/docs
DEPENDS ${DOC_DEPENDENCIES} pampa_user.h)
# Pdf user documentation
if (UNIX)
add_custom_target (userpdfdoc
COMMAND ${CMAKE_COMMAND} -E echo_append "Building User Pdf Documentation..."
COMMAND make
COMMAND ${CMAKE_COMMAND} -E copy refman.pdf ../doc_${PAMPA_VERSION}.${PAMPA_RELEASE}.${PAMPA_PATCHLEVEL}.pdf
COMMAND ${CMAKE_COMMAND} -E echo "Done."
WORKING_DIRECTORY ${PAMPA_SOURCE_DIR}/docs/user_${PAMPA_VERSION}.${PAMPA_RELEASE}.${PAMPA_PATCHLEVEL}/latex)
add_custom_target (apipdfdoc
COMMAND ${CMAKE_COMMAND} -E echo_append "Building Api Pdf Documentation..."
COMMAND make
COMMAND ${CMAKE_COMMAND} -E copy refman.pdf ../doc_api_${PAMPA_VERSION}.${PAMPA_RELEASE}.${PAMPA_PATCHLEVEL}.pdf
COMMAND ${CMAKE_COMMAND} -E echo "Done."
WORKING_DIRECTORY ${PAMPA_SOURCE_DIR}/docs/api_${PAMPA_VERSION}.${PAMPA_RELEASE}.${PAMPA_PATCHLEVEL}/latex)
endif (UNIX)
add_dependencies (apidoc pampa)
add_dependencies (apipdfdoc apidoc)
add_dependencies (userdoc pampa)
add_dependencies (userpdfdoc userdoc)
# Define target doc
add_custom_target (doc DEPENDS apidoc apipdfdoc userdoc userpdfdoc)
# Specify where man documentation will be installed
file (GLOB MAN_FILES ${PAMPA_SOURCE_DIR}/docs/user_${PAMPA_VERSION}.${PAMPA_RELEASE}.${PAMPA_PATCHLEVEL}/man/man3/*.3)
install (FILES ${MAN_FILES}
DESTINATION share/man/man3)
endif (DOXYGEN_FOUND)
This diff is collapsed.
/*!
\page coding_conv Coding conventions
\section coding_conv_glb_nam Global naming conventions
\subsection naming_conv_intro Introduction
Names of structure fields or variables follow very strict naming conventions.
These conventions allow one to infere the function of a variable from its
name and, conversely, to devise a name from the meaning of a variable to be
created.
Variable names comprise three fields : the prefix, the infix, and the suffix.
Most often, variable names are 10 characters long, because the common sizes
of the three fields is 4-3-3.
- The suffix indicates the usage of the variable, that is, how its contents
are to be used.
- nbr: number (as the quantity of)
- num: number of (as an index)
- idx: index (which does not represent a "num")
- tab: array accessed through un-based indices (starting at 0)
- tax: array accessed through based indices (starting at "baseval")
- msk: mask value (for array index computations such as hash tables or based arrays)
- bax: dummy based array coupled to a "msk" index mask
For instance, a "num" or "nbr" variable can be used as an index to a "tab" or "tax" array.
- The infix, which is composed by three characters, indicates the locality
of variables used in a distributed context:
- glb: global: variable/array is replicated and has the same value across
all processes
- loc: local: variable/array is replicated, but contains data that is
specific (local) to each processing element
- gst: ghost: variable/array contains local data, plus copy (ghost) data
that has been obtained from neighboring processing elements.
- The prefix, which contains four characters, indicates the contents:
- degr: degree value