initial import

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@3825 2fb0f335-1f38-0410-981e-8018bf24f1b0

Makefile.am

+# $Id: duneproject 5842 2010-01-20 18:48:34Z joe $
+
+# we need the module file to be able to build via dunecontrol
+EXTRA_DIST=dune.module
+
+SUBDIRS = src m4 dune doc
+
+if BUILD_DOCS
+# TODO: set up documentation tree automatically
+#SUBDIRS += doc
+endif
+
+# don't follow the full GNU-standard
+# we need automake 1.5
+AUTOMAKE_OPTIONS = foreign 1.5
+
+# pass most important options when "make distcheck" is used
+DISTCHECK_CONFIGURE_FLAGS = --with-dune-pdelab=$(DUNE_PDELAB_ROOT)  CXX="$(CXX)" CC="$(CC)"
+
+include $(top_srcdir)/am/top-rules
+include $(top_srcdir)/am/global-rules
+

README

+Preparing the Sources
+=========================
+
+Additional to the software mentioned in README you'll need the
+following programs installed on your system:
+
+  automake >= 1.5
+
+  autoconf >= 2.50
+
+  libtool
+
+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.
+
+On your project and all uninstalled DUNE source modules found the script 
+will then calls the GNU autoconf/automake to create a ./configure-script 
+and the Makefiles. Afterwards that configure script will be called and the
+modules will be build using make all
+
+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
+defining three variables:
+
+AUTOGEN_FLAGS    flags passed to autogen
+CONFIGURE_FLAGS  flags passed to configure
+MAKE_FLAGS       flags passed to make
+
+An example options file might look like this:
+
+#use this options to autogen, configure and make if no other options are given
+AUTOGEN_FLAGS="--ac=2.50 --ac=1.8" #Forces automake 2,50 and autoconf 1.8
+CONFIGURE_FLAGS="CXX=g++-3.4 --prefix=/install/path" #force g++-3.4 as compiler
+MAKE_FLAGS=install #Per default run make install instead of simply make
+
+If you save this information into example.opts you can path the opts file to
+dunecontrol via the --opts option, e. g.
+
+  dunecontrol --opts=example.opts all
+
+To get a full list of available configure flags just run
+
+  dunecontrol configure --help
+
+after running at least 
+  dunecontrol autogen
+
+More info
+---------
+
+See
+
+     dunecontrol --help
+   
+for further options.
+
+
+The full build-system is described in the dune-common/doc/buildsystem (SVN version) or under share/doc/dune-common/buildsystem if you installed DUNE!
+
+$Id: duneproject 5842 2010-01-20 18:48:34Z joe $
+

configure.ac

+# -*- Autoconf -*-
+# Process this file with autoconf to produce a configure script.
+AC_PREREQ(2.50)
+DUNE_AC_INIT # gets module version from dune.module file
+AM_INIT_AUTOMAKE
+AC_CONFIG_SRCDIR([src/dumux.cc])
+AM_CONFIG_HEADER([config.h])
+
+
+# we need no more than the standard DE-stuff
+# this module depends on dune-pdelab
+# this implies checking for [dune-common], [dune-grid], [dune-localfunctions], [dune-istl], [dune-pdelab]
+DUNE_CHECK_ALL
+
+# implicitly set the Dune-flags everywhere
+AC_SUBST(AM_CPPFLAGS, $DUNE_CPPFLAGS)
+AC_SUBST(AM_LDFLAGS, $DUNE_LDFLAGS)
+LIBS="$DUNE_LIBS"
+
+AC_CONFIG_FILES([
+  Makefile
+  src/Makefile
+  doc/Makefile
+  doc/doxygen/Makefile
+  doc/doxygen/Doxyfile
+  dune/Makefile
+  dune/dumux/Makefile
+  m4/Makefile
+  dumux.pc
+])
+AC_OUTPUT
+# finally print the summary information
+DUNE_SUMMARY_ALL

doc/Makefile.am

+
+SUBDIRS = doxygen
+CURDIR = doc
+BASEDIR = ..
+
+# add list of html files to generate from wml
+PAGES=
+
+docdir=$(datadir)/doc/dumux
+
+include $(top_srcdir)/am/webstuff
+include $(top_srcdir)/am/global-rules

doc/doxygen/Doxylocal

+# 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@/dune/
+# 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@/dune/dumux/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@/dune/dumux/pics
+

doc/doxygen/Makefile.am

+
+BASEDIR=../..
+CURDIR=doc/doxygen
+
+include $(top_srcdir)/am/doxygen
+include $(top_srcdir)/am/global-rules
+

dumux.pc.in

+prefix=@prefix@
+exec_prefix=@exec_prefix@
+libdir=@libdir@
+includedir=@includedir@
+CXX=@CXX@
+CC=@CC@
+DEPENDENCIES=@REQUIRES@
+
+Name: @PACKAGE_NAME@
+Version: @VERSION@
+Description: dumux module
+URL: http://dune-project.org/
+Requires: dune-pdelab
+Libs: -L
+Cflags: -I

dumux/Makefile.am

+SUBDIRS = dumux
+
+include $(top_srcdir)/am/global-rules

dumux/dumux/Makefile.am

+dumuxincludedir = $(includedir)/dune/dumux
+dumuxinclude_HEADERS = dumux.hh
+
+include $(top_srcdir)/am/global-rules

dumux/dumux/dumux.hh

+#ifndef DUNE_dumux.hh
+#define DUNE_dumux.hh
+
+// add your classes here
+
+#endif // DUNE_dumux.hh

dune.module

+################################
+# Dune module information file #
+################################
+
+#Name of the module
+Module: dumux
+Version: 1.1
+Maintainer: bernd@iws.uni-stuttgart.de
+#depending on 
+Depends: dune-pdelab

m4/Makefile.am

+M4FILES = dumux.m4
+
+aclocaldir = $(datadir)/aclocal
+aclocal_DATA = $(M4FILES)
+
+EXTRA_DIST = $(M4FILES)
+
+include $(top_srcdir)/am/global-rules

m4/dumux.m4

+dnl -*- autoconf -*-
+# Macros needed to find dumux and dependent libraries.  They are called by
+# the macros in ${top_src_dir}/dependencies.m4, which is generated by
+# "dunecontrol autogen"
+
+# Additional checks needed to build dumux
+# This macro should be invoked by every module which depends on dumux, as
+# well as by dumux itself
+AC_DEFUN([DUMUX_CHECKS])
+
+# Additional checks needed to find dumux
+# This macro should be invoked by every module which depends on dumux, but
+# not by dumux itself
+AC_DEFUN([DUMUX_CHECK_MODULE],
+[
+  DUNE_CHECK_MODULES([dumux],[dumux/dumux.hh])
+])

stamp-vc

+A stamp file to signify that this directory comes from a version control system, not an unpacked tarball