From: bangerth Date: Fri, 2 Nov 2012 01:28:37 +0000 (+0000) Subject: Go over the rest of readme.html. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8fba9bd0986d15036c303b23a9cb9c8e03e67787;p=dealii-svn.git Go over the rest of readme.html. git-svn-id: https://svn.dealii.org/branches/branch_cmake@27309 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/readme.html b/deal.II/doc/readme.html index 263135c470..50ce9986c4 100644 --- a/deal.II/doc/readme.html +++ b/deal.II/doc/readme.html @@ -356,19 +356,41 @@ libraries in a number of standard locations on your file system. For optional interfaces, it gives up if they are not there and deal.II will be built without them. However, there - are three interfaces that we need to have: to BOOST, UMFPACK and - the Threading Building Blocks. If they are not found in places - like /usr/ then cmake will resort to versions - of these libraries that we provide bundled as part of the - deal.II tar files. + is one interface that we need to + have: BOOST. If it is + not found in places like /usr/ then cmake will + resort to versions of these libraries that we provide bundled as part of + the deal.II tar files.

The following paragraphs describe how the interfaces to the various - packages deal.II interacts with can be configured. + packages deal.II interacts with can be configured. As + a general rule in the discussion below, if configuring the interface to + package libx requires passing a flag of the + form -DLIBX_DIR=/path/to/libx then you can alternatively + also set LIBX_DIR as an environment variable in + your .bashrc or .cshrc file so that you do not + have to enter this argument everytime you call cmake.

+ +
ARPACK
+
+

+ ARPACK is a library supporting the computation of + eigenvalues. To use it, use the -DARPACK_DIR=/path/to/arpack argument. + ARPACK comes with its + own license; + if you want to use it with deal.II, + please read it and make sure that you agree with it. + For a detailed description of how to compile ARPACK and linking with deal.II, see + this page. +

+
+
BLAS, @@ -440,6 +462,33 @@

+ +
MUMPS
+
+

+ MUMPS + (MUltifrontal Massively Parallel sparse direct Solver) + is a sparse direct solver that can factorize matrices within or + across nodes of a cluster. To use it, provide the + -DMUMPS_DIR=/path/to/mumps argument to cmake. + For a detailed description of how to compile MUMPS (and + some dependencies) and linking with deal.II, see + this page. +

+
+ + +
NetCDF
+
+

+ NetCDF is a library that provides services for + reading and writing mesh data (and many other + things). deal.II can use it to read meshes via + one of the functions of the GridIn class. To use it, + pass -DNETCDF_DIR=/path/to/netcdf to cmake. +

+
p4est
@@ -465,9 +514,7 @@ To interface with it, add -DPETSC_DIR=/path/to/petsc -DPETSC_ARCH=architecture to the argument list for cmake. The values for these arguments must be the - same as those specified when building PETSc. Alternatively, you can - also set environment variables PETSC_DIR, PETSC_ARCH - and cmake will pick them up. + same as those specified when building PETSc.

@@ -488,7 +535,24 @@ variable to set is SLEPC_DIR (it uses the same architecture as specified in PETSC_ARCH). For the interface with SLEPc to work, deal.II's - interface to PETSc must also be configured correctly (see above). + PETSc interface must also be configured correctly (see above). +

+
+ + +
Threading Building Blocks (TBB)
+
+

+ Threading Building Blocks (TBB) + is a library that provides advanced services for using multiple + processor cores on a single machine and is used + in deal.II to parallelize many operations. If not + found in a system-wide location, cmake will + resort to the version bundled as part of + the deal.II download. It is always enabled unless + threads are explicitly disabled, see above.

@@ -535,59 +599,8 @@ UMFPACK here. We include UMFPACK in the deal.II distributions courtesy of its author, Timothy A. Davis. +

- - -
- -OLD TEXT OLD TEXT OLD TEXT -
-
TECPLOT
-
Autodetected if one of the variables $TECHOME, - $TEC80HOME or $TEC90HOME points to a valid installation - of the tecio library. If enabled, allows data output in TECPLOT format. -
- - - -
NetCDF
-
Autodetected if the NETCDF_DIR environment variable - points to a valid installation of the NetCDF - library. Can also be enabled by - --with-netcdf=/path/to/netcdf which overrides the path in - $NETCDF_DIR. If enabled, deal.II allows grid - input in NetCDF format (GridIn::read_netcdf). If NetCDF was installed as - part of /usr or /opt, instead of local - directories in a home directory for example, you can use configure - switches --with-netcdf-include, --with-netcdf-libs. -
- - -
MUltifrontal Massively Parallel sparse direct Solver (MUMPS)
-
- It is possible to make use some subroutines that make use of the - MUltifrontal Massively Parallel sparse direct Solver - (MUMPS). For a detailed description of how to compile MUMPS (and - some dependencies) and linking with deal.II, see - this page. -
- - -
ARPACK
-
- There is a wrapper for the eigenvalue solver - ARPACK - library, which has its own license; if you want to use it with deal.II, - please read it and make sure that you agree with it. - You can find the license of ARPACK - here. - For a detailed description of how to compile ARPACK and linking with deal.II, see - this page. -
- -