Commit 067e396b authored by Praetorius, Simon's avatar Praetorius, Simon

Merge branch 'feature/amdisproject' into 'develop'

initial version of amdisproject script

See merge request !70
parents 14a25e76 d655c2cc
Pipeline #1775 passed with stage
in 43 minutes and 6 seconds
......@@ -14,12 +14,13 @@ dune_project()
dune_enable_all_packages(MODULE_LIBRARIES amdis fmt)
add_subdirectory("bin")
add_subdirectory("cmake/modules")
add_subdirectory("doc")
add_subdirectory("externals")
add_subdirectory("src")
add_subdirectory("test")
add_subdirectory("examples" EXCLUDE_FROM_ALL)
add_subdirectory("doc")
add_subdirectory("cmake/modules")
add_subdirectory("externals")
target_link_libraries(amdis fmt)
......
install(PROGRAMS
amdisproject
DESTINATION ${CMAKE_INSTALL_BINDIR})
#!/usr/bin/env bash
#
# TODO:
#
# * Check module names entered as dependencies.
set -e
canonicalname(){
if test $# -ne 1; then
echo Usage: canonicalname path >&2
return 1
fi
file="`eval echo $1`" # expand ~
if test ! -e "$file"; then
echo $file: file not found >&2
return 1
fi
# if this is a symlink, then follow the symlink
if test -L "$file"; then
fdir="`dirname \"$file\"`"
flink="`readlink \"$file\"`"
if test -e "$flink"; then
# these are absolute links, or links in the CWD
canonicalname "$flink"
else
canonicalname "$fdir/$flink"
fi
else
# if this is a file, then remember the filename and
# canonicalize the directory name
if test -f "$file"; then
fdir="`dirname \"$file\"`"
fname="`basename \"$file\"`"
fdir="`canonicalname \"$fdir\"`"
echo "$fdir/$fname"
fi
# if this is a directory, then create an absolute
# directory name and we are done
if test -d "$file"; then
(cd "$file"; pwd)
fi
fi
}
canonicalpath(){
if test $# -ne 1; then
echo Usage: canonicalpath path >&2
return 1
fi
dirname "$(canonicalname "$1")"
}
pkg_config_dependencies(){
if test $# -ne 1; then
echo Usage: pkg_config_dependencies name >&2
return 1
fi
name="$1"
depends="`pkg-config --variable=DEPENDENCIES $name| sed -e 's/,/ /g'`"
for pkg in $depends; do
depends="$depends `pkg_config_dependencies $pkg`"
done
echo $depends
}
modulesexist(){
local status dep found
status=0
for dep in $1; do
found=false
if [[ " $2 " == *" $dep "* ]]; then
found=true
fi
# If module not found in list, try pkg-config
if ! $found && pkg-config $dep &> /dev/null; then
found=true
fi
if ! $found; then
echo "ERROR:">&2
echo "Module with name $dep was not found" >&2
echo "Did you forget to specify its location" >&2
echo "in the DUNE_CONTROL_PATH variable?">&2
echo >&2
status=1
fi
done
return $status
}
make_unique(){
if [ "$#" = "1" ]; then
# take first word
for exclude_word in $1; do
break;
done
make_unique $exclude_word "$1" 0
else
local exclude_word="$1"
local words="$2"
local pos="$3"
local length=0
local i=0
local new_words=""
local cur=0
for word in $words; do
if [ $i -le $pos ]; then
i=$((i+1))
length=$((length+1))
new_words="$new_words $word"
continue
fi
if [ "$word" != "$exclude_word" ]; then
new_words="$new_words $word"
if [ "$((length-1))" = "$pos" ]; then
next_word="$word"
fi
length=$((length+1))
fi
done
if [ "$pos" -lt "$length" ]; then
# process next word
make_unique "$next_word" "$new_words" $((pos+1))
else
export UNIQUE_WORDS="$new_words"
fi
fi
}
echo
echo == AMDiS project/module generator ==
echo
echo amdisproject will assist you in the creation of a new AMDiS application.
echo During this process a new directory with the name of your project will be
echo created. This directory will hold all configuration and Makefiles and a
echo simple example application.
echo
################## FIND AVAILABLE MODULES ##################
DUNE_MODULES_LIB=$(IFS=':' && find $DUNE_CONTROL_PATH -type f -path "*/lib/dunemodules.lib")
. ${DUNE_MODULES_LIB}
export PREFIX_DIR="`canonicalpath "${DUNE_MODULES_LIB}"`/.."
extract_multiarch_pkg_config_path
# search for modules, both installed and src modules
find_modules_in_path
# sort modules to remove duplicates
sort_modules $FOUND_MODULES
FOUND_MODULES=$MODULES
# require module amdis
modulesexist "amdis" "$FOUND_MODULES"
# get the real module names
MODULES=""
for i in $FOUND_MODULES; do
if [ "$i" != "amdis" ]; then
mod=$(eval echo \$NAME_$i)
MODULES="$MODULES$mod "
fi
done
if [ "$MODULES" = "" ]; then
echo "ERROR:">&2
echo " No dune modules were found!">&2
echo " Did you forget to specify the places where ">&2
echo " you installed your modules in the ">&2
echo " DUNE_CONTROL_PATH environment variable">&2
echo " and adjusted the PKG_CONFIG_PATH environment">&2
echo " accordingly?" >&2
exit 1;
fi
################## READ CMDLINE OPTIONS ##########
PROJECT="$1"
DEPENDENCIES="$2"
VERSION="$3"
MAINTAINER="$4"
################## READ OPTIONS ##################
while [ "$DATACORRECT" != "y" -a "$DATACORRECT" != "Y" ]; do
while [ -z $PROJECT ]; do
read -p "1) Name of your new Project? (e.g.: amdis-ellipt): " PROJECT
if echo "$MODULES" | grep -q ^$PROJECT$; then
read -p " A module named $PROJECT already exists. Continue anyway? [y/N] " CONT
if test x$DELETE = xy -o x$DELETE = xY; then
PROJECT=""
fi
elif echo "$PROJECT" | grep -q "\."; then
echo "The Name contains a dot (.) which is not allowed."
PROJECT=""
fi
done
MODULE="$PROJECT"
DEPOK=1
while [ "$DEPOK" != 0 ]; do
echo "2) Which additional modules should this project depend on?"
echo " The following modules have been found:"
echo " $MODULES"
# for i in $MODULES; do echo -n " $i"; done
# echo ""
read -p " Enter space-separated list (or nothing): " DEPENDENCIES
if [ -z "$DEPENDENCIES" ]; then
DEPOK=0
fi
set +e
modulesexist "$DEPENDENCIES" "$MODULES"
DEPOK=$?
set -e
if [ "$DEPOK" != 0 ]; then
DEPENDENCIES=""
fi
done
if [ -z "$DEPENDENCIES" ]; then
DEPENDENCIES="amdis"
else
DEPENDENCIES="amdis ${DEPENDENCIES}"
fi
while [ -z $VERSION ]; do
read -p "3) Project/Module version? " VERSION
done
while [ -z "$MAINTAINER" ]; do
read -p "4) Maintainer's email address? " MAINTAINER
done
echo
echo "creating Project \"$PROJECT\", version $VERSION "
echo "which depends on \"$DEPENDENCIES\""
echo "with maintainer \"$MAINTAINER\""
read -p "Are these informations correct? [y/N] " DATACORRECT
# reset data if necessary
if [ "$DATACORRECT" != "y" -a "$DATACORRECT" != "Y" ]; then
PROJECT=""
DEPENDENCIES=""
VERSION=""
MAINTAINER=""
fi
done
echo
echo "A sample code $MODULE.cc is generated in the \"$PROJECT\" directory."
echo "Look at the README.md and dune.module files there."
echo "Now you can run the dunecontrol script which will setup the new module."
echo "Sometimes you may have to tweak CMakeLists.txt a bit."
if test -d $PROJECT; then
echo WARNING:
echo "A directory with the name $PROJECT already exists."
echo "Do you want to continue anyway?"
read -p "Type Y to overwrite the old directory, N to abort. [y/N] " DELETE
if test x$DELETE != xy -a x$DELETE != xY; then
echo Abort...
exit 1
fi
rm -rf "$PROJECT"
fi
mkdir "$PROJECT"
################## dune.module ##################
cat > "$PROJECT/dune.module" <<C_DELIM
################################
# Dune module information file #
################################
Module: $MODULE
Version: $VERSION
Maintainer: $MAINTAINER
Depends: $DEPENDENCIES
Suggests: # add additional optional dune modules here
C_DELIM
## Create the parameters passed to DUNE_CHECK_ALL
# save module list of dunemodules.inc
save_MODULES=$MODULES
for name in $DEPENDENCIES; do
mod="`fix_variable_name $name`"
if test "x$(eval echo \$HAVE_$mod)" != "x"; then
# found via dunemodules.inc
sort_modules "$mod"
for mod in $MODULES; do
M_DEPS="$M_DEPS $(eval echo \$NAME_$mod)"
done
MODULES=$save_MODULES
else
# found via pkg-config
M_DEPS="`pkg_config_dependencies $name` $name"
fi
for dep in $M_DEPS; do
CHECK="$CHECK [$dep]"
done
done
set +x
make_unique "$CHECK"
# insert , between modules
j=0
for dep in $UNIQUE_WORDS; do
if [ "$j" = "0" ]; then
CHECK="$dep"
j=1
else
CHECK="$CHECK, $dep"
fi
done
echo "------------------------------------------"
echo "writing initial files:"
# complete module name with _ instead of - to not confuse automake
fix_and_assign CMODULE $MODULE
# module name without prefix "amdis-"
NAME=`echo $PROJECT | sed -e 's/amdis[_-]//'`
# $NAME with _ instead of - to not confuse automake
NAME_=`echo $NAME | tr '-' '_'`
# module name in uppercase with _ instead of -
UNAME=`echo $PROJECT | tr '-' '_' | sed 's/\(.*\)/\U\1/'`
################## README ##################
echo "- $PROJECT/README.md"
cat > "$PROJECT/README.md" <<R_DELIM
Preparing the Sources
=========================
Additional to the software mentioned in README.md you'll need the
following programs installed on your system:
cmake >= 3.1
Getting started
---------------
If these preliminaries are met, you should run
dunecontrol all
which will find all installed dune modules as well as all dune modules
(not installed) which sources reside in a subdirectory of the current
directory. Note that if dune is not installed properly you will either
have to add the directory where the dunecontrol script resides (probably
./dune-common/bin) to your path or specify the relative path of the script.
Most probably you'll have to provide additional information to dunecontrol
(e.g. compilers, configure options) and/or make options.
The most convenient way is to use options files in this case. The files
define four variables:
CMAKE_FLAGS flags passed to cmake (during configure)
An example options file might look like this:
#use this options to configure and make if no other options are given
CMAKE_FLAGS=" \\
-DCMAKE_CXX_COMPILER=g++-5 \\
-DCMAKE_CXX_FLAGS='-Wall -pedantic' \\
-DCMAKE_INSTALL_PREFIX=/install/path" #Force g++-5 and set compiler flags
If you save this information into example.opts you can pass the opts file to
dunecontrol via the --opts option, e.g.
dunecontrol --opts=example.opts all
More info
---------
See
dunecontrol --help
for further options.
The full build system is described in the dune-common/doc/buildsystem (Git version) or under share/doc/dune-common/buildsystem if you installed DUNE!
R_DELIM
################## CMakeLists.txt ##################
echo "- $PROJECT/CMakeLists.txt"
cat> "$PROJECT/CMakeLists.txt" << M_DELIM
# We require version CMake version 3.1 to prevent issues
# with dune_enable_all_packages and older CMake versions.
cmake_minimum_required(VERSION 3.1)
project($PROJECT CXX)
if(NOT (dune-common_DIR OR dune-common_ROOT OR
"\${CMAKE_PREFIX_PATH}" MATCHES ".*dune-common.*"))
string(REPLACE \${CMAKE_PROJECT_NAME} dune-common dune-common_DIR
\${PROJECT_BINARY_DIR})
endif()
#find dune-common and set the module path
find_package(dune-common REQUIRED)
list(APPEND CMAKE_MODULE_PATH "\${PROJECT_SOURCE_DIR}/cmake/modules"
\${dune-common_MODULE_PATH})
#include the dune macros
include(DuneMacros)
# start a dune project with information from dune.module
dune_project()
dune_enable_all_packages()
add_subdirectory(amdis)
add_subdirectory(cmake/modules)
add_subdirectory(doc)
add_subdirectory(init)
add_subdirectory(macro)
add_subdirectory(src)
# finalize the dune project, e.g. generating config.h etc.
finalize_dune_project(GENERATE_CONFIG_H_CMAKE)
M_DELIM
################## PROJECT.PC.IN ##################
echo "- $PROJECT/$MODULE.pc.in"
cat> "$PROJECT/$MODULE.pc.in" << CC_DELIM
prefix=@prefix@
exec_prefix=@exec_prefix@
libdir=@libdir@
includedir=@includedir@
CXX=@CXX@
CC=@CC@
DEPENDENCIES=@REQUIRES@
Name: @PACKAGE_NAME@
Version: @VERSION@
Description: $MODULE module
URL: http://gitlab.mn.tu-dresden.de
Requires: ${DEPENDENCIES}
Libs: -L\${libdir}
Cflags: -I\${includedir}
CC_DELIM
echo " Please remember to update your $PROJECT/$MODULE.pc.in,"
echo " Description and URL are missing right now."
################# config.h.cmake #####################
echo "- $PROJECT/config.h.cmake"
cat> "$PROJECT/config.h.cmake" <<EOF
/* begin $PROJECT
put the definitions for config.h specific to
your project here. Everything above will be
overwritten
*/
/* begin private */
/* Name of package */
#define PACKAGE "@DUNE_MOD_NAME@"
/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "@DUNE_MAINTAINER@"
/* Define to the full name of this package. */
#define PACKAGE_NAME "@DUNE_MOD_NAME@"
/* Define to the full name and version of this package. */
#define PACKAGE_STRING "@DUNE_MOD_NAME@ @DUNE_MOD_VERSION@"
/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "@DUNE_MOD_NAME@"
/* Define to the home page for this package. */
#define PACKAGE_URL "@DUNE_MOD_URL@"
/* Define to the version of this package. */
#define PACKAGE_VERSION "@DUNE_MOD_VERSION@"
/* end private */
/* Define to the version of $PROJECT */
#define ${UNAME}_VERSION "@${UNAME}_VERSION@"
/* Define to the major version of $PROJECT */
#define ${UNAME}_VERSION_MAJOR @${UNAME}_VERSION_MAJOR@
/* Define to the minor version of $PROJECT */
#define ${UNAME}_VERSION_MINOR @${UNAME}_VERSION_MINOR@
/* Define to the revision of $PROJECT */
#define ${UNAME}_VERSION_REVISION @${UNAME}_VERSION_REVISION@
/* end $PROJECT
Everything below here will be overwritten
*/
EOF
## done
###############################################################
################## The source subdirectory ####################
###############################################################
mkdir "$PROJECT/src"
################## src/CMakeLists.txt ##################
echo "- $PROJECT/src/CMakeLists.txt"
cat> "$PROJECT/src/CMakeLists.txt" << M_DELIM
add_amdis_executable(
NAME "${MODULE}"
SOURCES ${MODULE}.cpp
DIM 2 DOW 2
ALBERTA_GRID)
M_DELIM
################## PROJECT.CC ##################
echo "- $PROJECT/src/$MODULE.cpp"
cat> "$PROJECT/src/$MODULE.cpp" << CC_DELIM
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <amdis/AMDiS.hpp>
using namespace AMDiS;
int main(int argc, char** argv)
{
AMDiS::init(argc, argv);
// your code comes here
AMDiS::finalize();
}
CC_DELIM
################################################################
################## The headers subdirectory ####################
################################################################
echo "- $PROJECT/amdis/$NAME"
mkdir "$PROJECT/amdis"
mkdir "$PROJECT/amdis/$NAME"
################## amdis/CMakeLists.txt #################
echo "- $PROJECT/amdis/CMakeLists.txt"
cat> $PROJECT/amdis/CMakeLists.txt <<EOF
add_subdirectory($NAME)
EOF
################## amdis/$NAME/CMakeLists.txt ###########
echo "- $PROJECT/amdis/$NAME/CMakeLists.txt"
cat> $PROJECT/amdis/$NAME/CMakeLists.txt <<EOF
#install headers
install(FILES ${NAME}.hpp DESTINATION \${CMAKE_INSTALL_INCLUDEDIR}/amdis/$NAME)
EOF
################## amdis/$NAME/$NAME.hh #################
echo "- $PROJECT/amdis/$NAME/$NAME.hpp"
cat> $PROJECT/amdis/$NAME/$NAME.hpp <<EOF
#pragma once
// add your classes here
EOF
###############################################################
################## The doc subdirectory #######################
###############################################################
mkdir "$PROJECT/doc"
################## doc/CMakeLists.txt #################
echo "- $PROJECT/doc/CMakeLists.txt"
cat> "$PROJECT/doc/CMakeLists.txt" << CC_DELIM
add_subdirectory("doxygen")
CC_DELIM
###############################################################
############### The doc/doxygen subdirectory ##################
###############################################################
mkdir "$PROJECT/doc/doxygen"
#################### basic Doxylocal ##########################
echo "- $PROJECT/doc/doxygen/Doxylocal"
if [ "x`which doxygen`" == "x" ]; then
echo "Doxygen is not installed! Your documentation will not work without."
fi
# Where to search and which files to use
cat> $PROJECT/doc/doxygen/Doxylocal << CC_DELIM
# This file contains local changes to the doxygen configuration
# please us '+=' to add file/directories to the lists
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT += @top_srcdir@/amdis/
# see e.g. dune-grid for the examples of mainpage and modules
# INPUT += @srcdir@/mainpage \\
# @srcdir@/modules
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
# EXCLUDE += @top_srcdir@/amdis/$NAME/test
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
# EXAMPLE_PATH += @top_srcdir@/src
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
# IMAGE_PATH += @top_srcdir@/amdis/$NAME/pics
CC_DELIM
################# doc/doxygen/CMakeLists.txt #####################
echo "- $PROJECT/doc/doxygen/CMakeLists.txt"
cat> "$PROJECT/doc/doxygen/CMakeLists.txt" << CC_DELIM
# shortcut for creating the Doxyfile.in and Doxyfile
add_doxygen_target()
CC_DELIM
#########################################################
############### The cmake subdirectory ##################
#########################################################
mkdir "$PROJECT/cmake"
#########################################################
############### The cmake/modules subdirectory ##########
#########################################################
mkdir "$PROJECT/cmake/modules"
macroname=""
for i in $(echo $PROJECT| sed 's/-/ /g'); do
firstchar=$(echo $i | sed 's/\(.\).*/\1/')
macroname=$macroname$(echo $firstchar | tr '[a-z]' '[A-Z]')$(echo $i | sed 's/.\(.*\)/\1/')
done
macroname="$macroname""Macros.cmake"
################# cmake/modules/CMakeLists.txt #####################
echo "- $PROJECT/cmake/modules/CMakeLists.txt"
cat> "$PROJECT/cmake/modules/CMakeLists.txt" <<EOF
set(modules "$macroname")
install(FILES \${modules} DESTINATION \${DUNE_INSTALL_MODULEDIR})
EOF
################# cmake/modules/$macroname #####################
echo "- $PROJECT/cmake/modules/$macroname"
cat> "$PROJECT/cmake/modules/$macroname" <<EOF
# File for module specific CMake tests.
EOF
#########################################################
############### The init subdirectory ##########
#########################################################
mkdir "$PROJECT/init"
echo "- $PROJECT/init/$NAME.dat"
cat> "$PROJECT/init/$NAME.dat" <<EOF
mesh->global refinements: 0
$NAME->mesh: mesh
$NAME->solver->name: default
$NAME->solver->tolerance: 1.e-8
$NAME->solver->info: 1
$NAME->output[0]->filename: $NAME_
$NAME->output[0]->name: solution
$NAME->output[0]->ParaView mode: 1
EOF
################# init/CMakeLists.txt #####################
echo "- $PROJECT/init/CMakeLists.txt"
cat> "$PROJECT/init/CMakeLists.txt" <<EOF
install(FILES
$NAME.dat
DESTINATION init)
EOF
#########################################################
############### The macro subdirectory ##########
#########################################################
mkdir "$PROJECT/macro"
echo "- $PROJECT/macro/$NAME.2d.amc"
cat> "$PROJECT/macro/$NAME.2d.amc" <<EOF
DIM: 2
DIM_OF_WORLD: 2
number of vertices: 5
number of elements: 4
vertex coordinates:
0.0 0.0
1.0 0.0
1.0 1.0
0.0 1.0
0.5 0.5
element vertices:
0 1 4
1 2 4
2 3 4
3 0 4
element boundaries:
0 0 1
0 0 1
0 0 1
0 0 1