Updated Windows (markdown)
[dealii.wiki.git] / Frequently-Asked-Questions.md
1 # The deal.II FAQ
2 This page collects a few answers to questions that have frequently been asked about deal.II and that we thought are worth recording as they may be useful to others as well.
3
4 ## Table of Contents
5   * [The deal.II FAQ](#the-dealii-faq)
6     * [Table of Contents](#table-of-contents)
7     * [General questions on deal.II](#general-questions-on-dealii)
8       * [Can I use/implement triangles/tetrahedra in deal.II?](#can-i-useimplement-trianglestetrahedra-in-dealii)
9       * [I'm stuck!](#im-stuck)
10       * [I'm not sure the mailing list is the right place to ask ...](#im-not-sure-the-mailing-list-is-the-right-place-to-ask-)
11       * [How fast is deal.II?](#how-fast-is-dealii)
12       * [deal.II programs behave differently in 1d than in 2/3d](#dealii-programs-behave-differently-in-1d-than-in-23d)
13       * [I want to use deal.II for work in my company. Do I need a special license?](#i-want-to-use-dealii-for-work-in-my-company-do-i-need-a-special-license)
14     * [Supported System Architectures](#supported-system-architectures)
15       * [Can I use deal.II on a Windows platform?](#can-i-use-dealii-on-a-windows-platform)
16         * [Run deal.II in the Windows Subsystem for Linux](#run-dealii-in-the-windows-subsystem-for-linux)
17         * [Run deal.II natively on Windows](#run-dealii-natively-on-windows)
18         * [Run deal.II through a virtual box](#run-dealii-through-a-virtual-box)
19         * [Dual-boot your machine with Ubuntu](#dual-boot-your-machine-with-ubuntu)
20       * [Can I use deal.II on an Apple Macintosh?](#can-i-use-dealii-on-an-apple-macintosh)
21       * [Does deal.II support shared memory parallel computing?](#does-dealii-support-shared-memory-parallel-computing)
22       * [Does deal.II support parallel computing with message passing?](#does-dealii-support-parallel-computing-with-message-passing)
23       * [How does deal.II support multi-threading?](#how-does-dealii-support-multi-threading)
24       * [My deal.II installation links with the Threading Building Blocks (TBB) but doesn't appear to use multiple threads!](#my-dealii-installation-links-with-the-threading-building-blocks-tbb-but-doesnt-appear-to-use-multiple-threads)
25     * [Configuration and Compiling](#configuration-and-compiling)
26       * [Where do I start?](#where-do-i-start)
27       * [I tried to install deal.II on system X and it does not work](#i-tried-to-install-dealii-on-system-x-and-it-does-not-work)
28       * [How do I change the compiler?](#how-do-i-change-the-compiler)
29       * [I can configure and compile the library but installation fails. What is going on?](#i-can-configure-and-compile-the-library-but-installation-fails-what-is-going-on)
30       * [I get warnings during linking when compiling the library. What's wrong?](#i-get-warnings-during-linking-when-compiling-the-library-whats-wrong)
31       * [I can't seem to link/run with PETSc](#i-cant-seem-to-linkrun-with-petsc)
32         * [Is there a sure-fire way to compile deal.II with PETSc?](#is-there-a-sure-fire-way-to-compile-dealii-with-petsc)
33         * [I want to use HYPRE through PETSc](#i-want-to-use-hypre-through-petsc)
34         * [Is there a sure-fire way to compile dealii with SLEPc?](#is-there-a-sure-fire-way-to-compile-dealii-with-slepc)
35       * [Trilinos detection fails with an error in the file Sacado.hpp or <code>Sacado_cmath.hpp</code>](#trilinos-detection-fails-with-an-error-in-the-file-sacadohpp-or-sacado_cmathhpp)
36       * [My program links with some template parameters but not with others.](#my-program-links-with-some-template-parameters-but-not-with-others)
37       * [When trying to run my program on Mac OS X, I get image errors.](#when-trying-to-run-my-program-on-mac-os-x-i-get-image-errors)
38     * [C++ questions](#c-questions)
39       * [What integrated development environment (IDE) works well with deal.II?](#what-integrated-development-environment-ide-works-well-with-dealii)
40       * [Is there a good introduction to C++?](#is-there-a-good-introduction-to-c)
41       * [Are there features of C++ that you avoid in deal.II?](#are-there-features-of-c-that-you-avoid-in-dealii)
42       * [Why use templates for the space dimension?](#why-use-templates-for-the-space-dimension)
43       * [Doesn't it take forever to compile templates?](#doesnt-it-take-forever-to-compile-templates)
44       * [Why do I need to use typename in all these templates?](#why-do-i-need-to-use-typename-in-all-these-templates)
45       * [Why do I need to use this-&gt; in all these templates?](#why-do-i-need-to-use-this--in-all-these-templates)
46       * [Does deal.II require C++11 support?](#does-dealii-require-c11-support)
47         * [deal.II version 9.0.0](#dealii-version-900)
48         * [deal.II version 8.5.0 and previous](#dealii-version-850-and-previous)
49       * [Can I convert Triangulation cell iterators to DoFHandler cell iterators?](#can-i-convert-triangulation-cell-iterators-to-dofhandler-cell-iterators)
50     * [Questions about specific behavior of parts of deal.II](#questions-about-specific-behavior-of-parts-of-dealii)
51       * [How do I create the mesh for my problem?](#how-do-i-create-the-mesh-for-my-problem)
52       * [How do I describe complex boundaries?](#how-do-i-describe-complex-boundaries)
53       * [How do I get the degree of freedom indices at vertices?](#how-do-i-get-the-degree-of-freedom-indices-at-vertices) 
54       * [I am using discontinuous Lagrange elements (FE_DGQ) but they don't seem to have vertex degrees of freedom!?](#i-am-using-discontinuous-lagrange-elements-fe_dgq-but-they-dont-seem-to-have-vertex-degrees-of-freedom)
55       * [How do I access values of discontinuous elements at vertices?](#how-do-i-access-values-of-discontinuous-elements-at-vertices)
56       * [Does deal.II support anisotropic finite element shape functions?](#does-dealii-support-anisotropic-finite-element-shape-functions)
57       * [The graphical output files don't make sense to me -- they seem to have too many degrees of freedom!](#the-graphical-output-files-dont-make-sense-to-me----they-seem-to-have-too-many-degrees-of-freedom)
58       * [In my graphical output, the solution appears discontinuous at hanging nodes](#in-my-graphical-output-the-solution-appears-discontinuous-at-hanging-nodes)
59       * [When I run the tutorial programs, I get slightly different results](#when-i-run-the-tutorial-programs-i-get-slightly-different-results)
60       * [How do I access the whole vector in a parallel MPI computation?](#how-do-i-access-the-whole-vector-in-a-parallel-mpi-computation)
61       * [How to get the (mapped) position of support points of my element?](#how-to-get-the-mapped-position-of-support-points-of-my-element)
62     * [Debugging deal.II applications](#debugging-dealii-applications)
63       * [I don't have a whole lot of experience programming large-scale software. Any recommendations?](#i-dont-have-a-whole-lot-of-experience-programming-large-scale-software-any-recommendations)
64       * [Are there strategies to avoid bugs in the first place?](#are-there-strategies-to-avoid-bugs-in-the-first-place)
65       * [How can deal.II help me find bugs?](#how-can-dealii-help-me-find-bugs)
66       * [Should I use a debugger?](#should-i-use-a-debugger)
67       * [deal.II aborts my program with an error message](#dealii-aborts-my-program-with-an-error-message)
68       * [The program aborts saying that an exception was thrown, but I can't find out where](#the-program-aborts-saying-that-an-exception-was-thrown-but-i-cant-find-out-where)
69       * [I get an exception in virtual dealii::Subscriptor::~Subscriptor() that makes no sense to me!](#i-get-an-exception-in-virtual-dealiisubscriptorsubscriptor-that-makes-no-sense-to-me)
70       * [I get an error that the solver doesn't converge. But which solver?](#i-get-an-error-that-the-solver-doesnt-converge-but-which-solver)
71       * [How do I know whether my finite element solution is correct? (Or: What is the "Method of Manufactured Solutions"?)](#how-do-i-know-whether-my-finite-element-solution-is-correct-or-what-is-the-method-of-manufactured-solutions)
72       * [My program doesn't produce the expected output!](#my-program-doesnt-produce-the-expected-output)
73       * [The solution converges initially, but the error doesn't go down below 10<sup>-8</sup>!](#the-solution-converges-initially-but-the-error-doesnt-go-down-below-10-8)
74       * [My code converges with one version of deal.II but not with another](#my-code-converges-with-one-version-of-dealii-but-not-with-another)
75       * [My time dependent solver does not produce the correct answer!](#my-time-dependent-solver-does-not-produce-the-correct-answer)
76       * [My Newton method for a nonlinear problem does not converge (or converges too slowly)!](#my-newton-method-for-a-nonlinear-problem-does-not-converge-or-converges-too-slowly)
77       * [Printing deal.II data types in debuggers is barely readable!](#printing-dealii-data-types-in-debuggers-is-barely-readable)
78       * [My program is slow!](#my-program-is-slow)
79       * [How do I debug MPI programs?](#how-do-i-debug-mpi-programs)
80       * [I have an MPI program that hangs](#i-have-an-mpi-program-that-hangs)
81       * [One statement/block/function in my MPI program takes a long time](#one-statementblockfunction-in-my-mpi-program-takes-a-long-time)
82     * [I have a special kind of equation!](#i-have-a-special-kind-of-equation)
83       * [Where do I start?](#where-do-i-start-1)
84       * [Can I solve my particular problem?](#can-i-solve-my-particular-problem)
85       * [Why use deal.II instead of writing my application from scratch?](#why-use-dealii-instead-of-writing-my-application-from-scratch)
86       * [Can I solve problems over complex numbers?](#can-i-solve-problems-over-complex-numbers)
87       * [How can I solve a problem with a system of PDEs instead of a single equation?](#how-can-i-solve-a-problem-with-a-system-of-pdes-instead-of-a-single-equation)
88       * [Is it possible to use different models/equations on different parts of the domain?](#is-it-possible-to-use-different-modelsequations-on-different-parts-of-the-domain)
89       * [Where do I start to implement a new Finite Element Class?](#where-do-i-start-to-implement-a-new-finite-element-class)
90     * [General finite element questions](#general-finite-element-questions)
91       * [How do I compute the error](#how-do-i-compute-the-error)
92       * [How to plot the error as a pointwise function](#how-to-plot-the-error-as-a-pointwise-function)
93       * [I'm trying to plot the right hand side vector but it doesn't seem to make sense!](#im-trying-to-plot-the-right-hand-side-vector-but-it-doesnt-seem-to-make-sense)
94       * [What does XXX mean?](#what-does-xxx-mean)
95     * [I want to contribute to the development of deal.II!](#i-want-to-contribute-to-the-development-of-dealii)
96     * [I found a typo or a bug and fixed it on my machine. How do I get it included in deal.II?](#i-found-a-typo-or-a-bug-and-fixed-it-on-my-machine-how-do-i-get-it-included-in-dealii)
97     * [I'm fluent in deal.II, are there jobs for me?](#im-fluent-in-dealii-are-there-jobs-for-me)
98
99 ## General questions on deal.II
100
101 ### Can I use/implement triangles/tetrahedra in deal.II?
102
103 This is truly one of the most frequently asked questions. The short answer
104 is: No, you can't. deal.II's basic data structures are too much tailored to
105 quadrilaterals and hexahedra to make this trivially possible. Implementing
106 other reference cells such as triangles and tetrahedra amounts to
107 re-implementing nearly all grid and DoF classes from scratch, along with
108 the finite element shape functions, mappings, quadratures and a whole host
109 of other things. Making triangles and tetrahedra work would certainly involve
110 having to write several ten thousand lines of code, and to make it usable
111 in all the rest of the library would require auditing a very significant
112 fraction of the 600,000 lines of code that make up deal.II today.
113
114 That said, the current specialization on quadrilaterals and hexahedra has
115 two very positive aspects: First, quadrilaterals and hexahedra typically
116 provide a significantly better approximation quality than triangular meshes
117 with the same number of degrees of freedom; you therefore get more accurate
118 solutions for the same amount of work. Secondly, because the shape of cells
119 are known, we can make a lot of things known to the compiler (such as the
120 number of iterations of a loop over all vertices of a cell) which avoid a
121 large number of run-time computations and makes the library as fast as it
122 is. A simple example is that in deal.II we know that a loop over all
123 vertices of a cell has exactly `GeometryInfo<dim>::vertices_per_cell`
124 iterations, a number that is known to the compiler at compile-time. If we
125 allowed both triangles and quadrilaterals, the loop would have
126 `cell->n_vertices()` iterations, but this would in general not be known at
127 compile time and consequently not allow the compiler to optimize on.
128
129 If you do need to work with a geometry for which all you have is a
130 triangular or tetrahedral mesh, then you can convert this mesh into one
131 that consists of quadrilaterals and hexahedra using the `tethex` program,
132 see https://github.com/martemyev/tethex .
133
134 ### I'm stuck!
135
136 Further down below on this page (in the debugging section) we list a number
137 of strategies on how to find errors in your program. If your question is
138 how to implement something new for which you don't know where to start,
139 have you taken a look at the set of tutorial programs and checked whether
140 one or the other already has something that's close to what you want?
141
142 That said, there will be situations where documentation doesn't help and
143 where you need other someone else's opinion. That's what the [deal.II
144 mailing lists](http://dealii.org/mail.html) are there for: Feel free to
145 ask! You may also wish to subscribe to the users' list -- not so much
146 because someone else might ask the same question you have, but because
147 reading the list gives you background information on things others are
148 working on that may help you when you want to do something similar.
149
150 When asking for help on the mailing list, be specific. We frequently get mail of the following kind:
151 <pre>
152   I'm trying to do X. This works fine but it fails when I try to transfer
153   the data to my MyClass::Estimator object. I tried to use something
154   similar to what's done in a couple of tutorial programs but it doesn't
155   work. I'm new at C++ and I just can't seem to get the syntax right.
156 </pre>
157
158 This message doesn't contain nearly enough information for anyone to really
159 help you: we don't know what `MyClass::Estimator` is, we don't know how you
160 try to transfer data, we haven't seen your code, and we haven't seen the
161 compiler's error messages. (For more examples of how not to write help
162 requests, see [Section 3.2 of this
163 document](http://faculty.washington.edu/dchinn/how-not-to-code.pdf).) We
164 could poke in the dark, but it would probably be more productive if you
165 gave us a bit more detail explaining what doesn't work: show us the code
166 you implemented, show us the compiler's error message, or be specific in
167 some other way in describing what the problem is!
168
169 ### I'm not sure the mailing list is the right place to ask ...
170
171 Yes, it probably is. Please direct your questions to the mailing list and
172 not to individual developers. There are many reasons:
173
174   1. Others might have similar questions in the future and can search the
175      archives.
176   1. There are many active users on the mailing list that are happy to
177      help. There probably is someone who did something very similar before.
178   1. Imagine everyone would stop using the mailing list and email us
179      directly. We would spend most of our time answering the same questions
180      over and over.
181   1. Many users are reading the mailing list and are interested in deal.II
182      in general and are learning by skimming emails. Give them a chance.
183   1. As a consequence of all this, we typically prioritize questions on
184      mailing lists over emails sent directly to us asking for help.
185   1. Don't be afraid. There are no stupid questions (only off-topic ones).
186      Everyone started out at some point. Asking the questions in the open
187      helps us improve the library and documentation.
188
189 That said, if there is something you can not discuss in the open, feel free
190 to contact us!
191
192
193 ### How fast is deal.II?
194
195 The answer to this question really depends on your metric. If you had to
196 write, say, a Stokes solver with a particular linear solver, a particular
197 time stepping scheme, on a piecewise polygonal domain, and Q2/Q1 elements,
198 you can write a code that is 20% or 30% faster than what you would get when
199 using deal.II because you know the building blocks, shape functions,
200 mappings, etc. But it'll take you 6 months to do so, and 20,000 lines of
201 code. On the other hand, when using deal.II, you can do it in 2 weeks and
202 204 lines (that's the number of semicolons in step-22).
203
204 In other words, if by "fast" you mean the absolute maximal efficiency in
205 terms of CPU time deal.II is more than likely to lose against a
206 hand-written Fortran77 code. But for most of us, the real question of
207 "fast" also includes the time it takes to get the code running and
208 verified, and in that case deal.II is most likely the fastest library out
209 there simply by virtue of the fact that it is by far the largest and most
210 comprehensive finite element library available as Open Source.
211
212 This all, by the way, does not mean that we don't care about speed: We
213 spend a lot of effort profiling the library and working on the hot spots to
214 make codes fast. The discussion of this issue in the introduction of
215 step-22 is a good example. There are also some guidelines below on how to
216 profile your code in the debugging section of this FAQ.
217
218 ### deal.II programs behave differently in 1d than in 2/3d
219
220 In deal.II, you can write programs that look exactly the same in 2d and 3d,
221 but there are cases where 1d is slightly different. That said, this is an
222 area that we have significantly rewritten, and starting with deal.II 7.1,
223 most cases should work in 1d in just the same way as they do in 2d/3d. If
224 you find something that doesn't work, please report it to the mailing list.
225
226 Historically, the differences primarily resulted from the fact that in
227 deal.II, we represent vertices differently from lines and quads; whereas
228 the latter can store information (for example boundary indicators, user
229 flags, etc) vertices don't. As a consequence, the boundary indicator of a
230 boundary part in 1d (i.e. either the left or right vertex) were determined
231 by convention, rather than by setting it explicitly: the left boundary of a
232 1d domain always had boundary indicator zero, the right boundary always
233 boundary indicator one. This was different from the 2d/3d case where by
234 default (unless you explicitly set things differently) all boundaries have
235 indicator zero. This left-boundary-has-id-0, right-boundary-has-id-1 is
236 still the default today, but at least you can set the boundary indicators
237 of these end-points to something different today.
238
239 A second difference is that vertices have no extent, and so you can't apply
240 quadrature to them. As a consequence, the FEFaceValues class wasn't usable
241 in 1d. Again, this should work these days: every quadrature formula that
242 has a single quadrature point is a valid one for points as well.
243
244 ### I want to use deal.II for work in my company. Do I need a special license?
245
246 Before going into any more details, you **need** to carefully read the
247 license deal.II is under. In particular, the explanations below are not meant
248 to be legal advice and does not override the provisions in the Open Source
249 license.
250
251 However, before this, let us provide our overarching philosophy: It is our
252 intention to have constructive relationships with those who want to use our
253 work commercially, and we encourage commercial use. After having used a
254 more restrictive license until 2013, we have come to the conclusion that
255 these licenses serve neither side particularly well: it made commercial use
256 difficult, and the lack of commercial use deprived us of critical feedback,
257 potential contributions from professional users, and our users of potential
258 employment opportunities. Everyone is better off with the LGPL license we
259 are using now, and we hope that deal.II also finds use in commercial
260 settings.
261
262 Now for the smaller print: Generally, the LGPL is a fairly liberal license.
263 In particular, if you *develop a code based on deal.II*, then there is no
264 requirement that you also open source your own code: you can keep it closed
265 source, under a proprietary license, and you don't need to give it to
266 anyone (neither your customers nor to us).
267
268 The LGPL is only restrictive in that the *changes you make to deal.II
269 itself* must also be licensed under the LGPL. There is not frequently a
270 need to change the library itself, and in many of these cases you will
271 probably be interested to get them into the upstream development sources
272 anyway (e.g., in cases of bugs) rather than having to forward port them
273 indefinitely. Of course, we are interested in this as well. However, there
274 is no such requirement that you upstream these changes: the only people you
275 have to make these modifications to deal.II available to are your
276 customers.
277
278 As mentioned above, the preceding paragraphs are not a legal
279 interpretation. For definite interpretations of the LGPL, you may want to
280 consult lawyers familiar with the topic or search the web for more detailed
281 interpretations.
282
283
284 ## Supported System Architectures
285
286 ### Can I use deal.II on a Windows platform?
287
288 deal.II has been developed with a Unix-like environment in mind and it
289 shows in a number of places regarding the build system and compilers
290 supported. That said, there are multiple methods to get deal.II running if
291 you have a Windows machine.
292
293 #### Run deal.II in the Windows Subsystem for Linux
294
295 Windows 10 has gained a compatibility layer for running Linux binaries
296 natively on Windows. You can find more information on the
297 [Wikipedia page](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux).
298 This means you do not have to use
299 [virtualization](#run-dealii-through-a-virtual-box), or [dual
300 boot](#dual-boot-your-machine-with-ubuntu) any more to install a
301 full-featured Linux distribution! We summarize the installation on a
302 separate wiki page on [[Windows]].
303
304 #### Run deal.II natively on Windows
305
306 Since deal.II 8.4.0 we have experimental support for Microsoft Visual Studio (2013 and 2015). See the separate page on [[Windows]] for more details.
307
308 #### Run deal.II through a virtual box
309
310 The simplest way to try out deal.II is to run it in a premade virtual
311 machine. You can download the virtual machine for VirtualBox from
312 http://www.math.clemson.edu/~heister/dealvm/ and run it inside windows.
313
314 Note that your experience depends on how powerful your machine is. More
315 than 4GB RAM are recommended. A native installation of Linux is preferable
316 (see below).
317
318 #### Dual-boot your machine with Ubuntu
319
320 The simplest way to install Linux as a Windows user is to dual-boot.
321 Dual-boot means that you simply install a second operating system on your
322 computer and you choose which one to start when you boot the machine. Most
323 versions of Linux support installing themselves as a second operating
324 system. One example is using the Ubuntu installer for Windows. This
325 installer will automatically dual-boot your system for you in a safe and
326 fully reversible manner. Simply follow the instructions on
327 http://www.ubuntu.com/download/desktop/install-ubuntu-with-windows
328
329 If at some point in the future you wish to remove Ubuntu from your system,
330 from the Windows program manager (add-remove programs in older versions and
331 programs and features in newer versions) you can simply uninstall Ubuntu as
332 you would any other program.
333
334 *Note:* The actual install file is linked through the text "Windows
335 installer" in the first gray box.  You will be prompted to donate to
336 Ubuntu, which is entirely optional. You will also be prompted to use a
337 different version of Ubuntu if you use Windows 8.
338
339 ### Can I use deal.II on an Apple Macintosh?
340
341 Yes, at least on the more modern OS X operating systems this works just
342 fine. deal.II supports native compilers shipping with XCode as well as gcc
343 from Mac Ports.
344
345 The only issue we are currently aware of is that if deal.II is configured
346 to interface with PETSc, then PETSc needs to be configured with the
347 <code>--with-x=0</code> flag to prevent linking in the X11 libraries (you
348 probably won't need them anyway). Installing with PETSc has a myriad of
349 other problems, though we believe that we have a way to stably interface
350 it. You may want to read through the PETSc-related entries further down,
351 however.
352
353 ### Does deal.II support shared memory parallel computing?
354
355 Yes. deal.II supports multithreading with the help of the
356 [http://www.threadingbuildingblocks.org Threading Building Blocks (TBB)
357 library](c967ec2ff74d85bd4327f9f773a93af3]). It is enabled by default and
358 can be controlled via the `DEAL_II_WITH_THREADS` configuration toggle
359 passed to `cmake` (see the deal.II readme file).
360
361 ### Does deal.II support parallel computing with message passing?
362
363 Yes, and in fact it has been shown to scale very nicely to at least 16,384
364 processor cores in a paper by Bangerth, Burstedde, Heister and Kronbichler.
365 You should take a look at the documentation modules discussing parallel
366 computing, as well as the step-40 tutorial program.
367
368
369 ### How does deal.II support multi-threading?
370
371 deal.II will use multi-threading using several approaches:
372 1. some BLAS routines might be multi-threaded (typically using OpenMP).
373    This can be controlled from the command line using OMP_NUM_THREADS (also
374    see the entry in the FAQ below)
375 2. Many places in the library are parallelized using the Threading Building
376    Blocks (TBB) library.
377
378 MPI_InitFinalize() has an optional third argument that specifies the number
379 of threads to use for the TBB. The default is 1. This gets send to the TBB
380 via a call to  MultithreadInfo::set_thread_limit(). If you pass
381 numbers::invalid_unsigned_int into MPI_InitFinalize (or if you don't use
382 that class, call set_thread_limit directly) then TBB will use the maximum
383 number of threads that makes sense (and you can limit it using
384 DEAL_II_NUM_THREADS from the command line).
385
386 Also note that while our Trilinos wrappers support multi-threading, the
387 PETSc wrappers do not support this at this time, so you need to run with
388 one thread per process.
389
390 ### My deal.II installation links with the Threading Building Blocks (TBB) but doesn't appear to use multiple threads!
391
392 This may be a quirky interaction with the [GOTO
393 BLAS](http://www.tacc.utexas.edu/tacc-projects/gotoblas2/) :-( If you use
394 Trilinos or PETSc, both of these require a BLAS library from your system,
395 and the deal.II cmake configuration will make sure that it is linked with.
396 The problem stems from the fact that by default, the GOTO BLAS will simply
397 grab all cores of the system for its own use, and -- before your `main()`
398 function even starts, allow the main thread to use only a single core. (For
399 the technically interested: it sets the processor scheduling affinity mask,
400 using `set_sched_affinity` to a single bit.)
401
402 When the TBB initialization runs, still before `main()` starts, it will
403 find that it can only run on a single core and will consequently not be
404 able to work on multiple tasks in parallel.
405
406 The solution to this problem is to forbid the GOTO BLAS to grab all
407 processors for itself, since we spend very little time in BLAS anyway. This
408 can be done by setting either the `OMP_NUM_THREADS` or `GOTO_NUM_THREADS`
409 environment variables to 1, see
410 http://www.tacc.utexas.edu/tacc-software/gotoblas2/faq .
411
412
413 ## Configuration and Compiling
414
415 ### Where do I start?
416
417 Have a look at the  [ReadMe instructions](http://www.dealii.org/developer/readme.html) for details on how to configure and install the library with `cmake`.
418
419 ### I tried to install deal.II on system X and it does not work
420
421 That does occasionally (though relatively rarely) happen, in particular if
422 you work on an operating system or with a compiler that the primary
423 developers don't have access to. In a case like this, you should ask for
424 help on the mailing list. However, remember: If your question only contains
425 the text "I tried to install deal.II on system X and it does not work" then
426 that's not quite enough to figure out what is happening. Even though the
427 people developing this software belong to the most able programmers in the
428 universe (and a decent number of parallel universes), all of us need data
429 to find errors. So, whatever went wrong, paste the error message into your
430 email. If the error is from the `cmake` invocation, show us the error
431 message that was printed on screen.
432 If the error happens after configuring and during compiling, add lines from
433 screen output showing the error to the mail.
434
435
436 ### How do I change the compiler?
437
438 deal.II can be compiled by a number of compilers without problems (see the
439 section [prerequisites](http://www.dealii.org/readme.html#prerequisites) in
440 the readme file). If `cmake` does not pick the right one, selecting another
441 is simple, and described in a
442 [section](http://www.dealii.org/developer/development/cmake.html#compiler)
443 in the [cmake
444 documentation](http://www.dealii.org/developer/development/cmake.html).
445
446 ### I can configure and compile the library but installation fails. What is going on?
447
448 If you configure with the default ``CMAKE_INSTALL_PREFIX``, the library is configured to installed to ``/usr/local`` and this fails without superuser rights with an error message like
449 ```
450 CMake Error at cmake/scripts/cmake_install.cmake:42 (FILE):
451   file cannot create directory: /usr/local/common/scripts.  Maybe need
452   administrative privileges.
453 ```
454 Please see the [readme](http://www.dealii.org/developer/readme.html#configuration) on how to pick an install directory with write access (for example some path below your home directory).
455
456 ### I get warnings during linking when compiling the library. What's wrong?
457
458 On some linux distributions with particular versions of the system
459 compiler, one can get warnings like these during the linking stage of
460 compiling the library:
461 ```
462 `.L3019' referenced in section `.rodata' of
463 /home/bangerth/deal.II/lib/lac/sparse_matrix.float.g.o: defined in discarded section
464 `.gnu.linkonce.t._ZN15SparsityPattern21optimized_lower_boundEPKjS1_RS0_'
465 of /home/bangerth/deal.II/lib/lac/sparse_matrix.float.g.o
466 ```
467
468 While annoying, these warnings do not actually seem to indicate anything
469 particularly harmful. Apparently, the compiler generates the same code
470 multiple times in exactly the same form, and the linker is only warning
471 that it is throwing away all but one of the copies. There doesn't seem to
472 be way to avoid these warnings, but they can be safely ignored.
473
474 ### I can't seem to link/run with PETSc
475
476 Recent deal.II releases support PETSc 3.0 and later. This works, but there
477 are a number of things that can go wrong and that result in compilation or
478 linker errors, as explained below. If your program links properly with
479 PETSc support, it will very likely also produce the correct results.
480
481 If you get errors like this when trying to run step-17 of the tutorials,
482 even though linking seems to have succeeded just fine:
483 ```
484    [make run
485    ============================ Running step-17
486    ./step-17: error while loading shared libraries: libpetsc.so: cannot open
487               shared object file: No such file or directory
488    make: *** [run](step-17]) Error 127
489 ```
490
491 this means is that while linking, the compiler could find the libpetsc.so
492 library, but the executable can't find it when running. The reason is that
493 we can tell the linker where to look, but the executable apparently did not
494 remember this (this is the standard Unix behavior). What you have to do is
495 to set the LD_LIBRARY_PATH to include the path to the PETSc libraries. For
496 example, under `bash` you would have to do this:
497 ```
498    export LD_LIBRARY_PATH=/path/to/petsc/libraries:$LD_LIBRARY_PATH
499 ```
500
501 If you do so, the Unix loader can query the environment variable for where
502 to find this particular library when trying to run the executable, and
503 running the program should succeed.
504
505 Similarly, if you get errors of the kind during linking
506 ```
507 /home/xxx/deal.II/lib/libdeal_II.g.so: undefined reference to
508 `KSPSetInitialGuessNonzero(_p_KSP*, PetscTruth)'
509 /home/xxx/deal.II/lib/libdeal_II.g.so: undefined reference to
510 `VecAXPY(_p_Vec*, double, _p_Vec*)'
511 ...
512 ```
513
514 then the compiler can't seem to find the PETSc libraries. The solution is
515 as above: specify the path to those libraries via `LD_LIBRARY_PATH`.
516
517
518 #### Is there a sure-fire way to compile deal.II with PETSc?
519
520 Short answer is "No". The slightly longer answer is, "PETSc has too many
521 knobs, switches, dials, and a kitchen sink too many for its own damned
522 good. There is not a sure-fire way to compile deal.II with PETSc!". It
523 turns out that PETSc is a very versatile machine and, as such, there is no
524 shortage of things that can go wrong in trying to configure PETSc to work
525 seamlessly with deal.II on a first attempt. We have all struggled with
526 this, although it has become a lot better in recent years.
527
528 You can find instructions on how to install PETSc linked to from the
529 deal.II ReadMe file, or going directly to
530 http://www.dealii.org/developer/external-libs/petsc.html .
531
532 #### I want to use HYPRE through PETSc
533
534 Hypre implements algebraic multigrid methods (AMG) as preconditioners, for
535 example the BoomerAMG method. AMGs are among the most efficient
536 preconditioners available and they have also been shown to be scalable to
537 thousands of processors. deal.II allows the use of Hypre through the
538 PETScWrappers::PreconditionBoomerAMG class; it is used in `step-40`. Hypre
539 can be installed as a sub-package of PETSc and deal.II can access it
540 through the PETSc interfaces.
541
542 To use the Hypre interfaces through PETSc, you need to configure PETSc as
543 discussed in http://www.dealii.org/developer/external-libs/petsc.html  ,
544 and add the following switch to the command line: `--download-hypre=1`.
545
546 #### Is there a sure-fire way to compile dealii with SLEPc?
547
548 Happily, the answer to this question is a definite yes; that is, <b>if you
549 have successfully compiled and linked PETSc already</b>.
550
551 The real trick here is that during configuration SLEPc will pull out
552 PETSc's configuration and just does whatever that tells it to do. Detailed
553 steps are discussed in
554 http://www.dealii.org/developer/external-libs/slepc.html .
555
556 Once deal.II is compiled, it is worth to start by looking at the step-36
557 tutorial program to see how to get started using the interface with SLEPc.
558
559 <i>
560 Note: To use the solvers and other algorithms SLEPc provides it is
561 absolutely essential to have your PETSc installation working correctly
562 since they share the same vector-matrix (and other) data structures.
563 </i>
564
565
566 ### Trilinos detection fails with an error in the file `Sacado.hpp` or `Sacado_cmath.hpp`
567
568 This is a complicated one (and it should also be fixed in more recent
569 Trilinos versions). In the Trilinos file `Sacado_cmath.hpp`, there is some
570 code of the form
571 ```cpp
572   namespace std
573   {
574     inline float acosh(float x)
575     {
576       return std::log(x + std::sqrt(x*x - float(1.0)));
577     }
578     ...
579   }
580 ```
581
582 In other words, Sacado is putting things into namespace `std`. The functions it
583 is putting there are functions that have been defined by the C99 standard but
584 that didn't make it into the C++98 standard before; some of them are widely
585 used. The problem is that these functions were later added to the standard and
586 so if your compiler is new enough (e.g. GCC 4.5 and later) then the compiler's
587 C++ standard library already contains these functions. Adding them again in this
588 file then yields errors of the kind
589 ```
590 /home/.../trilinos-10.4.2/include/Sacado_cmath.hpp: In function 'float std::acosh(float)':
591 /home/.../trilinos-10.4.2/include/Sacado_cmath.hpp:41:16: error: redefinition of 'float std::acosh(float)'
592 /usr/include/c++/4.5/tr1_impl/cmath:321:3: error: 'float std::acosh(float)' previously defined here
593 ```
594
595 The only useful way to avoid this error is to edit the Trilinos header
596 file. To do this, find and open the file `include/Sacado_cmath.hpp` in the
597 directory in which Trilinos was installed. Then change the block enclosed
598 in
599 ```cpp
600   namespace std
601   {
602     ...
603   }
604 ```
605
606 to read
607 ```cpp
608 #ifndef _GLIBCXX_USE_C99_MATH
609   namespace std
610   {
611     ...
612   }
613 #endif
614 ```
615
616 What this will do is make sure that the new members of namespace `std` are
617 only added if the compiler has not already done so itself.
618
619
620
621
622 ### My program links with some template parameters but not with others.
623
624 deal.II has many types for whose initialization you need to provide a
625 template parameter, e.g. `SparseMatrix<double>`. The implementation of
626 these classes can typically be found in files ending `.templates.h`, e.g.
627 `sparse_matrix.templates.h`. The corresponding `.cc` files, e.g.
628 `sparse_matrix.cc`, essentially only provide the explicit instantiations of
629 these classes for the most commonly used template parameters. Sometimes
630 this is done by including a corresponding `.inst` file, e.g.
631 `sparse_matrix.inst`.
632
633 If you want to use a data type with a template parameter for which there is
634 an explicit instantiation, you only need to include the respective `.h`
635 header file, e.g. `sparse_matrix.h`. If, however, you want to use a
636 template parameter for which there is no explicit instantiation in the
637 corresponding `.cc` file, you have to include the respective `.templates.h`
638 file in order for your program to link successfully.
639
640 The reason for all of this is essentially a matter of reducing compilation
641 time. As long as you use data types with template parameters for which
642 there is an explicit instantiation - and this should be the case most of
643 the time - you do not need to compile the respective (lengthy) .templates.h
644 file every time you compile your code. If, however, you need to use an
645 instance of e.g. `SparseMatrix<bool>`, you have to include the respective
646 `.templates.h` file and you have to compile it along with the remaining
647 files of your program every time.
648
649 ### When trying to run my program on Mac OS X, I get image errors.
650
651 You may encounter an error of the form
652
653 ```
654 dyld: Library not loaded: libdeal_II.g.7.0.0.dylib. Reason: image not found
655 ```
656
657 on OS X. This goes hand in hand with the following message you should have
658 gotten at the end of the output of `./configure`:
659
660 ```
661      Please add the line
662         export DYLD_LIBRARY_PATH=\$DYLD_LIBRARY_PATH:$DEAL2_DIR/lib
663      to your .bash_profile file so that OSX will be
664      able to find the deal.II shared libraries when
665      executing your programs.
666 ```
667
668 What happens is this: when you say "make all", all the deal.II files are
669 compiled and linked into a library (called libdeal_II.g.7.0.0) which on Macs
670 have the file ending .dylib. Then you go to examples/step-1 and compile your
671 program, which uses all the functions and classes that have previously been
672 put into this library.
673
674 Now the following happens: On most operating systems, the actual executable
675 program (i.e. the file step-1 in your directory that resulted from compiling)
676 does not contain any information that would indicate where the various
677 libraries that it uses can be found. For example, the step-1 program does not
678 know where the libdeal_II.g.7.0.0.dylib file is. This is just how most
679 operating systems function. But when you want to execute the program, somehow
680 the program has to know where the library it needs is located. On most
681 unix-like operating systems, this is done by setting an "environment
682 variable" -- on linux this would the variable "LD_LIBRARY_PATH", on Mac OS X
683 it is "DYLD_LIBRARY_PATH".
684
685 So to let the operating system know where the library is located, you could
686 type
687   export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:/Users/renjun/deal.ii/lib
688 every time before you want to execute the program. That would be cumbersome. A
689 simpler way would be if this export command is executed every time when you
690 open a new shell window. This can be achieved by putting this command in a
691 file that is executed every time you open a shell window. Depending on what
692 shell you use, these files are alternatively called
693   .cshrc
694   .bashrc
695   .bash_profile
696 or similar. I'm not quite sure which file is relevant for you, but you can try
697 them one after the other by putting the text in there, closing the window,
698 opening it again, and then trying to execute
699   ./step-1
700 (or saying "make run" in this directory) and seeing whether that works.
701
702 ## C++ questions
703
704 ### What integrated development environment (IDE) works well with deal.II?
705
706 The short answer is probably: whatever works best for you. deal.II uses the
707 build tool CMake, which can generate a project description for virtually every
708 IDE. In the past, many of the main developers have used emacs (or even vi), but
709 there are much better tools around today, such as [eclipse](http://www.eclipse.org/),
710 [KDevelop](http://www.kdevelop.org),
711 [Xcode](http://developer.apple.com/technologies/tools/),
712 [QtCreator](http://qt.nokia.com/products/developer-tools/), all of which
713 have been used by people using deal.II.
714
715 We have gathered some notes on using the following IDEs for deal.II:
716   - [[Eclipse]]
717   - [[KDevelop]]
718   - [[emacs]]: While we don't recommend using emacs any more, this link provides a couple of notes on formatting styles used within deal.II.
719
720 When thinking about what IDE to use, keep this in mind: Many of us have
721 used emacs (or, worse, vi) for years and feel very comfortable with it.
722 But, emacs and vi were both started in 1976, at a time when computers had
723 little memory, virtually no CPU power, and only text-based interfaces.
724 While they have of course become a lot better over time, the design
725 limitations this involved are still very much part of the code base:
726 fundamentally, they are both still text-based and file-oriented. What IDEs
727 can provide are multiple views of the same project in graphical and textual
728 form and, more importantly, can integrate entire projects spanning hundreds
729 of files in multiple directories: they know where a variable is declared
730 (even if it's in a different file), what it's type is, and the properties
731 of this type. Neither emacs nor vi nor any other older editor can provide
732 anything that comes even close to what kdevelop or eclipse can offer in
733 this regard.
734
735 What all this implies is that you should consider using one of the more
736 modern tools, even if you're well acquainted with an existing, older one.
737 Of course it takes a while to get used to a new application but my
738 (Wolfgang's) experience with switching from emacs to kdevelop was that I
739 have become '''so''' much more productive by using modern tools that the
740 time invested in learning it was amortized very quickly. I found this
741 experience a real eye-opener!
742
743 ### Is there a good introduction to C++?
744
745 There are of course many good books and online resources that explain C++.
746 As far as websites are concerned,
747 [www.cplusplus.com](http://www.cplusplus.com) has both [reference material
748 for individual classes of the C++ standard
749 library](http://cplusplus.com/reference/) as well as a [a tutorial on parts
750 of the C++ language](http://cplusplus.com/tutorial) if you want to brush up
751 on the correct syntax of things.
752
753 ### Are there features of C++ that you avoid in deal.II?
754
755 There are few things that we avoid <i>as a matter of principle.</i> C++ is,
756 by and large, a pretty well designed language in the sense that its
757 features are there because they have been found to be useful by a lot of
758 people. As an example, people have found that it is easier to write and
759 debug code that throws exceptions in error cases rather than encoding error
760 situations by special return values (e.g. by returning -1). There are of
761 course ways to avoid exceptions (or templates, or certain parts of the C++
762 standard libraries, or any number of other things people have found
763 objectionable in C++) and some software projects have chosen to restrict
764 the use of C++ (for example Mozilla) or to emulate only those parts of C++
765 they like in C (e.g. the GNOME desktop environment, which leads to awkward
766 to understand code
767 [as described here](http://developer.gnome.org/gobject/stable/howto-gobject-methods.html)).
768
769 But ultimately, it is our belief that these approaches shoot their
770 inventors in the foot: they avoid features of C++ that were really intended
771 to make programming life simpler. It may be simpler for novice programmers
772 to read code without templates; ultimately, however, learning to read and
773 use templates will make you a much more productive programmer since you
774 don't write the same code multiple times. As a consequence, the use of C++
775 is driven by the question of what is best suited to write a particular
776 algorithm, not by abstract considerations. This fits into the realization
777 that deal.II is a large piece of software -- not a small research project
778 -- that requires professional software management practices and for which
779 long term development can no longer be driven by an individual programmer's
780 preferences of style.
781
782 ### Why use templates for the space dimension?
783
784 The fundamental motivation for this is to use dimension-independent
785 programming, i.e. you want to write code in such a way that it looks
786 exactly the same in 2d as in 3d (or 1d, for that matter). There are of
787 course many ways to do this (and libraries have done this for a long time
788 before deal.II has). The three most popular ones are to use a preprocessor
789 `#define` that sets the space dimension globally, to use a global variable
790 that does this, and to have each object have a member variable that denotes
791 the space dimension it is supposed to live in (in much the same way as the
792 template argument does in deal.II). Neither of these approaches is optimal
793 (nor is our own approach to use templates), however. In particular, using a
794 preprocessor symbol or a global variable will not allow you to mix and
795 match objects of different dimensionality. There are situations when you
796 want to do that; for example deal.II internally builds higher dimensional
797 quadrature formulas as tensor products of lower dimensional ones, and in
798 application codes you may wish to discretize both volume models (e.g.
799 simulating 3d models of plate tectonics and mountain belt formation) with
800 surface models (e.g. erosion processes on the 2d earth surface).
801
802 This leaves the option to have a member variable denoting the space
803 dimension in each object, a choice most other finite element libraries have
804 followed. But this isn't optimal either, for two reasons. For example,
805 consider this code that describes the equivalent of the `Point<dim>` class
806 for points in dim-dimensional space and its `norm()` member function:
807
808 ```cpp
809 class Point
810 {
811 public:
812   Point (const unsigned int dimension)
813     : dim(dimension),
814       coordinates (new double[dim])
815   {}
816
817   ~Point() { delete[] coordinates; }
818
819   double norm () const;
820   ...
821 private:
822   unsigned int dim;
823   double *coordinates;
824 };
825
826 double Point::norm () const
827 {
828   double s = 0;
829   for (unsigned int d=0; d<dim; ++d)
830     s += coordinates[d] * coordinates[d];
831   return std::sqrt(s);
832 }
833 ```
834
835 This is going to lead to rather slow code, for multiple reasons:
836
837  - The constructor and destructor have to allocate and deallocate memory on
838    the heap, both expensive processes.
839
840  - When accessing any element of the `coordinates` array, two pointers have
841    to be dereferenced. For example, the access to `coordinates[d]` really
842    expands to `*(this->coordinates + d)`.
843
844  - The compiler can not optimize the loop since the upper bound `dim` of
845    the loop variable is unknown at compile time.
846
847
848 Compare this to the way deal.II (approximately) implements this class:
849
850 ```cpp
851   template <int dim>
852   class Point
853   {
854     public:
855       Point () {}
856       ~Point() {}
857
858       double norm () const;
859       ...
860     private:
861       double coordinates[dim];
862   };
863
864   template <int dim>
865   double Point<dim>::norm () const
866   {
867     double s = 0;
868     for (unsigned int d=0; d<dim; ++d)
869       s += coordinates[d] * coordinates[d];
870     return std::sqrt(s);
871   }
872 ```
873
874 Here, the following holds:
875
876  - Constructor and destructor do not have to allocate and deallocate memory
877    on the heap; rather, since the size of the `coordinates` array is known
878    at compile time (i.e. whenever you instantiate the template for a
879    particular dimension), the array lives on the stack. It is also much
880    smaller than before: the dimension is encoded in the type and doesn't
881    need a memory location, we don't need to store a pointer to an array,
882    and we don't incur the memory overhead of having to manage an object on
883    the heap.
884
885  - When accessing any element of the `coordinates` array, only one pointer
886    has to be dereferenced. For example, the access to `coordinates` really
887    expands to `*(this + d)`.
888
889  - The compiler can optimize the loop since the upper bound `dim` of the
890    loop variable is known at compile time. In particular, for a point in
891    2d, the code the compiler will produce is likely to look more like this
892    because the loop can be unrolled and the loop counter can be optimized
893    away:
894 ```cpp
895 double Point<2>::norm () const
896 {
897   return std::sqrt(coordinates[0] * coordinates[0] + coordinates[1] * coordinates[1]);
898 }
899 ```
900 Obviously, for a 3d point, the code will look differently, but the compiler
901 can do this since it knows what the dimension of the point is at compile
902 time.
903
904 There is another reason for the deal.II way: type safety. In short, a 2d
905 point is not the same as a 3d point. If you assign one to the other, then
906 this may be on purpose and the executable should simply change the value of
907 the `dim` member variable from 2 to 3. But it may also be a legitimate
908 error -- for example, you shouldn't be able to use 2d points to initialize
909 the 3d quadrature points needed to integrate on a 3d cell. This can of
910 course be caught by run-time checks, but the reason for strongly typed
911 languages such as C++ has always been that it is much more efficient if the
912 compiler can already catch this sort of error at compile time. Using
913 templates for the space dimension avoids these sort of mistakes up front by
914 forcing the programmer to explicitly specify her intent, rather than
915 encoding intent in assertions.
916
917 Of course there are also downsides to using templates. Most notably, error
918 messages that involve templates are notoriously unreadable, and that
919 compiling template heavy code is slow: for example, we have to compile the
920 `Point` class three times (for dim=1, dim=2 and dim=3) rather than only
921 once. Nevertheless, we believe that these valid objections do not outweigh
922 the benefits of templates.
923
924 ### Doesn't it take forever to compile templates?
925
926 Yes, in general it does. The reason is that while for non-templates it is
927 enough to put the ''declaration'' of a function into the header file and
928 the ''definition'' into the `.cc` file, for templates that doesn't work.
929 Let's say you have something like
930 ```cpp
931   template <typename T> T square (const T & t);
932 ```
933
934 in your header file and you put the definition
935 ```cpp
936   template <typename T> T square (const T & t) { return t*t; }
937 ```
938
939 into the `.cc` file, then the compiler will say "Yes, I saw this template,
940 and if I see a use of this function later on I will generate a function
941 from it by replacing `T` by whatever type you use in the call". But if
942 there is no call later on in the same `.cc` file, then the compiler won't
943 do anything. If, at the same time, in a different `.cc` file that includes
944 the header file, you use the function with `T=double` the compiler will say
945 "Yes, I saw the declaration, but there is no definition; I assume the
946 function has been compiled in a different `.cc` file with `T=double` and
947 I'll simply record a call to this instantiation in the object file". The
948 call will then be resolved at link time if indeed another object file
949 contains an instantiation of the template for `T=double`. However, if no
950 other object file contains such a definition, a linker error will result.
951
952 In general, for functions like the above, it is difficult to foresee what
953 kinds of template arguments the function may be instantiated for, and so
954 there is no real practical way to put the definition into a `.cc` file.
955 Rather, one puts it into a header file, and so all `.cc` files that may use
956 this function see its definition (i.e. its body) and the compiler can
957 instantiate it in each source file for whatever template argument is
958 necessary. This makes sure that you never get linker errors, but at the
959 same time it makes compiling slow since every header file now not only has
960 to parse the function's declaration, but also its definition -- and in the
961 case of deal.II the definitions of all template functions add up to tens or
962 hundreds of thousands of lines of code. This is one of the reason why many
963 C++ programs compile relatively slowly: because they use a significant part
964 of the C++ standard library, most of which consists of templates.
965
966 deal.II can avoid much of this overhead. The trick is to recognize that in
967 the example above we don't really know what types `T` user code may
968 possibly want to use for this template. But in the case of using the space
969 dimension as a template parameter, we know pretty exactly all the possibly
970 values: `Triangulation<dim>` may really only be instantiated for `dim=1, 2,
971 3` and for nothing else. Consequently, we can do the following: Put all the
972 definitions of the member functions of deal.II into the `.cc` file and at
973 the bottom of the file instruct the compiler to please instantiate all of
974 these templates for `dim=1, 2, 3`. Similar things can be done for many
975 other template functions in deal.II; for example, there are a good number
976 of functions that require vector types as template arguments, of which
977 deal.II provides a good number, yet this list is finite and enumerable.
978 Consequently, we can simply, at the bottom of the `.cc` file, tell the
979 compiler to instantiate all of these template functions for every single
980 vector type deal.II supports, and then don't have to put thousands of lines
981 of template definitions into header files.
982
983 In many cases, enumerating all possible template arguments is tedious; it
984 is also difficult to extend this list when a new vector type is added, for
985 example. To simplify this task, deal.II uses a preprocessor: for many files
986 that want to instantiate a function or class for multiple template
987 arguments, we have a file `.inst.in` that has the equivalent of a
988 `for`-loop over all possible values or types for a template argument; the
989 file is processed by the `common/scripts/expand_instantiations` program to
990 produce a `.inst` file that can then be included into the `.cc` file.
991
992 ### Why do I need to use `typename` in all these templates?
993
994 This is indeed a frequent question. To answer it, it is necessary to
995 understand how a compiler deals with templates, which will take a bit of
996 space here. Let's take for example this case:
997
998 ```cpp
999   void f(int);
1000   void g(double d)
1001   {
1002     f(d);
1003   }
1004   void f(double);
1005 ```
1006
1007 Here, in the function `void g(double)`, we call `f` with a double as an
1008 argument. Because at that point the compiler has only seen the declaration
1009 of the first overload of `f`, it will convert the double `d` to an integer
1010 and call this first overload. The fact that a second overload was declared
1011 later does not change this situation, since it wasn't visible at the time
1012 the compiler parsed `g`.
1013
1014 Templates are designed to work essentially the same, but there are slight
1015 complications. Take this example:
1016
1017 ```cpp
1018   void f(int);
1019   void f(char);
1020   template <typename T> void g(T t)
1021   {
1022     f(1.1);
1023     f(t);
1024   }
1025   void f(double);
1026 ```
1027
1028 In the first line of `g`, the same thing happens as before: the argument is
1029 cast to `int` and the first of the two overloads of `f` is called. But when
1030 the compiler sees the template, it doesn't know yet what type `T` actually
1031 represents, so there is no way to settle on one of the two functions `f`
1032 the compiler has seen before when deciding about the second line. In fact,
1033 the C++ standard says that because the type of the argument `t` in the call
1034 depends on the template type, determining what function to actually call
1035 should only happen <i>at the time and place when the template is
1036 instantiated</i> (this is called <i>argument dependent name lookup</i> or
1037 <i>ADL</i>). In other words, if below the code above we had this:
1038 ```cpp
1039   void h()
1040   {
1041     g(1.1);
1042   }
1043 ```
1044
1045 then in the instantiation of `g` the first call would be to `f(int)`
1046 (because the argument 1.1 does not depend on the type given in the template
1047 argument, and consequently only functions are considered that were seen
1048 <i>before the definition of</i> `g(T)`) whereas the second call to `f`
1049 would be to `f(double)` -- even though `f(double)` wasn't even declared at
1050 the place the compiler saw the call in the template (though it is available
1051 at the place where we instantiate `g<double>`) -- because the function call
1052 argument `t` has type `T` and therefore depends on the template argument.
1053
1054 Argument dependent lookup allows you to use function templates like `g`
1055 with your own data types. For example, you could have your own library that
1056 does
1057 ```cpp
1058   #include <f.h>
1059
1060   struct X { /* something */ };
1061
1062   void f (const X & x) { /* do something with the X */ }
1063
1064   void my_function()
1065   {
1066     X x;
1067     g(x);
1068   }
1069 ```
1070
1071 Presumably the writer of the `g` function did not know about your own type
1072 `X` yet, but her code still works because you provided a suitable overload
1073 of `f` in your own code.
1074
1075 So ADL is clever and allows you to use templates in ways the author of the
1076 template did not anticipate. But it has a dark side: for every statement in
1077 your code, the compiler has to figure out whether it depends on the
1078 template types or not, and it needs in fact to know quite a lot about it.
1079 Take this example:
1080
1081 ```cpp
1082   int p;
1083   template <typename T>
1084   void g(T t)
1085   {
1086     T::something * p;
1087     f(p);
1088   }
1089 ```
1090
1091 Here, is the call to `f` dependent because `p` depends on the type `T`? If
1092 `f` is called with an argument of type `X` that is declared like this
1093
1094 ```cpp
1095   struct X
1096   {
1097     typedef int something;
1098   };
1099 ```
1100
1101 then `T::something * p;` would declare a local variable called `p` that is
1102 of type pointer-to-int. On the other hand, if we had
1103
1104 ```cpp
1105   struct X
1106   {
1107     static double something;
1108   };
1109 ```
1110
1111 then `T::something * p;` multiplies the variable `X::something` by the
1112 global variable `p` and ignores the result of the multiplication. The
1113 following call to `f` would then be non-dependent because the type of the
1114 (global) variable `p` does not depend on the template argument.
1115
1116 The example shows that the compiler can't know whether a call is dependent
1117 or not in a template it is just seeing unless we tell it that
1118 `T::something` is supposed to be a type or a variable or function name. To
1119 avoid this situation, C++ says: if a compiler sees `T::something` then this
1120 is a variable or function name unless it is prefixed by the keyword
1121 `typename` in which case it is supposed to be a type. In other words, the
1122 call to `f` here is going to be non-dependent:
1123 ```cpp
1124   int p;
1125   template <typename T>
1126   void g(T t)
1127   {
1128     T::something * p;
1129     f(p);
1130   }
1131 ```
1132
1133 and instantiating `g` with the first example for `X` is going to lead to
1134 errors because `T::something` didn't turn out to be a variable. On the
1135 other hand, if we had
1136 ```cpp
1137   int p;
1138   template <typename T>
1139   void g(T t)
1140   {
1141     typename T::something * p;
1142     f(p);
1143   }
1144 ```
1145
1146 then the call is dependent and will be deferred until the compiler knows
1147 the type of `T`.
1148
1149 ### Why do I need to use `this->` in all these templates?
1150
1151 This is a consequence of the same rule in the C++ standard as discussed in
1152 the previous question, Argument Dependent Lookup of names (ADL). Consider
1153 this piece of code:
1154 ```cpp
1155   template <typename T>
1156   class Base
1157   {
1158   public:
1159     void f();
1160   };
1161
1162   template <typename T>
1163   class Derived : public Base<T>
1164   {
1165   public:
1166     void g();
1167   };
1168
1169   template <typename T>
1170   void Derived<T>::g()
1171   {
1172     f();
1173   }
1174 ```
1175
1176 By the rules, when the compiler <i>parses</i> the function `Derived::g`
1177 (note that parsing happens before and independently of <i>instantiating</i>
1178 the function for a particular argument type `T`), it sees that the call to
1179 `f()` does not depend on the template type and so it looks for a
1180 declaration of such a function somewhere. In the example above, it doesn't
1181 find one (we'll come to this in a second), which will yield an error. On
1182 the other hand, in this code,
1183 ```cpp
1184   void f(); // global function
1185
1186   template <typename T>
1187   class Base
1188   {
1189   public:
1190     void f();
1191   };
1192
1193   template <typename T>
1194   class Derived : public Base<T>
1195   {
1196   public:
1197     void g();
1198   };
1199
1200   template <typename T>
1201   void Derived<T>::g()
1202   {
1203     f();
1204   }
1205 ```
1206
1207 it would find the global function and so when instantiating the function
1208 for, say, `T=int`, you'd get a function `Derived<int>::g` that would call
1209 the global function `::f`. This may or may not be what you had in mind.
1210
1211 The question of course is why the compiler didn't record a call to
1212 `Base<T>::f` in `Derived<int>::g`? After all, the compiler knows that
1213 `Derived` is derived from `Base`. This has a lot to do with the fact that
1214 at the time of <i>parsing</i> the template, the compiler doesn't know for
1215 which template arguments the template will later be instantiated, and with
1216 explicit or partial specializations.  Consider for example this code:
1217 ```cpp
1218   template <typename T>
1219   class Base
1220   {
1221   public:
1222     void f();
1223   };
1224
1225   class X
1226   {
1227   public:
1228     void f();
1229   };
1230
1231   template <> class Base<int> : public X {};
1232
1233   template <typename T>
1234   class Derived : public Base<T>
1235   {
1236   public:
1237     void g();
1238   };
1239
1240   template <typename T>
1241   void Derived<T>::g()
1242   {
1243     f();
1244   }
1245 ```
1246
1247 Here, if you look at `Derived<T>::g`, the call to `f()` will be resolved to
1248 `Base<T>::f` for all possible types `T`, unless `T=int` in which case the
1249 call will be to `X::f`. The point is that at the time the compiler sees
1250 (parses) the template, it simply doesn't know yet what `T` is, and so ADL
1251 says: if the call is not dependent, find a non-dependent function to record
1252 (e.g. a global function) rather than trying to find a call in scopes you
1253 can't yet know will be relevant (e.g. `Base` or `X`). Likewise, in this
1254 code,
1255 ```cpp
1256   template <typename T>
1257   class Base
1258   {
1259   public:
1260     void f();
1261   };
1262
1263   template <>
1264   class Base<int>
1265   {
1266   public:
1267     struct f {};
1268   };
1269
1270   template <typename T>
1271   class Derived : public Base<T>
1272   {
1273   public:
1274     void g();
1275   };
1276
1277   template <typename T>
1278   void Derived<T>::g()
1279   {
1280     f();
1281   }
1282 ```
1283
1284 the meaning of `f()` changes depending on the template type: if `T=int`, it
1285 creates an object of type `Base<int>>::f` and then throws the object away
1286 again immediately. For all other template arguments `T`, it calls
1287 `Base::f`.
1288
1289 Given this longish description of how compilers look up names under the ADL
1290 rule, let's get back to the original question: If you have this code,
1291 ```cpp
1292   template <typename T>
1293   class Base
1294   {
1295   public:
1296     void f();
1297   };
1298
1299   template <typename T>
1300   class Derived : public Base<T>
1301   {
1302   public:
1303     void g();
1304   };
1305
1306   template <typename T> void Derived<T>::g()
1307   {
1308     f();
1309   }
1310 ```
1311
1312 how do you achieve that the call in `Derived::g` goes to `Base::f`? The
1313 answer is: Tell the compiler to defer the decision of what the call is
1314 supposed to do till the time when it knows what `T` actually is. And we've
1315 already seen how to do that: we need to make the call <i>dependent</i> on
1316 `T`! The way to do that is this:
1317 ```cpp
1318   template <typename T>
1319   void Derived<T>::g()
1320   {
1321     this->f();
1322   }
1323 ```
1324
1325 Here, `this` is a pointer to an object of type `Derived<T>`, which is of
1326 course dependent. So the resolution of what the statement is supposed to
1327 represent is deferred until instantiation time; at that time, however, the
1328 compiler knows what the base class is (for example it knows if there are
1329 explicit specializations) and so it knows which base classes to look into
1330 in an attempt to find a function with the name `f`.
1331
1332 ### Does deal.II require C++11 support?
1333 The answer to this question depends on the version of deal.II that you are
1334 interested in using
1335
1336 #### deal.II version 9.0.0
1337 As of version 9.0.0, deal.II requires C++11 support equivalent to that provided
1338 by GCC 4.8.0., which is, essentially, every new feature in C++11.
1339
1340 #### deal.II version 8.5.0 and previous
1341 The current release of deal.II, 8.5.0, is compatible with the C++98 and C++03
1342 standards, but some features (e.g., the `LinearOperator` class) are only
1343 available if your compiler supports a subset of C++11 features. GCC 4.6 and
1344 newer implement enough of C++11 for these features to be turned on. More
1345 exactly, we currently require the following language features to be present:
1346
1347 1. `auto`-typed variables
1348 2. The `nullptr` keyword
1349 3. Move constructors
1350 4. The `declval` and `decltype` keywords
1351 5. Lambda functions
1352
1353 while we do not use the following features:
1354
1355 1. Marking virtual functions as `override`
1356 2. Some features of the `type_traits` header, such as `std::is_trivially_copyable`
1357 3. Inheriting constructors
1358 4. Template aliases
1359
1360 The deal.II documentation has a
1361 [page](http://dealii.org/8.5.0/doxygen/deal.II/group__CPP11.html) dedicated to
1362 the issue of what parts of C++11 we use and how this works. For a more complete
1363 list of features we do and do not use see
1364 [the GCC 4.6 C++11 compatibility page](https://gcc.gnu.org/gcc-4.6/cxx0x_status.html).
1365
1366 ### Can I convert Triangulation cell iterators to DoFHandler cell iterators?
1367
1368 Yes. You can also convert between iterators belonging to different
1369 DoFHandlers as long as the are based on the identical Triangulation:
1370
1371 ```cpp
1372 Triangulation<2>::active_cell_iterator it = triangulation.begin_active();
1373
1374 DoFHandler<2>::active_cell_iterator it2 (&triangulation, it->level(), it->index(), &dof_handler);
1375 ```
1376
1377 ## Questions about specific behavior of parts of deal.II
1378
1379 ### How do I create the mesh for my problem?
1380
1381 Before answering the immediate question, one remark: When you use adaptive
1382 mesh refinement, you definitely want the initial mesh to be as coarse as
1383 possible. The reason is that you can make it as fine as you want using
1384 adaptive refinement as long as you have memory and CPU time available.
1385 However, this requires that you don't waste mesh cells in parts of the
1386 domain where they don't pay off. As a consequence, you don't want to start
1387 with a mesh that is too fine to start with, because that takes up a good
1388 part of your cell budget already, and because you can't coarsen away cells
1389 that are in the initial mesh.
1390
1391 That said, there are essentially three ways to generate a mesh, all of
1392 which are discussed in significantly more detail in the step-49 tutorial
1393 program:
1394  - For many standard geometries (square, cube, circle, sphere, ...) there
1395    are functions in namespace `GridGenerator` that can generate coarse
1396    meshes.
1397  - If `GridGenerator` does not offer a mesh for the geometry you have, but
1398    if the geometry is simple, then you can often create one "by hand". Take
1399    a look, for example, at how we create the mesh in step-14 using the
1400    `Triangulation::create_triangulation` function. All you need to do is
1401    take a piece of paper, draw the geometry and a number of coarse cells
1402    that form quadrilaterals, identify the locations of vertices and the
1403    connectivity from cells to vertices, and pass the corresponding lists to
1404    the Triangulation. Something similar can be done for simple 3d
1405    geometries.
1406  - If your geometry is truly complicated enough so that you can't draw a
1407    mesh by hand any more (i.e. if it requires more than, for example, 20-30
1408    coarse mesh cells), then you'll need a mesh generator. For
1409    quadrilaterals and hexahedra, there aren't all that many mesh
1410    generators. [gmsh](http://www.gmsh.info),
1411    [lagrit](https://lagrit.lanl.gov/) and [cubit](http://cubit.sandia.gov/)
1412    come to mind. The primary problem is that most mesh generators' output
1413    meshes aren't particularly coarse by default, so you may want to pay
1414    particular attention to this point when running the mesh generator.
1415    (This is relevant since deal.II is particularly good about creating
1416    adaptively refined meshes, but if your coarse mesh is already very large
1417    then you will likely not have a lot of resources left to adaptively
1418    refine it some more.) Once you have a mesh from a mesh generator, you
1419    would read it using the `GridIn` class, as demonstrated, for example, in
1420    step-5.
1421  - As it was already mentioned, if you do need to work with a geometry for which all you have is a triangular or tetrahedral mesh, then you can convert this mesh into one that consists of quadrilaterals and hexahedra using the tethex program, see https://github.com/martemyev/tethex .
1422
1423 ### How do I describe complex boundaries?
1424
1425 You need to define classes derived from the `Boundary` base class and
1426 attach these to particular parts of the boundary of the triangulation. The
1427 `Triangulation` class will then query your boundary object whenever it
1428 needs a new point on the boundary after mesh refinement.
1429
1430 In deal.II releases after 8.1, the way geometry is described has been made
1431 much more flexible. In particular, it is no longer only possible to
1432 describe the boundary, but it is also possible to describe where points in
1433 the interior lie. The step-53 tutorial program explains how this is done
1434 for a realistic example.
1435
1436
1437 ### How do I get the degree of freedom indices at vertices?
1438
1439 For simple cases (for example, where only `FE_Q` elements are used) you could 
1440 use the `cell->vertex_dof_index()` function. This would mean that you'd require 
1441 a single grid traversal to extract each DoF value  associated with support 
1442 points corresponding to the vertices. The code to do this would look something 
1443 like this: 
1444 ```cpp
1445 auto cell = dof_handler.begin_active ();
1446 const auto endc = dof_handler.end ();
1447 for (; cell != endc; ++cell)
1448 {
1449   for (unsigned int vertex = 0; vertex < GeometryInfo<dim>::vertices_per_cell; 
1450        ++vertex)
1451   {
1452     for (unsigned int component=0; component<fe.n_components(); ++component)
1453       // Index associated with the given component at the cell local vertex
1454       const unsigned int idx = cell->vertex_dof_index(vertex,component);
1455   }
1456 }  
1457 ```
1458 If this is something that you might repeat often then you could use the `GridTools::find_cells_adjacent_to_vertex()` function to cache this association 
1459 once up front for a single vertex, or the `GridTools::vertex_to_cell_map()` function 
1460 to do the same for all vertices. 
1461
1462 For the most general case (e.g., when using non-primitive finite elements), you 
1463 might need to use `DoFTools::map_dofs_to_support_points()` function and then find
1464 which support points at located at the vertex position that you're interested in.
1465
1466 ### I am using discontinuous Lagrange elements (`FE_DGQ`) but they don't seem to have vertex degrees of freedom!?
1467
1468 Indeed. And here's the reason: a vertex is an entity that is shared between
1469 different cells, i.e. it doesn't belong to one cell or another. If you have
1470 a shape function that is associated with it, then its support will extend
1471 to all of the cells that are adjacent to the vertex since no cell is
1472 different than any other cell. This is what happens, for example, with the
1473 `FE_Q(1)` element. The same is true, by the way, for degrees of freedom
1474 (and associated shape functions) that correspond to edges and faces between
1475 cells.
1476
1477 But that doesn't answer the question of discontinuous elements. There, you
1478 have functions that are interpolation polynomials whose <i>support
1479 point</i> happens to be located at the same position as the vertex, but the
1480 actual support of the shape function is restricted to a single cell. In
1481 other words, '''logically''' these shape functions belong to a cell, not a
1482 vertex or edge or face, since the latter are all shared between adjacent
1483 cells. What this leads to is that, for example for the `FE_DGQ(1)` element,
1484 you have
1485  - `fe.dofs_per_vertex` is zero
1486  - `fe.dofs_per_line` is zero
1487  - `fe.dofs_per_face` is zero
1488  - `fe.dofs_per_cell` is 4 in 2d and 8 in 3d.
1489 In other words, all shape functions are associated with the cell interior.
1490
1491 If this answer isn't quite satisfactory (because, after all, the shape
1492 functions <i>are</i> defined by interpolation at the location of the
1493 vertices), one could turn the question around: If you ask me for the degree
1494 of freedom associated with vertex 13, then I should ask you in return
1495 <i>which one</i> you have in mind since if there, say, four cells that meet
1496 at this vertex, then there will be 4 degrees of freedom defined there.
1497 Likewise, if you ask me for the value of the degree of freedom associated
1498 with vertex 13, then I should ask you in return <i>which one</i> as the
1499 function is discontinuous there and will have multiple values at the
1500 location of the vertex.
1501
1502 ### How do I access values of discontinuous elements at vertices?
1503
1504 The previous question answered why DG elements aren't defined at the
1505 vertices of the mesh. Consequently, functions like `cell->vertex_dof_index`
1506 aren't going to provide anything useful. Nevertheless, there are occasions
1507 where one would like to recover values of a discontinuous field at the
1508 location of the vertices, for example to average the values one gets from
1509 all adjacent cells in recovery estimators.
1510
1511 So how does one do that? The answer is: Getting the values at the vertices
1512 of a cell works just like getting the values at any other point of a cell.
1513 You have to set up a quadrature formula that has quadrature points at the
1514 vertices and then use an FEValues object with it. If you then use
1515 FEValues::get_function_values, you will get the values at all quadrature
1516 points (i.e. vertices) at once.
1517
1518 Setting up this quadrature formula can be done in two different ways: (i)
1519 You can create an object of type `Quadrature` from a vector of points that
1520 you can initialize with the reference coordinates of the 2<sup>dim</sup>
1521 vertices of a cell; or (ii) you can use the `QTrapez` class that has its
1522 quadrature points in the vertices. In the latter case, however, you need to
1523 verify that the order of quadrature points is indeed the same order as the
1524 vertices of a cell and, if that is not the case, translate between the two
1525 numbering systems.
1526
1527 ### Does deal.II support anisotropic finite element shape functions?
1528
1529 There is currently no easy-to-use support for this. It's not going to work
1530 for continuous elements because we assume that `fe.dofs_per_face` is the
1531 same for all faces of a cell.
1532
1533 It may be possible to make this work for discontinuous elements, though.
1534 What you would have to do is define a bunch of different elements with
1535 anisotropic shape functions and select which element to use on which cells,
1536 using the `hp::DoFHandler` to deal with using different elements on
1537 different cells. The part that's missing is to implement elements with
1538 anisotropic shape functions. I imagine that this wouldn't be too
1539 complicated to do since the element is discontinuous, but someone would
1540 have to implement it.
1541
1542 That said, you can do anisotropic <i>refinement</i>, which of course also
1543 introduces a kind of anisotropic approximation of your finite element
1544 space.
1545
1546 ### The graphical output files don't make sense to me -- they seem to have too many degrees of freedom!
1547
1548 Let's assume you have a 2x2 mesh and a Q<sub>1</sub> element then you would
1549 assume that output files (e.g. in VTK format) just have 9 vertex locations
1550 and 9 values, one for each of the 9 nodes of the mesh. However, the file
1551 actually shows 16 vertices and 16 such values.
1552
1553 The reason is that frequently output quantities in deal.II are
1554 discontinuous: it may be that the finite element in use is discontinuous to
1555 begin with; or that the quantity we want to output is defined on a
1556 cell-by-cell basis (e.g. error indicators) and therefore discontinuous; or
1557 that it is a quantity computed from a DataPostprocessor object that could
1558 be discontinuous. In order to not make things more complicated than
1559 necessary, deal.II <i>always</i> assumes that quantities are discontinuous,
1560 even if some of them may in fact be continuous. The problem is that all
1561 graphical formats want to see one value for each output field per vertex.
1562 But discontinuous fields have more than one value at the location of a
1563 vertex of the mesh. The solution to the problem is then to simply output
1564 each vertex multiple times -- with different vertex numbers but at exactly
1565 the same location, once for each cell it is adjacent to. In other words, in
1566 2d, each cell has four unique vertices. The 2x2 mesh in the example
1567 therefore has 16 vertices (4 vertices for each of the 4 cells) and we
1568 output 16 values. Several of these vertices will have the same location and
1569 if the field is indeed continuous, several of the values will also be the
1570 same.
1571
1572 ### In my graphical output, the solution appears discontinuous at hanging nodes
1573
1574 Let me guess -- you are using higher order elements? If that's the
1575 case, then the solution only looks discontinuous but isn't
1576 really. What's happening is that the solution is, in fact, a higher
1577 order polynomial (e.g., a quadratic polynomial) along each edge of a
1578 cell but because all visualization file formats only support writing
1579 data as bilinear elements we need to write data in a way that shows
1580 only a linear interpolation of this higher order polynomial along each
1581 edge. This is no problem if the two neighboring elements share the
1582 entire edge because then the linear interpolations from both sides
1583 coincide. However, if we have a hanging node, then the value at the
1584 hanging node appears to float above or below the linear interpolation
1585 from the longer side, like here (in the left picture, see the gap at
1586 the bottom in the blue green area, and around the top left in the
1587 greenish area; pictures by Kevin Dugan):
1588
1589 <img width="400px" src="http://www.dealii.org/images/wiki/gap-in-q2-1.png" align="center" />
1590 <img width="400px" src="http://www.dealii.org/images/wiki/gap-in-q2-2.png" align="center" />
1591
1592 From this description you can already guess what the solution is: the
1593 solution is internally in fact continuous: even though we only show a
1594 linear interpolation on the long edge, the true solution actually goes
1595 through the "floating" node. All this is, consequently, just an
1596 artifact of the way visualization programs show data.
1597
1598 If this bothers you or it simply looks bad in your graphics, you can
1599 lessen the problem by not plotting just a linear interpolation on each
1600 cell but outputting the solution as a linear interpolation on a larger
1601 number of "patches" per cell (e.g., plotting 5x5 patches per
1602 cell). This can be done by using the `DataOut::build_patches` function
1603 with an argument larger than one -- see its documentation.
1604
1605 This all said, if you are in fact using a Q1 element and you see such
1606 gaps in the solution, then something is genuinely wrong. One
1607 possibility is that you forget to call `ConstraintMatrix::distribute`
1608 after solving the linear system, or you do not set up these
1609 constraints correctly. In either case, it's a bug if this happens with
1610 Q1 elements.
1611
1612 ### When I run the tutorial programs, I get slightly different results
1613
1614 This is sometimes unavoidable. deal.II uses a number of iterative
1615 algorithms (e.g. in solving linear systems, but the adaptive mesh
1616 refinement loop is also an iteration if you think about it) where certain
1617 criteria are specified by comparing floating point numbers. For example,
1618 the CG method terminates the iteration whenever the residual drops below a
1619 certain threshold; similarly, we refine as many cells as are necessary to
1620 take care of a fraction of the total error. In both cases, the quantities
1621 that are compared are floating point numbers which are subject to floating
1622 point round off. The problem is that floating point round off depends on
1623 the processor (sometimes), compiler flags or randomness (if parallelization
1624 is involved) and consequently an a solver may terminate one iteration
1625 earlier or later, depending on your environment, than the one from which we
1626 produced our results. With a different solution typically come different
1627 refinement indicators and different meshes downstream.
1628
1629 In other words, this is something that simply happens. What should worry
1630 you, however, is if you run the same program twice and you get slightly
1631 different output. This hints at non-deterministic effects that one should
1632 investigate.
1633
1634 ### How do I access the whole vector in a parallel MPI computation?
1635
1636 Note that this causes a bottleneck for large scale computations and you
1637 should try to use a parallel vector with ghost entries instead. If you
1638 really need to do this, create a TrilinosWrappers::Vector (or a
1639 PETScWrappers::Vector) and assign your parallel vector to it (or use a copy
1640 constructor). You can find this being done in step-17 if you search for
1641 "localized_solution".
1642
1643 ### How to get the (mapped) position of support points of my element?
1644
1645 Option 1: The support points on the unit cell can be accessed using
1646 FiniteElement::get_unit_support_point(s) and mapped to real coordinates
1647 using Mapping::transform_unit_to_real_cell()
1648
1649 Option 2: DoFTools::map_dofs_to_support_points() maps all the support
1650 points at once.
1651
1652 Option 3: You can create a FEValues object using the support points as a
1653 Quadrature:
1654 <pre>
1655 Quadrature<dim> q(fe.get_unit_support_points());
1656 FEValues<dim> fe_values (..., q, update_q_points);
1657 ...
1658 fe_values.get_quadrature_points();
1659 </pre>
1660
1661
1662 ## Debugging deal.II applications
1663
1664 ### I don't have a whole lot of experience programming large-scale software. Any recommendations?
1665
1666 Yes. First, the questions of this FAQ already give you a number of good
1667 pointers for example on debugging. Also, a good resource for some of the
1668 questions mathematicians, scientists and engineers (who may have taken a
1669 programming course, but know little of the bigger world of software
1670 engineering) typically have, is the [Software
1671 Carpentry](http://software-carpentry.org/) page. That site is specifically
1672 targeted at people who may want to use scientific computing to solve
1673 particular applications, but have little or no formal training in dealing
1674 with large software. In other words, it is specifically written for people
1675 for an audience like the users of deal.II.
1676
1677
1678 ### Are there strategies to avoid bugs in the first place?
1679
1680 Why yes, good you ask. There are indeed techniques that help you avoid
1681 writing code that has bugs. By and large, these techniques go by the name
1682 <i>defensive programming</i>, and the idea is to get yourself into a
1683 mindset while programming that anticipates that you will make mistakes,
1684 rather than expecting that your code is correct and then reacting to the
1685 situation when it turns out that this isn't true. The point is that even
1686 the most experienced programmers do introduce a lot of bugs into their
1687 code; what makes them good is that they have strategies to find them
1688 quickly and systematically.
1689
1690 Below we show one of the most important lessons learned. A more complete
1691 list can be found in [our code conventions
1692 page](http://dealii.org/developer/doxygen/deal.II/CodingConventions.html)
1693 which has a collection of best practices including code snippets to show
1694 how they are used.
1695
1696 The single most successful strategy to avoid bugs is to <i>make assumptions explicit</i>. For example, assume for a second that you have a class that denotes a point in 3d space:
1697 ```cpp
1698   class Point3d
1699   {
1700   public:
1701     double coordinate (const unsigned int i) const;
1702     // ...more here...
1703   private:
1704     double coordinates[3];
1705   };
1706
1707   double
1708   Point3d::coordinate (const unsigned int i) const
1709   {
1710     return coordinates[i];
1711   }
1712 ```
1713
1714 Here, when we wrote the `coordinate()` function, we worked under the
1715 assumption that the index `i` is between zero and two. As long as that
1716 assumption is satisfied, everything is fine. The problems start when
1717 someone calls this function with an index greater than two -- the function
1718 will in that case simply return garbage, but that may not be immediately
1719 obvious and may only much later lead to weird results in your program.
1720 Inexperienced programmers will say "Why would I do that, it doesn't make
1721 any sense!". Defensive programming starts from the premise that this is
1722 something that simply <i>will happen</i> at one point in time, whether you
1723 want to or not. It's actually not very difficult to do, since all of us
1724 have probably written code like this:
1725 ```cpp
1726   Point3d point;
1727   // ... do something with it
1728   double norm = 0;
1729   for (unsigned int i=0; i<=3; ++i)
1730     norm += point.coordinate(i) ** point.coordinate(i);
1731   norm = std::sqrt(norm);
1732 ```
1733
1734 Note that we have accidentally used `<=` instead of `<` in the loop.
1735
1736 If we accept that bugs will happen, we should make it as simple as possible
1737 to find them. In the spirit of making assumptions explicit, let's write
1738 above function like this:
1739 ```cpp
1740   double
1741   Point3d::coordinate (const unsigned int i) const
1742   {
1743     if (i >= 3)
1744       {
1745         std::cout << "Error: function called with invalid argument!" << std::endl;
1746         std::abort ();
1747       }
1748     return coordinates[i]
1749   }
1750 ```
1751
1752 This has the advantage that an error message is produced whenever the
1753 function is called with invalid arguments, and for good measure we also
1754 abort the program to make sure the error message can really not be missed
1755 in the rest of the output of the program. The disadvantage is that this
1756 check will always be performed whenever the program runs, even if it is
1757 well tested and we are fairly certain that in all places where the function
1758 is called, indices are valid. To avoid this drawback, the C programming
1759 language has the `assert` macro, which expands to the code above by
1760 default, but that can be disabled using a compiler flag. deal.II provides
1761 an improved version of this macro that is used as follows:
1762 ```cpp
1763   double
1764   Point3d::coordinate (const unsigned int i) const
1765   {
1766     Assert (i<3, ExcMessage ("Function called with invalid argument!"));
1767     return coordinates[i];
1768   }
1769 ```
1770
1771 The macro expands to nothing in optimized mode (see below), and if it is
1772 triggered in debug mode it doesn't only abort the program, but also prints
1773 an error message and shows how we got to this point in the program.
1774
1775 Using assertions in your program is the single most efficient way to make
1776 assumptions explicit and help find bugs in your program as early as
1777 possible. If you are looking for some more background, check out the
1778 wikipedia articles on
1779 [assertions](http://en.wikipedia.org/wiki/Assertion_(computing)),
1780 [preconditions](http://en.wikipedia.org/wiki/Precondition) and
1781 [postconditions](http://en.wikipedia.org/wiki/Postcondition), and generally
1782 the [design by contract
1783 methodology](http://en.wikipedia.org/wiki/Design_by_contract).
1784
1785 ### How can deal.II help me find bugs?
1786
1787 In addition to using the `Assert` macro introduced above, the deal.II
1788 libraries come in two flavors: debug mode and optimized mode. The
1789 difference is that the debug mode libraries contain a lot of assertions
1790 that verify the validity of parameters you may pass when calling library
1791 functions and classes; the optimized libraries don't contain these and are
1792 compiled with flags that instruct the compiler to optimize. This makes
1793 executables linked against the optimized libraries between 4 and 10 times
1794 faster. On the other hand, you will find that you will find 90% or more of
1795 your bugs by using the debug libraries because most bugs simply pass data
1796 to other functions that they don't expect or that don't make sense. The
1797 consequence is that you should always use debug mode when you are still
1798 developing your code. Only when it runs without bugs -- and under no
1799 circumstances any earlier -- should you switch to optimized mode to do
1800 production runs. One of the silliest things you can do is switch to
1801 optimized mode because you otherwise get an error you can't make sense of
1802 and that you don't know how to fix; certainly, if the library complains
1803 about something and you ignore it, nothing good can come out of the
1804 remainder of the run of your program.
1805
1806 You can switch between debug and optimized mode, at least for the example
1807 programs, by compiling the example with either `make debug` or `make
1808 release`. There are further
1809 [instructions](https://www.dealii.org/8.3.0/users/cmakelists.html#cmakesimple.build_type)
1810 in the documentation describing how to set this up in your own codes.
1811
1812 ### Should I use a debugger?
1813
1814 This question has an emphatic, unambiguous answer: Yes! You may get by for
1815 a while by just putting debug output into your program, compiling it, and
1816 running it, but ultimately finding bugs with a debugger is much faster,
1817 much more convenient, and more reliable because you don't have to recompile
1818 the program all the time and because you can inspect the values of
1819 variables and how they change. Learn how to use a debugger as soon as
1820 possible. It is time well invested.
1821
1822 Debuggers come in a variety of ways. On Linux and other Unix-like operating
1823 systems, they are almost all based in one way or other on the [GNU Debugger
1824 (GDB)](http://www.gnu.org/s/gdb/). GDB itself is a tool that is driven by
1825 interactively typing commands; if you know your way around with it, it is
1826 quite usable but it is rather austere and unless you are already familiar
1827 with this style of debugging, don't learn it. Rather, you should either use
1828 a graphical front-end or, even better, a front-end to GDB that is
1829 integrated into an Integrated Development Environment (IDE). An example of
1830 the stand-alone graphical front-ends to GDB are
1831 [DDD](http://www.gnu.org/software/ddd/), a program that was the first of
1832 its kind on Linux for many years but whose development has pretty much
1833 ceased in the early 2000s; it is still quite a good program, though.
1834 Another example is [KDbg](http://kdbg.org/), a GDB front-end for the KDE
1835 desktop environment.
1836
1837 As mentioned, a better choice is to use a debugger front-end that is
1838 integrated into the IDE. Every decent IDE has an integrated debugger, so
1839 you have your choice. A list of IDEs and how they work with deal.II is
1840 given in the C++ section of this FAQ.
1841
1842 ### deal.II aborts my program with an error message
1843
1844 You are likely seeing something like the following:
1845 ```
1846 --------------------------------------------------------
1847 An error occurred in line <1223> of file </.../dealii/include/deal.II/lac/vector.h> in function
1848     Number& dealii::Vector<Number>::operator()(dealii::Vector<Number>::size_type)
1849     [with Number = double; dealii::Vector<Number>::size_type = unsigned int]
1850 The violated condition was:
1851     i<vec_size
1852 The name and call sequence of the exception was:
1853     ExcIndexRangeType<size_type>(i,0,vec_size)
1854 Additional Information:
1855 Index 10 is not in the half-open range [0,10).
1856
1857 Stacktrace:
1858 -----------
1859 #0  ./deliberate-mistake: foo()
1860 #1  ./deliberate-mistake: main
1861 --------------------------------------------------------
1862
1863 ```
1864
1865 This error is generated by the following program:
1866 ```cpp
1867 #include <deal.II/lac/vector.h>
1868 using namespace dealii;
1869
1870 void foo ()
1871 {
1872   Vector<double> x(10);
1873   for (unsigned int i=0; i<=x.size(); ++i)
1874     x(i) = i;
1875 }
1876
1877
1878 int main ()
1879 {
1880   foo ();
1881 }
1882 ```
1883
1884 So what to do in a case like this? The first step is to carefully read what
1885 the error message actually says as it contains pretty much all the
1886 information you need. So let's take the error message apart:
1887
1888  - The first two lines tell you where the problem happened: in the current
1889    case, in line 1223 of file
1890    `/.../dealii/include/deal.II/lac/vector.h` in the function
1891    `Number& dealii::Vector<Number>::operator()(dealii::Vector<Number>::size_type)`.
1892    This is a function in the library, so you likely don't know what exactly it
1893    does and what to do with it, but there is more information to come.
1894
1895  - The second part is the condition that should have been true but wasn't,
1896    leading to the error: `i<vec_size`. The variables involved in this
1897    condition (`i,vec_size`) are local variables of the function, or member
1898    variables of the class, so again you may not be entirely familiar with
1899    them. But you can already gather some of the information: `i` likely is
1900    an index, which should have been less than the variable `vec_size`
1901    (which sounds a lot like the length of a vector); the assertion says
1902    that it <i>should</i> have been smaller, but that it wasn't actually.
1903
1904  - There is more information: The exception generated is of kind
1905    `ExcIndexRange<size_type>(i,0,vec_size)` and the additional information says
1906    `Index 10 is not in the half-open range [0,10)`. In other words, the variable
1907    `i` has value `10`, and `vec_size` is also ten. This should already give you
1908    a fairly good idea what is happening: the vector has size ten, and following
1909    C array convention, that means that only indices zero through nine are value,
1910    but ten is not.
1911
1912  - The final part of the error message -- the stack trace -- tells you how
1913    you got to this place: reading from the bottom, `main()` called `foo()`
1914    which called the function that generated the error.
1915
1916 Taken together, this information should allow you figure out in 80% of
1917 cases what was going on, and fix the problem. Here, it is that we used the
1918 condition `i<=x.size()` in the loop, rather than the correct condition
1919 `i<x.size()`. In the remaining 20% of cases, things might be more
1920 difficult. For example, `foo()` might be a large and difficult function,
1921 and you would need to know in which part of the function did we access an
1922 invalid index of the vector. Or `i` was an index computed from other
1923 variables and you'd need to find out why it got the invalid value. In these
1924 cases, you'll have to learn how to use a debugger such as gdb, and in
1925 particular how to move up and down in the call stack and to inspect local
1926 variables in your source code.
1927
1928 ### The program aborts saying that an exception was thrown, but I can't find out where
1929
1930 deal.II creates two kinds of exceptions (in deal.II language): ones where we
1931 simply abort the program because you are doing something that can't be right
1932 (such as accessing element 11 of a 10-element vector; this results in what has
1933 been discussed in the previous question) and ones that use the C++ construct
1934 `throw` to raise an exception. The latter construct is used for things that
1935 can't be statically checked in debug mode because they may depend on values
1936 read from input files or on a status that may simply change from one run of
1937 the program to the next; consequently, they <i>always</i> need to be verified,
1938 not only in debug mode, and there is sometimes a way to work around it in a
1939 program. The typical case is trying to write to a file that can't be opened
1940 (e.g. because the directory/file you specified in a parameter file doesn't
1941 exist or because the file system has run out of disk space).
1942
1943 Most of the time, the exceptions deal.II throws are annotated with the
1944 location and function where this exception was raised, and if you use a
1945 `main()` function such as the one used starting in step-6, this information
1946 will be printed. However, there are also cases where this kind of information
1947 is not available and then it is often difficult to establish where exactly the
1948 problem is coming from: all you know is that an exception was thrown, but not
1949 where or why.
1950
1951 To debug such problems, two approaches have proven useful:
1952
1953  - Run your program in a debugger (see the question about debuggers above,
1954    as well as these videos showing how to use the debugger in
1955    22c8e221823811aa1178b450171824af:
1956    http://www.math.tamu.edu/~bangerth/videos.676.8.html,
1957    http://www.math.tamu.edu/~bangerth/videos.676.25.html). You need to
1958    instruct the debugger to stop whenever an exception is thrown. If you
1959    work with gdb on the command line, then issue the command `catch throw`
1960    before starting the program and it will stop everytime the code executes
1961    a `throw` statement. Integrated development environments typically also
1962    have ways of switching this on. Note that not every exception that is
1963    thrown actually indicates an error -- sometimes, there are legitimate
1964    reasons to throw an exception and catch it in the calling function, so
1965    you may have to continue (resume) a number of times before finding the
1966    place where this happens.
1967
1968  - Debugging by subtraction: Starting at the end of your program, remove
1969    one function/code block after the other until your program runs through
1970    without aborting. For example, if your program looked like step-6, see
1971    if it runs through if you don't create graphical output in `run()`. If
1972    it does, then you know that the exception must have been thrown in the
1973    block of code you just removed. If the program continues to abort, then
1974    reduce the number of mesh refinement cycles to find out within which
1975    cycle the problem happens. If it happens in the very first cycle, then
1976    remove calling the linear solver. If the program now runs through, then
1977    the problem happened in the solver. If it still aborts, then it must
1978    have happened before the solver, for example in the assembly. Repeating
1979    this, you will be able to narrow down which statement caused the
1980    problem, and knowing where a problem happens is already more than half
1981    of what you need to know to fix it.
1982
1983
1984 ### I get an exception in `virtual dealii::Subscriptor::~Subscriptor()` that makes no sense to me!
1985
1986 The full text of the error message probably looks something like this (the
1987 stack trace at the bottom is of course different in your code):
1988 ```
1989 An error occurred in line <103> of file </.../deal.II/source/base/subscriptor.cc> in function
1990     virtual dealii::Subscriptor::~Subscriptor()
1991 The violated condition was:
1992     counter == 0
1993 The name and call sequence of the exception was:
1994     ExcInUse (counter, object_info->name(), infostring)
1995 Additional Information:
1996 Object of class N6dealii15SparsityPatternE is still used by 5 other objects.
1997   from Subscriber SparseMatrix
1998
1999 Stacktrace:
2000 -----------
2001 #0  /.../deal.II/lib/libdeal_II.g.so.7.0.0: dealii::Subscriptor::~Subscriptor()
2002 #1  /.../deal.II/lib/libdeal_II.g.so.7.0.0: dealii::SparsityPattern::~SparsityPattern()
2003 #2  /.../deal.II/lib/libdeal_II.g.so.7.0.0: dealii::BlockSparsityPatternBase<dealii::SparsityPattern>::reinit(unsigned int, unsigned int)
2004 #3  /.../deal.II/lib/libdeal_II.g.so.7.0.0: dealii::BlockSparsityPattern::reinit(unsigned int, unsigned int)
2005 #4  /.../deal.II/lib/libdeal_II.g.so.7.0.0: dealii::BlockSparsityPattern::copy_from(dealii::BlockCompressedSimpleSparsityPattern const&)
2006 #5  ./step-6: NavierStokesProjectionIB<2>::setup_system()
2007 #6  ./step-6: NavierStokesProjectionIB<2>::run(bool, unsigned int)
2008 #7  ./step-6: main
2009 ```
2010
2011 What is happening is this: deal.II derives a bunch of classes from the
2012 `Subscriptor` base class and then uses the `SmartPointer` class to point to
2013 such objects. `SmartPointer` is actually a fairly simple class: when given
2014 a pointer, it increases a counter in the `Subscriptor` base of the object
2015 pointed to by one, and when the pointer is reset to another object or goes
2016 out of scope, it decreases the counter again. (It can also records
2017 <i>who</i> points to this object.) If someone tries to delete the object
2018 pointed to, then the destructor `dealii::Subscriptor::~Subscriptor()` is
2019 run and checks that in fact the counter in this object is zero, i.e. that
2020 nobody is pointing to the object any more -- because if some pointer was
2021 still pointing to it, it would be a poor decision to delete the object as
2022 then the pointer would point to invalid memory. If the counter is nonzero,
2023 you get the error above: you are trying to delete an object that is still
2024 pointed to. In the case above, you try to delete a `SparsityPattern` object
2025 (that is, from the stack trace, a part of a block sparsity pattern) even
2026 though there is still a `SparseMatrix` pointing to it (we get this from the
2027 "Additional Information" field).
2028
2029 The solution in cases like these is to make sure that at the time you
2030 delete the object, no other objects still have pointers that point to it.
2031
2032 There is one rather frequent case that results in an error like the above
2033 and that is often difficult to understand: if an exception is thrown in
2034 some function and not caught, all local objects are destroyed in the
2035 opposite order of their declaration; if it isn't caught in the function
2036 that called the place where the exception was generated, its local
2037 variables are also destroyed, and so on. This automatic destruction of
2038 objects typically bypasses all the clean-up code you may have at the end of
2039 a function and can then lead to errors like the above. For example, take
2040 this code:
2041 ```cpp
2042 void f()
2043 {
2044   SparseMatrix s;
2045   SparsityPattern sp;
2046   // initialize sp somehow
2047   s.reinit (sp);
2048   Vector v;
2049   // build a linear system
2050
2051   solve_linear_system (s, v);
2052
2053   s.reinit ();
2054 }
2055 ```
2056
2057 If the code executes normally, at the bottom of the function, the local
2058 variables `s,sp,v` will be destroyed in reverse order. Since we have called
2059 `s.reinit()`, the object no longer stores a pointer to `sp` and so
2060 destruction of `sp` before `s` incurs no harm. But if the function
2061 `solve_linear_system` throws an exception, for example because the linear
2062 system is singular, the call to `s.reinit()` isn't executed any more, and
2063 you will get an error like the one shown at the top.
2064
2065 In cases like these, the challenge becomes finding where the exception was
2066 thrown. The easiest way is to run your program in a debugger and let the
2067 debugger tell you whenever an exception is generated. In `gdb`, you can do
2068 that by saying `catch throw` before running the program; essentially, the
2069 command puts a breakpoint on all places where exceptions are thrown.
2070 Remember, however, that not every place where an exception is thrown is a
2071 candidate for the problem above: it may also be an exception that is caught
2072 in the function above and that never propagates to a point where it
2073 produces trouble. Consequently, it may well happen that you have to
2074 continue several times after seeing an exception thrown until you finally
2075 find the place where the offending exception happens.
2076
2077 ### I get an error that the solver doesn't converge. But which solver?
2078
2079 Solvers are often deeply nested -- take a look for example at step-20 or
2080 step-22, where there is an outer solver for a Schur complement matrix, but
2081 both in the implementation of the Schur complement as well as in the
2082 implementation of the preconditioner we solve other linear problems which
2083 themselves may have to be preconditioned, etc. So if you get an exception
2084 that the solver didn't converge, which one is it?
2085
2086 The way to find out is to not wait till the exception propagates all the
2087 way to `main()` and display the error code there. Rather, you probably
2088 don't have a Plan B anyway if a solver fails, so you may want to abort the
2089 program if that happens. To do this, wrap the call to the solver in a
2090 try-catch block like this:
2091 ```cpp
2092   try
2093   {
2094     cg.solve (system_matrix, solution, system_rhs, preconditioner);
2095   }
2096   catch (...)
2097   {
2098     std::cerr << "*** Failure in Schur complement solver! ***" << std::endl;
2099     std::abort ();
2100   }
2101 ```
2102
2103 Of course, if this is in the Schur preconditioner, you may want to use a
2104 different error message. In any case, what this code does is catch the
2105 exceptions thrown by the solver here, or by the system matrix's `vmult`
2106 function (if not already caught there) or by the preconditioner (if not
2107 already caught there). If you had already caught exceptions in the `vmult`
2108 function and in the preconditioner, then you now know that any exception
2109 you get at this location must have been because the CG solver failed, not
2110 the preconditioner, etc. The upshot is that you need to wrap <i>every</i>
2111 call to a solver with such a try-catch block.
2112
2113 ### How do I know whether my finite element solution is correct? (Or: What is the "Method of Manufactured Solutions"?)
2114
2115 This is not always trivial, but there is an "industry-standard" way of
2116 verifying that your code works as intended, called the '''method of
2117 manufactured solutions'''. Before we describe the method, let us point this
2118 out: '''A code that has not been verified (i.e. for which correctness has
2119 not been established) is worthless. You do not want to have results in your
2120 thesis or a publication that may later turn out to be incorrect because
2121 your code does not converge to the correct solution!'''
2122
2123 The idea to verify a code is that you need a problem for which you know the
2124 exact solution. Unless you solve the very simplest possible partial
2125 differential equations, it is typically not possible to choose a right hand
2126 side and boundary values and then find the corresponding solution to the
2127 PDE analytically, on a piece of paper. But you can turn this around: Let's
2128 say your equation is <i>Lu=f</i>, then choose some function <i>u</i> and
2129 compute <i>f=Lu</i>. Note that the solution <i>u</i> does not necessarily
2130 have to be something that looks like a useful or physically reasonable
2131 solution to the equation, all that is necessary is that it is a function
2132 you know. Because <i>L</i> is a differential operator, computing <i>f</i>
2133 only involves computing the derivatives of the known function; this may
2134 yield lengthy expressions if you have nonlinearities or spatially variable
2135 coefficients in the equation, but should not be too complicated and can
2136 also be done using computer algebra programs such as Maple or Mathematica.
2137
2138 If you now put this particular right hand side <i>f</i> into your program
2139 (along with boundary values that correspond to the values of the function
2140 <i>u</i> you have chosen) you will get a numerical solution
2141 <i>u<sub>h</sub></i> that we would hope converges against the exact
2142 solution <i>u</i> at a particular rate, say <i>O(h<sup>2</sup>)</i> in the
2143 <i>L<sub>2</sub></i> norm. But since you know the exact solution (you have
2144 chosen it before), you can compute the error between numerical solution and
2145 exact solution, and verify not only that your code converges, but also that
2146 it shows the convergence rate you expect.
2147
2148 The method of manufactured solutions is shown in the step-7 tutorial
2149 program.
2150
2151 ### My program doesn't produce the expected output!
2152
2153 There are of course many possible causes for this, and you need to find out
2154 which of these causes might be the reason. Possible places to start are:
2155
2156  - Are matrix and right hand side assembled correctly? For most reasonably
2157    simple problems, you can compute the local contributions to these
2158    matrices by hand, and then compare those with the ones you compute on
2159    every cell of your program (remember that you can print the contents of
2160    the local matrix and right hand side to screen). A good strategy is also
2161    to reduce your problem to a 1x1 or 2x2 mesh and then print out the
2162    entire system matrix for comparison.
2163
2164  - Do you compute the matrix you need, or its transpose? The mathematical
2165    literature often multiplies the equation from the right with a test
2166    function but that is awkward because the matrix you get this way is the
2167    transpose from the one you need. The deal.II documentation goes to
2168    lengths in multiplying test functions from the left to avoid this sort
2169    of error; do the same in your derivations.
2170
2171  - Your constraints or boundary values may be wrong. While the
2172    ConstraintMatrix and functions like
2173    VectorTools::interpolate_boundary_values are well enough tested that
2174    they are unlikely candidates for problems, you may have computed
2175    constraints wrongly if you collect them by hand (for example if you deal
2176    with periodic boundary conditions or similar) or you may have specified
2177    the wrong boundary indicator for a Dirichlet boundary condition. Again,
2178    the solution is to reduce the problem to the simplest one you can find
2179    (e.g. on the 1x1 or 2x2 mesh talked about above) and to ask the
2180    ConstraintMatrix to print its contents so that you can compare it by
2181    hand with your expectations.
2182
2183  - Your discretization might be wrong. Some equations require you to use
2184    particular (combination of) finite elements; for example, for the Stokes
2185    equations and many other saddle point problems, you need to satisfy an
2186    LBB or Babuska-Brezzi condition. For other equations, you need to add
2187    stabilization terms to the bilinear form; for example, advection or
2188    transport dominated problems require stabilization terms such as
2189    artificial diffusion, streamlinear diffusion, or SUPG.
2190
2191  - The solver might be wrong. This can reasonably easily happen if you have
2192    a complex solver such as, for example, the one used in step-22. In such
2193    cases it has proven useful to simply replace the entire solver by the
2194    sparse direct UMFPACK solver (see step-29). UMFPACK is not the fastest
2195    solver around, but it never fails: if the linear system has a solution,
2196    UMFPACK will find it. If the output of your program is essentially the
2197    same as before, then the solver wasn't your problem.
2198
2199  - Your assumptions may be wrong. Double check that you had the correct
2200    right hand side to compute the numerical solution you compare against
2201    your analytical one. Also remember that the numerical solution is
2202    usually only an approximation of the true one.
2203
2204 In general, if your program is not computing the output you expect, here
2205 are a few strategies that have often worked in finding the problem:
2206  - Take a good look at the output you get. For example, a close look can
2207    already tell you if (i) the boundary conditions are correct, (ii) the
2208    solution is continuous at hanging nodes, (iii) the solution follows the
2209    characteristics of the right hand side. This may already help you narrow
2210    down which part of the program may be the culprit. A common mistake is
2211    also to have a solution that by some accident is too large by a certain
2212    factor; consequently, the error will not converge to zero but to some
2213    constant value. This, again, is easily visible from a graphical
2214    representation of the solution and/or the error. Plotting the error is
2215    discussed in the section below entitled "How to plot the error as a
2216    pointwise function".
2217  - If you have a time dependent problem, is the first time step right?
2218    There is no point in running the program for 1000 time steps and trying
2219    to find our why it is wrong, if already the first time step is wrong.
2220  - If you still can't find what's going on, make the program as small as
2221    possible. Copy it to another directory and start stripping off parts
2222    that you don't need. For example, if it is a time dependent program for
2223    which you have previously already found out that the first time step is
2224    wrong, then remove the time loop. If you have tried whether you have the
2225    same problem when the mesh is uniformly refined, then throw out all the
2226    code that deals with adaptive refinement, constraints and hanging nodes.
2227    In this process, every time you simplify the program, verify that the
2228    problem is still there. If the problem disappears, you know that it must
2229    have been in the last simplification step. If the problem remains, it
2230    must be in the code that is now one step smaller. Ultimately, the code
2231    should be small enough so that you can just go through it and find the
2232    error by inspection.
2233  - Learn to use a debugger. You will find that using a debugger is so much
2234    more convenient than trying to put screen output statements into your
2235    code, recompiling, and hoping that they reveal the problem. Modern
2236    integrated development environment as the ones discussed elsewhere in
2237    this FAQ have the debugger built-in, allowing you to use it seamlessly
2238    in your editing environment.
2239
2240 ### The solution converges initially, but the error doesn't go down below 10<sup>-8</sup>!
2241
2242 First: If the error converges to zero, then you are basically doing
2243 something right already. Congratulations!
2244
2245 As for why the error does not converge any further, there are two typical
2246 cases what could be the reason:
2247
2248  - While the discretization error should converge to zero, the error of
2249    your numerical solution is composed of both the discretization error and
2250    the error of your linear or nonlinear solver. If, for example, you solve
2251    the linear system to an accuracy of 10<sup>-5</sup>, then there will be
2252    a point where the discretization error will get smaller than that by
2253    using finer and finer meshes but the solver error will not become
2254    smaller any more. To continue observing the correct convergence order,
2255    you will also have to solve the linear system with more accuracy.
2256
2257  - If you compute the error through an external program, for example by
2258    writing out the solution to a file and reading it from another program
2259    that knows about the exact solution, then you need to make sure you
2260    write the solution with sufficient accuracy. The default setting of C++
2261    writes floating point numbers with approximately 8 digits, so if you
2262    want to make sure that your solution is correct to 10<sup>-10</sup>, for
2263    example, you'll have to write out the solution with more than 10 digits.
2264
2265
2266 ### My code converges with one version of deal.II but not with another
2267
2268 That is a tough case because the problem could literally be anywhere in the functions you call from deal.II.
2269 Rather than trying to start debugging blindly to find out what exactly is going on it's probably more productive to delineate the steps one could use to narrow down where the problem is.
2270
2271 In an ideal world, you would have already found out which commit in the history of deal.II caused the problem.
2272 Let's say you have checked out the two offending versions of deal.II into separate source directories `dealii-good` and `dealii-bad`, and that you compiled them both separately and installed them into directories `install-good` and `install-bad`. If you can't find out which commit caused the problem, the good and bad versions could also be the last two releases.
2273
2274 Let's also say that you have a directory `application` in which you have your own code.
2275 Now create two directories, `app-good`, `app-bad` parallel to `application`. Then do
2276 ```bash
2277   cd application
2278   for i in * ; do
2279     ln -s $i ../app-good/$i
2280     ln -s $i ../app-bad/$i
2281   done
2282 ```
2283 This way you have two directories in which you can configure, compile, and run the exact same version of your application (exact same because they both contain links to the exact same source files), just compiled against the good and bad versions of the library, respectively.
2284
2285 So you do
2286 ```bash
2287   cd app-good
2288   cmake . -DDEAL_II_DIR=.../install-good
2289   make
2290
2291   cd ../app-bad
2292   cmake . -DDEAL_II_DIR=.../install-bad
2293   make
2294 ```
2295 If you run in these two directories, e.g., in two separate xterm windows, you will get one working and one failing run. Now start modifying the source files in `application` to figure out where the first point in the program is where there are differences. For example, after assembly, you could do insert a statement of the form
2296 ```cpp
2297   std::cout << "Linear system: " << system_matrix.l1_norm() << ' ' << system_rhs.l2_norm() << std::endl;
2298 ```
2299 I would suspect (though that doesn't have to be true -- but just assume for the moment) that if you compile and run this modification in your two windows that you will get different results. At this point, you can remove everything that is executed after this point from your program -- likely a few hundred lines of code. Or, if you're too lazy, just put `abort()` after that statement because everything that comes after it clearly only shows symptoms but not the cause of the problem.
2300
2301 Now that you know that the problem exists at the end of assembly, make your way further forward in the program. For example, is the local matrix on the first cell on which you assemble the same between the two programs? If it is, the problem is on a later cell. If it isn't the same, try to think about what the cause may be. Is the mesh the same? You can test that by putting output into an earlier spot of the program; if that output is different between the two programs, you can again delete everything that happens after that point.
2302
2303 The whole exercise is designed to find the first place in the program where you can unambiguously say that something has changed. Non-convergence is just such a non-specific problem that it is not helpful in finding what exactly is going on. It also happens rather late in typical programs that there are too many possibilities for where the root cause may be.
2304
2305 ### My time dependent solver does not produce the correct answer!
2306
2307 For time dependent problems, there are a number of other things you can try
2308 over the discussion already given in the previous answer. In particular:
2309
2310  - If you have a time iteration and the solution at the final time (where
2311    you may evaluate the error) is wrong, then it was likely already wrong
2312    at the first time step. Try to run your program only for a single time
2313    step and make sure the solution there is correct. For example, it could
2314    be that you set the boundary values wrongly; this would be quite
2315    apparent if you looked at the first time step because the effect would
2316    be largest close to the boundary, but it may no longer be visible if you
2317    ran your program for a couple hundred time steps.
2318
2319  - Are your initial values correct? Output the initial values using DataOut
2320    just like you output the solution and inspect it for correctness.
2321
2322  - If you have a multi-stage time stepping scheme, are *all* the initial
2323    values correct?
2324
2325  - Finally, you can test your scheme by setting the time step to zero. In
2326    that case, the solution at time step zero should of course be equal to
2327    the solution at time step zero. If it isn't, you already know better
2328    where to look.
2329
2330 ### My Newton method for a nonlinear problem does not converge (or converges too slowly)!
2331
2332 Newton methods are tricky to get right. In particular, they sometimes
2333 converge (if slowly) even though the implementation has a bug because all
2334 that is required for convergence is that the search direction is a
2335 direction of descent; consequently, if for example you have the wrong
2336 matrix, you may compute something that is a direction of descent, but not
2337 the full Newton direction, and so converges but not at quadratic order.
2338
2339 Here are a few considerations for implementing Newton's method for
2340 nonlinear PDEs:
2341
2342  - Try it with a linear program by removing all the nonlinearities in your
2343    problem. Your Newton iteration must converge in a single step, i.e. the
2344    Newton residual must be zero at the beginning of the second iteration.
2345    If that's not the case, something is wrong in your implementation.
2346
2347  - Newton's iteration will converge with optimal order for the problem
2348    *R(u)=0*, where *R* may be thought of as a residual, if you
2349    <i>consistently</i> compute the Newton residual
2350    *(&phi;<sup>i</sup>, R(u<sup>k</sup>))* and the Newton (Jacobian) matrix
2351    *R'(u<sup>k</sup>)*. If you have
2352    a bug in either of the two, your method may converge, but typically at a
2353    (much) lower rate and with consequently many more iterations.
2354
2355    Consequently, one way to debug Newton's methods is to verify that the Newton
2356    matrix and Newton residual are matching in their code. However, if you
2357    have a matching bug in <i>both</i> of the matrix and right hand side
2358    assembly, then your Newton method will converge with correct order but
2359    against the wrong solution.
2360
2361  - If you have nonzero boundary values for your problem, set the correct
2362    boundary values for the initial guess and use zero boundary values for
2363    all following updates. This way, the updated
2364    *u<sup>k+1</sup> = u<sup>k</sup> + &delta; u<sup>k</sup>*
2365    already has the right boundary values for all following iterations, where
2366    *&delta; u<sup>k</sup>* is the Newton update.
2367
2368  - If your problem is strongly nonlinear, you may need to employ a line
2369    search where you compute
2370    *u<sup>k+1</sup> = u<sup>k</sup> + &alpha; &delta; u<sup>k</sup>*
2371    and successively try *&alpha;=1, &alpha;=1/2, &alpha;=1/4*, etc., until the
2372    residual computed for *u<sup>k+1</sup>* for this *&alpha;* is smaller than
2373    the residual for *u<sup>k</sup>*.
2374
2375  - A rule of thumb is that if your problem is strongly nonlinear, you may
2376    need 5 or 10 iterations with a step length *&alpha;* less than one, and
2377    all following steps use the full step length *&alpha;=1*.
2378
2379  - For most reasonably behaved problems, once your iteration reaches the
2380    point where it takes full steps, it usually converges in 5 or 10 more
2381    iterations to very high accuracy. If you need significantly more than 10
2382    iterations, something is likely wrong.
2383
2384 ### Printing deal.II data types in debuggers is barely readable!
2385
2386 Indeed. For example, plain gdb prints this for cell iterators:
2387 ```
2388 $2 = {<dealii::TriaIterator<dealii::DoFCellAccessor<dealii::DoFHandler<2, 3> > >> = {<dealii::TriaRawIterator<dealii::DoFCellAccessor<dealii::DoFHandler<2, 3> > >> = {<std::iterator<std::bidirectional_iterator_tag, dealii::DoFCellAccessor<dealii::DoFHandler<2, 3> >, long, dealii::DoFCellAccessor<dealii::DoFHandler<2, 3> >*, dealii::DoFCellAccessor<dealii::DoFHandler<2, 3> >&>> = {<No data fields>},
2389       accessor = {<dealii::DoFAccessor<2, dealii::DoFHandler<2, 3> >> = {<dealii::CellAccessor<2, 3>> = {<dealii::TriaAccessor<2, 2, 3>> = {<dealii::TriaAccessorBase<2, 2, 3>> = {
2390                 static space_dimension = <optimized out>, static dimension = <optimized out>,
2391                 static structure_dimension = <optimized out>, present_level = -9856,
2392                 present_index = 32767, tria = 0x4a1556}, <No data fields>}, <No data fields>},
2393           static dimension = 2, static space_dimension = 3, dof_handler = 0x7fffffffdac8},
2394         static dim = <optimized out>,
2395         static spacedim = <optimized out>}}, <No data fields>}, <No data fields>}
2396 ```
2397
2398 Fortunately, this can be simplified to this:
2399 ```cpp
2400 $3 = {
2401   triangulation = 0x4a1556,
2402   dof_handler = 0x7fffffffdac8,
2403   level = 2,
2404   index = 52
2405 }
2406 ```
2407
2408 All you need is (i) gdb version 7.1 or later, or a graphical frontend for
2409 it (e.g. [DDD](http://www.gnu.org/software/ddd/) or
2410 [kdevelop](http://www.kdevelop.org)), (ii) some code that goes into your
2411 $HOME/.gdbinit file. Instructions for setting up this file, which implements
2412 pretty printers for `Point`, `Tensor`, `Vector`, and the various iterator
2413 classes for triangulations and DoFHandlers, are posted
2414 [here](Debugging-with-GDB).
2415
2416 gdb can also pretty print many of the `std::XXX` classes, but not all linux
2417 distributions have it configured this way. To enable this, follow the
2418 instructions [from this
2419 website](http://sourceware.org/gdb/wiki/STLSupport). The little python
2420 snippet can be placed as a separate python block into `.gdbinit`.
2421
2422 ### My program is slow!
2423
2424 This is a problem that is true for a lot of us. The question is which part
2425 of your program is causing it. Before going into more detail, there are,
2426 however, some general observations:
2427
2428  - Running deal.II programs in debug mode will take, depending on the program,
2429    between 4 and 10 times as long as in optimized mode. If you are using the
2430    standard setup for your own `CMakeLists.txt` file (described in the
2431    [documentation](https://www.dealii.org/8.3.0/users/cmakelists.html)), then
2432    compiling your code with `make release` will both compile your code at a
2433    higher optimization level and link it against the optimized version of
2434    deal.II.
2435
2436  - A typical finite element program will spend around one third of its time
2437    in assembling linear systems, around one half in solving these linear
2438    systems, and the rest of the time on other things. If your program's
2439    percentages significant deviate from this rule of thumb, you know where
2440    to start.
2441
2442  - There is a rule that says that even the best programmers are unable to
2443    point out where in the program the most CPU time is spent without some
2444    form of profiling. This is definitely true also for the primary
2445    developers of deal.II, so it is likely true for you as well. A corollary
2446    to this rule is that if you start optimizing parts of your code without
2447    first profiling it, you are more than likely just going to make things
2448    more complicated without significant gains because you pick the simplest
2449    places to optimize, not the ones with the biggest impact.
2450
2451 So how can you find out which parts of the program are slow? There are two
2452 tools that we've really come to like, both from the
2453 [valgrind](http://www.valgrind.org/) project: callgrind and cachegrind.
2454 Valgrind essentially emulates what your CPU would do with your program and
2455 in the process collects all sorts of information. In particular, if you run
2456 your program as in
2457 ```
2458   valgrind --tool=callgrind ./myprogram
2459 ```
2460
2461 (this will take around 10 times longer than when you just call
2462 `./myprogram` because of the emulation) then the result will be a file in
2463 this directory that contains information about where your program spent its
2464 time. There are a number of graphical frontends that can visualize this
2465 data; my favorite is `kcachegrind` (a misnomer -- it is, despite its name,
2466 actually a frontend from callgrind, not cachegrind). Pictures of how this
2467 output looks can be found in the introduction of step-22. It typically
2468 shows how much time was spent in each function and a call graph of which
2469 functions where called from where.
2470
2471 Using valgrind's cachegrind can give you a more detailed look at much of
2472 the same kind of information. In particular, it can show you source line
2473 for source line how many instructions were executed there, and how many
2474 memory accesses (as well as cache hits and misses) were generated there.
2475 See the valgrind manual for more information.
2476
2477 Lastly, since you are probably most interested in the performance of the
2478 optimized version of your code (which you will probably use for long
2479 expensive runs), you should run valgrind on the optimized executable.
2480
2481 ### How do I debug MPI programs?
2482
2483 This is clearly an awkward topic for which there are few good options:
2484 debugging parallel programs using MPI has always been a pain and it is
2485 frustrating even to experienced programmers. That said, there are parallel
2486 debuggers that can deal with MPI, for example
2487 [TotalView](http://www.roguewave.com/products/totalview-family/totalview.aspx)
2488 that can make this process at least somewhat simpler.
2489
2490 Whether you have or don't have TotalView, here are a few guidelines of
2491 strategies that have helped us in the past:
2492
2493  - Try to reduce the problem to the smallest one you can find: The smallest
2494    mesh, the smallest number of processors. Reducing the number of
2495    processors needed to demonstrate the bug must be your highest priority.
2496
2497  - One of the biggest problems you typically have is that the processes
2498    that communicate via MPI typically run on different machines. If you can
2499    manage to reduce the problem to a small enough number of processors, you
2500    can run them all locally on a single workstation, rather than a cluster
2501    of computers. Ideally, you would reduce the problem to 2 or 4 processors
2502    and then just start the program using `mpirun -np 4 ./myexecutable` on
2503    the headnode of the cluster, a workstation, or even a laptop.
2504
2505  - Try to figure out which MPI process (the MPI rank) has the problem, for
2506    example by printing the output of
2507    `Utilities::System::get_this_mpi_process(MPI_COMM_WORLD)` at various
2508    points in your program.
2509
2510  - If you know which MPI process has the problem and if this is
2511    reproducible, let each process print out its MPI rank and its process id
2512    (PID) using the system function `getpid` at the very beginning of the
2513    program. The PID is going to be different every time you run the
2514    program, but if you know the connection between MPI rank and PID and you
2515    know which rank will produce the problem, then you can predict which PID
2516    will have the problem. The point of this is that you can attach a
2517    debugger to this PID; for example, `gdb` has the command `attach <pid>`
2518    with which you can attach the debugger to a running program, rather than
2519    running the program from the start within the debugger. Attaching a
2520    program to the debugger will stop it (and, after a while, will typically
2521    also stop all the other MPI processes once they come to a place where
2522    they are waiting for a communication from the stopped process). You can
2523    then look at variables, continue running to breakpoints, or do whatever
2524    else you want to do with the process you attached the debugger to. In
2525    particular, if for example you attached the debugger to the process that
2526    you know will segfault or run onto a failing assertion, you can just
2527    type `continue` in the debugger to let the program continue till it
2528    aborts. You can then inspect the state of the program at the point of
2529    the problem inside the debugger you attached.
2530
2531  - The above process relies on the fact that you have time to attach a
2532    debugger between starting the program, reading the mapping from MPI
2533    process rank to PID, and attaching a debugger. If the program produces
2534    the error very quickly, it is often useful to insert a call to
2535    `sleep(60);` (and including the appropriate header file) just after
2536    outputting MPI rank and PID. This gives you 60 seconds to attach the
2537    debugger before the program will continue.
2538
2539  - If finding out which MPI process has the problem turns out to be too
2540    complicated, or if it isn't predictable which process will produce an
2541    error, then there is a fallback option: attach a debugger to
2542    <i>every</i> MPI process. This is awkward to do by hand, but there is a
2543    shortcut: under linux (or any other unix system) you can run
2544    the program as in
2545 ```
2546   mpirun -np 4 xterm -e gdb --args ./my_executable
2547 ```
2548 The equivalent for macOS is
2549 ```
2550   mpirun -np 4 xterm -e lldb -f ./my_executable
2551 ```
2552
2553 In this example, we start 4 MPI processes; in each of these 4 processes, we
2554 open an `xterm` window in which we start an instance of `gdb`/`lldb` with the
2555 executable. You'd then `run` the executable in each of the 4 windows, and
2556 debug it as you usually would. This might be tedious but as mentioned
2557 above, debugging MPI programs often is tedious indeed. To find out which
2558 gdb window belongs to which MPI rank, you can type the command
2559 ```
2560   !env | grep RANK
2561 ```
2562 into the gdb window (this works with OpenMPI at least). See https://plus.google.com/+TimoHeister/posts/AgmoMT8W7GZ for more info.
2563
2564 ### I have an MPI program that hangs
2565
2566 Apart from programs that segfault or that run onto a failing assertion
2567 (both cases that are relatively easy to debug using the techniques above),
2568 programs that just hang are the most common problem in parallel
2569 programming. The typical cause for this is that there is a point in your
2570 program where all or some MPI processes expect to get a message from a
2571 process X (e.g. in a global communication, say MPI_Reduce, MPI_Barrier, or
2572 directly in point-to-point communications) but process X is not where it
2573 should be -- for example, because it is in an endless loop, or -- more
2574 likely -- because process X didn't think that it should participate in this
2575 communication. In either case, the other processes will wait forever for
2576 process X's message and deadlock the program. An example for this case
2577 would go like this:
2578 ```cpp
2579   void assemble_system ()
2580   {
2581     // optimization in case there is nothing to do; we won't
2582     // have to initialize FEValues and other local objects in
2583     // that case
2584     if (tria.n_locally_owned_active_cells() == 0)
2585       return;
2586
2587     ...
2588     for (cell = ...)
2589       if (!cell->is_ghost() && !cell->is_artificial())
2590         ...do the assembly on the locally owned cells...
2591
2592     system_rhs.compress();
2593   }
2594 ```
2595
2596 Here, the call to `compress()` at the end involves communication between
2597 MPI processes. In particular, say, it implies that process Y will wait for
2598 some data from process X. Now what happens if process X realizes that it
2599 doesn't have any locally owned cells? In that case, process X will quit the
2600 function at the very top, and will never call `compress()`. In other words,
2601 process Y will wait forever, possibly making process Z wait further down
2602 the program etc. In the end, the program will be deadlocked.
2603
2604 The goal of debugging the program must be to find where individual
2605 processes are stopped in order to determine which incoming communication
2606 they are waiting for. If you attached a debugger to the program above,
2607 you'd find for example that all but one process is stopped in the call to
2608 `compress()`, and the one remaining process is stopped in some other MPI
2609 call, then you already have a good idea what may be going on.
2610
2611 ### One statement/block/function in my MPI program takes a long time
2612
2613 Let's say you have a block of code that you suspect takes a long time and
2614 you want to time it like this:
2615 ```cpp
2616   Timer t;
2617   t.start();
2618   my_function();
2619   t.stop();
2620   if (my MPI rank == 0)
2621     std::cout << "Calling my_function() took " << timer() << " seconds." << std::endl;
2622 ```
2623
2624 The output is large, i.e. you think that the function you called is taking
2625 a long time to execute and that you should focus your efforts on optimizing
2626 it. But in an MPI program, this isn't quite always true. Imagine, for
2627 example, that the function looked like this:
2628 ```cpp
2629   void my_function ()
2630   {
2631     double val = compute_something_locally();
2632     double global_sum = 0;
2633     MPI_Reduce (&val, &global_sum, MPI_DOUBLE, 1, 0, MPI_COMM_WORLD);
2634     if (my MPI rank == 0)
2635       std::cout << "Global sum = " << global_sum << std::endl;
2636   }
2637 ```
2638
2639 In the call to `MPI_Reduce`, all processors have to send something to
2640 processor zero. Processor zero will have to wait till everyone sends stuff
2641 to this processor. But what if processor X is still busy doing something
2642 else (stuff above the call to `my_function`) for a while? The processor
2643 zero will wait for quite a while, not because the operations in
2644 `my_function` are particularly expensive (either on processor zero or
2645 processor X) but because processor X was still busy doing something else.
2646 In other words: you need to direct your efforts in making the "something
2647 else on processor X" faster, not making `my_function` faster.
2648
2649 To find out whether this is really the problem, here is a simple way to see
2650 what the "real" cost of `my_function` is:
2651 ```cpp
2652   Timer t;
2653   MPI_Barrier (MPI_COMM_WORLD);
2654   t.start();
2655   my_function();
2656   MPI_Barrier (MPI_COMM_WORLD);
2657   t.stop();
2658   if (my MPI rank == 0)
2659     std::cout << "Calling my_function() took " << timer() << " seconds." << std::endl;
2660 ```
2661
2662 This way, you really only measure the time spent between when all
2663 processors have finished doing what they were doing before, and when they
2664 are all finished doing what they needed to do for `my_function`.
2665
2666 Another way to find some answers is to use the capabilities of the `Timer`
2667 class which can provide more detailed information when deal.II is
2668 configured to support MPI.
2669
2670 ## I have a special kind of equation!
2671
2672 ### Where do I start?
2673
2674 The deal.II tutorial has a number of programs that deal with particular
2675 kinds of equations, such as vector-valued problems, mixed discretizations,
2676 nonlinear and time-dependent problems, etc. The best way to start is to
2677 take a look at the existing tutorial programs and see if there is one that
2678 is already close to what you want to do. Then take that, try to understand
2679 its structure, and find a way to modify it to solve your problem as well.
2680 Most applications written based on deal.II are not written entirely from
2681 scratch, but have started out as modified tutorial programs.
2682
2683 ### Can I solve my particular problem?
2684
2685 The simple answer is: if it can be written as a PDE, then this is possible
2686 as evidenced by the many publications in widely disparate fields obtained
2687 with the help of deal.II. The more complicated answer is: deal.II is not a
2688 problem-solving environment, it is a toolbox that supports you in solving a
2689 PDE by the method of finite elements. You will have to implement assembling
2690 matrices and right hand side vectors yourself, as well as nonlinear outer
2691 iterations, etc. However, you will not need to care about programming a
2692 triangulation class that can handle locally refined grids in one, two, and
2693 three dimensions, linear algebra classes, linear solvers, different finite
2694 element classes, etc.
2695
2696 To give only a very brief overview of what is possible, here is a list of
2697 the nontrivial problems that were treated by the programs that the main
2698 authors alone wrote to date:
2699
2700  - Time-dependent acoustic and elastic wave equation, including nonlocal
2701    absorbing boundary conditions;
2702  - Stokes flow discretized with the discontinuous Galerkin finite element
2703    method;
2704  - General hyperbolic problems including Euler flow, using the
2705    discontinuous Galerkin finite element method;
2706  - Distributed parameter estimation problems;
2707  - Mixed finite element discretization of a mortar multiblock formulation
2708    of the Laplace equation;
2709  - Large-deformation elasto-plasticity in the simulation of plate
2710    tectonics.
2711
2712 To illustrate the complexity of the programs mentioned above we note that
2713 most of them include adaptive mesh refinement tailored to the efficient
2714 computation of specific quantities of physical interest and error
2715 estimation measured in terms of these quantities. This includes the
2716 solution of a so-called dual problems, that means e.g. for the wave
2717 equation the solution of a wave equation solved backward in time.
2718
2719 Problems other users of deal.II have solved include:
2720  - Elastoplasticity;
2721  - Porous media flow;
2722  - Crystal growth simulations;
2723  - Fuel cell simulations and optimization;
2724  - Fluid-structure interaction problems;
2725  - Time dependent large deformation problems for metal forming;
2726  - Contact problems;
2727  - Viscoelastic deformation of continental plates;
2728  - Glacial ice flows;
2729  - Thermoelastoplastic metal forming;
2730  - Eulerian coordinates problems in biomechanical modeling.
2731
2732 Some images from these applications can be found on this wiki's [[Gallery]]
2733 page. A good overview of the sort of problems that are being solved with the
2734 help of deal.II can also be obtained by looking at the large number of
2735 [publications](http://www.dealii.org/publications.html) written with the help of
2736 deal.II.
2737
2738 Probably, many other problem types are solved by the many users which we do
2739 not know of directly. If someone would like to have his project added to
2740 this page, just contact us.
2741
2742
2743 ### Why use deal.II instead of writing my application from scratch?
2744
2745 You can usually get the initial version of a code for any given problem
2746 done relatively quickly when you write it yourself, since the learning
2747 curve is not as steep as if you had to learn a new library; it's also true
2748 that it's easy to make this code twice as fast as if you had to use a
2749 library. In other words, this sounds like you should write finite element
2750 codes for your problem yourself.
2751
2752 However, you also need to keep in mind that it is the things you want to do
2753 after the first 3 months that will take you forever if you want to write it
2754 yourself, and where you will never be able to catch up with existing,
2755 established libraries: higher order elements; complicated, unstructured 3d
2756 meshes; parallelization; producing output in a format that's easily
2757 visualizable in 3d; adding an advected field for a tracer quantity; etc.
2758 Viewed this way, it's worth remembering that the primary commodity that's
2759 in short supply is not CPU time but your own programming time, and that's
2760 where you will be '''orders magnitude faster''' when using what others have
2761 already done, even if maybe your program ends up twice as slow as if you
2762 had written it from scratch with a particular application in mind.
2763
2764 ### Can I solve problems over complex numbers?
2765
2766 Yes, you can, and it has been done numerous times with deal.II. However, we
2767 have a standard recommendation: consider such problems as systems of
2768 partial differential equations, where the individual components of the
2769 solution are the real and imaginary part of your unknown. The reason for
2770 this is that for complex-valued problems, the product `<u,v>` of two vectors
2771 is not the same as `<v,u>`, and it is very easy to get this wrong in many
2772 places. If you want to avoid these common traps, then the easiest way
2773 around is to split up you equation into two equations of real and imaginary
2774 part first, and then treat the resulting system as a system of real
2775 variables. This also makes the type of linear system clearer that you get
2776 after discretization, and tells you something about which solver may be
2777 adequate for it.
2778
2779 The step-29 tutorial program shows how this is done for a complex-valued
2780 Helmholtz problem.
2781
2782 ### How can I solve a problem with a system of PDEs instead of a single equation?
2783
2784 The easiest way to do this is setting up a system finite element after you
2785 chose your base element, e.g.,
2786 ```cpp
2787 FE_Q<dim> base_element(2);
2788 FESystem<dim> system_element(base_element, 3);
2789 ```
2790
2791 will produce a biquadratic element for a system of 3 equations. With this
2792 finite element, all the functions that you always called for a scalar
2793 finite element should just work for this vector-valued element as well.
2794
2795 Refer to the step-8 and in particular to the step-20 tutorial programs for
2796 a lot more information on this topic. Several of the other tutorial
2797 programs beyond step-20 also use vector-valued elements and there is a
2798 whole module in the documentation on vector-valued problems that is worth
2799 reading.
2800
2801 ### Is it possible to use different models/equations on different parts of the domain?
2802
2803 Yes. The step-46 tutorial program shows how to do this: It solves a problem
2804 in which we solve Stokes flow in one part of the domain, and elasticity in
2805 the rest of the domain, and couple them on the interface. Similar
2806 techniques can be used if you want to exclude part of the domain from
2807 consideration, for example when considering voids in a body in which the
2808 governing equations do not make sense because there is no medium.
2809
2810 ### Where do I start to implement a new Finite Element Class?
2811
2812 If you really need an element that isn't already implemented in deal.II,
2813 then you'll have to understand the interplay between FEValues, the finite
2814 element, the mapping, and quadrature objects. A good place to start would
2815 be to read the deal.II paper (Bangerth, Hartmann, Kanschat, ACM Trans.
2816 Math. Softw., 2007).
2817
2818 The actual implementation would most conveniently start from the `FE_Poly`
2819 class. You first implement the necessary polynomial space in the base
2820 library, then you derive `FE_Your_FE_Name` from `FE_Poly` (using your new
2821 polynomial class as a template) and add the connectivity information.
2822
2823 You'll probably need more specific help at various points -- this is what
2824 the mailing list is there for!
2825
2826 ## General finite element questions
2827
2828 ### How do I compute the error
2829
2830 If your goal is to compute the error in the form `||`u-u<sub>h</sub>`||` in some
2831 kind of norm, then you should use the function
2832 [VectorTools::integrate_difference](https://www.dealii.org/8.3.0/doxygen/deal.II/namespaceVectorTools.html#a01174a2a7e2ee8fa6abdfdd93ac7a317)
2833 which can compute the norm above in any number of norms (such as the L2, H1,
2834 etc., norms). Take a look at step-7.
2835
2836 On the other hand, if your goal is to *estimate* the error, then the one class
2837 that can do this is
2838 [Kelly Error Estimator](https://www.dealii.org/8.3.0/doxygen/deal.II/classKellyErrorEstimator.html).
2839 This class is used in most of the tutorial programs that use adaptively refined
2840 meshes, starting with step-6.
2841
2842 ### How to plot the error as a pointwise function
2843
2844 The functions mentioned in the previous question compute the error as a
2845 cellwise value. As a consequence, the values computed also include a factor
2846 that results from the size of the cell. If you're interested in the pointwise
2847 error as something that can be visualized, for example because you want to
2848 find a pattern in why the solution is not as you expect it to be, what you
2849 should do is this:
2850  - Interpolate the exact solution
2851  - Subtract the interpolated exact solution from the computed solution
2852  - Put the resulting vector into a
2853    [DataOut object](https://www.dealii.org/8.3.0/doxygen/deal.II/classDataOut.html).
2854    This will plot the nodal values of the errors u-u<sub>h</sub> on the current
2855    mesh.
2856
2857 As an example, the following code shows how to do this in principle:
2858 ```cpp
2859   template <int dim>
2860   class ExactSolution : public Function<dim>
2861   {
2862   public:
2863     ExactSolution () : Function<dim>(dim+1) {}
2864
2865     virtual double value (const Point<dim>   &p,
2866                           const unsigned int  component) const
2867     {
2868       return ...exact solution as a function of p...
2869     }
2870   };
2871
2872
2873   template <int dim>
2874   void MyProblem<dim>::plot_error () const
2875   {
2876     Vector<double> interpolated_exact_solution (dof_handler.n_dofs());
2877     VectorTools::interpolate (dof_handler,
2878                               ExactSolution<dim>(),
2879                               interpolated_exact_solution);
2880     interpolated_exact_solution -= solution;
2881
2882     DataOut<dim> data_out;
2883
2884     data_out.attach_dof_handler (dof_handler);
2885     data_out.add_data_vector (solution, "solution");
2886     data_out.add_data_vector (interpolated_exact_solution, "pointwise_error");
2887   }
2888 ```
2889
2890
2891 ### I'm trying to plot the right hand side vector but it doesn't seem to make sense!
2892
2893 In particular, what you probably see is that the plot shows values that are
2894 smaller by a factor of two along the boundary than in the inside, and by a
2895 factor of four in the corners (in 2d) or eight (in 3d). Similarly, on
2896 adaptively refined cells, the values appear to scale with the cell size.
2897 The reason is that trying to plot a right hand side vector doesn't make
2898 sense.
2899
2900 While you plot the vector as if it is function (by connecting dots with
2901 straight lines in 1d, or plotting surfaces in 2d), the thing you right hand
2902 side vector is in fact an element of the dual space. To wit:
2903  - A vector in primal space is a vector of nodal values so that `sum_i  U_i
2904    phi_i(x)` is a reasonable function of `x`. Solution vectors are examples
2905    of elements of primal space.
2906  - A vector in dual space is a vector W formed from the integration of an
2907    object in primal space against the shape functions, e.g. `W_i  = int
2908    f(x) phi_i(x)`. Examples of dual vectors are right hand side vectors.
2909
2910 For vectors in dual space, it doesn't make sense to plot them as functions
2911 of the form
2912      `sum_i W_i phi_i(x)`.
2913 The reason is that the values of the coefficients W_i are not of
2914 **amplitude** kind. Rather, the W_i are of kind amplitude (e.g. f(x)) times
2915 integration volume (the integral `*` dx over the support of shape functions
2916 phi_i). In other words, the sizes of cells comes into play for W_i, as does
2917 whether a shape function lies in the interior or at the boundary. In your
2918 case, the area of the integral when you integrate against shape functions
2919 at the boundary happens to be half the size of the integration area for
2920 shape functions in the interior.
2921
2922
2923 ### What does XXX mean?
2924
2925 The documentation of deal.II uses many finite element specific terms that
2926 may not always be entirely clear to someone not familiar with this
2927 language. In addition, we have certainly also invented our shares of
2928 deal.II specific terminology. If you encounter something you are not
2929 familiar with, take a look at the [deal.II glossary
2930 page](http://www.dealii.org/developer/doxygen/deal.II/DEALGlossary.html)
2931 that explains many of them.
2932
2933 ## I want to contribute to the development of deal.II!
2934
2935 deal.II is Open Source -- this not only implies that you as everyone else has
2936 access to the source codes, it also implies a certain development model:
2937 whoever would like to contribute to the further development is invited to do
2938 so: If you have changes or ideas, please send them to the
2939 [deal.II mailing list](http://www.dealii.org/mail.html)!
2940
2941 This model follows a small number of simple rules. The first and basic one
2942 is that if you have something that might be of interest to others as well,
2943 you are invited to send it to the list for possible inclusion into the
2944 library and use by others as well. Such additions useful to others are, for
2945 example:
2946  - new backends for output in a new graphical format;
2947  - input filters for some kind of data;
2948  - tool classes that do something that might be interesting to use in other
2949    programs as well.
2950
2951 A few projects (some easy, some difficult) can also be found in the
2952 [list of open issues](https://github.com/dealii/dealii/issues), where they
2953 are generally marked as "Enhancements".
2954
2955 If you consider providing some code for inclusion with the library, these
2956 are the simple rules of gaining reputation in the Open Source community:
2957  - your reputation grows with the number and complexity of your
2958    contributions;
2959  - your reputation with the maintainers of the library also grows with the
2960    degree of conformance of your proposed additions with the administrative
2961    rules stated below;
2962  - originators of code are credited full authorship.
2963
2964 In order to allow that a library remains a consistent piece of software,
2965 there are a number of administrative rules:
2966  - there are a number of maintainers that decide what goes into the
2967    library;
2968  - maintainers are benevolent, i.e. in general they want your addition to
2969    become part of the library;
2970  - however, they have to evaluate additions with respect to some criteria,
2971    among which are value for others;
2972  - whether it fits into the general framework (meaning that if your
2973    contribution requires the installation of some obscure other library
2974    that people do not usually have, then that must be discussed;
2975    alternatively, a way must be provided to disable your contribution on
2976    machines that do not have this lib);
2977  - completeness and amount of documentation;
2978  - existence and completeness of error checking through assertions.
2979
2980 However, again: the basic rule is that if you think your addition is
2981 interesting to others, there most probably is a way to get it into the
2982 library!
2983
2984
2985 ## I found a typo or a bug and fixed it on my machine. How do I get it included in deal.II?
2986
2987 First: thank you for wanting to do this! This software project is kept alive
2988 by people like you contributing to it. We like to include any improvement,
2989 even if it is just a single typo that you fixed.
2990
2991 If you have only a small change, or if this is your first time submitting
2992 changes, the easiest way to get them to us is by just emailing the
2993 [deal.II mailing lists](http://dealii.org/mail.html) and we will make sure they
2994 get incorporated. If you continue submitting patches (which we hope you will!)
2995 and become more experienced, we will start to ask you to use
2996 [git](http://en.wikipedia.org/wiki/Git_%28software%29) as the version control
2997 system and base your patches off of the
2998 [deal.II github repository](https://github.com/dealii/dealii).
2999
3000 The process for this is essentially the following (if you don't quite
3001 understand the terminology below, take a look at the manuals at the
3002 [github web site](https://github.com/), read
3003 [this online tutorial](https://www.atlassian.com/git/tutorial), or ask on the
3004 mailing list):
3005   - Create a github account
3006   - Fork the deal.II github repository, using the button at the top right
3007     of https://github.com/dealii/dealii
3008   - Clone the repository onto your local file system
3009   - Create a branch for your changes
3010   - Make your changes
3011   - Push your changes to your github repository
3012   - Create a pull request for your changes by going to your github
3013     account's deal.II tab where, after the previous step, there should be a
3014     button that allows you to create a pull request.
3015
3016 This list may sound intimidating at first, but in reality it's a fairly
3017 straightforward process that takes no more than 2 minutes after the first
3018 couple of times. But, as said, we'll be happy to hold your hand the first few
3019 times around and help you with the process! There's also a video lecture that
3020 demonstrates
3021 [how to submit a patch to github](http://www.math.colostate.edu/~bangerth/videos.676.32.8.html).
3022
3023 If you've submitted patches several times and know your way around git by now,
3024 please also consider to
3025   - make sure you base your patch off the most recent revision of the
3026     repository
3027   - you rewrite the history of your patch so that it contains a relatively
3028     small number of commits that are each internally consistent and could
3029     also be applied independently (see, for example, [the discussion
3030     towards the bottom of this
3031     page](https://github.com/dealii/dealii/pull/87)).
3032
3033
3034
3035 ## I'm fluent in deal.II, are there jobs for me?
3036
3037 Certainly. People with numerical skills are a sought commodity, both in
3038 academia and in businesses. In the US, the National Labs are also hiring
3039 lots of people in this field.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.