From ead40c87410270bed5688124440cb2075eaa541a Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 23 Aug 2019 10:21:26 -0600 Subject: [PATCH] Clarify the use of the adjective 'integral'. --- examples/step-3/doc/intro.dox | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/examples/step-3/doc/intro.dox b/examples/step-3/doc/intro.dox index 81e387aa0c..4bf7aeb905 100644 --- a/examples/step-3/doc/intro.dox +++ b/examples/step-3/doc/intro.dox @@ -335,8 +335,13 @@ following tutorial programs.

A note on types

-deal.II defines a number of integral %types via alias in namespace types. In -particular, in this program you will see types::global_dof_index in a couple of +deal.II defines a number of integral %types via alias in namespace dealii::types. +(In the previous sentence, the word "integral" is used as the adjective +that corresponds to the noun "integer". It shouldn't be confused with the +noun "integral" that represents the area or volume under a curve +or surface. The adjective "integral" is widely used in the C++ world in +contexts such as "integral type", "integral constant", etc.) +In particular, in this program you will see types::global_dof_index in a couple of places: an integer type that is used to denote the global index of a degree of freedom, i.e., the index of a particular degree of freedom within the DoFHandler object that is defined on top of a triangulation (as opposed to the -- 2.39.5