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