From: maier Date: Fri, 19 Oct 2012 10:12:54 +0000 (+0000) Subject: Restructure the documentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=61e4c1ca775ba11bf400cc08adaaa608e19a680a;p=dealii-svn.git Restructure the documentation git-svn-id: https://svn.dealii.org/branches/branch_cmake@27145 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/CMakeLists.txt b/deal.II/doc/CMakeLists.txt index e3f4e7454c..1c3462eb3f 100644 --- a/deal.II/doc/CMakeLists.txt +++ b/deal.II/doc/CMakeLists.txt @@ -23,16 +23,14 @@ IF(DEAL_II_COMPONENT_DOCUMENTATION) # ADD_SUBDIRECTORY(doxygen) - # - # Install the remaining (static) elements of documentation: + # Install the static elements of the html documentation: # - INSTALL(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/ DESTINATION ${DEAL_II_DOCUMENTATION_RELDIR} COMPONENT documentation - FILES_MATCHING REGEX "^.*(html|css|eps|jpg|gif|fig|png|ico)$" PATTERN "doxygen" EXCLUDE + PATTERN "CMakeLists.txt" EXCLUDE ) CONFIGURE_FILE( diff --git a/deal.II/doc/development/Makefile b/deal.II/doc/development/Makefile deleted file mode 100644 index 9fb511bbfe..0000000000 --- a/deal.II/doc/development/Makefile +++ /dev/null @@ -1,145 +0,0 @@ -# $Id$ - - -D = ../.. -include $D/common/Make.global_options - - -default: makefiles.html makefile.small.html makefile.large.html - - -# Have a list of variables defined in common/Make.global_options and expand them into -# something that looks decent in HTML. The special text "--break--" draws a horizontal -# line to separate different blocks of variables -VARIABLES = D DEAL_II_VERSION DEAL_II_MAJOR DEAL_II_MINOR \ - --break-- \ - CXX GXX-VERSION GXX-VERSION-DETAILED \ - CC CC-VERSION \ - F77 F77-VERSION \ - SHLIBLD \ - AR \ - RANLIB \ - PERL \ - TARGET \ - --break-- \ - LIBPATH \ - LIBDIR \ - LIBS \ - OBJEXT EXEEXT static-lib-suffix shared-lib-suffix \ - lib-suffix \ - --break-- \ - lib-deal2.o \ - lib-deal2.g \ - --break-- \ - INCLUDE \ - CXXFLAGS.g \ - CXXFLAGS.o \ - CFLAGS.g \ - CFLAGS.o \ - F77FLAGS.g \ - F77FLAGS.o \ - SHLIBFLAGS \ - LDFLAGS \ - F77LIBS \ - --break-- \ - enable-shared \ - enable-parser \ - DEAL_II_USE_MPI \ - --break-- \ - enable-threads \ - lib-contrib-tbb.g \ - lib-contrib-tbb.o \ - --break-- \ - USE_CONTRIB_UMFPACK \ - --break-- \ - USE_CONTRIB_HSL \ - lib-contrib-hsl \ - --break-- \ - USE_CONTRIB_PETSC \ - DEAL_II_PETSC_DIR \ - DEAL_II_PETSC_ARCH \ - DEAL_II_PETSC_VERSION_MAJOR \ - DEAL_II_PETSC_VERSION_MINOR \ - DEAL_II_PETSC_VERSION_SUBMINOR \ - DEAL_II_PETSC_MPIUNI_LIB \ - lib-contrib-petsc.g \ - lib-contrib-petsc.o \ - include-path-petsc \ - include-path-petsc-bmake \ - --break-- \ - USE_CONTRIB_SLEPC \ - DEAL_II_SLEPC_DIR \ - DEAL_II_SLEPC_VERSION_MAJOR \ - DEAL_II_SLEPC_VERSION_MINOR \ - DEAL_II_SLEPC_VERSION_SUBMINOR \ - lib-contrib-slepc \ - include-path-slepc \ - --break-- \ - USE_CONTRIB_TRILINOS \ - DEAL_II_TRILINOS_INCDIR \ - DEAL_II_TRILINOS_LIBDIR \ - DEAL_II_TRILINOS_SHARED \ - DEAL_II_TRILINOS_STATIC \ - DEAL_II_TRILINOS_VERSION_MAJOR \ - DEAL_II_TRILINOS_VERSION_MINOR \ - DEAL_II_TRILINOS_VERSION_SUBMINOR \ - lib-contrib-trilinos \ - include-path-trilinos \ - --break-- \ - USE_CONTRIB_MUMPS \ - DEAL_II_MUMPS_DIR \ - DEAL_II_SCALAPACK_DIR \ - DEAL_II_BLACS_DIR \ - DEAL_II_BLACS_ARCH \ - lib-contrib-mumps \ - include-path-mumps \ - --break-- \ - USE_CONTRIB_ARPACK \ - DEAL_II_ARPACK_DIR \ - DEAL_II_ARPACK_ARCH \ - lib-contrib-arpack \ - --break-- \ - USE_CONTRIB_METIS \ - DEAL_II_METIS_DIR \ - lib-contrib-metis \ - include-path-contrib-metis \ - --break-- \ - USE_CONTRIB_P4EST \ - DEAL_II_P4EST_DIR \ - --break-- \ - TECIO_INCLUDE \ - TECIO_LIBRARY - -expand_variable = $(if $(1:--break--=), \ - '$$($1) $($1)',\ - '
') - -VARIABLE_VALUES = $(foreach v,$(VARIABLES),$(call expand_variable,$v)) - -makefiles.html: Makefile makefiles.1.html $D/common/Make.global_options makefiles.2.html - @cat makefiles.1.html > $@ - @echo "

" >> $@ - @echo "" >> $@ - @echo "" >> $@ - @echo $(VARIABLE_VALUES) >> $@ - @echo "
Makefile variableValue in common/Make.global_options

" >> $@ - @cat makefiles.2.html >> $@ - - -makefile.small.html: Makefile.small - @$(PERL) makefile2html < $< > $@ - -makefile.large.html: Makefile.large - @$(PERL) makefile2html < $< > $@ - -validate-xrefs: - @$(PERL) $D/common/scripts/validate-xrefs.pl \ - $(filter-out makefiles.1.html makefiles.2.html, \ - $(shell echo *.html)) - - - -clean: - -rm -f makefiles.html makefile.small.html makefile.large.html - -.PHONY: default validate-xrefs clean diff --git a/deal.II/doc/development/Makefile.large b/deal.II/doc/development/Makefile.large deleted file mode 100644 index 71d2664a04..0000000000 --- a/deal.II/doc/development/Makefile.large +++ /dev/null @@ -1,128 +0,0 @@ -# $Id$ - -# The large projects Makefile looks much like the one for small -# projects. Basically, only the following seven parameters need to be -# set by you: - -application-name = waves -deal_II_dimension = 2 - -# The next variable tells us the name of the executable. It is prefixed by -# `lib/' to designate its destination directory. Note that the program -# name depends on the dimension, so you can keep copies for the -# different dimensions around: -target = lib/$(application-name)-$(deal_II_dimension)d - -# The `debug-mode' variable works as in the small projects Makefile: -debug-mode = on - -# And so does the following variable. You will have to set it to -# something reasonable that, for example, includes the location where you -# put output files that you want the `make clean' rule to delete -clean-up-files = - -# Finally, here is a variable which tells the `run' rule which -# parameters to pass to the executable. Usually, this will be the name -# of an input file. -run-parameters = parameter-file.prm - -# Now, this is the last variable you need to set, namely the path to -# the deal.II toplevel directory: -D = ../../deal.II - - - -# -# -# Usually, you will not need to change anything beyond this point. -# -# -# This tells `make' where to find the global settings and rules: -include $D/common/Make.global_options - - -# First get a list of files belonging to the project. Include files -# are expected in `include/', while implementation files are expected -# in `source/'. Object files are placed into `lib/[123]d', using the -# same base name as the `.cc' file. -cc-files := $(shell echo source/*.cc) -o-files := $(cc-files:source/%.cc=lib/$(deal_II_dimension)d/%.$(OBJEXT)) -go-files := $(cc-files:source/%.cc=lib/$(deal_II_dimension)d/%.g.$(OBJEXT)) -h-files := $(wildcard include/*.h) -lib-h-files := $(shell echo $D/include/deal.II/*/*.h) - -# As before, define two variables that denote the debug and optimized -# versions of the deal.II libraries: -libs.g := $(lib-deal2.g) -libs.o := $(lib-deal2.o) - - - -# Now use the information from above to define the set of libraries to -# link with and the flags to be passed to the compiler: -ifeq ($(debug-mode),on) - libraries = $(go-files) $(libs.g) - flags = $(CXXFLAGS.g) -Iinclude -else - libraries = $(o-files) $(libs.o) - flags = $(CXXFLAGS.o) -Iinclude -endif - - -# Then augment the compiler flags by a specification of the dimension -# for which the program shall be compiled: -flags += -Ddeal_II_dimension=$(deal_II_dimension) - - -# The following two rules define how to compile C++ files into object -# files: -lib/$(deal_II_dimension)d/%.g.$(OBJEXT) : - @echo =====$(application-name)=======$(deal_II_dimension)d====debug=====$(MT)== $( $@ - -include lib/Makefile.dep - diff --git a/deal.II/doc/development/Makefile.small b/deal.II/doc/development/Makefile.small deleted file mode 100644 index 5d4bc0aebb..0000000000 --- a/deal.II/doc/development/Makefile.small +++ /dev/null @@ -1,144 +0,0 @@ -# $Id$ - - -# For the small projects Makefile, you basically need to fill in only -# four fields. -# -# The first is the name of the application. It is assumed that the -# application name is the same as the base file name of the single C++ -# file from which the application is generated. -target = step-1 - -# The second field determines whether you want to run your program in -# debug or optimized mode. The latter is significantly faster, but no -# run-time checking of parameters and internal states is performed, so -# you should set this value to `on' while you develop your program, -# and to `off' when running production computations. -debug-mode = on - - -# As third field, we need to give the path to the top-level deal.II -# directory. You need to adjust this to your needs. Since this path is -# probably the most often needed one in the Makefile internals, it is -# designated by a single-character variable, since that can be -# reference using $D only, i.e. without the parentheses that are -# required for most other parameters, as e.g. in $(target). -D = ../../ - - -# The last field specifies the names of data and other files that -# shall be deleted when calling `make clean'. Object and backup files, -# executables and the like are removed anyway. Here, we give a list of -# files in the various output formats that deal.II supports. -clean-up-files = *gmv *gnuplot *gpl *eps *pov *vtk *ucd *d2 - - - - -# -# -# Usually, you will not need to change anything beyond this point. -# -# -# The next statement tells the `make' program where to find the -# deal.II top level directory and to include the file with the global -# settings -include $D/common/Make.global_options - - -# Since the whole project consists of only one file, we need not -# consider difficult dependencies. We only have to declare the -# libraries which we want to link to the object file. deal.II has two -# libraries: one for the debug mode version of the -# application and one for optimized mode. -libs.g := $(lib-deal2.g) -libs.o := $(lib-deal2.o) - - -# We now use the variable defined above to switch between debug and -# optimized mode to select the set of libraries to link with. Included -# in the list of libraries is the name of the object file which we -# will produce from the single C++ file. Note that by default we use -# the extension .g.o for object files compiled in debug mode and .o for -# object files in optimized mode (or whatever local default on your -# system is instead of .o) -ifeq ($(debug-mode),on) - libraries = $(target).g.$(OBJEXT) $(libs.g) -else - libraries = $(target).$(OBJEXT) $(libs.o) -endif - - -# Now comes the first production rule: how to link the single object -# file produced from the single C++ file into the executable. Since -# this is the first rule in the Makefile, it is the one `make' selects -# if you call it without arguments. -all: $(target)$(EXEEXT) -$(target)$(EXEEXT) : $(libraries) - @echo ============================ Linking $@ - @$(CXX) -o $@ $^ $(LIBS) $(LDFLAGS) - - -# To make running the application somewhat independent of the actual -# program name, we usually declare a rule `run' which simply runs the -# program. You can then run it by typing `make run'. This is also -# useful if you want to call the executable with arguments which do -# not change frequently. You may then want to add them to the -# following rule: -run: $(target)$(EXEEXT) - @echo ============================ Running $< - @./$(target)$(EXEEXT) - - -# As a last rule to the `make' program, we define what to do when -# cleaning up a directory. This usually involves deleting object files -# and other automatically created files such as the executable itself, -# backup files, and data files. Since the latter are not usually quite -# diverse, you needed to declare them at the top of this file. -clean: - -rm -f *.$(OBJEXT) *~ Makefile.dep $(target)$(EXEEXT) $(clean-up-files) - - -# Since we have not yet stated how to make an object file from a C++ -# file, we should do so now. Since the many flags passed to the -# compiler are usually not of much interest, we suppress the actual -# command line using the `at' sign in the first column of the rules -# and write the string indicating what we do instead. -./%.g.$(OBJEXT) : - @echo "==============debug========= $( $@" - @$(CXX) $(CXXFLAGS.g) -c $< -o $@ -./%.$(OBJEXT) : - @echo "==============optimized===== $( $@" - @$(CXX) $(CXXFLAGS.o) -c $< -o $@ - - -# The following statement tells make that the rules `run' and `clean' -# are not expected to produce files of the same name as Makefile rules -# usually do. -.PHONY: all run clean - - -# Finally there is a rule which you normally need not care much about: -# since the executable depends on some include files from the library, -# besides the C++ application file of course, it is necessary to -# re-generate the executable when one of the files it depends on has -# changed. The following rule creates a dependency file -# `Makefile.dep', which `make' uses to determine when to regenerate -# the executable. This file is automagically remade whenever needed, -# i.e. whenever one of the cc-/h-files changed. Make detects whether -# to remake this file upon inclusion at the bottom of this file. -# -# If the creation of Makefile.dep fails, blow it away and fail -Makefile.dep: $(target).cc Makefile \ - $(shell echo $D/include/deal.II/*/*.h) - @echo ============================ Remaking $@ - @$D/common/scripts/make_dependencies $(INCLUDE) -B. $(target).cc \ - > $@ \ - || (rm -f $@ ; false) - @if test -s $@ ; then : else rm $@ ; fi - -# To make the dependencies known to `make', we finally have to include -# them: -include Makefile.dep - - diff --git a/deal.II/doc/development/makefile2html b/deal.II/doc/development/makefile2html deleted file mode 100644 index a075046400..0000000000 --- a/deal.II/doc/development/makefile2html +++ /dev/null @@ -1,74 +0,0 @@ -# Copyright (C) 1999, 2000, 2002, 2005, 2006 by the deal.II group -# $Id$ - -print <<'EOT' - - - - - Makefile fro deal.II - - - -EOT -; - -# ignore the first few lines -$_ = <>; -while ( m!^#\s*\$Id!) { - $_ = <>; -} - -# have two states, in which the program can be: -# comment-mode and program-mode -$comment_mode = 0; -$program_mode = 1; -$state = $comment_mode; - -print "

\n"; - -while (<>) { - # ignore subversion tag - next if m!^#\*\s*\$Id:!; - - # substitute special characters - s/&/&/g; - s//>/g; - s/\t/ /g; - - if (($state == $program_mode) && m!^\s*#!) - { - $state = $comment_mode; - print "\n"; - print "\n"; - print "

\n"; - } - # if in comment mode and no comment line: toggle state. - # don't do so, if only a blank line - elsif (($state == $comment_mode) && !m!^\s*#! && !m!^\s*$!) - { - $state = $program_mode; - print "

\n"; - print "\n"; - print "
\n";
-    }
-    
-    if ($state == $comment_mode) 
-    {
-	m!\s*#\s*(.*)!;
-	print $1, "\n";
-	print "

\n\n

" if $1 =~ m!^\s*$!; - } - else - { - print " $_"; - } -} - -if ($state == $program_mode) { - print "

\n"; -} - -print "\n\n"; diff --git a/deal.II/doc/development/makefiles.1.html b/deal.II/doc/development/makefiles.1.html deleted file mode 100644 index cbf3d19d40..0000000000 --- a/deal.II/doc/development/makefiles.1.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - The deal.II Homepage - Makefiles - - - - - -

Makefiles for deal.II projects

- -

- The file common/Make.global_options exports several - make variables to other Makefiles which - include it. You will want to include this file into the Makefiles of - your project to use the same compiler flags and to access the paths - to libraries. This page documents available - variables, documents the values which are used - in your local installation, and shows - generic Makefiles which you may want to use - in your own projects. -

- - -

Available variables

- -

- Following is a partial list of available variables which are exported to - other Makefiles. There are additional variables, in particular ones that - determine the interaction with other libraries such as PETSc, Trilinos, - METIS, etc; for details on these variables, take a look - at common/Make.global_options. -

- -
    -
  • General

    - -
    -
    D
    -

    - Path to the deal.II library -

    -
    - - -
    CXX
    -

    - Executable name of the C++ compiler -

    -
    - - -
    CC
    -

    - Executable name of the C compiler, which - is used to generate shared libraries -

    -
    - - -
    GXX-VERSION
    -

    - Name and version of the C++ compiler. Possible - names presently include - gcc3.3, gcc3.4, - gcc4.0, gcc4.1, etc, - ibm_xlc, MIPSpro, - sun_workshop, sun_forte, - intel_icc5, intel_icc6, - intel_icc7, compaq_cxx, and - probably a few more as well. Not all of - these compilers are actually supported (see the - ReadMe file for a - list of supported compilers and platforms), it is only a list of - recognized compilers. - Note that the naming of this variable is historical (it - should read CXX-VERSION), since - it is also used even if the compiler is not the GNU C++ - compiler. -

    -
    - - -
    GXX-VERSION-DETAILED
    -

    - Like GXX-VERSION, just that it may also contain the dot version - number, for example gcc3.3.3. -

    -
    - -
    CC-VERSION
    -

    - Name and version of the CC compiler. Possible names are - similar to the ones listed above. -

    -
    - - -
    F77
    -

    - Executable name of the F77 compiler; often, no Fortran - compiler is needed, in which case the variable may be empty if - none was found -

    -
    - - -
    F77-VERSION
    -

    - Name and version of the Fortran 77 compiler. Possible - names presently include egcs1.1, - gcc2.95, gcc2.96, - gcc2.97, gcc3.0, SunF77, - AIXF77, MIPSproF77; - there may be others in the future, if we have access to - other systems -

    -
    - - -
    SHLIBLD
    -

    - Executable name of compiler that is used to link object - files to shared libraries. This will usually be the C++ - compiler. -

    -
    - - -
    enable-shared
    -

    - Determines whether shared or static libraries are used. - In the former case it is set to yes. -

    -
    - -
    enable-threads
    -

    - Determines whether multiple threads should be used or not. - In the former case it is set to yes. -

    -
    - -
    PERL
    -

    - Executable name of the `perl' program -

    -
    - - -
    DEAL_II_MAJOR
    -

    - Major version number of the deal.II - library, i.e. the number before the first dot. Note that - this version number is also available in programs through a - preprocessor variable -

    -
    - - -
    DEAL_II_MINOR
    -

    - Minor version number of the deal.II - library, i.e. the number after the first dot; if there are - further numbers, like in version 3.0.1, then they are - discarded as these versions only fix bugs but do not change - features. Note that this version number is also available - in programs through a preprocessor variable -

    -
    - - -
    TARGET
    -

    - The target triplet as returned by config.guess. For example, on the - system where I write this, it is i686-pc-linux-gnu, but it may also - be sparc-sun-solaris2.7, or whatever config.guess determines for - your system. -

    -
    -
    - - - -
  • Paths to libraries

    - -
    -
    LIBDIR
    -

    - Path to the deal.II libraries. -

    -
    - - -
    LIBPATH
    -

    - All the library paths (the deal.II libraries as well as other - libraries we need to link with) prefixed by -L, i.e. the - flags needed by the compiler to find the libraries - when they are linked in. These -L paths are appended to what - was in $(LIBPATH) before. -

    -
    - -
    LIBS
    -

    - Additional libraries to be linked in, such as Fortran - support, or Tecplot libraries when binary output is available. -

    -
    - -
    F77LIBS
    -

    - Libraries to be linked in when we link with Fortran - files. These libraries are checked at configuration time, - and are included into $(LIBS) when they are - actually needed -

    -
    -
    - - - -
  • Paths and filenames of libraries

    - -
    -
    OBJEXT
    -

    - Extension of object files. On unix, this is usually simply - o, on Windows systems it is obj. -

    -
    - - -
    EXEEXT
    -

    - Extension of executables. On unix, this is usually the - empty string, on Windows systems it is .exe. -

    -
    - -
    static-lib-suffix
    -

    - File extension of static libraries. Usually set to .a -

    -
    - -
    shared-lib-suffix
    -

    - File extension of shared libraries. If shared libraries - are supported, this suffix is usually .so on unix-like - systems, but is .dylib on Mac OS X - and .dll on windows. -

    -
    - -
    lib-suffix
    -

    - File extension of libraries. Depending on the value of - enable-shared, it is either set to - static-lib-suffix or to - shared-lib-suffix. -

    -
    - -
    lib-deal2.o lib-deal2.g
    -

    - Path and filename of the deal.II libraries. -

    -
    -
    - - - -
  • Paths to include files

    - -
    -
    INCLUDE
    - -

    All include paths figured out by the configure - script are now included into the variable - $(INCLUDE) (which include the compiler option - -I in front of each directory). They are also - automatically included in your compiler calls as soon as you use - $(CXXFLAGS.g) or $(CXXFLAGS.o). -

    - -

    An exception to this rule are paths listed below. These are - added to the variable $(INCLUDE) only during make. -

    -
    - - -
    include-path-contrib-petsc - include-path-contrib-petsc-bmake -
    -

    - If PETSc is used, then these variables have the paths to the usual - PETSc include files and the PETSc architecture dependent include - files. - (See the - ReadMe - file for more information on installation of PETSC.) -

    -
    - - -
    include-path-contrib-metis -
    -

    - If METIS is used, then this variable has the path to the METIS - include files. (See the - ReadMe - file for more information on installation of METIS.) -

    -
    -
    - - -
  • Compiler flags

    - -
    -
    CXXFLAGS.g
    -

    - C++ compiler flags for debug mode -

    -
    - - -
    CXXFLAGS.o
    -

    - C++ compiler flags for optimized mode -

    -
    - -
    CCFLAGS.g
    -

    - C compiler flags for debug mode. -

    -
    - - -
    CCFLAGS.o
    -

    - C compiler flags for optimized mode. -

    -
    - - -
    F77FLAGS.g
    -

    - Fortran 77 compiler flags for debug mode -

    -
    - - -
    F77FLAGS.o
    -

    - Fortran 77 compiler flags for optimized mode -

    -
    -
    - - - -
  • Linker flags

    - -
    -
    LDFLAGS
    -

    - General linker flags -

    -
    -
    - - - -

    Values of available variables

    - - In the copy of the library to which the file which you - are presently viewing belongs (i.e., your local one, or the one on the - deal.II homepage), here is a list of some of the - variables defined in common/Make.global_options: - - diff --git a/deal.II/doc/development/makefiles.2.html b/deal.II/doc/development/makefiles.2.html deleted file mode 100644 index 77e0eae366..0000000000 --- a/deal.II/doc/development/makefiles.2.html +++ /dev/null @@ -1,91 +0,0 @@ - - -

    Generic Makefiles

    - -

    - deal.II comes with sample Makefiles for - applications that use this library. They show how to use the information - provided by the variables explained above. -

    - -

    - At present, there are two such Makefile templates. All Makefiles - need slight modifications before they will work in your - project; the places for modifications are marked and easy to find. The - templates are: - -

      -
    • - Small - project Makefile: This Makefile is targeted at small - applications consisting of only a single .cc - file. Examples of this kind are the - step-by-step - tutorial programs. - You can find this Makefile - here. -

      - -
    • - Large - projects: This file is targeted at larger projects, and - for this file to work, we already assume a certain - subdirectory structure of your project. In particular, it - assumes that in your project directory the following - subdirectories exist (where project is the - directory in which the whole project is located): -

      -
        -
      • project/source: The location of all - your .cc files. -
      • project/include: The location of all - your .h files. -
      • project/lib: Where the Makefile will - put the final executable. -
          -
        • project/lib/1d: Where the Makefile will - put your object files if you compile for 1d. -
        • project/lib/2d: Same for 2d. -
        • project/lib/3d: Same for 3d. -
        -
      -

      - Using this - directory structure, it is possible to quickly switch - between dimensions in which a program shall run in, - enabling us to develop applications which run in 1d, 2d, or - 3d without long compilation times. Furthermore, placing - object files in different directories prevents cluttering - directories with unnecessarily many files. -

      - -

      - The dimension for which the project shall be compiled is - not stated in the source code, as in the small projects - Makefile, but is determined by a flag set in the - Makefile. The Makefile then makes sure that the preprocessor - constant deal_II_dimension is set appropriately and - passed through to the compiler when creating object files. -

      - -

      - You can find this Makefile - here. -

      -
    - -
    - -
    - The deal.II Group
    - -
    -

    - Valid HTML 4.01! -

    -
    - - - diff --git a/deal.II/doc/doxygen/options.dox.in b/deal.II/doc/doxygen/options.dox.in index 230ea6e511..e3ec767bf4 100644 --- a/deal.II/doc/doxygen/options.dox.in +++ b/deal.II/doc/doxygen/options.dox.in @@ -507,7 +507,7 @@ IMAGE_PATH = # to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. -INPUT_FILTER = ${CMAKE_SOURCE_DIR}/doc/scripts/filter +INPUT_FILTER = ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/filter # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the diff --git a/deal.II/doc/scripts/create_anchors b/deal.II/doc/doxygen/scripts/create_anchors similarity index 100% rename from deal.II/doc/scripts/create_anchors rename to deal.II/doc/doxygen/scripts/create_anchors diff --git a/deal.II/doc/scripts/filter b/deal.II/doc/doxygen/scripts/filter similarity index 100% rename from deal.II/doc/scripts/filter rename to deal.II/doc/doxygen/scripts/filter diff --git a/deal.II/doc/scripts/intro2toc b/deal.II/doc/doxygen/scripts/intro2toc similarity index 100% rename from deal.II/doc/scripts/intro2toc rename to deal.II/doc/doxygen/scripts/intro2toc diff --git a/deal.II/doc/scripts/make_toc.pl b/deal.II/doc/doxygen/scripts/make_toc.pl similarity index 100% rename from deal.II/doc/scripts/make_toc.pl rename to deal.II/doc/doxygen/scripts/make_toc.pl diff --git a/deal.II/doc/scripts/program2doxygen b/deal.II/doc/doxygen/scripts/program2doxygen similarity index 100% rename from deal.II/doc/scripts/program2doxygen rename to deal.II/doc/doxygen/scripts/program2doxygen diff --git a/deal.II/doc/scripts/program2doxyplain b/deal.II/doc/doxygen/scripts/program2doxyplain similarity index 100% rename from deal.II/doc/scripts/program2doxyplain rename to deal.II/doc/doxygen/scripts/program2doxyplain diff --git a/deal.II/doc/scripts/program2html b/deal.II/doc/doxygen/scripts/program2html similarity index 100% rename from deal.II/doc/scripts/program2html rename to deal.II/doc/doxygen/scripts/program2html diff --git a/deal.II/doc/scripts/program2plain b/deal.II/doc/doxygen/scripts/program2plain similarity index 100% rename from deal.II/doc/scripts/program2plain rename to deal.II/doc/doxygen/scripts/program2plain diff --git a/deal.II/doc/scripts/program2toc b/deal.II/doc/doxygen/scripts/program2toc similarity index 100% rename from deal.II/doc/scripts/program2toc rename to deal.II/doc/doxygen/scripts/program2toc diff --git a/deal.II/doc/scripts/steps.pl b/deal.II/doc/doxygen/scripts/steps.pl similarity index 100% rename from deal.II/doc/scripts/steps.pl rename to deal.II/doc/doxygen/scripts/steps.pl diff --git a/deal.II/doc/scripts/validate-xrefs.pl b/deal.II/doc/doxygen/scripts/validate-xrefs.pl similarity index 100% rename from deal.II/doc/scripts/validate-xrefs.pl rename to deal.II/doc/doxygen/scripts/validate-xrefs.pl diff --git a/deal.II/doc/doxygen/tutorial/CMakeLists.txt b/deal.II/doc/doxygen/tutorial/CMakeLists.txt index 585a6473d6..aed040f133 100644 --- a/deal.II/doc/doxygen/tutorial/CMakeLists.txt +++ b/deal.II/doc/doxygen/tutorial/CMakeLists.txt @@ -25,7 +25,7 @@ ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/steps.dot COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/steps.pl + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/steps.pl ${steps} > ${CMAKE_CURRENT_BINARY_DIR}/steps.dot ) @@ -58,7 +58,7 @@ ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/toc.html COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/make_toc.pl + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/make_toc.pl > ${CMAKE_CURRENT_BINARY_DIR}/toc.html WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} @@ -105,7 +105,7 @@ FOREACH(step ${steps}) OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${step}.cc COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/program2plain + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/program2plain < ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.cc DEPENDS @@ -124,7 +124,7 @@ FOREACH(step ${steps}) >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/intro2toc + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/intro2toc < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/intro.dox >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND cat @@ -133,7 +133,7 @@ FOREACH(step ${steps}) >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/program2toc + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/program2toc < ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND cat @@ -142,7 +142,7 @@ FOREACH(step ${steps}) >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/intro2toc + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/intro2toc < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/results.dox >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND cat @@ -151,17 +151,17 @@ FOREACH(step ${steps}) >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/create_anchors + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/create_anchors < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/intro.dox >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/program2doxygen + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/program2doxygen < ${CMAKE_SOURCE_DIR}/examples/${step}/${step}.cc >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND ${PERL_EXECUTABLE} ARGS - ${CMAKE_SOURCE_DIR}/doc/scripts/create_anchors + ${CMAKE_SOURCE_DIR}/doc/doxygen/scripts/create_anchors < ${CMAKE_SOURCE_DIR}/examples/${step}/doc/results.dox >> ${CMAKE_CURRENT_BINARY_DIR}/${step}.h COMMAND cat diff --git a/deal.II/doc/glossary/Makefile b/deal.II/doc/glossary/Makefile deleted file mode 100644 index 89dffe7165..0000000000 --- a/deal.II/doc/glossary/Makefile +++ /dev/null @@ -1,23 +0,0 @@ -# $Id$ - -# include defaults file -D = ../.. -include $D/common/Make.global_options - - -default: index.html - -index.html: extract.pl glossary.data - $(PERL) $^ > $@ - - -validate-xrefs: - $(PERL) $D/doc/auto/scripts/validate-xrefs.pl index.html - - -clean: - -rm -f index.html - - - -.PHONY: clean default validate-xrefs diff --git a/deal.II/doc/glossary/extract.pl b/deal.II/doc/glossary/extract.pl deleted file mode 100644 index 1d996ad07a..0000000000 --- a/deal.II/doc/glossary/extract.pl +++ /dev/null @@ -1,36 +0,0 @@ -$/ = "\n\n"; - -print << 'EOT' - - -deal.II glossary - - - -

    deal.II Glossary

    - -
    -EOT - ; - -while(<>) -{ - s/\s+/ /g; - while ( /<<([^>]+)>>/g ) { - $link_name = $1; - $link_name =~ s/\s/_/g; - s/<<([^>]+)>>/$1<\/A>/g; - } - while ( /([^:]+):(.*)/g ) { - $link_name = $1; - $link_name =~ s/\s/_/g; - s/([^:]+):(.*)/
    $1<\/A><\/DT>\n\t
    $2<\/DD>/; - } - print "\n$_\n"; -} - -print << 'EOT' -
    - -EOT - ; diff --git a/deal.II/doc/glossary/glossary.data b/deal.II/doc/glossary/glossary.data deleted file mode 100644 index 45bb0b2631..0000000000 --- a/deal.II/doc/glossary/glossary.data +++ /dev/null @@ -1,33 +0,0 @@ -active cell: a triangulation cell that is not refined further - -boundary component: part of the domain in physical space. Denotes -either function for a curved boundary or the selection of a <> - -boundary condition: part of the weak formulation of a partial -differential equation - -boundary indicator: data of lower dimensional <>s, indicating the number of a <> - -cell: element of a subdivision, being of the same dimension as the -domain of computation - -DG: see <> - -DGFEM: <> finite element method. - -Discontinuous Galerkin: A Galerkin discretization with all degrees of -freedom in the interior of the grid cells. Continuity between grid -cells is established by jump terms on the cell interfaces. - -hex: hexahedron, mapping of the unit cube into the domain - -locally finest level: all <>s, i.e. the finest cell at each -point of the domain - -quad: quadrilateral, mapping of the unit square into the domain - -triangulation object: the different kinds of polytopes forming a -triangulation, lines, quadrilaterals and hexahedra - diff --git a/deal.II/doc/glossary/index.html b/deal.II/doc/glossary/index.html new file mode 100644 index 0000000000..4380ce4fb5 --- /dev/null +++ b/deal.II/doc/glossary/index.html @@ -0,0 +1,47 @@ + + +deal.II glossary + + + +

    deal.II Glossary

    + +
    + +
    active cell
    +
    a triangulation cell that is not refined further
    + +
    boundary component
    +
    part of the domain in physical space. Denotes either function for a curved boundary or the selection of a boundary condition
    + +
    boundary condition
    +
    part of the weak formulation of a partial differential equation
    + +
    boundary indicator
    +
    data of lower dimensional triangulation objects, indicating the number of a boundary component
    + +
    cell
    +
    element of a subdivision, being of the same dimension as the domain of computation
    + +
    DG
    +
    see Discontinuous Galerkin
    + +
    DGFEM
    +
    Discontinuous Galerkin finite element method.
    + +
    Discontinuous Galerkin
    +
    A Galerkin discretization with all degrees of freedom in the interior of the grid cells. Continuity between grid cells is established by jump terms on the cell interfaces.
    + +
    hex
    +
    hexahedron, mapping of the unit cube into the domain
    + +
    locally finest level
    +
    all active cells, i.e. the finest cell at each point of the domain
    + +
    quad
    +
    quadrilateral, mapping of the unit square into the domain
    + +
    triangulation object
    +
    the different kinds of polytopes forming a triangulation, lines, quadrilaterals and hexahedra
    +
    + diff --git a/deal.II/doc/mail/date.mrc b/deal.II/doc/mail/date.mrc deleted file mode 100644 index adb20f31ca..0000000000 --- a/deal.II/doc/mail/date.mrc +++ /dev/null @@ -1,153 +0,0 @@ - -deal.II Mailinglist - - - - - - - - - - - - $IDXTITLE$ - - - . - - -

    $IDXTITLE$

    -
    - - - - -
    The deal.II mailing list
    - - -
    - - - - - - - - - $TIDXTITLE$ - - - - -

    $TIDXTITLE$

    -
    - - - - -
    The deal.II mailing list
    - - - - - - - - - - - $SUBJECTNA:72$ - - - - - - - - -
    -
    The deal.II mailing list
    - - - - - - - - - - - - - - - - -reply-to:from:return-path:apparently-from:sender:resent-sender - - - - - - - -
    - - - -

    $MSGGMTDATE(CUR;%Y - %b - %d)$
    - - - - -
    - - - - - -$SUBJECT$ -$FROMNAME$ - - - - - - - - - - - - -SubjectHeader> -

    $SUBJECTNA$

    - - - - - - - - - - - - - -

    -$FROMNAME$ ($FROMADDRNAME$ at $FROMADDRDOMAIN$) -
    -$GMTDATE$

    -
    -
    \ No newline at end of file diff --git a/deal.II/doc/news/2000/Makefile b/deal.II/doc/news/2000/Makefile deleted file mode 100644 index 182c337dc5..0000000000 --- a/deal.II/doc/news/2000/Makefile +++ /dev/null @@ -1,13 +0,0 @@ -# $Id$ - -# include defaults file -D = ../../.. -include $D/common/Make.global_options - - -validate-xrefs: - $(PERL) $D/doc/auto/scripts/validate-xrefs.pl *.html - - -.PHONY: validate-xrefs - diff --git a/deal.II/doc/news/2001/Makefile b/deal.II/doc/news/2001/Makefile deleted file mode 100644 index 182c337dc5..0000000000 --- a/deal.II/doc/news/2001/Makefile +++ /dev/null @@ -1,13 +0,0 @@ -# $Id$ - -# include defaults file -D = ../../.. -include $D/common/Make.global_options - - -validate-xrefs: - $(PERL) $D/doc/auto/scripts/validate-xrefs.pl *.html - - -.PHONY: validate-xrefs - diff --git a/deal.II/doc/news/2002/Makefile b/deal.II/doc/news/2002/Makefile deleted file mode 100644 index 182c337dc5..0000000000 --- a/deal.II/doc/news/2002/Makefile +++ /dev/null @@ -1,13 +0,0 @@ -# $Id$ - -# include defaults file -D = ../../.. -include $D/common/Make.global_options - - -validate-xrefs: - $(PERL) $D/doc/auto/scripts/validate-xrefs.pl *.html - - -.PHONY: validate-xrefs - diff --git a/deal.II/doc/news/2003/Makefile b/deal.II/doc/news/2003/Makefile deleted file mode 100644 index 182c337dc5..0000000000 --- a/deal.II/doc/news/2003/Makefile +++ /dev/null @@ -1,13 +0,0 @@ -# $Id$ - -# include defaults file -D = ../../.. -include $D/common/Make.global_options - - -validate-xrefs: - $(PERL) $D/doc/auto/scripts/validate-xrefs.pl *.html - - -.PHONY: validate-xrefs - diff --git a/deal.II/doc/news/Makefile b/deal.II/doc/news/Makefile deleted file mode 100644 index 8b93429d80..0000000000 --- a/deal.II/doc/news/Makefile +++ /dev/null @@ -1,15 +0,0 @@ -# $Id$ - -# include defaults file -D = ../.. -include $D/common/Make.global_options - - -validate-xrefs: - @$(PERL) $D/common/scripts/validate-xrefs.pl *.html */*.html - - - -.PHONY: validate-xrefs - - diff --git a/deal.II/doc/publications/Makefile b/deal.II/doc/publications/Makefile deleted file mode 100644 index 19b3b7b342..0000000000 --- a/deal.II/doc/publications/Makefile +++ /dev/null @@ -1,15 +0,0 @@ -# $Id$ - -D = ../.. -include $D/common/Make.global_options - - -# default: do nothing -default: - - -validate-xrefs: - $(PERL) $D/common/scripts/validate-xrefs.pl *.html - - -.PHONY: default validate-xrefs \ No newline at end of file diff --git a/deal.II/doc/reports/Makefile b/deal.II/doc/reports/Makefile deleted file mode 100644 index b5c20fcf0a..0000000000 --- a/deal.II/doc/reports/Makefile +++ /dev/null @@ -1,17 +0,0 @@ -# $Id$ - -# include paths and global variables -include ../../common/Make.global_options - -# check xrefs in all subdirs -validate-xrefs: - @for dir in * ; do \ - if test -d $$dir ; then \ - cd $$dir ; \ - if (ls -l | grep html > /dev/null) ; then \ - echo "Checking `pwd`" ; \ - $(PERL) $D/common/scripts/validate-xrefs.pl *html ; \ - fi ; \ - cd .. ; \ - fi ; \ - done