deal.II version GIT relicensing-2173-gae8fc9d14b 2024-11-24 06:40:00+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
step-32.h
Go to the documentation of this file.
1
1508 *   constexpr double kappa = 1e-6; /* m^2 / s */
1509 *   constexpr double reference_density = 3300; /* kg / m^3 */
1510 *   constexpr double reference_temperature = 293; /* K */
1511 *   constexpr double expansion_coefficient = 2e-5; /* 1/K */
1512 *   constexpr double specific_heat = 1250; /* J / K / kg */
1513 *   constexpr double radiogenic_heating = 7.4e-12; /* W / kg */
1514 *  
1515 *  
1516 *   constexpr double R0 = 6371000. - 2890000.; /* m */
1517 *   constexpr double R1 = 6371000. - 35000.; /* m */
1518 *  
1519 *   constexpr double T0 = 4000 + 273; /* K */
1520 *   constexpr double T1 = 700 + 273; /* K */
1521 *  
1522 *  
1523 * @endcode
1524 *
1525 * The next set of definitions are for functions that encode the density
1526 * as a function of temperature, the gravity vector, and the initial
1527 * values for the temperature. Again, all of these (along with the values
1528 * they compute) are discussed in the introduction:
1529 *
1530 * @code
1531 *   double density(const double temperature)
1532 *   {
1533 *   return (
1534 *   reference_density *
1535 *   (1 - expansion_coefficient * (temperature - reference_temperature)));
1536 *   }
1537 *  
1538 *  
1539 *   template <int dim>
1540 *   Tensor<1, dim> gravity_vector(const Point<dim> &p)
1541 *   {
1542 *   const double r = p.norm();
1543 *   return -(1.245e-6 * r + 7.714e13 / r / r) * p / r;
1544 *   }
1545 *  
1546 *  
1547 *  
1548 *   template <int dim>
1549 *   class TemperatureInitialValues : public Function<dim>
1550 *   {
1551 *   public:
1552 *   TemperatureInitialValues()
1553 *   : Function<dim>(1)
1554 *   {}
1555 *  
1556 *   virtual double value(const Point<dim> &p,
1557 *   const unsigned int component = 0) const override;
1558 *  
1559 *   virtual void vector_value(const Point<dim> &p,
1560 *   Vector<double> &value) const override;
1561 *   };
1562 *  
1563 *  
1564 *  
1565 *   template <int dim>
1566 *   double TemperatureInitialValues<dim>::value(const Point<dim> &p,
1567 *   const unsigned int) const
1568 *   {
1569 *   const double r = p.norm();
1570 *   const double h = R1 - R0;
1571 *  
1572 *   const double s = (r - R0) / h;
1573 *   const double q =
1574 *   (dim == 3) ? std::max(0.0, cos(numbers::PI * abs(p[2] / R1))) : 1.0;
1575 *   const double phi = std::atan2(p[0], p[1]);
1576 *   const double tau = s + 0.2 * s * (1 - s) * std::sin(6 * phi) * q;
1577 *  
1578 *   return T0 * (1.0 - tau) + T1 * tau;
1579 *   }
1580 *  
1581 *  
1582 *   template <int dim>
1583 *   void
1584 *   TemperatureInitialValues<dim>::vector_value(const Point<dim> &p,
1585 *   Vector<double> &values) const
1586 *   {
1587 *   for (unsigned int c = 0; c < this->n_components; ++c)
1588 *   values(c) = TemperatureInitialValues<dim>::value(p, c);
1589 *   }
1590 *  
1591 *  
1592 * @endcode
1593 *
1594 * As mentioned in the introduction we need to rescale the pressure to
1595 * avoid the relative ill-conditioning of the momentum and mass
1596 * conservation equations. The scaling factor is @f$\frac{\eta}{L}@f$ where
1597 * @f$L@f$ was a typical length scale. By experimenting it turns out that a
1598 * good length scale is the diameter of plumes, which is around 10 km:
1599 *
1600 * @code
1601 *   constexpr double pressure_scaling = eta / 10000;
1602 *  
1603 * @endcode
1604 *
1605 * The final number in this namespace is a constant that denotes the
1606 * number of seconds per (average, tropical) year. We use this only when
1607 * generating screen output: internally, all computations of this program
1608 * happen in SI units (kilogram, meter, seconds) but writing geological
1609 * times in seconds yields numbers that one can't relate to reality, and
1610 * so we convert to years using the factor defined here:
1611 *
1612 * @code
1613 *   const double year_in_seconds = 60 * 60 * 24 * 365.2425;
1614 *  
1615 *   } // namespace EquationData
1616 *  
1617 *  
1618 *  
1619 * @endcode
1620 *
1621 *
1622 * <a name="step_32-PreconditioningtheStokessystem"></a>
1623 * <h3>Preconditioning the Stokes system</h3>
1624 *
1625
1626 *
1627 * This namespace implements the preconditioner. As discussed in the
1628 * introduction, this preconditioner differs in a number of key portions
1629 * from the one used in @ref step_31 "step-31". Specifically, it is a right preconditioner,
1630 * implementing the matrix
1631 * @f{align*}{
1632 * \left(\begin{array}{cc}A^{-1} & -A^{-1}B^TS^{-1}
1633 * \\0 & S^{-1}
1634 * \end{array}\right)
1635 * @f}
1636 * where the two inverse matrix operations
1637 * are approximated by linear solvers or, if the right flag is given to the
1638 * constructor of this class, by a single AMG V-cycle for the velocity
1639 * block. The three code blocks of the <code>vmult</code> function implement
1640 * the multiplications with the three blocks of this preconditioner matrix
1641 * and should be self explanatory if you have read through @ref step_31 "step-31" or the
1642 * discussion of composing solvers in @ref step_20 "step-20".
1643 *
1644 * @code
1645 *   namespace LinearSolvers
1646 *   {
1647 *   template <class PreconditionerTypeA, class PreconditionerTypeMp>
1648 *   class BlockSchurPreconditioner : public EnableObserverPointer
1649 *   {
1650 *   public:
1651 *   BlockSchurPreconditioner(const TrilinosWrappers::BlockSparseMatrix &S,
1652 *   const TrilinosWrappers::BlockSparseMatrix &Spre,
1653 *   const PreconditionerTypeMp &Mppreconditioner,
1654 *   const PreconditionerTypeA &Apreconditioner,
1655 *   const bool do_solve_A)
1656 *   : stokes_matrix(&S)
1657 *   , stokes_preconditioner_matrix(&Spre)
1658 *   , mp_preconditioner(Mppreconditioner)
1659 *   , a_preconditioner(Apreconditioner)
1660 *   , do_solve_A(do_solve_A)
1661 *   {}
1662 *  
1663 *   void vmult(TrilinosWrappers::MPI::BlockVector &dst,
1664 *   const TrilinosWrappers::MPI::BlockVector &src) const
1665 *   {
1666 *   TrilinosWrappers::MPI::Vector utmp(src.block(0));
1667 *  
1668 *   {
1669 *   SolverControl solver_control(5000, 1e-6 * src.block(1).l2_norm());
1670 *  
1671 *   SolverCG<TrilinosWrappers::MPI::Vector> solver(solver_control);
1672 *  
1673 *   solver.solve(stokes_preconditioner_matrix->block(1, 1),
1674 *   dst.block(1),
1675 *   src.block(1),
1676 *   mp_preconditioner);
1677 *  
1678 *   dst.block(1) *= -1.0;
1679 *   }
1680 *  
1681 *   {
1682 *   stokes_matrix->block(0, 1).vmult(utmp, dst.block(1));
1683 *   utmp *= -1.0;
1684 *   utmp.add(src.block(0));
1685 *   }
1686 *  
1687 *   if (do_solve_A == true)
1688 *   {
1689 *   SolverControl solver_control(5000, utmp.l2_norm() * 1e-2);
1690 *   TrilinosWrappers::SolverCG solver(solver_control);
1691 *   solver.solve(stokes_matrix->block(0, 0),
1692 *   dst.block(0),
1693 *   utmp,
1694 *   a_preconditioner);
1695 *   }
1696 *   else
1697 *   a_preconditioner.vmult(dst.block(0), utmp);
1698 *   }
1699 *  
1700 *   private:
1701 *   const ObserverPointer<const TrilinosWrappers::BlockSparseMatrix>
1702 *   stokes_matrix;
1703 *   const ObserverPointer<const TrilinosWrappers::BlockSparseMatrix>
1704 *   stokes_preconditioner_matrix;
1705 *   const PreconditionerTypeMp &mp_preconditioner;
1706 *   const PreconditionerTypeA &a_preconditioner;
1707 *   const bool do_solve_A;
1708 *   };
1709 *   } // namespace LinearSolvers
1710 *  
1711 *  
1712 *  
1713 * @endcode
1714 *
1715 *
1716 * <a name="step_32-Definitionofassemblydatastructures"></a>
1717 * <h3>Definition of assembly data structures</h3>
1718 *
1719
1720 *
1721 * As described in the introduction, we will use the WorkStream mechanism
1722 * discussed in the @ref threads topic to parallelize operations among the
1723 * processors of a single machine. The WorkStream class requires that data
1724 * is passed around in two kinds of data structures, one for scratch data
1725 * and one to pass data from the assembly function to the function that
1726 * copies local contributions into global objects.
1727 *
1728
1729 *
1730 * The following namespace (and the two sub-namespaces) contains a
1731 * collection of data structures that serve this purpose, one pair for each
1732 * of the four operations discussed in the introduction that we will want to
1733 * parallelize. Each assembly routine gets two sets of data: a Scratch array
1734 * that collects all the classes and arrays that are used for the
1735 * calculation of the cell contribution, and a CopyData array that keeps
1736 * local matrices and vectors which will be written into the global
1737 * matrix. Whereas CopyData is a container for the final data that is
1738 * written into the global matrices and vector (and, thus, absolutely
1739 * necessary), the Scratch arrays are merely there for performance reasons
1740 * &mdash; it would be much more expensive to set up a FEValues object on
1741 * each cell, than creating it only once and updating some derivative data.
1742 *
1743
1744 *
1745 * @ref step_31 "step-31" had four assembly routines: One for the preconditioner matrix of
1746 * the Stokes system, one for the Stokes matrix and right hand side, one for
1747 * the temperature matrices and one for the right hand side of the
1748 * temperature equation. We here organize the scratch arrays and CopyData
1749 * objects for each of those four assembly components using a
1750 * <code>struct</code> environment (since we consider these as temporary
1751 * objects we pass around, rather than classes that implement functionality
1752 * of their own, though this is a more subjective point of view to
1753 * distinguish between <code>struct</code>s and <code>class</code>es).
1754 *
1755
1756 *
1757 * Regarding the Scratch objects, each struct is equipped with a constructor
1758 * that creates an @ref FEValues object using the @ref FiniteElement,
1759 * Quadrature, @ref Mapping (which describes the interpolation of curved
1760 * boundaries), and @ref UpdateFlags instances. Moreover, we manually
1761 * implement a copy constructor (since the FEValues class is not copyable by
1762 * itself), and provide some additional vector fields that are used to hold
1763 * intermediate data during the computation of local contributions.
1764 *
1765
1766 *
1767 * Let us start with the scratch arrays and, specifically, the one used for
1768 * assembly of the Stokes preconditioner:
1769 *
1770 * @code
1771 *   namespace Assembly
1772 *   {
1773 *   namespace Scratch
1774 *   {
1775 *   template <int dim>
1776 *   struct StokesPreconditioner
1777 *   {
1778 *   StokesPreconditioner(const FiniteElement<dim> &stokes_fe,
1779 *   const Quadrature<dim> &stokes_quadrature,
1780 *   const Mapping<dim> &mapping,
1781 *   const UpdateFlags update_flags);
1782 *  
1783 *   StokesPreconditioner(const StokesPreconditioner &data);
1784 *  
1785 *  
1786 *   FEValues<dim> stokes_fe_values;
1787 *  
1788 *   std::vector<Tensor<2, dim>> grad_phi_u;
1789 *   std::vector<double> phi_p;
1790 *   };
1791 *  
1792 *   template <int dim>
1793 *   StokesPreconditioner<dim>::StokesPreconditioner(
1794 *   const FiniteElement<dim> &stokes_fe,
1795 *   const Quadrature<dim> &stokes_quadrature,
1796 *   const Mapping<dim> &mapping,
1797 *   const UpdateFlags update_flags)
1798 *   : stokes_fe_values(mapping, stokes_fe, stokes_quadrature, update_flags)
1799 *   , grad_phi_u(stokes_fe.n_dofs_per_cell())
1800 *   , phi_p(stokes_fe.n_dofs_per_cell())
1801 *   {}
1802 *  
1803 *  
1804 *  
1805 *   template <int dim>
1806 *   StokesPreconditioner<dim>::StokesPreconditioner(
1807 *   const StokesPreconditioner &scratch)
1808 *   : stokes_fe_values(scratch.stokes_fe_values.get_mapping(),
1809 *   scratch.stokes_fe_values.get_fe(),
1810 *   scratch.stokes_fe_values.get_quadrature(),
1811 *   scratch.stokes_fe_values.get_update_flags())
1812 *   , grad_phi_u(scratch.grad_phi_u)
1813 *   , phi_p(scratch.phi_p)
1814 *   {}
1815 *  
1816 *  
1817 *  
1818 * @endcode
1819 *
1820 * The next one is the scratch object used for the assembly of the full
1821 * Stokes system. Observe that we derive the StokesSystem scratch class
1822 * from the StokesPreconditioner class above. We do this because all the
1823 * objects that are necessary for the assembly of the preconditioner are
1824 * also needed for the actual matrix system and right hand side, plus
1825 * some extra data. This makes the program more compact. Note also that
1826 * the assembly of the Stokes system and the temperature right hand side
1827 * further down requires data from temperature and velocity,
1828 * respectively, so we actually need two FEValues objects for those two
1829 * cases.
1830 *
1831 * @code
1832 *   template <int dim>
1833 *   struct StokesSystem : public StokesPreconditioner<dim>
1834 *   {
1835 *   StokesSystem(const FiniteElement<dim> &stokes_fe,
1836 *   const Mapping<dim> &mapping,
1837 *   const Quadrature<dim> &stokes_quadrature,
1838 *   const UpdateFlags stokes_update_flags,
1839 *   const FiniteElement<dim> &temperature_fe,
1840 *   const UpdateFlags temperature_update_flags);
1841 *  
1842 *   StokesSystem(const StokesSystem<dim> &data);
1843 *  
1844 *  
1845 *   FEValues<dim> temperature_fe_values;
1846 *  
1847 *   std::vector<Tensor<1, dim>> phi_u;
1848 *   std::vector<SymmetricTensor<2, dim>> grads_phi_u;
1849 *   std::vector<double> div_phi_u;
1850 *  
1851 *   std::vector<double> old_temperature_values;
1852 *   };
1853 *  
1854 *  
1855 *   template <int dim>
1856 *   StokesSystem<dim>::StokesSystem(
1857 *   const FiniteElement<dim> &stokes_fe,
1858 *   const Mapping<dim> &mapping,
1859 *   const Quadrature<dim> &stokes_quadrature,
1860 *   const UpdateFlags stokes_update_flags,
1861 *   const FiniteElement<dim> &temperature_fe,
1862 *   const UpdateFlags temperature_update_flags)
1863 *   : StokesPreconditioner<dim>(stokes_fe,
1864 *   stokes_quadrature,
1865 *   mapping,
1866 *   stokes_update_flags)
1867 *   , temperature_fe_values(mapping,
1868 *   temperature_fe,
1869 *   stokes_quadrature,
1870 *   temperature_update_flags)
1871 *   , phi_u(stokes_fe.n_dofs_per_cell())
1872 *   , grads_phi_u(stokes_fe.n_dofs_per_cell())
1873 *   , div_phi_u(stokes_fe.n_dofs_per_cell())
1874 *   , old_temperature_values(stokes_quadrature.size())
1875 *   {}
1876 *  
1877 *  
1878 *   template <int dim>
1879 *   StokesSystem<dim>::StokesSystem(const StokesSystem<dim> &scratch)
1880 *   : StokesPreconditioner<dim>(scratch)
1881 *   , temperature_fe_values(
1882 *   scratch.temperature_fe_values.get_mapping(),
1883 *   scratch.temperature_fe_values.get_fe(),
1884 *   scratch.temperature_fe_values.get_quadrature(),
1885 *   scratch.temperature_fe_values.get_update_flags())
1886 *   , phi_u(scratch.phi_u)
1887 *   , grads_phi_u(scratch.grads_phi_u)
1888 *   , div_phi_u(scratch.div_phi_u)
1889 *   , old_temperature_values(scratch.old_temperature_values)
1890 *   {}
1891 *  
1892 *  
1893 * @endcode
1894 *
1895 * After defining the objects used in the assembly of the Stokes system,
1896 * we do the same for the assembly of the matrices necessary for the
1897 * temperature system. The general structure is very similar:
1898 *
1899 * @code
1900 *   template <int dim>
1901 *   struct TemperatureMatrix
1902 *   {
1903 *   TemperatureMatrix(const FiniteElement<dim> &temperature_fe,
1904 *   const Mapping<dim> &mapping,
1905 *   const Quadrature<dim> &temperature_quadrature);
1906 *  
1907 *   TemperatureMatrix(const TemperatureMatrix &data);
1908 *  
1909 *  
1910 *   FEValues<dim> temperature_fe_values;
1911 *  
1912 *   std::vector<double> phi_T;
1913 *   std::vector<Tensor<1, dim>> grad_phi_T;
1914 *   };
1915 *  
1916 *  
1917 *   template <int dim>
1918 *   TemperatureMatrix<dim>::TemperatureMatrix(
1919 *   const FiniteElement<dim> &temperature_fe,
1920 *   const Mapping<dim> &mapping,
1921 *   const Quadrature<dim> &temperature_quadrature)
1922 *   : temperature_fe_values(mapping,
1923 *   temperature_fe,
1924 *   temperature_quadrature,
1925 *   update_values | update_gradients |
1926 *   update_JxW_values)
1927 *   , phi_T(temperature_fe.n_dofs_per_cell())
1928 *   , grad_phi_T(temperature_fe.n_dofs_per_cell())
1929 *   {}
1930 *  
1931 *  
1932 *   template <int dim>
1933 *   TemperatureMatrix<dim>::TemperatureMatrix(
1934 *   const TemperatureMatrix &scratch)
1935 *   : temperature_fe_values(
1936 *   scratch.temperature_fe_values.get_mapping(),
1937 *   scratch.temperature_fe_values.get_fe(),
1938 *   scratch.temperature_fe_values.get_quadrature(),
1939 *   scratch.temperature_fe_values.get_update_flags())
1940 *   , phi_T(scratch.phi_T)
1941 *   , grad_phi_T(scratch.grad_phi_T)
1942 *   {}
1943 *  
1944 *  
1945 * @endcode
1946 *
1947 * The final scratch object is used in the assembly of the right hand
1948 * side of the temperature system. This object is significantly larger
1949 * than the ones above because a lot more quantities enter the
1950 * computation of the right hand side of the temperature equation. In
1951 * particular, the temperature values and gradients of the previous two
1952 * time steps need to be evaluated at the quadrature points, as well as
1953 * the velocities and the strain rates (i.e. the symmetric gradients of
1954 * the velocity) that enter the right hand side as friction heating
1955 * terms. Despite the number of terms, the following should be rather
1956 * self explanatory:
1957 *
1958 * @code
1959 *   template <int dim>
1960 *   struct TemperatureRHS
1961 *   {
1962 *   TemperatureRHS(const FiniteElement<dim> &temperature_fe,
1963 *   const FiniteElement<dim> &stokes_fe,
1964 *   const Mapping<dim> &mapping,
1965 *   const Quadrature<dim> &quadrature);
1966 *  
1967 *   TemperatureRHS(const TemperatureRHS &data);
1968 *  
1969 *  
1970 *   FEValues<dim> temperature_fe_values;
1971 *   FEValues<dim> stokes_fe_values;
1972 *  
1973 *   std::vector<double> phi_T;
1974 *   std::vector<Tensor<1, dim>> grad_phi_T;
1975 *  
1976 *   std::vector<Tensor<1, dim>> old_velocity_values;
1977 *   std::vector<Tensor<1, dim>> old_old_velocity_values;
1978 *  
1979 *   std::vector<SymmetricTensor<2, dim>> old_strain_rates;
1980 *   std::vector<SymmetricTensor<2, dim>> old_old_strain_rates;
1981 *  
1982 *   std::vector<double> old_temperature_values;
1983 *   std::vector<double> old_old_temperature_values;
1984 *   std::vector<Tensor<1, dim>> old_temperature_grads;
1985 *   std::vector<Tensor<1, dim>> old_old_temperature_grads;
1986 *   std::vector<double> old_temperature_laplacians;
1987 *   std::vector<double> old_old_temperature_laplacians;
1988 *   };
1989 *  
1990 *  
1991 *   template <int dim>
1992 *   TemperatureRHS<dim>::TemperatureRHS(
1993 *   const FiniteElement<dim> &temperature_fe,
1994 *   const FiniteElement<dim> &stokes_fe,
1995 *   const Mapping<dim> &mapping,
1996 *   const Quadrature<dim> &quadrature)
1997 *   : temperature_fe_values(mapping,
1998 *   temperature_fe,
1999 *   quadrature,
2000 *   update_values | update_gradients |
2001 *   update_hessians | update_quadrature_points |
2002 *   update_JxW_values)
2003 *   , stokes_fe_values(mapping,
2004 *   stokes_fe,
2005 *   quadrature,
2006 *   update_values | update_gradients)
2007 *   , phi_T(temperature_fe.n_dofs_per_cell())
2008 *   , grad_phi_T(temperature_fe.n_dofs_per_cell())
2009 *   ,
2010 *  
2011 *   old_velocity_values(quadrature.size())
2012 *   , old_old_velocity_values(quadrature.size())
2013 *   , old_strain_rates(quadrature.size())
2014 *   , old_old_strain_rates(quadrature.size())
2015 *   ,
2016 *  
2017 *   old_temperature_values(quadrature.size())
2018 *   , old_old_temperature_values(quadrature.size())
2019 *   , old_temperature_grads(quadrature.size())
2020 *   , old_old_temperature_grads(quadrature.size())
2021 *   , old_temperature_laplacians(quadrature.size())
2022 *   , old_old_temperature_laplacians(quadrature.size())
2023 *   {}
2024 *  
2025 *  
2026 *   template <int dim>
2027 *   TemperatureRHS<dim>::TemperatureRHS(const TemperatureRHS &scratch)
2028 *   : temperature_fe_values(
2029 *   scratch.temperature_fe_values.get_mapping(),
2030 *   scratch.temperature_fe_values.get_fe(),
2031 *   scratch.temperature_fe_values.get_quadrature(),
2032 *   scratch.temperature_fe_values.get_update_flags())
2033 *   , stokes_fe_values(scratch.stokes_fe_values.get_mapping(),
2034 *   scratch.stokes_fe_values.get_fe(),
2035 *   scratch.stokes_fe_values.get_quadrature(),
2036 *   scratch.stokes_fe_values.get_update_flags())
2037 *   , phi_T(scratch.phi_T)
2038 *   , grad_phi_T(scratch.grad_phi_T)
2039 *   ,
2040 *  
2041 *   old_velocity_values(scratch.old_velocity_values)
2042 *   , old_old_velocity_values(scratch.old_old_velocity_values)
2043 *   , old_strain_rates(scratch.old_strain_rates)
2044 *   , old_old_strain_rates(scratch.old_old_strain_rates)
2045 *   ,
2046 *  
2047 *   old_temperature_values(scratch.old_temperature_values)
2048 *   , old_old_temperature_values(scratch.old_old_temperature_values)
2049 *   , old_temperature_grads(scratch.old_temperature_grads)
2050 *   , old_old_temperature_grads(scratch.old_old_temperature_grads)
2051 *   , old_temperature_laplacians(scratch.old_temperature_laplacians)
2052 *   , old_old_temperature_laplacians(scratch.old_old_temperature_laplacians)
2053 *   {}
2054 *   } // namespace Scratch
2055 *  
2056 *  
2057 * @endcode
2058 *
2059 * The CopyData objects are even simpler than the Scratch objects as all
2060 * they have to do is to store the results of local computations until
2061 * they can be copied into the global matrix or vector objects. These
2062 * structures therefore only need to provide a constructor, a copy
2063 * operation, and some arrays for local matrix, local vectors and the
2064 * relation between local and global degrees of freedom (a.k.a.
2065 * <code>local_dof_indices</code>). Again, we have one such structure for
2066 * each of the four operations we will parallelize using the WorkStream
2067 * class:
2068 *
2069 * @code
2070 *   namespace CopyData
2071 *   {
2072 *   template <int dim>
2073 *   struct StokesPreconditioner
2074 *   {
2075 *   StokesPreconditioner(const FiniteElement<dim> &stokes_fe);
2076 *   StokesPreconditioner(const StokesPreconditioner &data);
2077 *   StokesPreconditioner &operator=(const StokesPreconditioner &) = default;
2078 *  
2079 *   FullMatrix<double> local_matrix;
2080 *   std::vector<types::global_dof_index> local_dof_indices;
2081 *   };
2082 *  
2083 *   template <int dim>
2084 *   StokesPreconditioner<dim>::StokesPreconditioner(
2085 *   const FiniteElement<dim> &stokes_fe)
2086 *   : local_matrix(stokes_fe.n_dofs_per_cell(), stokes_fe.n_dofs_per_cell())
2087 *   , local_dof_indices(stokes_fe.n_dofs_per_cell())
2088 *   {}
2089 *  
2090 *   template <int dim>
2091 *   StokesPreconditioner<dim>::StokesPreconditioner(
2092 *   const StokesPreconditioner &data)
2093 *   : local_matrix(data.local_matrix)
2094 *   , local_dof_indices(data.local_dof_indices)
2095 *   {}
2096 *  
2097 *  
2098 *  
2099 *   template <int dim>
2100 *   struct StokesSystem : public StokesPreconditioner<dim>
2101 *   {
2102 *   StokesSystem(const FiniteElement<dim> &stokes_fe);
2103 *  
2104 *   Vector<double> local_rhs;
2105 *   };
2106 *  
2107 *   template <int dim>
2108 *   StokesSystem<dim>::StokesSystem(const FiniteElement<dim> &stokes_fe)
2109 *   : StokesPreconditioner<dim>(stokes_fe)
2110 *   , local_rhs(stokes_fe.n_dofs_per_cell())
2111 *   {}
2112 *  
2113 *  
2114 *  
2115 *   template <int dim>
2116 *   struct TemperatureMatrix
2117 *   {
2118 *   TemperatureMatrix(const FiniteElement<dim> &temperature_fe);
2119 *  
2120 *   FullMatrix<double> local_mass_matrix;
2121 *   FullMatrix<double> local_stiffness_matrix;
2122 *   std::vector<types::global_dof_index> local_dof_indices;
2123 *   };
2124 *  
2125 *   template <int dim>
2126 *   TemperatureMatrix<dim>::TemperatureMatrix(
2127 *   const FiniteElement<dim> &temperature_fe)
2128 *   : local_mass_matrix(temperature_fe.n_dofs_per_cell(),
2129 *   temperature_fe.n_dofs_per_cell())
2130 *   , local_stiffness_matrix(temperature_fe.n_dofs_per_cell(),
2131 *   temperature_fe.n_dofs_per_cell())
2132 *   , local_dof_indices(temperature_fe.n_dofs_per_cell())
2133 *   {}
2134 *  
2135 *  
2136 *  
2137 *   template <int dim>
2138 *   struct TemperatureRHS
2139 *   {
2140 *   TemperatureRHS(const FiniteElement<dim> &temperature_fe);
2141 *  
2142 *   Vector<double> local_rhs;
2143 *   std::vector<types::global_dof_index> local_dof_indices;
2144 *   FullMatrix<double> matrix_for_bc;
2145 *   };
2146 *  
2147 *   template <int dim>
2148 *   TemperatureRHS<dim>::TemperatureRHS(
2149 *   const FiniteElement<dim> &temperature_fe)
2150 *   : local_rhs(temperature_fe.n_dofs_per_cell())
2151 *   , local_dof_indices(temperature_fe.n_dofs_per_cell())
2152 *   , matrix_for_bc(temperature_fe.n_dofs_per_cell(),
2153 *   temperature_fe.n_dofs_per_cell())
2154 *   {}
2155 *   } // namespace CopyData
2156 *   } // namespace Assembly
2157 *  
2158 *  
2159 *  
2160 * @endcode
2161 *
2162 *
2163 * <a name="step_32-ThecodeBoussinesqFlowProblemcodeclasstemplate"></a>
2164 * <h3>The <code>BoussinesqFlowProblem</code> class template</h3>
2165 *
2166
2167 *
2168 * This is the declaration of the main class. It is very similar to @ref step_31 "step-31"
2169 * but there are a number differences we will comment on below.
2170 *
2171
2172 *
2173 * The top of the class is essentially the same as in @ref step_31 "step-31", listing the
2174 * public methods and a set of private functions that do the heavy
2175 * lifting. Compared to @ref step_31 "step-31" there are only two additions to this
2176 * section: the function <code>get_cfl_number()</code> that computes the
2177 * maximum CFL number over all cells which we then compute the global time
2178 * step from, and the function <code>get_entropy_variation()</code> that is
2179 * used in the computation of the entropy stabilization. It is akin to the
2180 * <code>get_extrapolated_temperature_range()</code> we have used in @ref step_31 "step-31"
2181 * for this purpose, but works on the entropy instead of the temperature
2182 * instead.
2183 *
2184 * @code
2185 *   template <int dim>
2186 *   class BoussinesqFlowProblem
2187 *   {
2188 *   public:
2189 *   struct Parameters;
2190 *   BoussinesqFlowProblem(Parameters &parameters);
2191 *   void run();
2192 *  
2193 *   private:
2194 *   void setup_dofs();
2195 *   void assemble_stokes_preconditioner();
2196 *   void build_stokes_preconditioner();
2197 *   void assemble_stokes_system();
2198 *   void assemble_temperature_matrix();
2199 *   void assemble_temperature_system(const double maximal_velocity);
2200 *   double get_maximal_velocity() const;
2201 *   double get_cfl_number() const;
2202 *   double get_entropy_variation(const double average_temperature) const;
2203 *   std::pair<double, double> get_extrapolated_temperature_range() const;
2204 *   void solve();
2205 *   void output_results();
2206 *   void refine_mesh(const unsigned int max_grid_level);
2207 *  
2208 *   double compute_viscosity(
2209 *   const std::vector<double> &old_temperature,
2210 *   const std::vector<double> &old_old_temperature,
2211 *   const std::vector<Tensor<1, dim>> &old_temperature_grads,
2212 *   const std::vector<Tensor<1, dim>> &old_old_temperature_grads,
2213 *   const std::vector<double> &old_temperature_laplacians,
2214 *   const std::vector<double> &old_old_temperature_laplacians,
2215 *   const std::vector<Tensor<1, dim>> &old_velocity_values,
2216 *   const std::vector<Tensor<1, dim>> &old_old_velocity_values,
2217 *   const std::vector<SymmetricTensor<2, dim>> &old_strain_rates,
2218 *   const std::vector<SymmetricTensor<2, dim>> &old_old_strain_rates,
2219 *   const double global_u_infty,
2220 *   const double global_T_variation,
2221 *   const double average_temperature,
2222 *   const double global_entropy_variation,
2223 *   const double cell_diameter) const;
2224 *  
2225 *   public:
2226 * @endcode
2227 *
2228 * The first significant new component is the definition of a struct for
2229 * the parameters according to the discussion in the introduction. This
2230 * structure is initialized by reading from a parameter file during
2231 * construction of this object.
2232 *
2233 * @code
2234 *   struct Parameters
2235 *   {
2236 *   Parameters(const std::string &parameter_filename);
2237 *  
2238 *   static void declare_parameters(ParameterHandler &prm);
2239 *   void parse_parameters(ParameterHandler &prm);
2240 *  
2241 *   double end_time;
2242 *  
2243 *   unsigned int initial_global_refinement;
2244 *   unsigned int initial_adaptive_refinement;
2245 *  
2246 *   bool generate_graphical_output;
2247 *   unsigned int graphical_output_interval;
2248 *  
2249 *   unsigned int adaptive_refinement_interval;
2250 *  
2251 *   double stabilization_alpha;
2252 *   double stabilization_c_R;
2253 *   double stabilization_beta;
2254 *  
2255 *   unsigned int stokes_velocity_degree;
2256 *   bool use_locally_conservative_discretization;
2257 *  
2258 *   unsigned int temperature_degree;
2259 *   };
2260 *  
2261 *   private:
2262 *   Parameters &parameters;
2263 *  
2264 * @endcode
2265 *
2266 * The <code>pcout</code> (for <i>%parallel <code>std::cout</code></i>)
2267 * object is used to simplify writing output: each MPI process can use
2268 * this to generate output as usual, but since each of these processes
2269 * will (hopefully) produce the same output it will just be replicated
2270 * many times over; with the ConditionalOStream class, only the output
2271 * generated by one MPI process will actually be printed to screen,
2272 * whereas the output by all the other threads will simply be forgotten.
2273 *
2274 * @code
2275 *   ConditionalOStream pcout;
2276 *  
2277 * @endcode
2278 *
2279 * The following member variables will then again be similar to those in
2280 * @ref step_31 "step-31" (and to other tutorial programs). As mentioned in the
2281 * introduction, we fully distribute computations, so we will have to use
2282 * the parallel::distributed::Triangulation class (see @ref step_40 "step-40") but the
2283 * remainder of these variables is rather standard with two exceptions:
2284 *
2285
2286 *
2287 * - The <code>mapping</code> variable is used to denote a higher-order
2288 * polynomial mapping. As mentioned in the introduction, we use this
2289 * mapping when forming integrals through quadrature for all cells.
2290 *
2291
2292 *
2293 * - In a bit of naming confusion, you will notice below that some of the
2294 * variables from namespace TrilinosWrappers are taken from namespace
2295 * TrilinosWrappers::MPI (such as the right hand side vectors) whereas
2296 * others are not (such as the various matrices). This is due to legacy
2297 * reasons. We will frequently have to query velocities
2298 * and temperatures at arbitrary quadrature points; consequently, rather
2299 * than importing ghost information of a vector whenever we need access
2300 * to degrees of freedom that are relevant locally but owned by another
2301 * processor, we solve linear systems in %parallel but then immediately
2302 * initialize a vector including ghost entries of the solution for further
2303 * processing. The various <code>*_solution</code> vectors are therefore
2304 * filled immediately after solving their respective linear system in
2305 * %parallel and will always contain values for all
2306 * @ref GlossLocallyRelevantDof "locally relevant degrees of freedom";
2307 * the fully distributed vectors that we obtain from the solution process
2308 * and that only ever contain the
2309 * @ref GlossLocallyOwnedDof "locally owned degrees of freedom" are
2310 * destroyed immediately after the solution process and after we have
2311 * copied the relevant values into the member variable vectors.
2312 *
2313 * @code
2314 *   parallel::distributed::Triangulation<dim> triangulation;
2315 *   double global_Omega_diameter;
2316 *  
2317 *   const MappingQ<dim> mapping;
2318 *  
2319 *   const FESystem<dim> stokes_fe;
2320 *   DoFHandler<dim> stokes_dof_handler;
2321 *   AffineConstraints<double> stokes_constraints;
2322 *  
2323 *   TrilinosWrappers::BlockSparseMatrix stokes_matrix;
2324 *   TrilinosWrappers::BlockSparseMatrix stokes_preconditioner_matrix;
2325 *  
2326 *   TrilinosWrappers::MPI::BlockVector stokes_solution;
2327 *   TrilinosWrappers::MPI::BlockVector old_stokes_solution;
2328 *   TrilinosWrappers::MPI::BlockVector stokes_rhs;
2329 *  
2330 *  
2331 *   const FE_Q<dim> temperature_fe;
2332 *   DoFHandler<dim> temperature_dof_handler;
2333 *   AffineConstraints<double> temperature_constraints;
2334 *  
2335 *   TrilinosWrappers::SparseMatrix temperature_mass_matrix;
2336 *   TrilinosWrappers::SparseMatrix temperature_stiffness_matrix;
2337 *   TrilinosWrappers::SparseMatrix temperature_matrix;
2338 *  
2339 *   TrilinosWrappers::MPI::Vector temperature_solution;
2340 *   TrilinosWrappers::MPI::Vector old_temperature_solution;
2341 *   TrilinosWrappers::MPI::Vector old_old_temperature_solution;
2342 *   TrilinosWrappers::MPI::Vector temperature_rhs;
2343 *  
2344 *  
2345 *   double time_step;
2346 *   double old_time_step;
2347 *   unsigned int timestep_number;
2348 *  
2349 *   std::shared_ptr<TrilinosWrappers::PreconditionAMG> Amg_preconditioner;
2350 *   std::shared_ptr<TrilinosWrappers::PreconditionJacobi> Mp_preconditioner;
2351 *   std::shared_ptr<TrilinosWrappers::PreconditionJacobi> T_preconditioner;
2352 *  
2353 *   bool rebuild_stokes_matrix;
2354 *   bool rebuild_stokes_preconditioner;
2355 *   bool rebuild_temperature_matrices;
2356 *   bool rebuild_temperature_preconditioner;
2357 *  
2358 * @endcode
2359 *
2360 * The next member variable, <code>computing_timer</code> is used to
2361 * conveniently account for compute time spent in certain "sections" of
2362 * the code that are repeatedly entered. For example, we will enter (and
2363 * leave) sections for Stokes matrix assembly and would like to accumulate
2364 * the run time spent in this section over all time steps. Every so many
2365 * time steps as well as at the end of the program (through the destructor
2366 * of the TimerOutput class) we will then produce a nice summary of the
2367 * times spent in the different sections into which we categorize the
2368 * run-time of this program.
2369 *
2370 * @code
2371 *   TimerOutput computing_timer;
2372 *  
2373 * @endcode
2374 *
2375 * After these member variables we have a number of auxiliary functions
2376 * that have been broken out of the ones listed above. Specifically, there
2377 * are first three functions that we call from <code>setup_dofs</code> and
2378 * then the ones that do the assembling of linear systems:
2379 *
2380 * @code
2381 *   void setup_stokes_matrix(
2382 *   const std::vector<IndexSet> &stokes_partitioning,
2383 *   const std::vector<IndexSet> &stokes_relevant_partitioning);
2384 *   void setup_stokes_preconditioner(
2385 *   const std::vector<IndexSet> &stokes_partitioning,
2386 *   const std::vector<IndexSet> &stokes_relevant_partitioning);
2387 *   void setup_temperature_matrices(
2388 *   const IndexSet &temperature_partitioning,
2389 *   const IndexSet &temperature_relevant_partitioning);
2390 *  
2391 *  
2392 * @endcode
2393 *
2394 * Following the @ref MTWorkStream "task-based parallelization" paradigm,
2395 * we split all the assembly routines into two parts: a first part that
2396 * can do all the calculations on a certain cell without taking care of
2397 * other threads, and a second part (which is writing the local data into
2398 * the global matrices and vectors) which can be entered by only one
2399 * thread at a time. In order to implement that, we provide functions for
2400 * each of those two steps for all the four assembly routines that we use
2401 * in this program. The following eight functions do exactly this:
2402 *
2403 * @code
2404 *   void local_assemble_stokes_preconditioner(
2405 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
2406 *   Assembly::Scratch::StokesPreconditioner<dim> &scratch,
2407 *   Assembly::CopyData::StokesPreconditioner<dim> &data);
2408 *  
2409 *   void copy_local_to_global_stokes_preconditioner(
2410 *   const Assembly::CopyData::StokesPreconditioner<dim> &data);
2411 *  
2412 *  
2413 *   void local_assemble_stokes_system(
2414 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
2415 *   Assembly::Scratch::StokesSystem<dim> &scratch,
2416 *   Assembly::CopyData::StokesSystem<dim> &data);
2417 *  
2418 *   void copy_local_to_global_stokes_system(
2419 *   const Assembly::CopyData::StokesSystem<dim> &data);
2420 *  
2421 *  
2422 *   void local_assemble_temperature_matrix(
2423 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
2424 *   Assembly::Scratch::TemperatureMatrix<dim> &scratch,
2425 *   Assembly::CopyData::TemperatureMatrix<dim> &data);
2426 *  
2427 *   void copy_local_to_global_temperature_matrix(
2428 *   const Assembly::CopyData::TemperatureMatrix<dim> &data);
2429 *  
2430 *  
2431 *  
2432 *   void local_assemble_temperature_rhs(
2433 *   const std::pair<double, double> global_T_range,
2434 *   const double global_max_velocity,
2435 *   const double global_entropy_variation,
2436 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
2437 *   Assembly::Scratch::TemperatureRHS<dim> &scratch,
2438 *   Assembly::CopyData::TemperatureRHS<dim> &data);
2439 *  
2440 *   void copy_local_to_global_temperature_rhs(
2441 *   const Assembly::CopyData::TemperatureRHS<dim> &data);
2442 *  
2443 * @endcode
2444 *
2445 * Finally, we forward declare a member class that we will define later on
2446 * and that will be used to compute a number of quantities from our
2447 * solution vectors that we'd like to put into the output files for
2448 * visualization.
2449 *
2450 * @code
2451 *   class Postprocessor;
2452 *   };
2453 *  
2454 *  
2455 * @endcode
2456 *
2457 *
2458 * <a name="step_32-BoussinesqFlowProblemclassimplementation"></a>
2459 * <h3>BoussinesqFlowProblem class implementation</h3>
2460 *
2461
2462 *
2463 *
2464 * <a name="step_32-BoussinesqFlowProblemParameters"></a>
2465 * <h4>BoussinesqFlowProblem::Parameters</h4>
2466 *
2467
2468 *
2469 * Here comes the definition of the parameters for the Stokes problem. We
2470 * allow to set the end time for the simulation, the level of refinements
2471 * (both global and adaptive, which in the sum specify what maximum level
2472 * the cells are allowed to have), and the interval between refinements in
2473 * the time stepping.
2474 *
2475
2476 *
2477 * Then, we let the user specify constants for the stabilization parameters
2478 * (as discussed in the introduction), the polynomial degree for the Stokes
2479 * velocity space, whether to use the locally conservative discretization
2480 * based on FE_DGP elements for the pressure or not (FE_Q elements for
2481 * pressure), and the polynomial degree for the temperature interpolation.
2482 *
2483
2484 *
2485 * The constructor checks for a valid input file (if not, a file with
2486 * default parameters for the quantities is written), and eventually parses
2487 * the parameters.
2488 *
2489 * @code
2490 *   template <int dim>
2491 *   BoussinesqFlowProblem<dim>::Parameters::Parameters(
2492 *   const std::string &parameter_filename)
2493 *   : end_time(1e8)
2494 *   , initial_global_refinement(2)
2495 *   , initial_adaptive_refinement(2)
2496 *   , adaptive_refinement_interval(10)
2497 *   , stabilization_alpha(2)
2498 *   , stabilization_c_R(0.11)
2499 *   , stabilization_beta(0.078)
2500 *   , stokes_velocity_degree(2)
2501 *   , use_locally_conservative_discretization(true)
2502 *   , temperature_degree(2)
2503 *   {
2504 *   ParameterHandler prm;
2505 *   BoussinesqFlowProblem<dim>::Parameters::declare_parameters(prm);
2506 *  
2507 *   std::ifstream parameter_file(parameter_filename);
2508 *  
2509 *   if (!parameter_file)
2510 *   {
2511 *   parameter_file.close();
2512 *  
2513 *   std::ofstream parameter_out(parameter_filename);
2514 *   prm.print_parameters(parameter_out, ParameterHandler::PRM);
2515 *  
2516 *   AssertThrow(
2517 *   false,
2518 *   ExcMessage(
2519 *   "Input parameter file <" + parameter_filename +
2520 *   "> not found. Creating a template file of the same name."));
2521 *   }
2522 *  
2523 *   prm.parse_input(parameter_file);
2524 *   parse_parameters(prm);
2525 *   }
2526 *  
2527 *  
2528 *  
2529 * @endcode
2530 *
2531 * Next we have a function that declares the parameters that we expect in
2532 * the input file, together with their data types, default values and a
2533 * description:
2534 *
2535 * @code
2536 *   template <int dim>
2537 *   void BoussinesqFlowProblem<dim>::Parameters::declare_parameters(
2538 *   ParameterHandler &prm)
2539 *   {
2540 *   prm.declare_entry("End time",
2541 *   "1e8",
2542 *   Patterns::Double(0),
2543 *   "The end time of the simulation in years.");
2544 *   prm.declare_entry("Initial global refinement",
2545 *   "2",
2546 *   Patterns::Integer(0),
2547 *   "The number of global refinement steps performed on "
2548 *   "the initial coarse mesh, before the problem is first "
2549 *   "solved there.");
2550 *   prm.declare_entry("Initial adaptive refinement",
2551 *   "2",
2552 *   Patterns::Integer(0),
2553 *   "The number of adaptive refinement steps performed after "
2554 *   "initial global refinement.");
2555 *   prm.declare_entry("Time steps between mesh refinement",
2556 *   "10",
2557 *   Patterns::Integer(1),
2558 *   "The number of time steps after which the mesh is to be "
2559 *   "adapted based on computed error indicators.");
2560 *   prm.declare_entry("Generate graphical output",
2561 *   "false",
2562 *   Patterns::Bool(),
2563 *   "Whether graphical output is to be generated or not. "
2564 *   "You may not want to get graphical output if the number "
2565 *   "of processors is large.");
2566 *   prm.declare_entry("Time steps between graphical output",
2567 *   "50",
2568 *   Patterns::Integer(1),
2569 *   "The number of time steps between each generation of "
2570 *   "graphical output files.");
2571 *  
2572 *   prm.enter_subsection("Stabilization parameters");
2573 *   {
2574 *   prm.declare_entry("alpha",
2575 *   "2",
2576 *   Patterns::Double(1, 2),
2577 *   "The exponent in the entropy viscosity stabilization.");
2578 *   prm.declare_entry("c_R",
2579 *   "0.11",
2580 *   Patterns::Double(0),
2581 *   "The c_R factor in the entropy viscosity "
2582 *   "stabilization.");
2583 *   prm.declare_entry("beta",
2584 *   "0.078",
2585 *   Patterns::Double(0),
2586 *   "The beta factor in the artificial viscosity "
2587 *   "stabilization. An appropriate value for 2d is 0.052 "
2588 *   "and 0.078 for 3d.");
2589 *   }
2590 *   prm.leave_subsection();
2591 *  
2592 *   prm.enter_subsection("Discretization");
2593 *   {
2594 *   prm.declare_entry(
2595 *   "Stokes velocity polynomial degree",
2596 *   "2",
2597 *   Patterns::Integer(1),
2598 *   "The polynomial degree to use for the velocity variables "
2599 *   "in the Stokes system.");
2600 *   prm.declare_entry(
2601 *   "Temperature polynomial degree",
2602 *   "2",
2603 *   Patterns::Integer(1),
2604 *   "The polynomial degree to use for the temperature variable.");
2605 *   prm.declare_entry(
2606 *   "Use locally conservative discretization",
2607 *   "true",
2608 *   Patterns::Bool(),
2609 *   "Whether to use a Stokes discretization that is locally "
2610 *   "conservative at the expense of a larger number of degrees "
2611 *   "of freedom, or to go with a cheaper discretization "
2612 *   "that does not locally conserve mass (although it is "
2613 *   "globally conservative.");
2614 *   }
2615 *   prm.leave_subsection();
2616 *   }
2617 *  
2618 *  
2619 *  
2620 * @endcode
2621 *
2622 * And then we need a function that reads the contents of the
2623 * ParameterHandler object we get by reading the input file and puts the
2624 * results into variables that store the values of the parameters we have
2625 * previously declared:
2626 *
2627 * @code
2628 *   template <int dim>
2629 *   void BoussinesqFlowProblem<dim>::Parameters::parse_parameters(
2630 *   ParameterHandler &prm)
2631 *   {
2632 *   end_time = prm.get_double("End time");
2633 *   initial_global_refinement = prm.get_integer("Initial global refinement");
2634 *   initial_adaptive_refinement =
2635 *   prm.get_integer("Initial adaptive refinement");
2636 *  
2637 *   adaptive_refinement_interval =
2638 *   prm.get_integer("Time steps between mesh refinement");
2639 *  
2640 *   generate_graphical_output = prm.get_bool("Generate graphical output");
2641 *   graphical_output_interval =
2642 *   prm.get_integer("Time steps between graphical output");
2643 *  
2644 *   prm.enter_subsection("Stabilization parameters");
2645 *   {
2646 *   stabilization_alpha = prm.get_double("alpha");
2647 *   stabilization_c_R = prm.get_double("c_R");
2648 *   stabilization_beta = prm.get_double("beta");
2649 *   }
2650 *   prm.leave_subsection();
2651 *  
2652 *   prm.enter_subsection("Discretization");
2653 *   {
2654 *   stokes_velocity_degree =
2655 *   prm.get_integer("Stokes velocity polynomial degree");
2656 *   temperature_degree = prm.get_integer("Temperature polynomial degree");
2657 *   use_locally_conservative_discretization =
2658 *   prm.get_bool("Use locally conservative discretization");
2659 *   }
2660 *   prm.leave_subsection();
2661 *   }
2662 *  
2663 *  
2664 *  
2665 * @endcode
2666 *
2667 *
2668 * <a name="step_32-BoussinesqFlowProblemBoussinesqFlowProblem"></a>
2669 * <h4>BoussinesqFlowProblem::BoussinesqFlowProblem</h4>
2670 *
2671
2672 *
2673 * The constructor of the problem is very similar to the constructor in
2674 * @ref step_31 "step-31". What is different is the %parallel communication: Trilinos uses
2675 * a message passing interface (MPI) for data distribution. When entering
2676 * the BoussinesqFlowProblem class, we have to decide how the parallelization
2677 * is to be done. We choose a rather simple strategy and let all processors
2678 * that are running the program work together, specified by the communicator
2679 * <code>MPI_COMM_WORLD</code>. Next, we create the output stream (as we
2680 * already did in @ref step_18 "step-18") that only generates output on the first MPI
2681 * process and is completely forgetful on all others. The implementation of
2682 * this idea is to check the process number when <code>pcout</code> gets a
2683 * true argument, and it uses the <code>std::cout</code> stream for
2684 * output. If we are one processor five, for instance, then we will give a
2685 * <code>false</code> argument to <code>pcout</code>, which means that the
2686 * output of that processor will not be printed. With the exception of the
2687 * mapping object (for which we use polynomials of degree 4) all but the
2688 * final member variable are exactly the same as in @ref step_31 "step-31".
2689 *
2690
2691 *
2692 * This final object, the TimerOutput object, is then told to restrict
2693 * output to the <code>pcout</code> stream (processor 0), and then we
2694 * specify that we want to get a summary table at the end of the program
2695 * which shows us wallclock times (as opposed to CPU times). We will
2696 * manually also request intermediate summaries every so many time steps in
2697 * the <code>run()</code> function below.
2698 *
2699 * @code
2700 *   template <int dim>
2701 *   BoussinesqFlowProblem<dim>::BoussinesqFlowProblem(Parameters &parameters_)
2702 *   : parameters(parameters_)
2703 *   , pcout(std::cout, (Utilities::MPI::this_mpi_process(MPI_COMM_WORLD) == 0))
2704 *   ,
2705 *  
2706 *   triangulation(MPI_COMM_WORLD,
2710 *   ,
2711 *  
2712 *   global_Omega_diameter(0.)
2713 *   ,
2714 *  
2715 *   mapping(4)
2716 *   ,
2717 *  
2718 *   stokes_fe(FE_Q<dim>(parameters.stokes_velocity_degree) ^ dim,
2719 *   (parameters.use_locally_conservative_discretization ?
2720 *   static_cast<const FiniteElement<dim> &>(
2721 *   FE_DGP<dim>(parameters.stokes_velocity_degree - 1)) :
2722 *   static_cast<const FiniteElement<dim> &>(
2723 *   FE_Q<dim>(parameters.stokes_velocity_degree - 1))))
2724 *   ,
2725 *  
2726 *   stokes_dof_handler(triangulation)
2727 *   ,
2728 *  
2729 *   temperature_fe(parameters.temperature_degree)
2730 *   , temperature_dof_handler(triangulation)
2731 *   ,
2732 *  
2733 *   time_step(0)
2734 *   , old_time_step(0)
2735 *   , timestep_number(0)
2736 *   , rebuild_stokes_matrix(true)
2737 *   , rebuild_stokes_preconditioner(true)
2738 *   , rebuild_temperature_matrices(true)
2739 *   , rebuild_temperature_preconditioner(true)
2740 *   ,
2741 *  
2742 *   computing_timer(MPI_COMM_WORLD,
2743 *   pcout,
2744 *   TimerOutput::summary,
2745 *   TimerOutput::wall_times)
2746 *   {}
2747 *  
2748 *  
2749 *  
2750 * @endcode
2751 *
2752 *
2753 * <a name="step_32-TheBoussinesqFlowProblemhelperfunctions"></a>
2754 * <h4>The BoussinesqFlowProblem helper functions</h4>
2755 *
2756 * <a name="step_32-BoussinesqFlowProblemget_maximal_velocity"></a>
2757 * <h5>BoussinesqFlowProblem::get_maximal_velocity</h5>
2758 *
2759
2760 *
2761 * Except for two small details, the function to compute the global maximum
2762 * of the velocity is the same as in @ref step_31 "step-31". The first detail is actually
2763 * common to all functions that implement loops over all cells in the
2764 * triangulation: When operating in %parallel, each processor can only work
2765 * on a chunk of cells since each processor only has a certain part of the
2766 * entire triangulation. This chunk of cells that we want to work on is
2767 * identified via a so-called <code>subdomain_id</code>, as we also did in
2768 * @ref step_18 "step-18". All we need to change is hence to perform the cell-related
2769 * operations only on cells that are owned by the current process (as
2770 * opposed to ghost or artificial cells), i.e. for which the subdomain id
2771 * equals the number of the process ID. Since this is a commonly used
2772 * operation, there is a shortcut for this operation: we can ask whether the
2773 * cell is owned by the current processor using
2774 * <code>cell-@>is_locally_owned()</code>.
2775 *
2776
2777 *
2778 * The second difference is the way we calculate the maximum value. Before,
2779 * we could simply have a <code>double</code> variable that we checked
2780 * against on each quadrature point for each cell. Now, we have to be a bit
2781 * more careful since each processor only operates on a subset of
2782 * cells. What we do is to first let each processor calculate the maximum
2783 * among its cells, and then do a global communication operation
2784 * <code>Utilities::MPI::max</code> that computes the maximum value among
2785 * all the maximum values of the individual processors. MPI provides such a
2786 * call, but it's even simpler to use the respective function in namespace
2787 * Utilities::MPI using the MPI communicator object since that will do the
2788 * right thing even if we work without MPI and on a single machine only. The
2789 * call to <code>Utilities::MPI::max</code> needs two arguments, namely the
2790 * local maximum (input) and the MPI communicator, which is MPI_COMM_WORLD
2791 * in this example.
2792 *
2793 * @code
2794 *   template <int dim>
2795 *   double BoussinesqFlowProblem<dim>::get_maximal_velocity() const
2796 *   {
2797 *   const QIterated<dim> quadrature_formula(QTrapezoid<1>(),
2798 *   parameters.stokes_velocity_degree);
2799 *   const unsigned int n_q_points = quadrature_formula.size();
2800 *  
2801 *   FEValues<dim> fe_values(mapping,
2802 *   stokes_fe,
2803 *   quadrature_formula,
2804 *   update_values);
2805 *   std::vector<Tensor<1, dim>> velocity_values(n_q_points);
2806 *  
2807 *   const FEValuesExtractors::Vector velocities(0);
2808 *  
2809 *   double max_local_velocity = 0;
2810 *  
2811 *   for (const auto &cell : stokes_dof_handler.active_cell_iterators())
2812 *   if (cell->is_locally_owned())
2813 *   {
2814 *   fe_values.reinit(cell);
2815 *   fe_values[velocities].get_function_values(stokes_solution,
2816 *   velocity_values);
2817 *  
2818 *   for (unsigned int q = 0; q < n_q_points; ++q)
2819 *   max_local_velocity =
2820 *   std::max(max_local_velocity, velocity_values[q].norm());
2821 *   }
2822 *  
2823 *   return Utilities::MPI::max(max_local_velocity, MPI_COMM_WORLD);
2824 *   }
2825 *  
2826 *  
2827 * @endcode
2828 *
2829 *
2830 * <a name="step_32-BoussinesqFlowProblemget_cfl_number"></a>
2831 * <h5>BoussinesqFlowProblem::get_cfl_number</h5>
2832 *
2833
2834 *
2835 * The next function does something similar, but we now compute the CFL
2836 * number, i.e., maximal velocity on a cell divided by the cell
2837 * diameter. This number is necessary to determine the time step size, as we
2838 * use a semi-explicit time stepping scheme for the temperature equation
2839 * (see @ref step_31 "step-31" for a discussion). We compute it in the same way as above:
2840 * Compute the local maximum over all locally owned cells, then exchange it
2841 * via MPI to find the global maximum.
2842 *
2843 * @code
2844 *   template <int dim>
2845 *   double BoussinesqFlowProblem<dim>::get_cfl_number() const
2846 *   {
2847 *   const QIterated<dim> quadrature_formula(QTrapezoid<1>(),
2848 *   parameters.stokes_velocity_degree);
2849 *   const unsigned int n_q_points = quadrature_formula.size();
2850 *  
2851 *   FEValues<dim> fe_values(mapping,
2852 *   stokes_fe,
2853 *   quadrature_formula,
2854 *   update_values);
2855 *   std::vector<Tensor<1, dim>> velocity_values(n_q_points);
2856 *  
2857 *   const FEValuesExtractors::Vector velocities(0);
2858 *  
2859 *   double max_local_cfl = 0;
2860 *  
2861 *   for (const auto &cell : stokes_dof_handler.active_cell_iterators())
2862 *   if (cell->is_locally_owned())
2863 *   {
2864 *   fe_values.reinit(cell);
2865 *   fe_values[velocities].get_function_values(stokes_solution,
2866 *   velocity_values);
2867 *  
2868 *   double max_local_velocity = 1e-10;
2869 *   for (unsigned int q = 0; q < n_q_points; ++q)
2870 *   max_local_velocity =
2871 *   std::max(max_local_velocity, velocity_values[q].norm());
2872 *   max_local_cfl =
2873 *   std::max(max_local_cfl, max_local_velocity / cell->diameter());
2874 *   }
2875 *  
2876 *   return Utilities::MPI::max(max_local_cfl, MPI_COMM_WORLD);
2877 *   }
2878 *  
2879 *  
2880 * @endcode
2881 *
2882 *
2883 * <a name="step_32-BoussinesqFlowProblemget_entropy_variation"></a>
2884 * <h5>BoussinesqFlowProblem::get_entropy_variation</h5>
2885 *
2886
2887 *
2888 * Next comes the computation of the global entropy variation
2889 * @f$\|E(T)-\bar{E}(T)\|_\infty@f$ where the entropy @f$E@f$ is defined as
2890 * discussed in the introduction. This is needed for the evaluation of the
2891 * stabilization in the temperature equation as explained in the
2892 * introduction. The entropy variation is actually only needed if we use
2893 * @f$\alpha=2@f$ as a power in the residual computation. The infinity norm is
2894 * computed by the maxima over quadrature points, as usual in discrete
2895 * computations.
2896 *
2897
2898 *
2899 * In order to compute this quantity, we first have to find the
2900 * space-average @f$\bar{E}(T)@f$ and then evaluate the maximum. However, that
2901 * means that we would need to perform two loops. We can avoid the overhead
2902 * by noting that @f$\|E(T)-\bar{E}(T)\|_\infty =
2903 * \max\big(E_{\textrm{max}}(T)-\bar{E}(T),
2904 * \bar{E}(T)-E_{\textrm{min}}(T)\big)@f$, i.e., the maximum out of the
2905 * deviation from the average entropy in positive and negative
2906 * directions. The four quantities we need for the latter formula (maximum
2907 * entropy, minimum entropy, average entropy, area) can all be evaluated in
2908 * the same loop over all cells, so we choose this simpler variant.
2909 *
2910 * @code
2911 *   template <int dim>
2912 *   double BoussinesqFlowProblem<dim>::get_entropy_variation(
2913 *   const double average_temperature) const
2914 *   {
2915 *   if (parameters.stabilization_alpha != 2)
2916 *   return 1.;
2917 *  
2918 *   const QGauss<dim> quadrature_formula(parameters.temperature_degree + 1);
2919 *   const unsigned int n_q_points = quadrature_formula.size();
2920 *  
2921 *   FEValues<dim> fe_values(temperature_fe,
2922 *   quadrature_formula,
2923 *   update_values | update_JxW_values);
2924 *   std::vector<double> old_temperature_values(n_q_points);
2925 *   std::vector<double> old_old_temperature_values(n_q_points);
2926 *  
2927 * @endcode
2928 *
2929 * In the two functions above we computed the maximum of numbers that were
2930 * all non-negative, so we knew that zero was certainly a lower bound. On
2931 * the other hand, here we need to find the maximum deviation from the
2932 * average value, i.e., we will need to know the maximal and minimal
2933 * values of the entropy for which we don't a priori know the sign.
2934 *
2935
2936 *
2937 * To compute it, we can therefore start with the largest and smallest
2938 * possible values we can store in a double precision number: The minimum
2939 * is initialized with a bigger and the maximum with a smaller number than
2940 * any one that is going to appear. We are then guaranteed that these
2941 * numbers will be overwritten in the loop on the first cell or, if this
2942 * processor does not own any cells, in the communication step at the
2943 * latest. The following loop then computes the minimum and maximum local
2944 * entropy as well as keeps track of the area/volume of the part of the
2945 * domain we locally own and the integral over the entropy on it:
2946 *
2947 * @code
2948 *   double min_entropy = std::numeric_limits<double>::max(),
2949 *   max_entropy = -std::numeric_limits<double>::max(), area = 0,
2950 *   entropy_integrated = 0;
2951 *  
2952 *   for (const auto &cell : temperature_dof_handler.active_cell_iterators())
2953 *   if (cell->is_locally_owned())
2954 *   {
2955 *   fe_values.reinit(cell);
2956 *   fe_values.get_function_values(old_temperature_solution,
2957 *   old_temperature_values);
2958 *   fe_values.get_function_values(old_old_temperature_solution,
2959 *   old_old_temperature_values);
2960 *   for (unsigned int q = 0; q < n_q_points; ++q)
2961 *   {
2962 *   const double T =
2963 *   (old_temperature_values[q] + old_old_temperature_values[q]) / 2;
2964 *   const double entropy =
2965 *   ((T - average_temperature) * (T - average_temperature));
2966 *  
2967 *   min_entropy = std::min(min_entropy, entropy);
2968 *   max_entropy = std::max(max_entropy, entropy);
2969 *   area += fe_values.JxW(q);
2970 *   entropy_integrated += fe_values.JxW(q) * entropy;
2971 *   }
2972 *   }
2973 *  
2974 * @endcode
2975 *
2976 * Now we only need to exchange data between processors: we need to sum
2977 * the two integrals (<code>area</code>, <code>entropy_integrated</code>),
2978 * and get the extrema for maximum and minimum. We could do this through
2979 * four different data exchanges, but we can it with two:
2980 * Utilities::MPI::sum also exists in a variant that takes an array of
2981 * values that are all to be summed up. And we can also utilize the
2982 * Utilities::MPI::max function by realizing that forming the minimum over
2983 * the minimal entropies equals forming the negative of the maximum over
2984 * the negative of the minimal entropies; this maximum can then be
2985 * combined with forming the maximum over the maximal entropies.
2986 *
2987 * @code
2988 *   const double local_sums[2] = {entropy_integrated, area},
2989 *   local_maxima[2] = {-min_entropy, max_entropy};
2990 *   double global_sums[2], global_maxima[2];
2991 *  
2992 *   Utilities::MPI::sum(local_sums, MPI_COMM_WORLD, global_sums);
2993 *   Utilities::MPI::max(local_maxima, MPI_COMM_WORLD, global_maxima);
2994 *  
2995 * @endcode
2996 *
2997 * Having computed everything this way, we can then compute the average
2998 * entropy and find the @f$L^\infty@f$ norm by taking the larger of the
2999 * deviation of the maximum or minimum from the average:
3000 *
3001 * @code
3002 *   const double average_entropy = global_sums[0] / global_sums[1];
3003 *   const double entropy_diff = std::max(global_maxima[1] - average_entropy,
3004 *   average_entropy - (-global_maxima[0]));
3005 *   return entropy_diff;
3006 *   }
3007 *  
3008 *  
3009 *  
3010 * @endcode
3011 *
3012 *
3013 * <a name="step_32-BoussinesqFlowProblemget_extrapolated_temperature_range"></a>
3014 * <h5>BoussinesqFlowProblem::get_extrapolated_temperature_range</h5>
3015 *
3016
3017 *
3018 * The next function computes the minimal and maximal value of the
3019 * extrapolated temperature over the entire domain. Again, this is only a
3020 * slightly modified version of the respective function in @ref step_31 "step-31". As in
3021 * the function above, we collect local minima and maxima and then compute
3022 * the global extrema using the same trick as above.
3023 *
3024
3025 *
3026 * As already discussed in @ref step_31 "step-31", the function needs to distinguish
3027 * between the first and all following time steps because it uses a higher
3028 * order temperature extrapolation scheme when at least two previous time
3029 * steps are available.
3030 *
3031 * @code
3032 *   template <int dim>
3033 *   std::pair<double, double>
3034 *   BoussinesqFlowProblem<dim>::get_extrapolated_temperature_range() const
3035 *   {
3036 *   const QIterated<dim> quadrature_formula(QTrapezoid<1>(),
3037 *   parameters.temperature_degree);
3038 *   const unsigned int n_q_points = quadrature_formula.size();
3039 *  
3040 *   FEValues<dim> fe_values(mapping,
3041 *   temperature_fe,
3042 *   quadrature_formula,
3043 *   update_values);
3044 *   std::vector<double> old_temperature_values(n_q_points);
3045 *   std::vector<double> old_old_temperature_values(n_q_points);
3046 *  
3047 *   double min_local_temperature = std::numeric_limits<double>::max(),
3048 *   max_local_temperature = -std::numeric_limits<double>::max();
3049 *  
3050 *   if (timestep_number != 0)
3051 *   {
3052 *   for (const auto &cell : temperature_dof_handler.active_cell_iterators())
3053 *   if (cell->is_locally_owned())
3054 *   {
3055 *   fe_values.reinit(cell);
3056 *   fe_values.get_function_values(old_temperature_solution,
3057 *   old_temperature_values);
3058 *   fe_values.get_function_values(old_old_temperature_solution,
3059 *   old_old_temperature_values);
3060 *  
3061 *   for (unsigned int q = 0; q < n_q_points; ++q)
3062 *   {
3063 *   const double temperature =
3064 *   (1. + time_step / old_time_step) *
3065 *   old_temperature_values[q] -
3066 *   time_step / old_time_step * old_old_temperature_values[q];
3067 *  
3068 *   min_local_temperature =
3069 *   std::min(min_local_temperature, temperature);
3070 *   max_local_temperature =
3071 *   std::max(max_local_temperature, temperature);
3072 *   }
3073 *   }
3074 *   }
3075 *   else
3076 *   {
3077 *   for (const auto &cell : temperature_dof_handler.active_cell_iterators())
3078 *   if (cell->is_locally_owned())
3079 *   {
3080 *   fe_values.reinit(cell);
3081 *   fe_values.get_function_values(old_temperature_solution,
3082 *   old_temperature_values);
3083 *  
3084 *   for (unsigned int q = 0; q < n_q_points; ++q)
3085 *   {
3086 *   const double temperature = old_temperature_values[q];
3087 *  
3088 *   min_local_temperature =
3089 *   std::min(min_local_temperature, temperature);
3090 *   max_local_temperature =
3091 *   std::max(max_local_temperature, temperature);
3092 *   }
3093 *   }
3094 *   }
3095 *  
3096 *   double local_extrema[2] = {-min_local_temperature, max_local_temperature};
3097 *   double global_extrema[2];
3098 *   Utilities::MPI::max(local_extrema, MPI_COMM_WORLD, global_extrema);
3099 *  
3100 *   return std::make_pair(-global_extrema[0], global_extrema[1]);
3101 *   }
3102 *  
3103 *  
3104 * @endcode
3105 *
3106 *
3107 * <a name="step_32-BoussinesqFlowProblemcompute_viscosity"></a>
3108 * <h5>BoussinesqFlowProblem::compute_viscosity</h5>
3109 *
3110
3111 *
3112 * The function that calculates the viscosity is purely local and so needs
3113 * no communication at all. It is mostly the same as in @ref step_31 "step-31" but with an
3114 * updated formulation of the viscosity if @f$\alpha=2@f$ is chosen:
3115 *
3116 * @code
3117 *   template <int dim>
3118 *   double BoussinesqFlowProblem<dim>::compute_viscosity(
3119 *   const std::vector<double> &old_temperature,
3120 *   const std::vector<double> &old_old_temperature,
3121 *   const std::vector<Tensor<1, dim>> &old_temperature_grads,
3122 *   const std::vector<Tensor<1, dim>> &old_old_temperature_grads,
3123 *   const std::vector<double> &old_temperature_laplacians,
3124 *   const std::vector<double> &old_old_temperature_laplacians,
3125 *   const std::vector<Tensor<1, dim>> &old_velocity_values,
3126 *   const std::vector<Tensor<1, dim>> &old_old_velocity_values,
3127 *   const std::vector<SymmetricTensor<2, dim>> &old_strain_rates,
3128 *   const std::vector<SymmetricTensor<2, dim>> &old_old_strain_rates,
3129 *   const double global_u_infty,
3130 *   const double global_T_variation,
3131 *   const double average_temperature,
3132 *   const double global_entropy_variation,
3133 *   const double cell_diameter) const
3134 *   {
3135 *   if (global_u_infty == 0)
3136 *   return 5e-3 * cell_diameter;
3137 *  
3138 *   const unsigned int n_q_points = old_temperature.size();
3139 *  
3140 *   double max_residual = 0;
3141 *   double max_velocity = 0;
3142 *  
3143 *   for (unsigned int q = 0; q < n_q_points; ++q)
3144 *   {
3145 *   const Tensor<1, dim> u =
3146 *   (old_velocity_values[q] + old_old_velocity_values[q]) / 2;
3147 *  
3148 *   const SymmetricTensor<2, dim> strain_rate =
3149 *   (old_strain_rates[q] + old_old_strain_rates[q]) / 2;
3150 *  
3151 *   const double T = (old_temperature[q] + old_old_temperature[q]) / 2;
3152 *   const double dT_dt =
3153 *   (old_temperature[q] - old_old_temperature[q]) / old_time_step;
3154 *   const double u_grad_T =
3155 *   u * (old_temperature_grads[q] + old_old_temperature_grads[q]) / 2;
3156 *  
3157 *   const double kappa_Delta_T =
3158 *   EquationData::kappa *
3159 *   (old_temperature_laplacians[q] + old_old_temperature_laplacians[q]) /
3160 *   2;
3161 *   const double gamma =
3162 *   ((EquationData::radiogenic_heating * EquationData::density(T) +
3163 *   2 * EquationData::eta * strain_rate * strain_rate) /
3164 *   (EquationData::density(T) * EquationData::specific_heat));
3165 *  
3166 *   double residual = std::abs(dT_dt + u_grad_T - kappa_Delta_T - gamma);
3167 *   if (parameters.stabilization_alpha == 2)
3168 *   residual *= std::abs(T - average_temperature);
3169 *  
3170 *   max_residual = std::max(residual, max_residual);
3171 *   max_velocity = std::max(std::sqrt(u * u), max_velocity);
3172 *   }
3173 *  
3174 *   const double max_viscosity =
3175 *   (parameters.stabilization_beta * max_velocity * cell_diameter);
3176 *   if (timestep_number == 0)
3177 *   return max_viscosity;
3178 *   else
3179 *   {
3180 *   Assert(old_time_step > 0, ExcInternalError());
3181 *  
3182 *   double entropy_viscosity;
3183 *   if (parameters.stabilization_alpha == 2)
3184 *   entropy_viscosity =
3185 *   (parameters.stabilization_c_R * cell_diameter * cell_diameter *
3186 *   max_residual / global_entropy_variation);
3187 *   else
3188 *   entropy_viscosity =
3189 *   (parameters.stabilization_c_R * cell_diameter *
3190 *   global_Omega_diameter * max_velocity * max_residual /
3191 *   (global_u_infty * global_T_variation));
3192 *  
3193 *   return std::min(max_viscosity, entropy_viscosity);
3194 *   }
3195 *   }
3196 *  
3197 *  
3198 *  
3199 * @endcode
3200 *
3201 *
3202 * <a name="step_32-TheBoussinesqFlowProblemsetupfunctions"></a>
3203 * <h4>The BoussinesqFlowProblem setup functions</h4>
3204 *
3205
3206 *
3207 * The following three functions set up the Stokes matrix, the matrix used
3208 * for the Stokes preconditioner, and the temperature matrix. The code is
3209 * mostly the same as in @ref step_31 "step-31", but it has been broken out into three
3210 * functions of their own for simplicity.
3211 *
3212
3213 *
3214 * The main functional difference between the code here and that in @ref step_31 "step-31"
3215 * is that the matrices we want to set up are distributed across multiple
3216 * processors. Since we still want to build up the sparsity pattern first
3217 * for efficiency reasons, we could continue to build the <i>entire</i>
3218 * sparsity pattern as a BlockDynamicSparsityPattern, as we did in
3219 * @ref step_31 "step-31". However, that would be inefficient: every processor would build
3220 * the same sparsity pattern, but only initialize a small part of the matrix
3221 * using it. It also violates the principle that every processor should only
3222 * work on those cells it owns (and, if necessary the layer of ghost cells
3223 * around it).
3224 *
3225
3226 *
3227 * Rather, we use an object of type TrilinosWrappers::BlockSparsityPattern,
3228 * which is (obviously) a wrapper around a sparsity pattern object provided
3229 * by Trilinos. The advantage is that the Trilinos sparsity pattern class
3230 * can communicate across multiple processors: if this processor fills in
3231 * all the nonzero entries that result from the cells it owns, and every
3232 * other processor does so as well, then at the end after some MPI
3233 * communication initiated by the <code>compress()</code> call, we will have
3234 * the globally assembled sparsity pattern available with which the global
3235 * matrix can be initialized.
3236 *
3237
3238 *
3239 * There is one important aspect when initializing Trilinos sparsity
3240 * patterns in parallel: In addition to specifying the locally owned rows
3241 * and columns of the matrices via the @p stokes_partitioning index set, we
3242 * also supply information about all the rows we are possibly going to write
3243 * into when assembling on a certain processor. The set of locally relevant
3244 * rows contains all such rows (possibly also a few unnecessary ones, but it
3245 * is difficult to find the exact row indices before actually getting
3246 * indices on all cells and resolving constraints). This additional
3247 * information allows to exactly determine the structure for the
3248 * off-processor data found during assembly. While Trilinos matrices are
3249 * able to collect this information on the fly as well (when initializing
3250 * them from some other reinit method), it is less efficient and leads to
3251 * problems when assembling matrices with multiple threads. In this program,
3252 * we pessimistically assume that only one processor at a time can write
3253 * into the matrix while assembly (whereas the computation is parallel),
3254 * which is fine for Trilinos matrices. In practice, one can do better by
3255 * hinting WorkStream at cells that do not share vertices, allowing for
3256 * parallelism among those cells (see the graph coloring algorithms and
3257 * WorkStream with colored iterators argument). However, that only works
3258 * when only one MPI processor is present because Trilinos' internal data
3259 * structures for accumulating off-processor data on the fly are not thread
3260 * safe. With the initialization presented here, there is no such problem
3261 * and one could safely introduce graph coloring for this algorithm.
3262 *
3263
3264 *
3265 * The only other change we need to make is to tell the
3266 * DoFTools::make_sparsity_pattern() function that it is only supposed to
3267 * work on a subset of cells, namely the ones whose
3268 * <code>subdomain_id</code> equals the number of the current processor, and
3269 * to ignore all other cells.
3270 *
3271
3272 *
3273 * This strategy is replicated across all three of the following functions.
3274 *
3275
3276 *
3277 * Note that Trilinos matrices store the information contained in the
3278 * sparsity patterns, so we can safely release the <code>sp</code> variable
3279 * once the matrix has been given the sparsity structure.
3280 *
3281 * @code
3282 *   template <int dim>
3283 *   void BoussinesqFlowProblem<dim>::setup_stokes_matrix(
3284 *   const std::vector<IndexSet> &stokes_partitioning,
3285 *   const std::vector<IndexSet> &stokes_relevant_partitioning)
3286 *   {
3287 *   stokes_matrix.clear();
3288 *  
3289 *   TrilinosWrappers::BlockSparsityPattern sp(stokes_partitioning,
3290 *   stokes_partitioning,
3291 *   stokes_relevant_partitioning,
3292 *   MPI_COMM_WORLD);
3293 *  
3294 *   Table<2, DoFTools::Coupling> coupling(dim + 1, dim + 1);
3295 *   for (unsigned int c = 0; c < dim + 1; ++c)
3296 *   for (unsigned int d = 0; d < dim + 1; ++d)
3297 *   if (!((c == dim) && (d == dim)))
3298 *   coupling[c][d] = DoFTools::always;
3299 *   else
3300 *   coupling[c][d] = DoFTools::none;
3301 *  
3302 *   DoFTools::make_sparsity_pattern(stokes_dof_handler,
3303 *   coupling,
3304 *   sp,
3305 *   stokes_constraints,
3306 *   false,
3307 *   Utilities::MPI::this_mpi_process(
3308 *   MPI_COMM_WORLD));
3309 *   sp.compress();
3310 *  
3311 *   stokes_matrix.reinit(sp);
3312 *   }
3313 *  
3314 *  
3315 *  
3316 *   template <int dim>
3317 *   void BoussinesqFlowProblem<dim>::setup_stokes_preconditioner(
3318 *   const std::vector<IndexSet> &stokes_partitioning,
3319 *   const std::vector<IndexSet> &stokes_relevant_partitioning)
3320 *   {
3321 *   Amg_preconditioner.reset();
3322 *   Mp_preconditioner.reset();
3323 *  
3324 *   stokes_preconditioner_matrix.clear();
3325 *  
3326 *   TrilinosWrappers::BlockSparsityPattern sp(stokes_partitioning,
3327 *   stokes_partitioning,
3328 *   stokes_relevant_partitioning,
3329 *   MPI_COMM_WORLD);
3330 *  
3331 *   Table<2, DoFTools::Coupling> coupling(dim + 1, dim + 1);
3332 *   for (unsigned int c = 0; c < dim + 1; ++c)
3333 *   for (unsigned int d = 0; d < dim + 1; ++d)
3334 *   if (c == d)
3335 *   coupling[c][d] = DoFTools::always;
3336 *   else
3337 *   coupling[c][d] = DoFTools::none;
3338 *  
3339 *   DoFTools::make_sparsity_pattern(stokes_dof_handler,
3340 *   coupling,
3341 *   sp,
3342 *   stokes_constraints,
3343 *   false,
3344 *   Utilities::MPI::this_mpi_process(
3345 *   MPI_COMM_WORLD));
3346 *   sp.compress();
3347 *  
3348 *   stokes_preconditioner_matrix.reinit(sp);
3349 *   }
3350 *  
3351 *  
3352 *   template <int dim>
3353 *   void BoussinesqFlowProblem<dim>::setup_temperature_matrices(
3354 *   const IndexSet &temperature_partitioner,
3355 *   const IndexSet &temperature_relevant_partitioner)
3356 *   {
3357 *   T_preconditioner.reset();
3358 *   temperature_mass_matrix.clear();
3359 *   temperature_stiffness_matrix.clear();
3360 *   temperature_matrix.clear();
3361 *  
3362 *   TrilinosWrappers::SparsityPattern sp(temperature_partitioner,
3363 *   temperature_partitioner,
3364 *   temperature_relevant_partitioner,
3365 *   MPI_COMM_WORLD);
3366 *   DoFTools::make_sparsity_pattern(temperature_dof_handler,
3367 *   sp,
3368 *   temperature_constraints,
3369 *   false,
3370 *   Utilities::MPI::this_mpi_process(
3371 *   MPI_COMM_WORLD));
3372 *   sp.compress();
3373 *  
3374 *   temperature_matrix.reinit(sp);
3375 *   temperature_mass_matrix.reinit(sp);
3376 *   temperature_stiffness_matrix.reinit(sp);
3377 *   }
3378 *  
3379 *  
3380 *  
3381 * @endcode
3382 *
3383 * The remainder of the setup function (after splitting out the three
3384 * functions above) mostly has to deal with the things we need to do for
3385 * parallelization across processors. Because setting all of this up is a
3386 * significant compute time expense of the program, we put everything we do
3387 * here into a timer group so that we can get summary information about the
3388 * fraction of time spent in this part of the program at its end.
3389 *
3390
3391 *
3392 * At the top as usual we enumerate degrees of freedom and sort them by
3393 * component/block, followed by writing their numbers to the screen from
3394 * processor zero. The DoFHandler::distributed_dofs() function, when applied
3395 * to a parallel::distributed::Triangulation object, sorts degrees of
3396 * freedom in such a way that all degrees of freedom associated with
3397 * subdomain zero come before all those associated with subdomain one,
3398 * etc. For the Stokes part, this entails, however, that velocities and
3399 * pressures become intermixed, but this is trivially solved by sorting
3400 * again by blocks; it is worth noting that this latter operation leaves the
3401 * relative ordering of all velocities and pressures alone, i.e. within the
3402 * velocity block we will still have all those associated with subdomain
3403 * zero before all velocities associated with subdomain one, etc. This is
3404 * important since we store each of the blocks of this matrix distributed
3405 * across all processors and want this to be done in such a way that each
3406 * processor stores that part of the matrix that is roughly equal to the
3407 * degrees of freedom located on those cells that it will actually work on.
3408 *
3409
3410 *
3411 * When printing the numbers of degrees of freedom, note that these numbers
3412 * are going to be large if we use many processors. Consequently, we let the
3413 * stream put a comma separator in between every three digits. The state of
3414 * the stream, using the locale, is saved from before to after this
3415 * operation. While slightly opaque, the code works because the default
3416 * locale (which we get using the constructor call
3417 * <code>std::locale("")</code>) implies printing numbers with a comma
3418 * separator for every third digit (i.e., thousands, millions, billions).
3419 *
3420
3421 *
3422 * In this function as well as many below, we measure how much time
3423 * we spend here and collect that in a section called "Setup dof
3424 * systems" across function invocations. This is done using an
3425 * TimerOutput::Scope object that gets a timer going in the section
3426 * with above name of the `computing_timer` object upon construction
3427 * of the local variable; the timer is stopped again when the
3428 * destructor of the `timing_section` variable is called. This, of
3429 * course, happens either at the end of the function, or if we leave
3430 * the function through a `return` statement or when an exception is
3431 * thrown somewhere -- in other words, whenever we leave this
3432 * function in any way. The use of such "scope" objects therefore
3433 * makes sure that we do not have to manually add code that tells
3434 * the timer to stop at every location where this function may be
3435 * left.
3436 *
3437 * @code
3438 *   template <int dim>
3439 *   void BoussinesqFlowProblem<dim>::setup_dofs()
3440 *   {
3441 *   TimerOutput::Scope timing_section(computing_timer, "Setup dof systems");
3442 *  
3443 *   stokes_dof_handler.distribute_dofs(stokes_fe);
3444 *  
3445 *   std::vector<unsigned int> stokes_sub_blocks(dim + 1, 0);
3446 *   stokes_sub_blocks[dim] = 1;
3447 *   DoFRenumbering::component_wise(stokes_dof_handler, stokes_sub_blocks);
3448 *  
3449 *   temperature_dof_handler.distribute_dofs(temperature_fe);
3450 *  
3451 *   const std::vector<types::global_dof_index> stokes_dofs_per_block =
3452 *   DoFTools::count_dofs_per_fe_block(stokes_dof_handler, stokes_sub_blocks);
3453 *  
3454 *   const types::global_dof_index n_u = stokes_dofs_per_block[0],
3455 *   n_p = stokes_dofs_per_block[1],
3456 *   n_T = temperature_dof_handler.n_dofs();
3457 *  
3458 *   std::locale s = pcout.get_stream().getloc();
3459 *   pcout.get_stream().imbue(std::locale(""));
3460 *   pcout << "Number of active cells: " << triangulation.n_global_active_cells()
3461 *   << " (on " << triangulation.n_levels() << " levels)" << std::endl
3462 *   << "Number of degrees of freedom: " << n_u + n_p + n_T << " (" << n_u
3463 *   << '+' << n_p << '+' << n_T << ')' << std::endl
3464 *   << std::endl;
3465 *   pcout.get_stream().imbue(s);
3466 *  
3467 *  
3468 * @endcode
3469 *
3470 * After this, we have to set up the various partitioners (of type
3471 * <code>IndexSet</code>, see the introduction) that describe which parts
3472 * of each matrix or vector will be stored where, then call the functions
3473 * that actually set up the matrices, and at the end also resize the
3474 * various vectors we keep around in this program.
3475 *
3476
3477 *
3478 *
3479 * @code
3480 *   const IndexSet &stokes_locally_owned_index_set =
3481 *   stokes_dof_handler.locally_owned_dofs();
3482 *   const IndexSet stokes_locally_relevant_set =
3483 *   DoFTools::extract_locally_relevant_dofs(stokes_dof_handler);
3484 *  
3485 *   std::vector<IndexSet> stokes_partitioning;
3486 *   stokes_partitioning.push_back(
3487 *   stokes_locally_owned_index_set.get_view(0, n_u));
3488 *   stokes_partitioning.push_back(
3489 *   stokes_locally_owned_index_set.get_view(n_u, n_u + n_p));
3490 *  
3491 *   std::vector<IndexSet> stokes_relevant_partitioning;
3492 *   stokes_relevant_partitioning.push_back(
3493 *   stokes_locally_relevant_set.get_view(0, n_u));
3494 *   stokes_relevant_partitioning.push_back(
3495 *   stokes_locally_relevant_set.get_view(n_u, n_u + n_p));
3496 *  
3497 *   const IndexSet temperature_partitioning =
3498 *   temperature_dof_handler.locally_owned_dofs();
3499 *   const IndexSet temperature_relevant_partitioning =
3500 *   DoFTools::extract_locally_relevant_dofs(temperature_dof_handler);
3501 *  
3502 * @endcode
3503 *
3504 * Following this, we can compute constraints for the solution vectors,
3505 * including hanging node constraints and homogeneous and inhomogeneous
3506 * boundary values for the Stokes and temperature fields. Note that as for
3507 * everything else, the constraint objects can not hold <i>all</i>
3508 * constraints on every processor. Rather, each processor needs to store
3509 * only those that are actually necessary for correctness given that it
3510 * only assembles linear systems on cells it owns. As discussed in the
3511 * @ref distributed_paper "this paper", the set of constraints we need to
3512 * know about is exactly the set of constraints on all locally relevant
3513 * degrees of freedom, so this is what we use to initialize the constraint
3514 * objects.
3515 *
3516 * @code
3517 *   {
3518 *   stokes_constraints.clear();
3519 *   stokes_constraints.reinit(stokes_locally_owned_index_set,
3520 *   stokes_locally_relevant_set);
3521 *  
3522 *   DoFTools::make_hanging_node_constraints(stokes_dof_handler,
3523 *   stokes_constraints);
3524 *  
3525 *   const FEValuesExtractors::Vector velocity_components(0);
3526 *   VectorTools::interpolate_boundary_values(
3527 *   stokes_dof_handler,
3528 *   0,
3529 *   Functions::ZeroFunction<dim>(dim + 1),
3530 *   stokes_constraints,
3531 *   stokes_fe.component_mask(velocity_components));
3532 *  
3533 *   std::set<types::boundary_id> no_normal_flux_boundaries;
3534 *   no_normal_flux_boundaries.insert(1);
3535 *   VectorTools::compute_no_normal_flux_constraints(stokes_dof_handler,
3536 *   0,
3537 *   no_normal_flux_boundaries,
3538 *   stokes_constraints,
3539 *   mapping);
3540 *   stokes_constraints.close();
3541 *   }
3542 *   {
3543 *   temperature_constraints.clear();
3544 *   temperature_constraints.reinit(temperature_partitioning,
3545 *   temperature_relevant_partitioning);
3546 *  
3547 *   DoFTools::make_hanging_node_constraints(temperature_dof_handler,
3548 *   temperature_constraints);
3549 *   VectorTools::interpolate_boundary_values(
3550 *   temperature_dof_handler,
3551 *   0,
3552 *   EquationData::TemperatureInitialValues<dim>(),
3553 *   temperature_constraints);
3554 *   VectorTools::interpolate_boundary_values(
3555 *   temperature_dof_handler,
3556 *   1,
3557 *   EquationData::TemperatureInitialValues<dim>(),
3558 *   temperature_constraints);
3559 *   temperature_constraints.close();
3560 *   }
3561 *  
3562 * @endcode
3563 *
3564 * All this done, we can then initialize the various matrix and vector
3565 * objects to their proper sizes. At the end, we also record that all
3566 * matrices and preconditioners have to be re-computed at the beginning of
3567 * the next time step. Note how we initialize the vectors for the Stokes
3568 * and temperature right hand sides: These are writable vectors (last
3569 * boolean argument set to @p true) that have the correct one-to-one
3570 * partitioning of locally owned elements but are still given the relevant
3571 * partitioning for means of figuring out the vector entries that are
3572 * going to be set right away. As for matrices, this allows for writing
3573 * local contributions into the vector with multiple threads (always
3574 * assuming that the same vector entry is not accessed by multiple threads
3575 * at the same time). The other vectors only allow for read access of
3576 * individual elements, including ghosts, but are not suitable for
3577 * solvers.
3578 *
3579 * @code
3580 *   setup_stokes_matrix(stokes_partitioning, stokes_relevant_partitioning);
3581 *   setup_stokes_preconditioner(stokes_partitioning,
3582 *   stokes_relevant_partitioning);
3583 *   setup_temperature_matrices(temperature_partitioning,
3584 *   temperature_relevant_partitioning);
3585 *  
3586 *   stokes_rhs.reinit(stokes_partitioning,
3587 *   stokes_relevant_partitioning,
3588 *   MPI_COMM_WORLD,
3589 *   true);
3590 *   stokes_solution.reinit(stokes_relevant_partitioning, MPI_COMM_WORLD);
3591 *   old_stokes_solution.reinit(stokes_solution);
3592 *  
3593 *   temperature_rhs.reinit(temperature_partitioning,
3594 *   temperature_relevant_partitioning,
3595 *   MPI_COMM_WORLD,
3596 *   true);
3597 *   temperature_solution.reinit(temperature_relevant_partitioning,
3598 *   MPI_COMM_WORLD);
3599 *   old_temperature_solution.reinit(temperature_solution);
3600 *   old_old_temperature_solution.reinit(temperature_solution);
3601 *  
3602 *   rebuild_stokes_matrix = true;
3603 *   rebuild_stokes_preconditioner = true;
3604 *   rebuild_temperature_matrices = true;
3605 *   rebuild_temperature_preconditioner = true;
3606 *   }
3607 *  
3608 *  
3609 *  
3610 * @endcode
3611 *
3612 *
3613 * <a name="step_32-TheBoussinesqFlowProblemassemblyfunctions"></a>
3614 * <h4>The BoussinesqFlowProblem assembly functions</h4>
3615 *
3616
3617 *
3618 * Following the discussion in the introduction and in the @ref threads
3619 * topic, we split the assembly functions into different parts:
3620 *
3621
3622 *
3623 * <ul> <li> The local calculations of matrices and right hand sides, given
3624 * a certain cell as input (these functions are named
3625 * <code>local_assemble_*</code> below). The resulting function is, in other
3626 * words, essentially the body of the loop over all cells in @ref step_31 "step-31". Note,
3627 * however, that these functions store the result from the local
3628 * calculations in variables of classes from the CopyData namespace.
3629 *
3630
3631 *
3632 * <li>These objects are then given to the second step which writes the
3633 * local data into the global data structures (these functions are named
3634 * <code>copy_local_to_global_*</code> below). These functions are pretty
3635 * trivial.
3636 *
3637
3638 *
3639 * <li>These two subfunctions are then used in the respective assembly
3640 * routine (called <code>assemble_*</code> below), where a WorkStream object
3641 * is set up and runs over all the cells that belong to the processor's
3642 * subdomain. </ul>
3643 *
3644
3645 *
3646 *
3647 * <a name="step_32-Stokespreconditionerassembly"></a>
3648 * <h5>Stokes preconditioner assembly</h5>
3649 *
3650
3651 *
3652 * Let us start with the functions that builds the Stokes
3653 * preconditioner. The first two of these are pretty trivial, given the
3654 * discussion above. Note in particular that the main point in using the
3655 * scratch data object is that we want to avoid allocating any objects on
3656 * the free space each time we visit a new cell. As a consequence, the
3657 * assembly function below only has automatic local variables, and
3658 * everything else is accessed through the scratch data object, which is
3659 * allocated only once before we start the loop over all cells:
3660 *
3661 * @code
3662 *   template <int dim>
3663 *   void BoussinesqFlowProblem<dim>::local_assemble_stokes_preconditioner(
3664 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
3665 *   Assembly::Scratch::StokesPreconditioner<dim> &scratch,
3666 *   Assembly::CopyData::StokesPreconditioner<dim> &data)
3667 *   {
3668 *   const unsigned int dofs_per_cell = stokes_fe.n_dofs_per_cell();
3669 *   const unsigned int n_q_points =
3670 *   scratch.stokes_fe_values.n_quadrature_points;
3671 *  
3672 *   const FEValuesExtractors::Vector velocities(0);
3673 *   const FEValuesExtractors::Scalar pressure(dim);
3674 *  
3675 *   scratch.stokes_fe_values.reinit(cell);
3676 *   cell->get_dof_indices(data.local_dof_indices);
3677 *  
3678 *   data.local_matrix = 0;
3679 *  
3680 *   for (unsigned int q = 0; q < n_q_points; ++q)
3681 *   {
3682 *   for (unsigned int k = 0; k < dofs_per_cell; ++k)
3683 *   {
3684 *   scratch.grad_phi_u[k] =
3685 *   scratch.stokes_fe_values[velocities].gradient(k, q);
3686 *   scratch.phi_p[k] = scratch.stokes_fe_values[pressure].value(k, q);
3687 *   }
3688 *  
3689 *   for (unsigned int i = 0; i < dofs_per_cell; ++i)
3690 *   for (unsigned int j = 0; j < dofs_per_cell; ++j)
3691 *   data.local_matrix(i, j) +=
3692 *   (EquationData::eta *
3693 *   scalar_product(scratch.grad_phi_u[i], scratch.grad_phi_u[j]) +
3694 *   (1. / EquationData::eta) * EquationData::pressure_scaling *
3695 *   EquationData::pressure_scaling *
3696 *   (scratch.phi_p[i] * scratch.phi_p[j])) *
3697 *   scratch.stokes_fe_values.JxW(q);
3698 *   }
3699 *   }
3700 *  
3701 *  
3702 *  
3703 *   template <int dim>
3704 *   void BoussinesqFlowProblem<dim>::copy_local_to_global_stokes_preconditioner(
3705 *   const Assembly::CopyData::StokesPreconditioner<dim> &data)
3706 *   {
3707 *   stokes_constraints.distribute_local_to_global(data.local_matrix,
3708 *   data.local_dof_indices,
3709 *   stokes_preconditioner_matrix);
3710 *   }
3711 *  
3712 *  
3713 * @endcode
3714 *
3715 * Now for the function that actually puts things together, using the
3716 * WorkStream functions. WorkStream::run needs a start and end iterator to
3717 * enumerate the cells it is supposed to work on. Typically, one would use
3718 * DoFHandler::begin_active() and DoFHandler::end() for that but here we
3719 * actually only want the subset of cells that in fact are owned by the
3720 * current processor. This is where the FilteredIterator class comes into
3721 * play: you give it a range of cells and it provides an iterator that only
3722 * iterates over that subset of cells that satisfy a certain predicate (a
3723 * predicate is a function of one argument that either returns true or
3724 * false). The predicate we use here is IteratorFilters::LocallyOwnedCell,
3725 * i.e., it returns true exactly if the cell is owned by the current
3726 * processor. The resulting iterator range is then exactly what we need.
3727 *
3728
3729 *
3730 * With this obstacle out of the way, we call the WorkStream::run
3731 * function with this set of cells, scratch and copy objects, and
3732 * with pointers to two functions: the local assembly and
3733 * copy-local-to-global function. These functions need to have very
3734 * specific signatures: three arguments in the first and one
3735 * argument in the latter case (see the documentation of the
3736 * WorkStream::run function for the meaning of these arguments).
3737 * Note how we use a lambda functions to
3738 * create a function object that satisfies this requirement. It uses
3739 * function arguments for the local assembly function that specify
3740 * cell, scratch data, and copy data, as well as function argument
3741 * for the copy function that expects the
3742 * data to be written into the global matrix (also see the discussion in
3743 * @ref step_13 "step-13"'s <code>assemble_linear_system()</code> function). On the other
3744 * hand, the implicit zeroth argument of member functions (namely
3745 * the <code>this</code> pointer of the object on which that member
3746 * function is to operate on) is <i>bound</i> to the
3747 * <code>this</code> pointer of the current function and is captured. The
3748 * WorkStream::run function, as a consequence, does not need to know
3749 * anything about the object these functions work on.
3750 *
3751
3752 *
3753 * When the WorkStream is executed, it will create several local assembly
3754 * routines of the first kind for several cells and let some available
3755 * processors work on them. The function that needs to be synchronized,
3756 * i.e., the write operation into the global matrix, however, is executed by
3757 * only one thread at a time in the prescribed order. Of course, this only
3758 * holds for the parallelization on a single MPI process. Different MPI
3759 * processes will have their own WorkStream objects and do that work
3760 * completely independently (and in different memory spaces). In a
3761 * distributed calculation, some data will accumulate at degrees of freedom
3762 * that are not owned by the respective processor. It would be inefficient
3763 * to send data around every time we encounter such a dof. What happens
3764 * instead is that the Trilinos sparse matrix will keep that data and send
3765 * it to the owner at the end of assembly, by calling the
3766 * <code>compress()</code> command.
3767 *
3768 * @code
3769 *   template <int dim>
3770 *   void BoussinesqFlowProblem<dim>::assemble_stokes_preconditioner()
3771 *   {
3772 *   stokes_preconditioner_matrix = 0;
3773 *  
3774 *   const QGauss<dim> quadrature_formula(parameters.stokes_velocity_degree + 1);
3775 *  
3776 *   using CellFilter =
3778 *  
3779 *   auto worker =
3780 *   [this](const typename DoFHandler<dim>::active_cell_iterator &cell,
3781 *   Assembly::Scratch::StokesPreconditioner<dim> &scratch,
3782 *   Assembly::CopyData::StokesPreconditioner<dim> &data) {
3783 *   this->local_assemble_stokes_preconditioner(cell, scratch, data);
3784 *   };
3785 *  
3786 *   auto copier =
3787 *   [this](const Assembly::CopyData::StokesPreconditioner<dim> &data) {
3788 *   this->copy_local_to_global_stokes_preconditioner(data);
3789 *   };
3790 *  
3792 *   stokes_dof_handler.begin_active()),
3793 *   CellFilter(IteratorFilters::LocallyOwnedCell(),
3794 *   stokes_dof_handler.end()),
3795 *   worker,
3796 *   copier,
3797 *   Assembly::Scratch::StokesPreconditioner<dim>(
3798 *   stokes_fe,
3799 *   quadrature_formula,
3800 *   mapping,
3802 *   Assembly::CopyData::StokesPreconditioner<dim>(stokes_fe));
3803 *  
3804 *   stokes_preconditioner_matrix.compress(VectorOperation::add);
3805 *   }
3806 *  
3807 *  
3808 *  
3809 * @endcode
3810 *
3811 * The final function in this block initiates assembly of the Stokes
3812 * preconditioner matrix and then in fact builds the Stokes
3813 * preconditioner. It is mostly the same as in the serial case. The only
3814 * difference to @ref step_31 "step-31" is that we use a Jacobi preconditioner for the
3815 * pressure mass matrix instead of IC, as discussed in the introduction.
3816 *
3817 * @code
3818 *   template <int dim>
3819 *   void BoussinesqFlowProblem<dim>::build_stokes_preconditioner()
3820 *   {
3821 *   if (rebuild_stokes_preconditioner == false)
3822 *   return;
3823 *  
3824 *   TimerOutput::Scope timer_section(computing_timer,
3825 *   " Build Stokes preconditioner");
3826 *   pcout << " Rebuilding Stokes preconditioner..." << std::flush;
3827 *  
3828 *   assemble_stokes_preconditioner();
3829 *  
3830 *   const FEValuesExtractors::Vector velocity_components(0);
3831 *   const std::vector<std::vector<bool>> constant_modes =
3833 *   stokes_dof_handler, stokes_fe.component_mask(velocity_components));
3834 *  
3835 *   Mp_preconditioner =
3836 *   std::make_shared<TrilinosWrappers::PreconditionJacobi>();
3837 *   Amg_preconditioner = std::make_shared<TrilinosWrappers::PreconditionAMG>();
3838 *  
3840 *   Amg_data.constant_modes = constant_modes;
3841 *   Amg_data.elliptic = true;
3842 *   Amg_data.higher_order_elements = true;
3843 *   Amg_data.smoother_sweeps = 2;
3844 *   Amg_data.aggregation_threshold = 0.02;
3845 *  
3846 *   Mp_preconditioner->initialize(stokes_preconditioner_matrix.block(1, 1));
3847 *   Amg_preconditioner->initialize(stokes_preconditioner_matrix.block(0, 0),
3848 *   Amg_data);
3849 *  
3850 *   rebuild_stokes_preconditioner = false;
3851 *  
3852 *   pcout << std::endl;
3853 *   }
3854 *  
3855 *  
3856 * @endcode
3857 *
3858 *
3859 * <a name="step_32-Stokessystemassembly"></a>
3860 * <h5>Stokes system assembly</h5>
3861 *
3862
3863 *
3864 * The next three functions implement the assembly of the Stokes system,
3865 * again split up into a part performing local calculations, one for writing
3866 * the local data into the global matrix and vector, and one for actually
3867 * running the loop over all cells with the help of the WorkStream
3868 * class. Note that the assembly of the Stokes matrix needs only to be done
3869 * in case we have changed the mesh. Otherwise, just the
3870 * (temperature-dependent) right hand side needs to be calculated
3871 * here. Since we are working with distributed matrices and vectors, we have
3872 * to call the respective <code>compress()</code> functions in the end of
3873 * the assembly in order to send non-local data to the owner process.
3874 *
3875 * @code
3876 *   template <int dim>
3877 *   void BoussinesqFlowProblem<dim>::local_assemble_stokes_system(
3878 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
3879 *   Assembly::Scratch::StokesSystem<dim> &scratch,
3880 *   Assembly::CopyData::StokesSystem<dim> &data)
3881 *   {
3882 *   const unsigned int dofs_per_cell =
3883 *   scratch.stokes_fe_values.get_fe().n_dofs_per_cell();
3884 *   const unsigned int n_q_points =
3885 *   scratch.stokes_fe_values.n_quadrature_points;
3886 *  
3887 *   const FEValuesExtractors::Vector velocities(0);
3888 *   const FEValuesExtractors::Scalar pressure(dim);
3889 *  
3890 *   scratch.stokes_fe_values.reinit(cell);
3891 *  
3892 *   const typename DoFHandler<dim>::active_cell_iterator temperature_cell =
3893 *   cell->as_dof_handler_iterator(temperature_dof_handler);
3894 *   scratch.temperature_fe_values.reinit(temperature_cell);
3895 *  
3896 *   if (rebuild_stokes_matrix)
3897 *   data.local_matrix = 0;
3898 *   data.local_rhs = 0;
3899 *  
3900 *   scratch.temperature_fe_values.get_function_values(
3901 *   old_temperature_solution, scratch.old_temperature_values);
3902 *  
3903 *   for (unsigned int q = 0; q < n_q_points; ++q)
3904 *   {
3905 *   const double old_temperature = scratch.old_temperature_values[q];
3906 *  
3907 *   for (unsigned int k = 0; k < dofs_per_cell; ++k)
3908 *   {
3909 *   scratch.phi_u[k] = scratch.stokes_fe_values[velocities].value(k, q);
3910 *   if (rebuild_stokes_matrix)
3911 *   {
3912 *   scratch.grads_phi_u[k] =
3913 *   scratch.stokes_fe_values[velocities].symmetric_gradient(k, q);
3914 *   scratch.div_phi_u[k] =
3915 *   scratch.stokes_fe_values[velocities].divergence(k, q);
3916 *   scratch.phi_p[k] =
3917 *   scratch.stokes_fe_values[pressure].value(k, q);
3918 *   }
3919 *   }
3920 *  
3921 *   if (rebuild_stokes_matrix == true)
3922 *   for (unsigned int i = 0; i < dofs_per_cell; ++i)
3923 *   for (unsigned int j = 0; j < dofs_per_cell; ++j)
3924 *   data.local_matrix(i, j) +=
3925 *   (EquationData::eta * 2 *
3926 *   (scratch.grads_phi_u[i] * scratch.grads_phi_u[j]) -
3927 *   (EquationData::pressure_scaling * scratch.div_phi_u[i] *
3928 *   scratch.phi_p[j]) -
3929 *   (EquationData::pressure_scaling * scratch.phi_p[i] *
3930 *   scratch.div_phi_u[j])) *
3931 *   scratch.stokes_fe_values.JxW(q);
3932 *  
3933 *   const Tensor<1, dim> gravity = EquationData::gravity_vector(
3934 *   scratch.stokes_fe_values.quadrature_point(q));
3935 *  
3936 *   for (unsigned int i = 0; i < dofs_per_cell; ++i)
3937 *   data.local_rhs(i) += (EquationData::density(old_temperature) *
3938 *   gravity * scratch.phi_u[i]) *
3939 *   scratch.stokes_fe_values.JxW(q);
3940 *   }
3941 *  
3942 *   cell->get_dof_indices(data.local_dof_indices);
3943 *   }
3944 *  
3945 *  
3946 *  
3947 *   template <int dim>
3948 *   void BoussinesqFlowProblem<dim>::copy_local_to_global_stokes_system(
3949 *   const Assembly::CopyData::StokesSystem<dim> &data)
3950 *   {
3951 *   if (rebuild_stokes_matrix == true)
3952 *   stokes_constraints.distribute_local_to_global(data.local_matrix,
3953 *   data.local_rhs,
3954 *   data.local_dof_indices,
3955 *   stokes_matrix,
3956 *   stokes_rhs);
3957 *   else
3958 *   stokes_constraints.distribute_local_to_global(data.local_rhs,
3959 *   data.local_dof_indices,
3960 *   stokes_rhs);
3961 *   }
3962 *  
3963 *  
3964 *  
3965 *   template <int dim>
3966 *   void BoussinesqFlowProblem<dim>::assemble_stokes_system()
3967 *   {
3968 *   TimerOutput::Scope timer_section(computing_timer,
3969 *   " Assemble Stokes system");
3970 *  
3971 *   if (rebuild_stokes_matrix == true)
3972 *   stokes_matrix = 0;
3973 *  
3974 *   stokes_rhs = 0;
3975 *  
3976 *   const QGauss<dim> quadrature_formula(parameters.stokes_velocity_degree + 1);
3977 *  
3978 *   using CellFilter =
3980 *  
3981 *   WorkStream::run(
3982 *   CellFilter(IteratorFilters::LocallyOwnedCell(),
3983 *   stokes_dof_handler.begin_active()),
3984 *   CellFilter(IteratorFilters::LocallyOwnedCell(), stokes_dof_handler.end()),
3985 *   [this](const typename DoFHandler<dim>::active_cell_iterator &cell,
3986 *   Assembly::Scratch::StokesSystem<dim> &scratch,
3987 *   Assembly::CopyData::StokesSystem<dim> &data) {
3988 *   this->local_assemble_stokes_system(cell, scratch, data);
3989 *   },
3990 *   [this](const Assembly::CopyData::StokesSystem<dim> &data) {
3991 *   this->copy_local_to_global_stokes_system(data);
3992 *   },
3993 *   Assembly::Scratch::StokesSystem<dim>(
3994 *   stokes_fe,
3995 *   mapping,
3996 *   quadrature_formula,
3998 *   (rebuild_stokes_matrix == true ? update_gradients : UpdateFlags(0))),
3999 *   temperature_fe,
4000 *   update_values),
4001 *   Assembly::CopyData::StokesSystem<dim>(stokes_fe));
4002 *  
4003 *   if (rebuild_stokes_matrix == true)
4004 *   stokes_matrix.compress(VectorOperation::add);
4005 *   stokes_rhs.compress(VectorOperation::add);
4006 *  
4007 *   rebuild_stokes_matrix = false;
4008 *  
4009 *   pcout << std::endl;
4010 *   }
4011 *  
4012 *  
4013 * @endcode
4014 *
4015 *
4016 * <a name="step_32-Temperaturematrixassembly"></a>
4017 * <h5>Temperature matrix assembly</h5>
4018 *
4019
4020 *
4021 * The task to be performed by the next three functions is to calculate a
4022 * mass matrix and a Laplace matrix on the temperature system. These will be
4023 * combined in order to yield the semi-implicit time stepping matrix that
4024 * consists of the mass matrix plus a time step-dependent weight factor
4025 * times the Laplace matrix. This function is again essentially the body of
4026 * the loop over all cells from @ref step_31 "step-31".
4027 *
4028
4029 *
4030 * The two following functions perform similar services as the ones above.
4031 *
4032 * @code
4033 *   template <int dim>
4034 *   void BoussinesqFlowProblem<dim>::local_assemble_temperature_matrix(
4035 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
4036 *   Assembly::Scratch::TemperatureMatrix<dim> &scratch,
4037 *   Assembly::CopyData::TemperatureMatrix<dim> &data)
4038 *   {
4039 *   const unsigned int dofs_per_cell =
4040 *   scratch.temperature_fe_values.get_fe().n_dofs_per_cell();
4041 *   const unsigned int n_q_points =
4042 *   scratch.temperature_fe_values.n_quadrature_points;
4043 *  
4044 *   scratch.temperature_fe_values.reinit(cell);
4045 *   cell->get_dof_indices(data.local_dof_indices);
4046 *  
4047 *   data.local_mass_matrix = 0;
4048 *   data.local_stiffness_matrix = 0;
4049 *  
4050 *   for (unsigned int q = 0; q < n_q_points; ++q)
4051 *   {
4052 *   for (unsigned int k = 0; k < dofs_per_cell; ++k)
4053 *   {
4054 *   scratch.grad_phi_T[k] =
4055 *   scratch.temperature_fe_values.shape_grad(k, q);
4056 *   scratch.phi_T[k] = scratch.temperature_fe_values.shape_value(k, q);
4057 *   }
4058 *  
4059 *   for (unsigned int i = 0; i < dofs_per_cell; ++i)
4060 *   for (unsigned int j = 0; j < dofs_per_cell; ++j)
4061 *   {
4062 *   data.local_mass_matrix(i, j) +=
4063 *   (scratch.phi_T[i] * scratch.phi_T[j] *
4064 *   scratch.temperature_fe_values.JxW(q));
4065 *   data.local_stiffness_matrix(i, j) +=
4066 *   (EquationData::kappa * scratch.grad_phi_T[i] *
4067 *   scratch.grad_phi_T[j] * scratch.temperature_fe_values.JxW(q));
4068 *   }
4069 *   }
4070 *   }
4071 *  
4072 *  
4073 *  
4074 *   template <int dim>
4075 *   void BoussinesqFlowProblem<dim>::copy_local_to_global_temperature_matrix(
4076 *   const Assembly::CopyData::TemperatureMatrix<dim> &data)
4077 *   {
4078 *   temperature_constraints.distribute_local_to_global(data.local_mass_matrix,
4079 *   data.local_dof_indices,
4080 *   temperature_mass_matrix);
4081 *   temperature_constraints.distribute_local_to_global(
4082 *   data.local_stiffness_matrix,
4083 *   data.local_dof_indices,
4084 *   temperature_stiffness_matrix);
4085 *   }
4086 *  
4087 *  
4088 *   template <int dim>
4089 *   void BoussinesqFlowProblem<dim>::assemble_temperature_matrix()
4090 *   {
4091 *   if (rebuild_temperature_matrices == false)
4092 *   return;
4093 *  
4094 *   TimerOutput::Scope timer_section(computing_timer,
4095 *   " Assemble temperature matrices");
4096 *   temperature_mass_matrix = 0;
4097 *   temperature_stiffness_matrix = 0;
4098 *  
4099 *   const QGauss<dim> quadrature_formula(parameters.temperature_degree + 2);
4100 *  
4101 *   using CellFilter =
4103 *  
4104 *   WorkStream::run(
4105 *   CellFilter(IteratorFilters::LocallyOwnedCell(),
4106 *   temperature_dof_handler.begin_active()),
4107 *   CellFilter(IteratorFilters::LocallyOwnedCell(),
4108 *   temperature_dof_handler.end()),
4109 *   [this](const typename DoFHandler<dim>::active_cell_iterator &cell,
4110 *   Assembly::Scratch::TemperatureMatrix<dim> &scratch,
4111 *   Assembly::CopyData::TemperatureMatrix<dim> &data) {
4112 *   this->local_assemble_temperature_matrix(cell, scratch, data);
4113 *   },
4114 *   [this](const Assembly::CopyData::TemperatureMatrix<dim> &data) {
4115 *   this->copy_local_to_global_temperature_matrix(data);
4116 *   },
4117 *   Assembly::Scratch::TemperatureMatrix<dim>(temperature_fe,
4118 *   mapping,
4119 *   quadrature_formula),
4120 *   Assembly::CopyData::TemperatureMatrix<dim>(temperature_fe));
4121 *  
4122 *   temperature_mass_matrix.compress(VectorOperation::add);
4123 *   temperature_stiffness_matrix.compress(VectorOperation::add);
4124 *  
4125 *   rebuild_temperature_matrices = false;
4126 *   rebuild_temperature_preconditioner = true;
4127 *   }
4128 *  
4129 *  
4130 * @endcode
4131 *
4132 *
4133 * <a name="step_32-Temperaturerighthandsideassembly"></a>
4134 * <h5>Temperature right hand side assembly</h5>
4135 *
4136
4137 *
4138 * This is the last assembly function. It calculates the right hand side of
4139 * the temperature system, which includes the convection and the
4140 * stabilization terms. It includes a lot of evaluations of old solutions at
4141 * the quadrature points (which are necessary for calculating the artificial
4142 * viscosity of stabilization), but is otherwise similar to the other
4143 * assembly functions. Notice, once again, how we resolve the dilemma of
4144 * having inhomogeneous boundary conditions, by just making a right hand
4145 * side at this point (compare the comments for the <code>project()</code>
4146 * function above): We create some matrix columns with exactly the values
4147 * that would be entered for the temperature @ref GlossStiffnessMatrix "stiffness matrix", in case we
4148 * have inhomogeneously constrained dofs. That will account for the correct
4149 * balance of the right hand side vector with the matrix system of
4150 * temperature.
4151 *
4152 * @code
4153 *   template <int dim>
4154 *   void BoussinesqFlowProblem<dim>::local_assemble_temperature_rhs(
4155 *   const std::pair<double, double> global_T_range,
4156 *   const double global_max_velocity,
4157 *   const double global_entropy_variation,
4158 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
4159 *   Assembly::Scratch::TemperatureRHS<dim> &scratch,
4160 *   Assembly::CopyData::TemperatureRHS<dim> &data)
4161 *   {
4162 *   const bool use_bdf2_scheme = (timestep_number != 0);
4163 *  
4164 *   const unsigned int dofs_per_cell =
4165 *   scratch.temperature_fe_values.get_fe().n_dofs_per_cell();
4166 *   const unsigned int n_q_points =
4167 *   scratch.temperature_fe_values.n_quadrature_points;
4168 *  
4169 *   const FEValuesExtractors::Vector velocities(0);
4170 *  
4171 *   data.local_rhs = 0;
4172 *   data.matrix_for_bc = 0;
4173 *   cell->get_dof_indices(data.local_dof_indices);
4174 *  
4175 *   scratch.temperature_fe_values.reinit(cell);
4176 *  
4177 *   typename DoFHandler<dim>::active_cell_iterator stokes_cell =
4178 *   cell->as_dof_handler_iterator(stokes_dof_handler);
4179 *   scratch.stokes_fe_values.reinit(stokes_cell);
4180 *  
4181 *   scratch.temperature_fe_values.get_function_values(
4182 *   old_temperature_solution, scratch.old_temperature_values);
4183 *   scratch.temperature_fe_values.get_function_values(
4184 *   old_old_temperature_solution, scratch.old_old_temperature_values);
4185 *  
4186 *   scratch.temperature_fe_values.get_function_gradients(
4187 *   old_temperature_solution, scratch.old_temperature_grads);
4188 *   scratch.temperature_fe_values.get_function_gradients(
4189 *   old_old_temperature_solution, scratch.old_old_temperature_grads);
4190 *  
4191 *   scratch.temperature_fe_values.get_function_laplacians(
4192 *   old_temperature_solution, scratch.old_temperature_laplacians);
4193 *   scratch.temperature_fe_values.get_function_laplacians(
4194 *   old_old_temperature_solution, scratch.old_old_temperature_laplacians);
4195 *  
4196 *   scratch.stokes_fe_values[velocities].get_function_values(
4197 *   stokes_solution, scratch.old_velocity_values);
4198 *   scratch.stokes_fe_values[velocities].get_function_values(
4199 *   old_stokes_solution, scratch.old_old_velocity_values);
4200 *   scratch.stokes_fe_values[velocities].get_function_symmetric_gradients(
4201 *   stokes_solution, scratch.old_strain_rates);
4202 *   scratch.stokes_fe_values[velocities].get_function_symmetric_gradients(
4203 *   old_stokes_solution, scratch.old_old_strain_rates);
4204 *  
4205 *   const double nu =
4206 *   compute_viscosity(scratch.old_temperature_values,
4207 *   scratch.old_old_temperature_values,
4208 *   scratch.old_temperature_grads,
4209 *   scratch.old_old_temperature_grads,
4210 *   scratch.old_temperature_laplacians,
4211 *   scratch.old_old_temperature_laplacians,
4212 *   scratch.old_velocity_values,
4213 *   scratch.old_old_velocity_values,
4214 *   scratch.old_strain_rates,
4215 *   scratch.old_old_strain_rates,
4216 *   global_max_velocity,
4217 *   global_T_range.second - global_T_range.first,
4218 *   0.5 * (global_T_range.second + global_T_range.first),
4219 *   global_entropy_variation,
4220 *   cell->diameter());
4221 *  
4222 *   for (unsigned int q = 0; q < n_q_points; ++q)
4223 *   {
4224 *   for (unsigned int k = 0; k < dofs_per_cell; ++k)
4225 *   {
4226 *   scratch.phi_T[k] = scratch.temperature_fe_values.shape_value(k, q);
4227 *   scratch.grad_phi_T[k] =
4228 *   scratch.temperature_fe_values.shape_grad(k, q);
4229 *   }
4230 *  
4231 *  
4232 *   const double T_term_for_rhs =
4233 *   (use_bdf2_scheme ?
4234 *   (scratch.old_temperature_values[q] *
4235 *   (1 + time_step / old_time_step) -
4236 *   scratch.old_old_temperature_values[q] * (time_step * time_step) /
4237 *   (old_time_step * (time_step + old_time_step))) :
4238 *   scratch.old_temperature_values[q]);
4239 *  
4240 *   const double ext_T =
4241 *   (use_bdf2_scheme ? (scratch.old_temperature_values[q] *
4242 *   (1 + time_step / old_time_step) -
4243 *   scratch.old_old_temperature_values[q] *
4244 *   time_step / old_time_step) :
4245 *   scratch.old_temperature_values[q]);
4246 *  
4247 *   const Tensor<1, dim> ext_grad_T =
4248 *   (use_bdf2_scheme ? (scratch.old_temperature_grads[q] *
4249 *   (1 + time_step / old_time_step) -
4250 *   scratch.old_old_temperature_grads[q] * time_step /
4251 *   old_time_step) :
4252 *   scratch.old_temperature_grads[q]);
4253 *  
4254 *   const Tensor<1, dim> extrapolated_u =
4255 *   (use_bdf2_scheme ?
4256 *   (scratch.old_velocity_values[q] * (1 + time_step / old_time_step) -
4257 *   scratch.old_old_velocity_values[q] * time_step / old_time_step) :
4258 *   scratch.old_velocity_values[q]);
4259 *  
4260 *   const SymmetricTensor<2, dim> extrapolated_strain_rate =
4261 *   (use_bdf2_scheme ?
4262 *   (scratch.old_strain_rates[q] * (1 + time_step / old_time_step) -
4263 *   scratch.old_old_strain_rates[q] * time_step / old_time_step) :
4264 *   scratch.old_strain_rates[q]);
4265 *  
4266 *   const double gamma =
4267 *   ((EquationData::radiogenic_heating * EquationData::density(ext_T) +
4268 *   2 * EquationData::eta * extrapolated_strain_rate *
4269 *   extrapolated_strain_rate) /
4270 *   (EquationData::density(ext_T) * EquationData::specific_heat));
4271 *  
4272 *   for (unsigned int i = 0; i < dofs_per_cell; ++i)
4273 *   {
4274 *   data.local_rhs(i) +=
4275 *   (T_term_for_rhs * scratch.phi_T[i] -
4276 *   time_step * extrapolated_u * ext_grad_T * scratch.phi_T[i] -
4277 *   time_step * nu * ext_grad_T * scratch.grad_phi_T[i] +
4278 *   time_step * gamma * scratch.phi_T[i]) *
4279 *   scratch.temperature_fe_values.JxW(q);
4280 *  
4281 *   if (temperature_constraints.is_inhomogeneously_constrained(
4282 *   data.local_dof_indices[i]))
4283 *   {
4284 *   for (unsigned int j = 0; j < dofs_per_cell; ++j)
4285 *   data.matrix_for_bc(j, i) +=
4286 *   (scratch.phi_T[i] * scratch.phi_T[j] *
4287 *   (use_bdf2_scheme ? ((2 * time_step + old_time_step) /
4288 *   (time_step + old_time_step)) :
4289 *   1.) +
4290 *   scratch.grad_phi_T[i] * scratch.grad_phi_T[j] *
4291 *   EquationData::kappa * time_step) *
4292 *   scratch.temperature_fe_values.JxW(q);
4293 *   }
4294 *   }
4295 *   }
4296 *   }
4297 *  
4298 *  
4299 *   template <int dim>
4300 *   void BoussinesqFlowProblem<dim>::copy_local_to_global_temperature_rhs(
4301 *   const Assembly::CopyData::TemperatureRHS<dim> &data)
4302 *   {
4303 *   temperature_constraints.distribute_local_to_global(data.local_rhs,
4304 *   data.local_dof_indices,
4305 *   temperature_rhs,
4306 *   data.matrix_for_bc);
4307 *   }
4308 *  
4309 *  
4310 *  
4311 * @endcode
4312 *
4313 * In the function that runs the WorkStream for actually calculating the
4314 * right hand side, we also generate the final matrix. As mentioned above,
4315 * it is a sum of the mass matrix and the Laplace matrix, times some time
4316 * step-dependent weight. This weight is specified by the BDF-2 time
4317 * integration scheme, see the introduction in @ref step_31 "step-31". What is new in this
4318 * tutorial program (in addition to the use of MPI parallelization and the
4319 * WorkStream class), is that we now precompute the temperature
4320 * preconditioner as well. The reason is that the setup of the Jacobi
4321 * preconditioner takes a noticeable time compared to the solver because we
4322 * usually only need between 10 and 20 iterations for solving the
4323 * temperature system (this might sound strange, as Jacobi really only
4324 * consists of a diagonal, but in Trilinos it is derived from more general
4325 * framework for point relaxation preconditioners which is a bit
4326 * inefficient). Hence, it is more efficient to precompute the
4327 * preconditioner, even though the matrix entries may slightly change
4328 * because the time step might change. This is not too big a problem because
4329 * we remesh every few time steps (and regenerate the preconditioner then).
4330 *
4331 * @code
4332 *   template <int dim>
4333 *   void BoussinesqFlowProblem<dim>::assemble_temperature_system(
4334 *   const double maximal_velocity)
4335 *   {
4336 *   const bool use_bdf2_scheme = (timestep_number != 0);
4337 *  
4338 *   if (use_bdf2_scheme == true)
4339 *   {
4340 *   temperature_matrix.copy_from(temperature_mass_matrix);
4341 *   temperature_matrix *=
4342 *   (2 * time_step + old_time_step) / (time_step + old_time_step);
4343 *   temperature_matrix.add(time_step, temperature_stiffness_matrix);
4344 *   }
4345 *   else
4346 *   {
4347 *   temperature_matrix.copy_from(temperature_mass_matrix);
4348 *   temperature_matrix.add(time_step, temperature_stiffness_matrix);
4349 *   }
4350 *  
4351 *   if (rebuild_temperature_preconditioner == true)
4352 *   {
4353 *   T_preconditioner =
4354 *   std::make_shared<TrilinosWrappers::PreconditionJacobi>();
4355 *   T_preconditioner->initialize(temperature_matrix);
4356 *   rebuild_temperature_preconditioner = false;
4357 *   }
4358 *  
4359 * @endcode
4360 *
4361 * The next part is computing the right hand side vectors. To do so, we
4362 * first compute the average temperature @f$T_m@f$ that we use for evaluating
4363 * the artificial viscosity stabilization through the residual @f$E(T) =
4364 * (T-T_m)^2@f$. We do this by defining the midpoint between maximum and
4365 * minimum temperature as average temperature in the definition of the
4366 * entropy viscosity. An alternative would be to use the integral average,
4367 * but the results are not very sensitive to this choice. The rest then
4368 * only requires calling WorkStream::run again, binding the arguments to
4369 * the <code>local_assemble_temperature_rhs</code> function that are the
4370 * same in every call to the correct values:
4371 *
4372 * @code
4373 *   temperature_rhs = 0;
4374 *  
4375 *   const QGauss<dim> quadrature_formula(parameters.temperature_degree + 2);
4376 *   const std::pair<double, double> global_T_range =
4377 *   get_extrapolated_temperature_range();
4378 *  
4379 *   const double average_temperature =
4380 *   0.5 * (global_T_range.first + global_T_range.second);
4381 *   const double global_entropy_variation =
4382 *   get_entropy_variation(average_temperature);
4383 *  
4384 *   using CellFilter =
4386 *  
4387 *   auto worker =
4388 *   [this, global_T_range, maximal_velocity, global_entropy_variation](
4389 *   const typename DoFHandler<dim>::active_cell_iterator &cell,
4390 *   Assembly::Scratch::TemperatureRHS<dim> &scratch,
4391 *   Assembly::CopyData::TemperatureRHS<dim> &data) {
4392 *   this->local_assemble_temperature_rhs(global_T_range,
4393 *   maximal_velocity,
4394 *   global_entropy_variation,
4395 *   cell,
4396 *   scratch,
4397 *   data);
4398 *   };
4399 *  
4400 *   auto copier = [this](const Assembly::CopyData::TemperatureRHS<dim> &data) {
4401 *   this->copy_local_to_global_temperature_rhs(data);
4402 *   };
4403 *  
4405 *   temperature_dof_handler.begin_active()),
4406 *   CellFilter(IteratorFilters::LocallyOwnedCell(),
4407 *   temperature_dof_handler.end()),
4408 *   worker,
4409 *   copier,
4410 *   Assembly::Scratch::TemperatureRHS<dim>(
4411 *   temperature_fe, stokes_fe, mapping, quadrature_formula),
4412 *   Assembly::CopyData::TemperatureRHS<dim>(temperature_fe));
4413 *  
4414 *   temperature_rhs.compress(VectorOperation::add);
4415 *   }
4416 *  
4417 *  
4418 *  
4419 * @endcode
4420 *
4421 *
4422 * <a name="step_32-BoussinesqFlowProblemsolve"></a>
4423 * <h4>BoussinesqFlowProblem::solve</h4>
4424 *
4425
4426 *
4427 * This function solves the linear systems in each time step of the
4428 * Boussinesq problem. First, we work on the Stokes system and then on the
4429 * temperature system. In essence, it does the same things as the respective
4430 * function in @ref step_31 "step-31". However, there are a few changes here.
4431 *
4432
4433 *
4434 * The first change is related to the way we store our solution: we keep the
4435 * vectors with locally owned degrees of freedom plus ghost nodes on each
4436 * MPI node. When we enter a solver which is supposed to perform
4437 * matrix-vector products with a distributed matrix, this is not the
4438 * appropriate form, though. There, we will want to have the solution vector
4439 * to be distributed in the same way as the matrix, i.e. without any
4440 * ghosts. So what we do first is to generate a distributed vector called
4441 * <code>distributed_stokes_solution</code> and put only the locally owned
4442 * dofs into that, which is neatly done by the <code>operator=</code> of the
4443 * Trilinos vector.
4444 *
4445
4446 *
4447 * Next, we scale the pressure solution (or rather, the initial guess) for
4448 * the solver so that it matches with the length scales in the matrices, as
4449 * discussed in the introduction. We also immediately scale the pressure
4450 * solution back to the correct units after the solution is completed. We
4451 * also need to set the pressure values at hanging nodes to zero. This we
4452 * also did in @ref step_31 "step-31" in order not to disturb the Schur complement by some
4453 * vector entries that actually are irrelevant during the solve stage. As a
4454 * difference to @ref step_31 "step-31", here we do it only for the locally owned pressure
4455 * dofs. After solving for the Stokes solution, each processor copies the
4456 * distributed solution back into the solution vector that also includes
4457 * ghost elements.
4458 *
4459
4460 *
4461 * The third and most obvious change is that we have two variants for the
4462 * Stokes solver: A fast solver that sometimes breaks down, and a robust
4463 * solver that is slower. This is what we already discussed in the
4464 * introduction. Here is how we realize it: First, we perform 30 iterations
4465 * with the fast solver based on the simple preconditioner based on the AMG
4466 * V-cycle instead of an approximate solve (this is indicated by the
4467 * <code>false</code> argument to the
4468 * <code>LinearSolvers::BlockSchurPreconditioner</code> object). If we
4469 * converge, everything is fine. If we do not converge, the solver control
4470 * object will throw an exception SolverControl::NoConvergence. Usually,
4471 * this would abort the program because we don't catch them in our usual
4472 * <code>solve()</code> functions. This is certainly not what we want to
4473 * happen here. Rather, we want to switch to the strong solver and continue
4474 * the solution process with whatever vector we got so far. Hence, we catch
4475 * the exception with the C++ try/catch mechanism. We then simply go through
4476 * the same solver sequence again in the <code>catch</code> clause, this
4477 * time passing the @p true flag to the preconditioner for the strong
4478 * solver, signaling an approximate CG solve.
4479 *
4480 * @code
4481 *   template <int dim>
4482 *   void BoussinesqFlowProblem<dim>::solve()
4483 *   {
4484 *   {
4485 *   TimerOutput::Scope timer_section(computing_timer,
4486 *   " Solve Stokes system");
4487 *  
4488 *   pcout << " Solving Stokes system... " << std::flush;
4489 *  
4490 *   TrilinosWrappers::MPI::BlockVector distributed_stokes_solution(
4491 *   stokes_rhs);
4492 *   distributed_stokes_solution = stokes_solution;
4493 *  
4494 *   distributed_stokes_solution.block(1) /= EquationData::pressure_scaling;
4495 *  
4496 *   const unsigned int
4497 *   start = (distributed_stokes_solution.block(0).size() +
4498 *   distributed_stokes_solution.block(1).local_range().first),
4499 *   end = (distributed_stokes_solution.block(0).size() +
4500 *   distributed_stokes_solution.block(1).local_range().second);
4501 *   for (unsigned int i = start; i < end; ++i)
4502 *   if (stokes_constraints.is_constrained(i))
4503 *   distributed_stokes_solution(i) = 0;
4504 *  
4505 *  
4506 *   PrimitiveVectorMemory<TrilinosWrappers::MPI::BlockVector> mem;
4507 *  
4508 *   unsigned int n_iterations = 0;
4509 *   const double solver_tolerance = 1e-8 * stokes_rhs.l2_norm();
4510 *   SolverControl solver_control(30, solver_tolerance);
4511 *  
4512 *   try
4513 *   {
4514 *   const LinearSolvers::BlockSchurPreconditioner<
4515 *   TrilinosWrappers::PreconditionAMG,
4516 *   TrilinosWrappers::PreconditionJacobi>
4517 *   preconditioner(stokes_matrix,
4518 *   stokes_preconditioner_matrix,
4519 *   *Mp_preconditioner,
4520 *   *Amg_preconditioner,
4521 *   false);
4522 *  
4523 *   SolverFGMRES<TrilinosWrappers::MPI::BlockVector> solver(
4524 *   solver_control,
4525 *   mem,
4526 *   SolverFGMRES<TrilinosWrappers::MPI::BlockVector>::AdditionalData(
4527 *   30));
4528 *   solver.solve(stokes_matrix,
4529 *   distributed_stokes_solution,
4530 *   stokes_rhs,
4531 *   preconditioner);
4532 *  
4533 *   n_iterations = solver_control.last_step();
4534 *   }
4535 *  
4536 *   catch (SolverControl::NoConvergence &)
4537 *   {
4538 *   const LinearSolvers::BlockSchurPreconditioner<
4539 *   TrilinosWrappers::PreconditionAMG,
4540 *   TrilinosWrappers::PreconditionJacobi>
4541 *   preconditioner(stokes_matrix,
4542 *   stokes_preconditioner_matrix,
4543 *   *Mp_preconditioner,
4544 *   *Amg_preconditioner,
4545 *   true);
4546 *  
4547 *   SolverControl solver_control_refined(stokes_matrix.m(),
4548 *   solver_tolerance);
4549 *   SolverFGMRES<TrilinosWrappers::MPI::BlockVector> solver(
4550 *   solver_control_refined,
4551 *   mem,
4552 *   SolverFGMRES<TrilinosWrappers::MPI::BlockVector>::AdditionalData(
4553 *   50));
4554 *   solver.solve(stokes_matrix,
4555 *   distributed_stokes_solution,
4556 *   stokes_rhs,
4557 *   preconditioner);
4558 *  
4559 *   n_iterations =
4560 *   (solver_control.last_step() + solver_control_refined.last_step());
4561 *   }
4562 *  
4563 *  
4564 *   stokes_constraints.distribute(distributed_stokes_solution);
4565 *  
4566 *   distributed_stokes_solution.block(1) *= EquationData::pressure_scaling;
4567 *  
4568 *   stokes_solution = distributed_stokes_solution;
4569 *   pcout << n_iterations << " iterations." << std::endl;
4570 *   }
4571 *  
4572 *  
4573 * @endcode
4574 *
4575 * Now let's turn to the temperature part: First, we compute the time step
4576 * size. We found that we need smaller time steps for 3d than for 2d for
4577 * the shell geometry. This is because the cells are more distorted in
4578 * that case (it is the smallest edge length that determines the CFL
4579 * number). Instead of computing the time step from maximum velocity and
4580 * minimal mesh size as in @ref step_31 "step-31", we compute local CFL numbers, i.e., on
4581 * each cell we compute the maximum velocity times the mesh size, and
4582 * compute the maximum of them. Hence, we need to choose the factor in
4583 * front of the time step slightly smaller. (We later re-considered this
4584 * approach towards time stepping. If you're curious about this, you may
4585 * want to read the time stepping section in @cite HDGB17 .)
4586 *
4587
4588 *
4589 * After temperature right hand side assembly, we solve the linear
4590 * system for temperature (with fully distributed vectors without
4591 * ghost elements and using the solution from the last timestep as
4592 * our initial guess for the iterative solver), apply constraints,
4593 * and copy the vector back to one with ghosts.
4594 *
4595
4596 *
4597 * In the end, we extract the temperature range similarly to @ref step_31 "step-31" to
4598 * produce some output (for example in order to help us choose the
4599 * stabilization constants, as discussed in the introduction). The only
4600 * difference is that we need to exchange maxima over all processors.
4601 *
4602 * @code
4603 *   {
4604 *   TimerOutput::Scope timer_section(computing_timer,
4605 *   " Assemble temperature rhs");
4606 *  
4607 *   old_time_step = time_step;
4608 *  
4609 *   const double scaling = (dim == 3 ? 0.25 : 1.0);
4610 *   time_step = (scaling / (2.1 * dim * std::sqrt(1. * dim)) /
4611 *   (parameters.temperature_degree * get_cfl_number()));
4612 *  
4613 *   const double maximal_velocity = get_maximal_velocity();
4614 *   pcout << " Maximal velocity: "
4615 *   << maximal_velocity * EquationData::year_in_seconds * 100
4616 *   << " cm/year" << std::endl;
4617 *   pcout << " "
4618 *   << "Time step: " << time_step / EquationData::year_in_seconds
4619 *   << " years" << std::endl;
4620 *  
4621 *   assemble_temperature_system(maximal_velocity);
4622 *   }
4623 *  
4624 *   {
4625 *   TimerOutput::Scope timer_section(computing_timer,
4626 *   " Solve temperature system");
4627 *  
4628 *   SolverControl solver_control(temperature_matrix.m(),
4629 *   1e-12 * temperature_rhs.l2_norm());
4630 *   SolverCG<TrilinosWrappers::MPI::Vector> cg(solver_control);
4631 *  
4632 *   TrilinosWrappers::MPI::Vector distributed_temperature_solution(
4633 *   temperature_rhs);
4634 *   distributed_temperature_solution = old_temperature_solution;
4635 *  
4636 *   cg.solve(temperature_matrix,
4637 *   distributed_temperature_solution,
4638 *   temperature_rhs,
4639 *   *T_preconditioner);
4640 *  
4641 *   temperature_constraints.distribute(distributed_temperature_solution);
4642 *   temperature_solution = distributed_temperature_solution;
4643 *  
4644 *   pcout << " " << solver_control.last_step()
4645 *   << " CG iterations for temperature" << std::endl;
4646 *  
4647 *   double temperature[2] = {std::numeric_limits<double>::max(),
4648 *   -std::numeric_limits<double>::max()};
4649 *   double global_temperature[2];
4650 *  
4651 *   for (unsigned int i =
4652 *   distributed_temperature_solution.local_range().first;
4653 *   i < distributed_temperature_solution.local_range().second;
4654 *   ++i)
4655 *   {
4656 *   temperature[0] =
4657 *   std::min<double>(temperature[0],
4658 *   distributed_temperature_solution(i));
4659 *   temperature[1] =
4660 *   std::max<double>(temperature[1],
4661 *   distributed_temperature_solution(i));
4662 *   }
4663 *  
4664 *   temperature[0] *= -1.0;
4665 *   Utilities::MPI::max(temperature, MPI_COMM_WORLD, global_temperature);
4666 *   global_temperature[0] *= -1.0;
4667 *  
4668 *   pcout << " Temperature range: " << global_temperature[0] << ' '
4669 *   << global_temperature[1] << std::endl;
4670 *   }
4671 *   }
4672 *  
4673 *  
4674 * @endcode
4675 *
4676 *
4677 * <a name="step_32-BoussinesqFlowProblemoutput_results"></a>
4678 * <h4>BoussinesqFlowProblem::output_results</h4>
4679 *
4680
4681 *
4682 * Next comes the function that generates the output. The quantities to
4683 * output could be introduced manually like we did in @ref step_31 "step-31". An
4684 * alternative is to hand this task over to a class PostProcessor that
4685 * inherits from the class DataPostprocessor, which can be attached to
4686 * DataOut. This allows us to output derived quantities from the solution,
4687 * like the friction heating included in this example. It overloads the
4688 * virtual function DataPostprocessor::evaluate_vector_field(),
4689 * which is then internally called from DataOut::build_patches(). We have to
4690 * give it values of the numerical solution, its derivatives, normals to the
4691 * cell, the actual evaluation points and any additional quantities. This
4692 * follows the same procedure as discussed in @ref step_29 "step-29" and other programs.
4693 *
4694 * @code
4695 *   template <int dim>
4696 *   class BoussinesqFlowProblem<dim>::Postprocessor
4697 *   : public DataPostprocessor<dim>
4698 *   {
4699 *   public:
4700 *   Postprocessor(const unsigned int partition, const double minimal_pressure);
4701 *  
4702 *   virtual void evaluate_vector_field(
4703 *   const DataPostprocessorInputs::Vector<dim> &inputs,
4704 *   std::vector<Vector<double>> &computed_quantities) const override;
4705 *  
4706 *   virtual std::vector<std::string> get_names() const override;
4707 *  
4708 *   virtual std::vector<
4709 *   DataComponentInterpretation::DataComponentInterpretation>
4710 *   get_data_component_interpretation() const override;
4711 *  
4712 *   virtual UpdateFlags get_needed_update_flags() const override;
4713 *  
4714 *   private:
4715 *   const unsigned int partition;
4716 *   const double minimal_pressure;
4717 *   };
4718 *  
4719 *  
4720 *   template <int dim>
4721 *   BoussinesqFlowProblem<dim>::Postprocessor::Postprocessor(
4722 *   const unsigned int partition,
4723 *   const double minimal_pressure)
4724 *   : partition(partition)
4725 *   , minimal_pressure(minimal_pressure)
4726 *   {}
4727 *  
4728 *  
4729 * @endcode
4730 *
4731 * Here we define the names for the variables we want to output. These are
4732 * the actual solution values for velocity, pressure, and temperature, as
4733 * well as the friction heating and to each cell the number of the processor
4734 * that owns it. This allows us to visualize the partitioning of the domain
4735 * among the processors. Except for the velocity, which is vector-valued,
4736 * all other quantities are scalar.
4737 *
4738 * @code
4739 *   template <int dim>
4740 *   std::vector<std::string>
4741 *   BoussinesqFlowProblem<dim>::Postprocessor::get_names() const
4742 *   {
4743 *   std::vector<std::string> solution_names(dim, "velocity");
4744 *   solution_names.emplace_back("p");
4745 *   solution_names.emplace_back("T");
4746 *   solution_names.emplace_back("friction_heating");
4747 *   solution_names.emplace_back("partition");
4748 *  
4749 *   return solution_names;
4750 *   }
4751 *  
4752 *  
4753 *   template <int dim>
4754 *   std::vector<DataComponentInterpretation::DataComponentInterpretation>
4755 *   BoussinesqFlowProblem<dim>::Postprocessor::get_data_component_interpretation()
4756 *   const
4757 *   {
4758 *   std::vector<DataComponentInterpretation::DataComponentInterpretation>
4759 *   interpretation(dim,
4760 *   DataComponentInterpretation::component_is_part_of_vector);
4761 *  
4762 *   interpretation.push_back(DataComponentInterpretation::component_is_scalar);
4763 *   interpretation.push_back(DataComponentInterpretation::component_is_scalar);
4764 *   interpretation.push_back(DataComponentInterpretation::component_is_scalar);
4765 *   interpretation.push_back(DataComponentInterpretation::component_is_scalar);
4766 *  
4767 *   return interpretation;
4768 *   }
4769 *  
4770 *  
4771 *   template <int dim>
4772 *   UpdateFlags
4773 *   BoussinesqFlowProblem<dim>::Postprocessor::get_needed_update_flags() const
4774 *   {
4775 *   return update_values | update_gradients | update_quadrature_points;
4776 *   }
4777 *  
4778 *  
4779 * @endcode
4780 *
4781 * Now we implement the function that computes the derived quantities. As we
4782 * also did for the output, we rescale the velocity from its SI units to
4783 * something more readable, namely cm/year. Next, the pressure is scaled to
4784 * be between 0 and the maximum pressure. This makes it more easily
4785 * comparable -- in essence making all pressure variables positive or
4786 * zero. Temperature is taken as is, and the friction heating is computed as
4787 * @f$2 \eta \varepsilon(\mathbf{u}) \cdot \varepsilon(\mathbf{u})@f$.
4788 *
4789
4790 *
4791 * The quantities we output here are more for illustration, rather than for
4792 * actual scientific value. We come back to this briefly in the results
4793 * section of this program and explain what one may in fact be interested in.
4794 *
4795 * @code
4796 *   template <int dim>
4797 *   void BoussinesqFlowProblem<dim>::Postprocessor::evaluate_vector_field(
4798 *   const DataPostprocessorInputs::Vector<dim> &inputs,
4799 *   std::vector<Vector<double>> &computed_quantities) const
4800 *   {
4801 *   const unsigned int n_evaluation_points = inputs.solution_values.size();
4802 *   Assert(inputs.solution_gradients.size() == n_evaluation_points,
4803 *   ExcInternalError());
4804 *   Assert(computed_quantities.size() == n_evaluation_points,
4805 *   ExcInternalError());
4806 *   Assert(inputs.solution_values[0].size() == dim + 2, ExcInternalError());
4807 *  
4808 *   for (unsigned int p = 0; p < n_evaluation_points; ++p)
4809 *   {
4810 *   for (unsigned int d = 0; d < dim; ++d)
4811 *   computed_quantities[p](d) = (inputs.solution_values[p](d) *
4812 *   EquationData::year_in_seconds * 100);
4813 *  
4814 *   const double pressure =
4815 *   (inputs.solution_values[p](dim) - minimal_pressure);
4816 *   computed_quantities[p](dim) = pressure;
4817 *  
4818 *   const double temperature = inputs.solution_values[p](dim + 1);
4819 *   computed_quantities[p](dim + 1) = temperature;
4820 *  
4821 *   Tensor<2, dim> grad_u;
4822 *   for (unsigned int d = 0; d < dim; ++d)
4823 *   grad_u[d] = inputs.solution_gradients[p][d];
4824 *   const SymmetricTensor<2, dim> strain_rate = symmetrize(grad_u);
4825 *   computed_quantities[p](dim + 2) =
4826 *   2 * EquationData::eta * strain_rate * strain_rate;
4827 *  
4828 *   computed_quantities[p](dim + 3) = partition;
4829 *   }
4830 *   }
4831 *  
4832 *  
4833 * @endcode
4834 *
4835 * The <code>output_results()</code> function has a similar task to the one
4836 * in @ref step_31 "step-31". However, here we are going to demonstrate a different
4837 * technique on how to merge output from different DoFHandler objects. The
4838 * way we're going to achieve this recombination is to create a joint
4839 * DoFHandler that collects both components, the Stokes solution and the
4840 * temperature solution. This can be nicely done by combining the finite
4841 * elements from the two systems to form one FESystem, and let this
4842 * collective system define a new DoFHandler object. To be sure that
4843 * everything was done correctly, we perform a sanity check that ensures
4844 * that we got all the dofs from both Stokes and temperature even in the
4845 * combined system. We then combine the data vectors. Unfortunately, there
4846 * is no straight-forward relation that tells us how to sort Stokes and
4847 * temperature vector into the joint vector. The way we can get around this
4848 * trouble is to rely on the information collected in the FESystem. For each
4849 * dof on a cell, the joint finite element knows to which equation component
4850 * (velocity component, pressure, or temperature) it belongs – that's the
4851 * information we need! So we step through all cells (with iterators into
4852 * all three DoFHandlers moving in sync), and for each joint cell dof, we
4853 * read out that component using the FiniteElement::system_to_base_index
4854 * function (see there for a description of what the various parts of its
4855 * return value contain). We also need to keep track whether we're on a
4856 * Stokes dof or a temperature dof, which is contained in
4857 * joint_fe.system_to_base_index(i).first.first. Eventually, the dof_indices
4858 * data structures on either of the three systems tell us how the relation
4859 * between global vector and local dofs looks like on the present cell,
4860 * which concludes this tedious work. We make sure that each processor only
4861 * works on the subdomain it owns locally (and not on ghost or artificial
4862 * cells) when building the joint solution vector. The same will then have
4863 * to be done in DataOut::build_patches(), but that function does so
4864 * automatically.
4865 *
4866
4867 *
4868 * What we end up with is a set of patches that we can write using the
4869 * functions in DataOutBase in a variety of output formats. Here, we then
4870 * have to pay attention that what each processor writes is really only its
4871 * own part of the domain, i.e. we will want to write each processor's
4872 * contribution into a separate file. This we do by adding an additional
4873 * number to the filename when we write the solution. This is not really
4874 * new, we did it similarly in @ref step_40 "step-40". Note that we write in the compressed
4875 * format @p .vtu instead of plain vtk files, which saves quite some
4876 * storage.
4877 *
4878
4879 *
4880 * All the rest of the work is done in the PostProcessor class.
4881 *
4882 * @code
4883 *   template <int dim>
4884 *   void BoussinesqFlowProblem<dim>::output_results()
4885 *   {
4886 *   TimerOutput::Scope timer_section(computing_timer, "Postprocessing");
4887 *  
4888 *   const FESystem<dim> joint_fe(stokes_fe, 1, temperature_fe, 1);
4889 *  
4890 *   DoFHandler<dim> joint_dof_handler(triangulation);
4891 *   joint_dof_handler.distribute_dofs(joint_fe);
4892 *   Assert(joint_dof_handler.n_dofs() ==
4893 *   stokes_dof_handler.n_dofs() + temperature_dof_handler.n_dofs(),
4894 *   ExcInternalError());
4895 *  
4896 *   TrilinosWrappers::MPI::Vector joint_solution;
4897 *   joint_solution.reinit(joint_dof_handler.locally_owned_dofs(),
4898 *   MPI_COMM_WORLD);
4899 *  
4900 *   {
4901 *   std::vector<types::global_dof_index> local_joint_dof_indices(
4902 *   joint_fe.n_dofs_per_cell());
4903 *   std::vector<types::global_dof_index> local_stokes_dof_indices(
4904 *   stokes_fe.n_dofs_per_cell());
4905 *   std::vector<types::global_dof_index> local_temperature_dof_indices(
4906 *   temperature_fe.n_dofs_per_cell());
4907 *  
4908 *   typename DoFHandler<dim>::active_cell_iterator
4909 *   joint_cell = joint_dof_handler.begin_active(),
4910 *   joint_endc = joint_dof_handler.end(),
4911 *   stokes_cell = stokes_dof_handler.begin_active(),
4912 *   temperature_cell = temperature_dof_handler.begin_active();
4913 *   for (; joint_cell != joint_endc;
4914 *   ++joint_cell, ++stokes_cell, ++temperature_cell)
4915 *   if (joint_cell->is_locally_owned())
4916 *   {
4917 *   joint_cell->get_dof_indices(local_joint_dof_indices);
4918 *   stokes_cell->get_dof_indices(local_stokes_dof_indices);
4919 *   temperature_cell->get_dof_indices(local_temperature_dof_indices);
4920 *  
4921 *   for (unsigned int i = 0; i < joint_fe.n_dofs_per_cell(); ++i)
4922 *   if (joint_fe.system_to_base_index(i).first.first == 0)
4923 *   {
4924 *   Assert(joint_fe.system_to_base_index(i).second <
4925 *   local_stokes_dof_indices.size(),
4926 *   ExcInternalError());
4927 *  
4928 *   joint_solution(local_joint_dof_indices[i]) = stokes_solution(
4929 *   local_stokes_dof_indices[joint_fe.system_to_base_index(i)
4930 *   .second]);
4931 *   }
4932 *   else
4933 *   {
4934 *   Assert(joint_fe.system_to_base_index(i).first.first == 1,
4935 *   ExcInternalError());
4936 *   Assert(joint_fe.system_to_base_index(i).second <
4937 *   local_temperature_dof_indices.size(),
4938 *   ExcInternalError());
4939 *   joint_solution(local_joint_dof_indices[i]) =
4940 *   temperature_solution(
4941 *   local_temperature_dof_indices
4942 *   [joint_fe.system_to_base_index(i).second]);
4943 *   }
4944 *   }
4945 *   }
4946 *  
4947 *   joint_solution.compress(VectorOperation::insert);
4948 *  
4949 *   const IndexSet locally_relevant_joint_dofs =
4950 *   DoFTools::extract_locally_relevant_dofs(joint_dof_handler);
4951 *   TrilinosWrappers::MPI::Vector locally_relevant_joint_solution;
4952 *   locally_relevant_joint_solution.reinit(locally_relevant_joint_dofs,
4953 *   MPI_COMM_WORLD);
4954 *   locally_relevant_joint_solution = joint_solution;
4955 *  
4956 *   Postprocessor postprocessor(Utilities::MPI::this_mpi_process(
4957 *   MPI_COMM_WORLD),
4958 *   stokes_solution.block(1).min());
4959 *  
4960 *   DataOut<dim> data_out;
4961 *   data_out.attach_dof_handler(joint_dof_handler);
4962 *   data_out.add_data_vector(locally_relevant_joint_solution, postprocessor);
4963 *   data_out.build_patches();
4964 *  
4965 *   static int out_index = 0;
4966 *   data_out.write_vtu_with_pvtu_record(
4967 *   "./", "solution", out_index, MPI_COMM_WORLD, 5);
4968 *  
4969 *   ++out_index;
4970 *   }
4971 *  
4972 *  
4973 *  
4974 * @endcode
4975 *
4976 *
4977 * <a name="step_32-BoussinesqFlowProblemrefine_mesh"></a>
4978 * <h4>BoussinesqFlowProblem::refine_mesh</h4>
4979 *
4980
4981 *
4982 * This function isn't really new either. Since the <code>setup_dofs</code>
4983 * function that we call in the middle has its own timer section, we split
4984 * timing this function into two sections. It will also allow us to easily
4985 * identify which of the two is more expensive.
4986 *
4987
4988 *
4989 * One thing of note, however, is that we only want to compute error
4990 * indicators on the locally owned subdomain. In order to achieve this, we
4991 * pass one additional argument to the KellyErrorEstimator::estimate
4992 * function. Note that the vector for error estimates is resized to the
4993 * number of active cells present on the current process, which is less than
4994 * the total number of active cells on all processors (but more than the
4995 * number of locally owned active cells); each processor only has a few
4996 * coarse cells around the locally owned ones, as also explained in @ref step_40 "step-40".
4997 *
4998
4999 *
5000 * The local error estimates are then handed to a %parallel version of
5002 * also @ref step_40 "step-40") which looks at the errors and finds the cells that need
5003 * refinement by comparing the error values across processors. As in
5004 * @ref step_31 "step-31", we want to limit the maximum grid level. So in case some cells
5005 * have been marked that are already at the finest level, we simply clear
5006 * the refine flags.
5007 *
5008 * @code
5009 *   template <int dim>
5010 *   void
5011 *   BoussinesqFlowProblem<dim>::refine_mesh(const unsigned int max_grid_level)
5012 *   {
5014 *   temperature_trans(temperature_dof_handler);
5017 *   stokes_trans(stokes_dof_handler);
5018 *  
5019 *   {
5020 *   TimerOutput::Scope timer_section(computing_timer,
5021 *   "Refine mesh structure, part 1");
5022 *  
5023 *   Vector<float> estimated_error_per_cell(triangulation.n_active_cells());
5024 *  
5026 *   temperature_dof_handler,
5027 *   QGauss<dim - 1>(parameters.temperature_degree + 1),
5028 *   std::map<types::boundary_id, const Function<dim> *>(),
5029 *   temperature_solution,
5030 *   estimated_error_per_cell,
5031 *   ComponentMask(),
5032 *   nullptr,
5033 *   0,
5034 *   triangulation.locally_owned_subdomain());
5035 *  
5037 *   triangulation, estimated_error_per_cell, 0.3, 0.1);
5038 *  
5039 *   if (triangulation.n_levels() > max_grid_level)
5040 *   for (typename Triangulation<dim>::active_cell_iterator cell =
5041 *   triangulation.begin_active(max_grid_level);
5042 *   cell != triangulation.end();
5043 *   ++cell)
5044 *   cell->clear_refine_flag();
5045 *  
5046 * @endcode
5047 *
5048 * With all flags marked as necessary, we can then tell the
5049 * parallel::distributed::SolutionTransfer objects to get ready to
5050 * transfer data from one mesh to the next, which they will do when
5051 * notified by
5052 * Triangulation as part of the @p execute_coarsening_and_refinement() call.
5053 * The syntax is similar to the non-%parallel solution transfer (with the
5054 * exception that here a pointer to the vector entries is enough). The
5055 * remainder of the function further down below is then concerned with
5056 * setting up the data structures again after mesh refinement and
5057 * restoring the solution vectors on the new mesh.
5058 *
5059 * @code
5060 *   const std::vector<const TrilinosWrappers::MPI::Vector *> x_temperature = {
5061 *   &temperature_solution, &old_temperature_solution};
5062 *   const std::vector<const TrilinosWrappers::MPI::BlockVector *> x_stokes = {
5063 *   &stokes_solution, &old_stokes_solution};
5064 *  
5065 *   triangulation.prepare_coarsening_and_refinement();
5066 *  
5067 *   temperature_trans.prepare_for_coarsening_and_refinement(x_temperature);
5068 *   stokes_trans.prepare_for_coarsening_and_refinement(x_stokes);
5069 *  
5070 *   triangulation.execute_coarsening_and_refinement();
5071 *   }
5072 *  
5073 *   setup_dofs();
5074 *  
5075 *   {
5076 *   TimerOutput::Scope timer_section(computing_timer,
5077 *   "Refine mesh structure, part 2");
5078 *  
5079 *   {
5080 *   TrilinosWrappers::MPI::Vector distributed_temp1(temperature_rhs);
5081 *   TrilinosWrappers::MPI::Vector distributed_temp2(temperature_rhs);
5082 *  
5083 *   std::vector<TrilinosWrappers::MPI::Vector *> tmp = {&distributed_temp1,
5084 *   &distributed_temp2};
5085 *   temperature_trans.interpolate(tmp);
5086 *  
5087 * @endcode
5088 *
5089 * enforce constraints to make the interpolated solution conforming on
5090 * the new mesh:
5091 *
5092 * @code
5093 *   temperature_constraints.distribute(distributed_temp1);
5094 *   temperature_constraints.distribute(distributed_temp2);
5095 *  
5096 *   temperature_solution = distributed_temp1;
5097 *   old_temperature_solution = distributed_temp2;
5098 *   }
5099 *  
5100 *   {
5101 *   TrilinosWrappers::MPI::BlockVector distributed_stokes(stokes_rhs);
5102 *   TrilinosWrappers::MPI::BlockVector old_distributed_stokes(stokes_rhs);
5103 *  
5104 *   std::vector<TrilinosWrappers::MPI::BlockVector *> stokes_tmp = {
5105 *   &distributed_stokes, &old_distributed_stokes};
5106 *  
5107 *   stokes_trans.interpolate(stokes_tmp);
5108 *  
5109 * @endcode
5110 *
5111 * enforce constraints to make the interpolated solution conforming on
5112 * the new mesh:
5113 *
5114 * @code
5115 *   stokes_constraints.distribute(distributed_stokes);
5116 *   stokes_constraints.distribute(old_distributed_stokes);
5117 *  
5118 *   stokes_solution = distributed_stokes;
5119 *   old_stokes_solution = old_distributed_stokes;
5120 *   }
5121 *   }
5122 *   }
5123 *  
5124 *  
5125 *  
5126 * @endcode
5127 *
5128 *
5129 * <a name="step_32-BoussinesqFlowProblemrun"></a>
5130 * <h4>BoussinesqFlowProblem::run</h4>
5131 *
5132
5133 *
5134 * This is the final and controlling function in this class. It, in fact,
5135 * runs the entire rest of the program and is, once more, very similar to
5136 * @ref step_31 "step-31". The only substantial difference is that we use a different mesh
5137 * now (a GridGenerator::hyper_shell instead of a simple cube geometry).
5138 *
5139 * @code
5140 *   template <int dim>
5141 *   void BoussinesqFlowProblem<dim>::run()
5142 *   {
5144 *   Point<dim>(),
5145 *   EquationData::R0,
5146 *   EquationData::R1,
5147 *   (dim == 3) ? 96 : 12,
5148 *   true);
5149 *  
5150 *   global_Omega_diameter = GridTools::diameter(triangulation);
5151 *  
5152 *   triangulation.refine_global(parameters.initial_global_refinement);
5153 *  
5154 *   setup_dofs();
5155 *  
5156 *   unsigned int pre_refinement_step = 0;
5157 *  
5158 *   start_time_iteration:
5159 *  
5160 *   {
5161 *   TrilinosWrappers::MPI::Vector solution(
5162 *   temperature_dof_handler.locally_owned_dofs());
5163 * @endcode
5164 *
5165 * VectorTools::project supports parallel vector classes with most
5166 * standard finite elements via deal.II's own native MatrixFree framework:
5167 * since we use standard Lagrange elements of moderate order this function
5168 * works well here.
5169 *
5170 * @code
5171 *   VectorTools::project(temperature_dof_handler,
5172 *   temperature_constraints,
5173 *   QGauss<dim>(parameters.temperature_degree + 2),
5174 *   EquationData::TemperatureInitialValues<dim>(),
5175 *   solution);
5176 * @endcode
5177 *
5178 * Having so computed the current temperature field, let us set the member
5179 * variable that holds the temperature nodes. Strictly speaking, we really
5180 * only need to set <code>old_temperature_solution</code> since the first
5181 * thing we will do is to compute the Stokes solution that only requires
5182 * the previous time step's temperature field. That said, nothing good can
5183 * come from not initializing the other vectors as well (especially since
5184 * it's a relatively cheap operation and we only have to do it once at the
5185 * beginning of the program) if we ever want to extend our numerical
5186 * method or physical model, and so we initialize
5187 * <code>old_temperature_solution</code> and
5188 * <code>old_old_temperature_solution</code> as well. The assignment makes
5189 * sure that the vectors on the left hand side (which where initialized to
5190 * contain ghost elements as well) also get the correct ghost elements. In
5191 * other words, the assignment here requires communication between
5192 * processors:
5193 *
5194 * @code
5195 *   temperature_solution = solution;
5196 *   old_temperature_solution = solution;
5197 *   old_old_temperature_solution = solution;
5198 *   }
5199 *  
5200 *   timestep_number = 0;
5201 *   time_step = old_time_step = 0;
5202 *  
5203 *   double time = 0;
5204 *  
5205 *   do
5206 *   {
5207 *   pcout << "Timestep " << timestep_number
5208 *   << ": t=" << time / EquationData::year_in_seconds << " years"
5209 *   << std::endl;
5210 *  
5211 *   assemble_stokes_system();
5212 *   build_stokes_preconditioner();
5213 *   assemble_temperature_matrix();
5214 *  
5215 *   solve();
5216 *  
5217 *   pcout << std::endl;
5218 *  
5219 *   if ((timestep_number == 0) &&
5220 *   (pre_refinement_step < parameters.initial_adaptive_refinement))
5221 *   {
5222 *   refine_mesh(parameters.initial_global_refinement +
5223 *   parameters.initial_adaptive_refinement);
5224 *   ++pre_refinement_step;
5225 *   goto start_time_iteration;
5226 *   }
5227 *   else if ((timestep_number > 0) &&
5228 *   (timestep_number % parameters.adaptive_refinement_interval ==
5229 *   0))
5230 *   refine_mesh(parameters.initial_global_refinement +
5231 *   parameters.initial_adaptive_refinement);
5232 *  
5233 *   if ((parameters.generate_graphical_output == true) &&
5234 *   (timestep_number % parameters.graphical_output_interval == 0))
5235 *   output_results();
5236 *  
5237 * @endcode
5238 *
5239 * In order to speed up linear solvers, we extrapolate the solutions
5240 * from the old time levels to the new one. This gives a very good
5241 * initial guess, cutting the number of iterations needed in solvers
5242 * by more than one half. We do not need to extrapolate in the last
5243 * iteration, so if we reached the final time, we stop here.
5244 *
5245
5246 *
5247 * As the last thing during a time step (before actually bumping up
5248 * the number of the time step), we check whether the current time
5249 * step number is divisible by 100, and if so we let the computing
5250 * timer print a summary of CPU times spent so far.
5251 *
5252 * @code
5253 *   if (time > parameters.end_time * EquationData::year_in_seconds)
5254 *   break;
5255 *  
5256 *   TrilinosWrappers::MPI::BlockVector old_old_stokes_solution;
5257 *   old_old_stokes_solution = old_stokes_solution;
5258 *   old_stokes_solution = stokes_solution;
5259 *   old_old_temperature_solution = old_temperature_solution;
5260 *   old_temperature_solution = temperature_solution;
5261 *   if (old_time_step > 0)
5262 *   {
5263 * @endcode
5264 *
5265 * Trilinos sadd does not like ghost vectors even as input. Copy
5266 * into distributed vectors for now:
5267 *
5268 * @code
5269 *   {
5270 *   TrilinosWrappers::MPI::BlockVector distr_solution(stokes_rhs);
5271 *   distr_solution = stokes_solution;
5272 *   TrilinosWrappers::MPI::BlockVector distr_old_solution(stokes_rhs);
5273 *   distr_old_solution = old_old_stokes_solution;
5274 *   distr_solution.sadd(1. + time_step / old_time_step,
5275 *   -time_step / old_time_step,
5276 *   distr_old_solution);
5277 *   stokes_solution = distr_solution;
5278 *   }
5279 *   {
5280 *   TrilinosWrappers::MPI::Vector distr_solution(temperature_rhs);
5281 *   distr_solution = temperature_solution;
5282 *   TrilinosWrappers::MPI::Vector distr_old_solution(temperature_rhs);
5283 *   distr_old_solution = old_old_temperature_solution;
5284 *   distr_solution.sadd(1. + time_step / old_time_step,
5285 *   -time_step / old_time_step,
5286 *   distr_old_solution);
5287 *   temperature_solution = distr_solution;
5288 *   }
5289 *   }
5290 *  
5291 *   if ((timestep_number > 0) && (timestep_number % 100 == 0))
5292 *   computing_timer.print_summary();
5293 *  
5294 *   time += time_step;
5295 *   ++timestep_number;
5296 *   }
5297 *   while (true);
5298 *  
5299 * @endcode
5300 *
5301 * If we are generating graphical output, do so also for the last time
5302 * step unless we had just done so before we left the do-while loop
5303 *
5304 * @code
5305 *   if ((parameters.generate_graphical_output == true) &&
5306 *   !((timestep_number - 1) % parameters.graphical_output_interval == 0))
5307 *   output_results();
5308 *   }
5309 *   } // namespace Step32
5310 *  
5311 *  
5312 *  
5313 * @endcode
5314 *
5315 *
5316 * <a name="step_32-Thecodemaincodefunction"></a>
5317 * <h3>The <code>main</code> function</h3>
5318 *
5319
5320 *
5321 * The main function is short as usual and very similar to the one in
5322 * @ref step_31 "step-31". Since we use a parameter file which is specified as an argument in
5323 * the command line, we have to read it in here and pass it on to the
5324 * Parameters class for parsing. If no filename is given in the command line,
5325 * we simply use the <code>step-32.prm</code> file which is distributed
5326 * together with the program.
5327 *
5328
5329 *
5330 * Because 3d computations are simply very slow unless you throw a lot of
5331 * processors at them, the program defaults to 2d. You can get the 3d version
5332 * by changing the constant dimension below to 3.
5333 *
5334 * @code
5335 *   int main(int argc, char *argv[])
5336 *   {
5337 *   try
5338 *   {
5339 *   using namespace Step32;
5340 *   using namespace dealii;
5341 *  
5342 *   Utilities::MPI::MPI_InitFinalize mpi_initialization(
5343 *   argc, argv, numbers::invalid_unsigned_int);
5344 *  
5345 *   std::string parameter_filename;
5346 *   if (argc >= 2)
5347 *   parameter_filename = argv[1];
5348 *   else
5349 *   parameter_filename = "step-32.prm";
5350 *  
5351 *   const int dim = 2;
5352 *   BoussinesqFlowProblem<dim>::Parameters parameters(parameter_filename);
5353 *   BoussinesqFlowProblem<dim> flow_problem(parameters);
5354 *   flow_problem.run();
5355 *   }
5356 *   catch (std::exception &exc)
5357 *   {
5358 *   std::cerr << std::endl
5359 *   << std::endl
5360 *   << "----------------------------------------------------"
5361 *   << std::endl;
5362 *   std::cerr << "Exception on processing: " << std::endl
5363 *   << exc.what() << std::endl
5364 *   << "Aborting!" << std::endl
5365 *   << "----------------------------------------------------"
5366 *   << std::endl;
5367 *  
5368 *   return 1;
5369 *   }
5370 *   catch (...)
5371 *   {
5372 *   std::cerr << std::endl
5373 *   << std::endl
5374 *   << "----------------------------------------------------"
5375 *   << std::endl;
5376 *   std::cerr << "Unknown exception!" << std::endl
5377 *   << "Aborting!" << std::endl
5378 *   << "----------------------------------------------------"
5379 *   << std::endl;
5380 *   return 1;
5381 *   }
5382 *  
5383 *   return 0;
5384 *   }
5385 * @endcode
5386<a name="step_32-Results"></a><h1>Results</h1>
5387
5388
5389When run, the program simulates convection in 3d in much the same way
5390as @ref step_31 "step-31" did, though with an entirely different testcase.
5391
5392
5393<a name="step_32-Comparisonofresultswithstep31"></a><h3>Comparison of results with step-31</h3>
5394
5395
5396Before we go to this testcase, however, let us show a few results from a
5397slightly earlier version of this program that was solving exactly the
5398testcase we used in @ref step_31 "step-31", just that we now solve it in parallel and with
5399much higher resolution. We show these results mainly for comparison.
5400
5401Here are two images that show this higher resolution if we choose a 3d
5402computation in <code>main()</code> and if we set
5403<code>initial_refinement=3</code> and
5404<code>n_pre_refinement_steps=4</code>. At the time steps shown, the
5405meshes had around 72,000 and 236,000 cells, for a total of 2,680,000
5406and 8,250,000 degrees of freedom, respectively, more than an order of
5407magnitude more than we had available in @ref step_31 "step-31":
5408
5409<table align="center" class="doxtable">
5410 <tr>
5411 <td>
5412 <img src="https://www.dealii.org/images/steps/developer/step-32.3d.cube.0.png" alt="">
5413 </td>
5414 </tr>
5415 <tr>
5416 <td>
5417 <img src="https://www.dealii.org/images/steps/developer/step-32.3d.cube.1.png" alt="">
5418 </td>
5419 </tr>
5420</table>
5421
5422The computation was done on a subset of 50 processors of the Brazos
5423cluster at Texas A&amp;M University.
5424
5425
5426<a name="step_32-Resultsfora2dcircularshelltestcase"></a><h3>Results for a 2d circular shell testcase</h3>
5427
5428
5429Next, we will run @ref step_32 "step-32" with the parameter file in the directory with one
5430change: we increase the final time to 1e9. Here we are using 16 processors. The
5431command to launch is (note that @ref step_32 "step-32".prm is the default):
5432
5433<code>
5434<pre>
5435\$ mpirun -np 16 ./step-32
5436</pre>
5437</code>
5438
5439Note that running a job on a cluster typically requires going through a job
5440scheduler, which we won't discuss here. The output will look roughly like
5441this:
5442
5443<code>
5444<pre>
5445\$ mpirun -np 16 ./step-32
5446Number of active cells: 12,288 (on 6 levels)
5447Number of degrees of freedom: 186,624 (99,840+36,864+49,920)
5448
5449Timestep 0: t=0 years
5450
5451 Rebuilding Stokes preconditioner...
5452 Solving Stokes system... 41 iterations.
5453 Maximal velocity: 60.4935 cm/year
5454 Time step: 18166.9 years
5455 17 CG iterations for temperature
5456 Temperature range: 973 4273.16
5457
5458Number of active cells: 15,921 (on 7 levels)
5459Number of degrees of freedom: 252,723 (136,640+47,763+68,320)
5460
5461Timestep 0: t=0 years
5462
5463 Rebuilding Stokes preconditioner...
5464 Solving Stokes system... 50 iterations.
5465 Maximal velocity: 60.3223 cm/year
5466 Time step: 10557.6 years
5467 19 CG iterations for temperature
5468 Temperature range: 973 4273.16
5469
5470Number of active cells: 19,926 (on 8 levels)
5471Number of degrees of freedom: 321,246 (174,312+59,778+87,156)
5472
5473Timestep 0: t=0 years
5474
5475 Rebuilding Stokes preconditioner...
5476 Solving Stokes system... 50 iterations.
5477 Maximal velocity: 57.8396 cm/year
5478 Time step: 5453.78 years
5479 18 CG iterations for temperature
5480 Temperature range: 973 4273.16
5481
5482Timestep 1: t=5453.78 years
5483
5484 Solving Stokes system... 49 iterations.
5485 Maximal velocity: 59.0231 cm/year
5486 Time step: 5345.86 years
5487 18 CG iterations for temperature
5488 Temperature range: 973 4273.16
5489
5490Timestep 2: t=10799.6 years
5491
5492 Solving Stokes system... 24 iterations.
5493 Maximal velocity: 60.2139 cm/year
5494 Time step: 5241.51 years
5495 17 CG iterations for temperature
5496 Temperature range: 973 4273.16
5497
5498[...]
5499
5500Timestep 100: t=272151 years
5501
5502 Solving Stokes system... 21 iterations.
5503 Maximal velocity: 161.546 cm/year
5504 Time step: 1672.96 years
5505 17 CG iterations for temperature
5506 Temperature range: 973 4282.57
5507
5508Number of active cells: 56,085 (on 8 levels)
5509Number of degrees of freedom: 903,408 (490,102+168,255+245,051)
5510
5511
5512
5513+---------------------------------------------+------------+------------+
5514| Total wallclock time elapsed since start | 115s | |
5515| | | |
5516| Section | no. calls | wall time | % of total |
5517+---------------------------------+-----------+------------+------------+
5518| Assemble Stokes system | 103 | 2.82s | 2.5% |
5519| Assemble temperature matrices | 12 | 0.452s | 0.39% |
5520| Assemble temperature rhs | 103 | 11.5s | 10% |
5521| Build Stokes preconditioner | 12 | 2.09s | 1.8% |
5522| Solve Stokes system | 103 | 90.4s | 79% |
5523| Solve temperature system | 103 | 1.53s | 1.3% |
5524| Postprocessing | 3 | 0.532s | 0.46% |
5525| Refine mesh structure, part 1 | 12 | 0.93s | 0.81% |
5526| Refine mesh structure, part 2 | 12 | 0.384s | 0.33% |
5527| Setup dof systems | 13 | 2.96s | 2.6% |
5528+---------------------------------+-----------+------------+------------+
5529
5530[...]
5531
5532+---------------------------------------------+------------+------------+
5533| Total wallclock time elapsed since start | 9.14e+04s | |
5534| | | |
5535| Section | no. calls | wall time | % of total |
5536+---------------------------------+-----------+------------+------------+
5537| Assemble Stokes system | 47045 | 2.05e+03s | 2.2% |
5538| Assemble temperature matrices | 4707 | 310s | 0.34% |
5539| Assemble temperature rhs | 47045 | 8.7e+03s | 9.5% |
5540| Build Stokes preconditioner | 4707 | 1.48e+03s | 1.6% |
5541| Solve Stokes system | 47045 | 7.34e+04s | 80% |
5542| Solve temperature system | 47045 | 1.46e+03s | 1.6% |
5543| Postprocessing | 1883 | 222s | 0.24% |
5544| Refine mesh structure, part 1 | 4706 | 641s | 0.7% |
5545| Refine mesh structure, part 2 | 4706 | 259s | 0.28% |
5546| Setup dof systems | 4707 | 1.86e+03s | 2% |
5547+---------------------------------+-----------+------------+------------+
5548</pre>
5549</code>
5550
5551The simulation terminates when the time reaches the 1 billion years
5552selected in the input file. You can extrapolate from this how long a
5553simulation would take for a different final time (the time step size
5554ultimately settles on somewhere around 20,000 years, so computing for
5555two billion years will take 100,000 time steps, give or take 20%). As
5556can be seen here, we spend most of the compute time in assembling
5557linear systems and &mdash; above all &mdash; in solving Stokes
5558systems.
5559
5560
5561To demonstrate the output we show the output from every 1250th time step here:
5562<table>
5563 <tr>
5564 <td>
5565 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-000.png" alt="">
5566 </td>
5567 <td>
5568 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-050.png" alt="">
5569 </td>
5570 <td>
5571 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-100.png" alt="">
5572 </td>
5573 </tr>
5574 <tr>
5575 <td>
5576 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-150.png" alt="">
5577 </td>
5578 <td>
5579 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-200.png" alt="">
5580 </td>
5581 <td>
5582 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-250.png" alt="">
5583 </td>
5584 </tr>
5585 <tr>
5586 <td>
5587 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-300.png" alt="">
5588 </td>
5589 <td>
5590 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-350.png" alt="">
5591 </td>
5592 <td>
5593 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-400.png" alt="">
5594 </td>
5595 </tr>
5596 <tr>
5597 <td>
5598 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-450.png" alt="">
5599 </td>
5600 <td>
5601 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-500.png" alt="">
5602 </td>
5603 <td>
5604 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-550.png" alt="">
5605 </td>
5606 </tr>
5607 <tr>
5608 <td>
5609 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-time-600.png" alt="">
5610 </td>
5611 <td>
5612 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-cells.png" alt="">
5613 </td>
5614 <td>
5615 <img src="https://www.dealii.org/images/steps/developer/step-32-2d-partition.png" alt="">
5616 </td>
5617 </tr>
5618</table>
5619
5620The last two images show the grid as well as the partitioning of the mesh for
5621the same computation with 16 subdomains and 16 processors. The full dynamics of
5622this simulation are really only visible by looking at an animation, for example
5623the one <a
5624href="https://www.dealii.org/images/steps/developer/step-32-2d-temperature.webm">shown
5625on this site</a>. This image is well worth watching due to its artistic quality
5626and entrancing depiction of the evolution of the magma plumes.
5627
5628If you watch the movie, you'll see that the convection pattern goes
5629through several stages: First, it gets rid of the instable temperature
5630layering with the hot material overlain by the dense cold
5631material. After this great driver is removed and we have a sort of
5632stable situation, a few blobs start to separate from the hot boundary
5633layer at the inner ring and rise up, with a few cold fingers also
5634dropping down from the outer boundary layer. During this phase, the solution
5635remains mostly symmetric, reflecting the 12-fold symmetry of the
5636original mesh. In a final phase, the fluid enters vigorous chaotic
5637stirring in which all symmetries are lost. This is a pattern that then
5638continues to dominate flow.
5639
5640These different phases can also be identified if we look at the
5641maximal velocity as a function of time in the simulation:
5642
5643<img src="https://www.dealii.org/images/steps/developer/step-32.2d.t_vs_vmax.png" alt="">
5644
5645Here, the velocity (shown in centimeters per year) becomes very large,
5646to the order of several meters per year) at the beginning when the
5647temperature layering is instable. It then calms down to relatively
5648small values before picking up again in the chaotic stirring
5649regime. There, it remains in the range of 10-40 centimeters per year,
5650quite within the physically expected region.
5651
5652
5653<a name="step_32-Resultsfora3dsphericalshelltestcase"></a><h3>Results for a 3d spherical shell testcase</h3>
5654
5655
56563d computations are very expensive computationally. Furthermore, as
5657seen above, interesting behavior only starts after quite a long time
5658requiring more CPU hours than is available on a typical
5659cluster. Consequently, rather than showing a complete simulation here,
5660let us simply show a couple of pictures we have obtained using the
5661successor to this program, called <i>ASPECT</i> (short for <i>Advanced
5662%Solver for Problems in Earth's ConvecTion</i>), that is being
5663developed independently of deal.II and that already incorporates some
5664of the extensions discussed below. The following two pictures show
5665isocontours of the temperature and the partition of the domain (along
5666with the mesh) onto 512 processors:
5667
5668<p align="center">
5669<img src="https://www.dealii.org/images/steps/developer/step-32.3d-sphere.solution.png" alt="">
5670
5671<img src="https://www.dealii.org/images/steps/developer/step-32.3d-sphere.partition.png" alt="">
5672</p>
5673
5674
5675<a name="step-32-extensions"></a>
5676<a name="step_32-Possibilitiesforextensions"></a><h3>Possibilities for extensions</h3>
5677
5678
5679There are many directions in which this program could be extended. As
5680mentioned at the end of the introduction, most of these are under active
5681development in the <i>ASPECT</i> (short for <i>Advanced %Solver for Problems
5682in Earth's ConvecTion</i>) code at the time this tutorial program is being
5683finished. Specifically, the following are certainly topics that one should
5684address to make the program more useful:
5685
5686<ul>
5687 <li> <b>Adiabatic heating/cooling:</b>
5688 The temperature field we get in our simulations after a while
5689 is mostly constant with boundary layers at the inner and outer
5690 boundary, and streamers of cold and hot material mixing
5691 everything. Yet, this doesn't match our expectation that things
5692 closer to the earth core should be hotter than closer to the
5693 surface. The reason is that the energy equation we have used does
5694 not include a term that describes adiabatic cooling and heating:
5695 rock, like gas, heats up as you compress it. Consequently, material
5696 that rises up cools adiabatically, and cold material that sinks down
5697 heats adiabatically. The correct temperature equation would
5698 therefore look somewhat like this:
5699 @f{eqnarray*}{
5700 \frac{D T}{Dt}
5701 -
5702 \nabla \cdot \kappa \nabla T &=& \gamma + \tau\frac{Dp}{Dt},
5703 @f}
5704 or, expanding the advected derivative @f$\frac{D}{Dt} =
5705 \frac{\partial}{\partial t} + \mathbf u \cdot \nabla@f$:
5706 @f{eqnarray*}{
5707 \frac{\partial T}{\partial t}
5708 +
5709 {\mathbf u} \cdot \nabla T
5710 -
5711 \nabla \cdot \kappa \nabla T &=& \gamma +
5712 \tau\left\{\frac{\partial
5713 p}{\partial t} + \mathbf u \cdot \nabla p \right\}.
5714 @f}
5715 In other words, as pressure increases in a rock volume
5716 (@f$\frac{Dp}{Dt}>0@f$) we get an additional heat source, and vice
5717 versa.
5718
5719 The time derivative of the pressure is a bit awkward to
5720 implement. If necessary, one could approximate using the fact
5721 outlined in the introduction that the pressure can be decomposed
5722 into a dynamic component due to temperature differences and the
5723 resulting flow, and a static component that results solely from the
5724 static pressure of the overlying rock. Since the latter is much
5725 bigger, one may approximate @f$p\approx p_{\text{static}}=-\rho_{\text{ref}}
5726 [1+\beta T_{\text{ref}}] \varphi@f$, and consequently
5727 @f$\frac{Dp}{Dt} \approx \left\{- \mathbf u \cdot \nabla \rho_{\text{ref}}
5728 [1+\beta T_{\text{ref}}]\varphi\right\} = \rho_{\text{ref}}
5729 [1+\beta T_{\text{ref}}] \mathbf u \cdot \mathbf g@f$.
5730 In other words, if the fluid is moving in the direction of gravity
5731 (downward) it will be compressed and because in that case @f$\mathbf u
5732 \cdot \mathbf g > 0@f$ we get a positive heat source. Conversely, the
5733 fluid will cool down if it moves against the direction of gravity.
5734
5735<li> <b>Compressibility:</b>
5736 As already hinted at in the temperature model above,
5737 mantle rocks are not incompressible. Rather, given the enormous pressures in
5738 the earth mantle (at the core-mantle boundary, the pressure is approximately
5739 140 GPa, equivalent to 1,400,000 times atmospheric pressure), rock actually
5740 does compress to something around 1.5 times the density it would have
5741 at surface pressure. Modeling this presents any number of
5742 difficulties. Primarily, the mass conservation equation is no longer
5743 @f$\textrm{div}\;\mathbf u=0@f$ but should read
5744 @f$\textrm{div}(\rho\mathbf u)=0@f$ where the density @f$\rho@f$ is now no longer
5745 spatially constant but depends on temperature and pressure. A consequence is
5746 that the model is now no longer linear; a linearized version of the Stokes
5747 equation is also no longer symmetric requiring us to rethink preconditioners
5748 and, possibly, even the discretization. We won't go into detail here as to
5749 how this can be resolved.
5750
5751<li> <b>Nonlinear material models:</b> As already hinted at in various places,
5752 material parameters such as the density, the viscosity, and the various
5753 thermal parameters are not constant throughout the earth mantle. Rather,
5754 they nonlinearly depend on the pressure and temperature, and in the case of
5755 the viscosity on the strain rate @f$\varepsilon(\mathbf u)@f$. For complicated
5756 models, the only way to solve such models accurately may be to actually
5757 iterate this dependence out in each time step, rather than simply freezing
5758 coefficients at values extrapolated from the previous time step(s).
5759
5760<li> <b>Checkpoint/restart:</b> Running this program in 2d on a number of
5761 processors allows solving realistic models in a day or two. However, in 3d,
5762 compute times are so large that one runs into two typical problems: (i) On
5763 most compute clusters, the queuing system limits run times for individual
5764 jobs are to 2 or 3 days; (ii) losing the results of a computation due to
5765 hardware failures, misconfigurations, or power outages is a shame when
5766 running on hundreds of processors for a couple of days. Both of these
5767 problems can be addressed by periodically saving the state of the program
5768 and, if necessary, restarting the program at this point. This technique is
5769 commonly called <i>checkpoint/restart</i> and it requires that the entire
5770 state of the program is written to a permanent storage location (e.g. a hard
5771 drive). Given the complexity of the data structures of this program, this is
5772 not entirely trivial (it may also involve writing gigabytes or more of
5773 data), but it can be made easier by realizing that one can save the state
5774 between two time steps where it essentially only consists of the mesh and
5775 solution vectors; during restart one would then first re-enumerate degrees
5776 of freedom in the same way as done before and then re-assemble
5777 matrices. Nevertheless, given the distributed nature of the data structures
5778 involved here, saving and restoring the state of a program is not
5779 trivial. An additional complexity is introduced by the fact that one may
5780 want to change the number of processors between runs, for example because
5781 one may wish to continue computing on a mesh that is finer than the one used
5782 to precompute a starting temperature field at an intermediate time.
5783
5784<li> <b>Predictive postprocessing:</b> The point of computations like this is
5785 not simply to solve the equations. Rather, it is typically the exploration
5786 of different physical models and their comparison with things that we can
5787 measure at the earth surface, in order to find which models are realistic
5788 and which are contradicted by reality. To this end, we need to compute
5789 quantities from our solution vectors that are related to what we can
5790 observe. Among these are, for example, heatfluxes at the surface of the
5791 earth, as well as seismic velocities throughout the mantle as these affect
5792 earthquake waves that are recorded by seismographs.
5793
5794<li> <b>Better refinement criteria:</b> As can be seen above for the
57953d case, the mesh in 3d is primarily refined along the inner
5796boundary. This is because the boundary layer there is stronger than
5797any other transition in the domain, leading us to refine there almost
5798exclusively and basically not at all following the plumes. One
5799certainly needs better refinement criteria to track the parts of the
5800solution we are really interested in better than the criterion used
5801here, namely the KellyErrorEstimator applied to the temperature, is
5802able to.
5803</ul>
5804
5805
5806There are many other ways to extend the current program. However, rather than
5807discussing them here, let us point to the much larger open
5808source code ASPECT (see https://aspect.geodynamics.org/ ) that constitutes the
5809further development of @ref step_32 "step-32" and that already includes many such possible
5810extensions.
5811 *
5812 *
5813<a name="step_32-PlainProg"></a>
5814<h1> The plain program</h1>
5815@include "step-32.cc"
5816*/
virtual void build_patches(const unsigned int n_subdivisions=0)
Definition data_out.cc:1062
void reinit(const Triangulation< dim, spacedim > &tria)
active_cell_iterator begin_active(const unsigned int level=0) const
Definition fe_q.h:554
std::pair< std::pair< unsigned int, unsigned int >, unsigned int > system_to_base_index(const unsigned int index) const
virtual RangeNumberType value(const Point< dim > &p, const unsigned int component=0) const
virtual void vector_value(const Point< dim > &p, Vector< RangeNumberType > &values) const
static void estimate(const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const Quadrature< dim - 1 > &quadrature, const std::map< types::boundary_id, const Function< spacedim, Number > * > &neumann_bc, const ReadVector< Number > &solution, Vector< float > &error, const ComponentMask &component_mask={}, const Function< spacedim > *coefficients=nullptr, const unsigned int n_threads=numbers::invalid_unsigned_int, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id, const types::material_id material_id=numbers::invalid_material_id, const Strategy strategy=cell_diameter_over_24)
Definition point.h:111
numbers::NumberTraits< Number >::real_type norm() const
Point< 2 > second
Definition grid_out.cc:4624
Point< 2 > first
Definition grid_out.cc:4623
unsigned int level
Definition grid_out.cc:4626
#define Assert(cond, exc)
#define AssertThrow(cond, exc)
typename ActiveSelector::active_cell_iterator active_cell_iterator
void loop(IteratorType begin, std_cxx20::type_identity_t< IteratorType > end, DOFINFO &dinfo, INFOBOX &info, const std::function< void(std_cxx20::type_identity_t< DOFINFO > &, typename INFOBOX::CellInfo &)> &cell_worker, const std::function< void(std_cxx20::type_identity_t< DOFINFO > &, typename INFOBOX::CellInfo &)> &boundary_worker, const std::function< void(std_cxx20::type_identity_t< DOFINFO > &, std_cxx20::type_identity_t< DOFINFO > &, typename INFOBOX::CellInfo &, typename INFOBOX::CellInfo &)> &face_worker, AssemblerType &assembler, const LoopControl &lctrl=LoopControl())
Definition loop.h:564
UpdateFlags
@ update_values
Shape function values.
@ update_JxW_values
Transformed quadrature weights.
@ update_gradients
Shape function gradients.
@ update_quadrature_points
Transformed quadrature points.
std::vector< index_type > data
Definition mpi.cc:735
std::size_t size
Definition mpi.cc:734
std::vector< value_type > split(const typename ::Triangulation< dim, spacedim >::cell_iterator &parent, const value_type parent_value)
const Event initial
Definition event.cc:64
const Event remesh
Definition event.cc:65
void approximate(const SynchronousIterators< std::tuple< typename DoFHandler< dim, spacedim >::active_cell_iterator, Vector< float >::iterator > > &cell, const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof_handler, const InputVector &solution, const unsigned int component)
Expression sign(const Expression &x)
std::vector< std::vector< bool > > extract_constant_modes(const DoFHandler< dim, spacedim > &dof_handler, const ComponentMask &component_mask={})
void extrapolate(const DoFHandler< dim, spacedim > &dof1, const InVector &z1, const DoFHandler< dim, spacedim > &dof2, OutVector &z2)
void hyper_shell(Triangulation< dim, spacedim > &tria, const Point< spacedim > &center, const double inner_radius, const double outer_radius, const unsigned int n_cells=0, bool colorize=false)
void refine(Triangulation< dim, spacedim > &tria, const Vector< Number > &criteria, const double threshold, const unsigned int max_to_mark=numbers::invalid_unsigned_int)
void scale(const double scaling_factor, Triangulation< dim, spacedim > &triangulation)
double volume(const Triangulation< dim, spacedim > &tria)
double diameter(const Triangulation< dim, spacedim > &tria)
@ valid
Iterator points to a valid object.
@ matrix
Contents is actually a matrix.
@ symmetric
Matrix is symmetric.
double norm(const FEValuesBase< dim > &fe, const ArrayView< const std::vector< Tensor< 1, dim > > > &Du)
Definition divergence.h:471
Point< spacedim > point(const gp_Pnt &p, const double tolerance=1e-10)
Definition utilities.cc:191
SymmetricTensor< 2, dim, Number > e(const Tensor< 2, dim, Number > &F)
SymmetricTensor< 2, dim, Number > b(const Tensor< 2, dim, Number > &F)
SymmetricTensor< 2, dim, Number > d(const Tensor< 2, dim, Number > &F, const Tensor< 2, dim, Number > &dF_dt)
VectorType::value_type * end(VectorType &V)
std::vector< unsigned int > serial(const std::vector< unsigned int > &targets, const std::function< RequestType(const unsigned int)> &create_request, const std::function< AnswerType(const unsigned int, const RequestType &)> &answer_request, const std::function< void(const unsigned int, const AnswerType &)> &process_answer, const MPI_Comm comm)
T sum(const T &t, const MPI_Comm mpi_communicator)
T max(const T &t, const MPI_Comm mpi_communicator)
unsigned int this_mpi_process(const MPI_Comm mpi_communicator)
Definition mpi.cc:107
std::string compress(const std::string &input)
Definition utilities.cc:389
void project(const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const AffineConstraints< typename VectorType::value_type > &constraints, const Quadrature< dim > &quadrature, const Function< spacedim, typename VectorType::value_type > &function, VectorType &vec, const bool enforce_zero_boundary=false, const Quadrature< dim - 1 > &q_boundary=(dim > 1 ? QGauss< dim - 1 >(2) :Quadrature< dim - 1 >()), const bool project_to_boundary_first=false)
void run(const Iterator &begin, const std_cxx20::type_identity_t< Iterator > &end, Worker worker, Copier copier, const ScratchData &sample_scratch_data, const CopyData &sample_copy_data, const unsigned int queue_length, const unsigned int chunk_size)
void run(const std::vector< std::vector< Iterator > > &colored_iterators, Worker worker, Copier copier, const ScratchData &sample_scratch_data, const CopyData &sample_copy_data, const unsigned int queue_length=2 *MultithreadInfo::n_threads(), const unsigned int chunk_size=8)
void abort(const ExceptionBase &exc) noexcept
bool check(const ConstraintKinds kind_in, const unsigned int dim)
long double gamma(const unsigned int n)
int(&) functions(const void *v1, const void *v2)
void reinit(MatrixBlock< MatrixType > &v, const BlockSparsityPattern &p)
static constexpr double PI
Definition numbers.h:254
void refine_and_coarsen_fixed_fraction(::Triangulation< dim, spacedim > &tria, const ::Vector< Number > &criteria, const double top_fraction_of_error, const double bottom_fraction_of_error, const VectorTools::NormType norm_type=VectorTools::L1_norm)
::SolutionTransfer< dim, VectorType, spacedim > SolutionTransfer
STL namespace.
::VectorizedArray< Number, width > min(const ::VectorizedArray< Number, width > &, const ::VectorizedArray< Number, width > &)
::VectorizedArray< Number, width > max(const ::VectorizedArray< Number, width > &, const ::VectorizedArray< Number, width > &)
::VectorizedArray< Number, width > cos(const ::VectorizedArray< Number, width > &)
::VectorizedArray< Number, width > sin(const ::VectorizedArray< Number, width > &)
::VectorizedArray< Number, width > sqrt(const ::VectorizedArray< Number, width > &)
::VectorizedArray< Number, width > abs(const ::VectorizedArray< Number, width > &)
Definition types.h:32
unsigned int subdomain_id
Definition types.h:43
const ::parallel::distributed::Triangulation< dim, spacedim > * triangulation