Reference documentation for deal.II version GIT 91e6c87029 2023-02-08 03:05:02+00:00
The step-70 tutorial program

This tutorial depends on step-19, step-60.

1. Introduction
2. The commented program
1. Results
2. The plain program

This program was contributed by Luca Heltai (International School for Advanced Studies, Trieste), Bruno Blais (Polytechnique Montréal), and Rene Gassmöller (University of California Davis)

Note
If you use this program as a basis for your own work, please consider citing it in your list of references. The initial version of this work was contributed to the deal.II project by the authors listed in the following citation:

# Introduction

### Massively parallel non-matching grid simulations of fluid structure interaction problems

In this tutorial we consider a mixing problem in the laminar flow regime. Such problems occur in a wide range of applications ranging from chemical engineering to power generation (e.g. turbomachinery). Mixing problems are particularly hard to solve numerically, because they often involve a container (with fixed boundaries, and possibly complex geometries such as baffles), represented by the domain $$\Omega$$, and one (or more) immersed and rotating impellers (represented by the domain $$\Omega^{\text{imp}}$$). The domain in which we would like to solve the flow equations is the (time dependent) difference between the two domains, namely: $$\Omega\setminus\Omega^{\text{imp}}$$.

For rotating impellers, the use of Arbitrary Lagrangian Eulerian formulations (in which the fluid domain – along with the mesh! – is smoothly deformed to follow the deformations of the immersed solid) is not possible, unless only small times (i.e., small fluid domain deformations) are considered. If one wants to track the evolution of the flow across multiple rotations of the impellers, the resulting deformed grid would simply be too distorted to be useful.

In this case, a viable alternative strategy would be to use non-matching methods (similarly to what we have done in step-60), where a background fixed grid (that may or may not be locally refined in time to better capture the solid motion) is coupled with a rotating, independent, grid.

In order to maintain the same notations used in step-60, we use $$\Omega$$ to denote the domain in $${\mathbb R}^{\text{spacedim}}$$ representing the container of both the fluid and the impeller, and we use $$\Gamma$$ in $${\mathbb R}^{\text{dim}}$$ to denote either the full impeller (when its spacedim measure is non-negligible, i.e., when we can represent it as a grid of dimension dim equal to spacedim), a co-dimension one representation of a thin impeller, or just the boundary of the full impeller.

The domain $$\Gamma$$ is embedded in $$\Omega$$ ( $$\Gamma \subseteq \Omega$$) and it is non-matching: It does not, in general, align with any of the features of the volume mesh. We solve a partial differential equation on $$\Omega$$, enforcing some conditions on the solution of the problem on the embedded domain $$\Gamma$$ by some penalization techniques. In the current case, the condition is that the velocity of the fluid at points on $$\Gamma$$ equal the velocity of the solid impeller at that point.

The technique we describe here is presented in the literature using one of many names: the immersed finite element method and the fictitious boundary method among others. The main principle is that the discretization of the two grids are kept completely independent. In the present tutorial, this approach is used to solve for the motion of a viscous fluid, described by the Stokes equation, that is agitated by a rigid non-deformable impeller.

Thus, the equations solved in $$\Omega$$ are the Stokes equations for a creeping flow (i.e. a flow where $$\text{Re}\rightarrow 0$$) and a no-slip boundary condition is applied on the moving embedded domain $$\Gamma$$ associated with the impeller. However, this tutorial could be readily extended to other equations (e.g. the Navier-Stokes equations, linear elasticity equation, etc.). It can be seen as a natural extension of step-60 that enables the solution of large problems using a distributed parallel computing architecture via MPI.

However, contrary to step-60, the Dirichlet boundary conditions on $$\Gamma$$ are imposed weakly instead of through the use of Lagrange multipliers, and we concentrate on dealing with the coupling of two fully distributed triangulations (a combination that was not possible in the implementation of step-60).

There are two interesting scenarios that occur when one wants to enforce conditions on the embedded domain $$\Gamma$$:

• The geometrical dimension dim of the embedded domain $$\Gamma$$ is the same of the domain $$\Omega$$ (spacedim), that is, the spacedim-dimensional measure of $$\Gamma$$ is not zero. In this case, the imposition of the Dirichlet boundary boundary condition on $$\Gamma$$ is done through a volumetric penalization. If the applied penalization only depends on the velocity, this is often referred to as $$\mathcal{L}^2$$ penalization whereas if the penalization depends on both the velocity and its gradient, it is an $$\mathcal{H}^1$$ penalization. The case of the $$\mathcal{L}^2$$ penalization is very similar to a Darcy-type approach. Both $$\mathcal{L}^2$$ and $$\mathcal{H}^1$$ penalizations have been analyzed extensively (see, for example, [4]).
• The embedded domain $$\Gamma$$ has an intrinsic dimension dim which is smaller than that of $$\Omega$$ (spacedim), thus its spacedim-dimensional measure is zero; for example it is a curve embedded in a two dimensional domain, or a surface embedded in a three-dimensional domain. This is of course physically impossible, but one may consider very thin sheets of metal moving in a fluid as essentially lower-dimensional if the thickness of the sheet is negligible. In this case, the boundary condition is imposed weakly on $$\Gamma$$ by applying the Nitsche method (see [68]).

Both approaches have very similar requirements and result in highly similar formulations. Thus, we treat them almost in the same way.

In this tutorial program we are not interested in further details on $$\Gamma$$: we assume that the dimension of the embedded domain (dim) is always smaller by one or equal with respect to the dimension of the embedding domain $$\Omega$$ (spacedim).

We are going to solve the following differential problem: given a sufficiently regular function $$g$$ on $$\Gamma$$, find the solution $$(\textbf{u},p)$$ to

\begin{eqnarray*} -\Delta \mathbf{u} + \nabla p &=& 0,\\ -\nabla \cdot \textbf{u} &=& 0,\\ \textbf{u} &=& \textbf{g} \text{ in } \Gamma,\\ \textbf{u} &=& 0 \text{ on } \partial\Omega. \end{eqnarray*}

This equation, which we have normalized by scaling the time units in such a way that the viscosity has a numerical value of 1, describes slow, viscous flow such as honey or lava. The main goal of this tutorial is to show how to impose the velocity field condition $$\mathbf{u} = \mathbf{g}$$ on a non-matching $$\Gamma$$ in a weak way, using a penalization method. A more extensive discussion of the Stokes problem including body forces, different boundary conditions, and solution strategies can be found in step-22.

Let us start by considering the Stokes problem alone, in the entire domain $$\Omega$$. We look for a velocity field $$\mathbf{u}$$ and a pressure field $$p$$ that satisfy the Stokes equations with homogeneous boundary conditions on $$\partial\Omega$$.

The weak form of the Stokes equations is obtained by first writing it in vector form as

\begin{eqnarray*} \begin{pmatrix} {-\Delta \textbf{u} + \nabla p} \\ {-\textrm{div}\;\textbf{u}} \end{pmatrix} = \begin{pmatrix} 0 \\ 0 \end{pmatrix}, \end{eqnarray*}

forming the dot product from the left with a vector-valued test function $$\phi = \begin{pmatrix}\textbf{v} \\ q\end{pmatrix}$$, and integrating over the domain $$\Omega$$, yielding the following set of equations:

\begin{eqnarray*} (\mathrm v, -\Delta \textbf{u} + \nabla p)_{\Omega} - (q,\textrm{div}\; \textbf{u})_{\Omega} = 0 \end{eqnarray*}

which has to hold for all test functions $$\phi = \begin{pmatrix}\textbf{v} \\ q\end{pmatrix}$$.

Integrating by parts and exploiting the boundary conditions on $$\partial\Omega$$, we obtain the following variational problem:

\begin{eqnarray*} (\nabla \textbf{v}, \nabla \textbf{u})_{\Omega} - (\textrm{div}\; \textbf{v}, p)_{\Omega} - (q, \textrm{div}\; \textbf{u})_{\Omega}&=& 0 \end{eqnarray*}

where $$(\cdot, \cdot)_{\Omega}$$ represents the $$L^2$$ scalar product. This is the same variational form used in step-22.

This variational formulation does not take into account the embedded domain. Contrary to step-60, we do not enforce strongly the constraints of $$\textbf{u}$$ on $$\Gamma$$, but enforce them weakly via a penalization term.

The analysis of this weak imposition of the boundary condition depends on the spacedim-dimensional measure of $$\Gamma$$ as either positive (if dim is equal to spacedim) or zero (if dim is smaller than spacedim). We discuss both scenarios.

#### Co-dimension one case

In this case, we assume that $$\Gamma$$ is the boundary of the actual impeller, that is, a closed curve embedded in a two-dimensional domain or a closed surface in a three-dimensional domain. The idea of this method starts by considering a weak imposition of the Dirichlet boundary condition on $$\Gamma$$, following the Nitsche method. This is achieved by using the following modified formulation on the fluid domain, where no strong conditions on the test functions on $$\Gamma$$ are imposed:

\begin{multline*} (\nabla \textbf{v}, \nabla \textbf{u})_{\Omega\setminus\Omega^{\text{imp}}} - (\textrm{div}\; \textbf{v}, p)_{\Omega\setminus\Omega^{\text{imp}}} - (q, \textrm{div}\; \textbf{u})_{\Omega\setminus\Omega^{\text{imp}}} \\ - (\textbf{v},\nabla \textbf{u} \cdot \textbf{n})_{\Gamma} + (\textbf{v}\cdot \textbf{n},p)_{\Gamma} \\ - (\nabla\textbf{v}\cdot \textbf{n},\textbf{u})_{\Gamma} + (q, \textbf{u} \cdot \textbf{n})_{\Gamma} + \beta (\textbf{v},\textbf{u})_{\Gamma} \\ = - (\nabla\textbf{v}\cdot \textbf{n},\textbf{g})_{\Gamma} + (q, \textbf{g} \cdot \textbf{n})_{\Gamma} + \beta (\textbf{v},\textbf{g})_{\Gamma}. \end{multline*}

The integrals over $$\Gamma$$ are lower-dimensional integrals. It can be shown (see [68]) that there exists a positive constant $$C_1$$ so that if $$\beta > C_1$$, the weak imposition of the boundary will be consistent and stable. The first two additional integrals on $$\Gamma$$ (the second line in the equation above) appear naturally after integrating by parts, when one does not assume that $$\mathbf{v}$$ is zero on $$\Gamma$$.

The third line in the equation above contains two terms that are added to ensure consistency of the weak form, and a stabilization term, that is there to enforce the boundary condition with an error which is consistent with the approximation error. The consistency terms and the stabilization term are added to the right hand side with the actual boundary data $$\mathbf{g}$$.

When $$\mathbf{u}$$ satisfies the condition $$\mathbf{u}=\mathbf{g}$$ on $$\Gamma$$, all the consistency and stability integrals on $$\Gamma$$ cancel out, and one is left with the usual weak form of Stokes flow, that is, the above formulation is consistent.

We note that an alternative (non-symmetric) formulation can be used :

\begin{multline*} (\nabla \textbf{v}, \nabla \textbf{u})_{\Omega\setminus\Omega^{\text{imp}}} - (\textrm{div}\; \textbf{v}, p)_{\Omega\setminus\Omega^{\text{imp}}} - (q, \textrm{div}\; \textbf{u})_{\Omega\setminus\Omega^{\text{imp}}} \\ -(\textbf{v},\nabla \textbf{u} \cdot \textbf{n})_{\Gamma} + (\textbf{v}\cdot \textbf{n},p)_{\Gamma} \\ +(\nabla\textbf{v}\cdot \textbf{n},\textbf{u})_{\Gamma} - (q, \textbf{u} \cdot \textbf{n})_{\Gamma} + \beta (\textbf{v},\textbf{u})_{\Gamma} \\ = (\nabla\textbf{v}\cdot \textbf{n},\textbf{g})_{\Gamma} - (q, \textbf{g} \cdot \textbf{n})_{\Gamma} + \beta (\textbf{v},\textbf{g})_{\Gamma}. \end{multline*}

Note the different sign of the first terms on the third and fourth lines. In this case, the stability and consistency conditions become $$\beta > 0$$. In the symmetric case, the value of $$\beta$$ is dependent on $$h$$, and it is in general chosen such that $$\beta = C h^{-1}$$ with $$h$$ a measure of size of the face being integrated and $$C$$ a constant such that $$1 \leq C \leq 10$$. This is as one usually does with the Nitsche penalty method to enforcing Dirichlet boundary conditions.

The non-symmetric approach, on the other hand, is related to how one enforced continuity for the non-symmetric interior penalty method for discontinuous Galerkin methods (the "NIPG" method [144]). Even if the non-symmetric case seems advantageous w.r.t. possible choices of stabilization parameters, we opt for the symmetric discretization, since in this case it can be shown that the dual problem is also consistent, leading to a solution where not only the energy norm of the solution converges with the correct order, but also its $$L^2$$ norm. Furthermore, the resulting matrix remains symmetric.

The above formulation works under the assumption that the domain is discretized exactly. However, if the deformation of the impeller is a rigid body motion, it is possible to artificially extend the solution of the Stokes problem inside the propeller itself, since a rigid body motion is also a solution to the Stokes problem. The idea is then to solve the same problem, inside $$\Omega^{\text{imp}}$$, imposing the same boundary conditions on $$\Gamma$$, using the same penalization technique, and testing with test functions $$\mathbf{v}$$ which are globally continuous over $$\Omega$$.

This results in the following (intermediate) formulation:

\begin{multline*} (\nabla \textbf{v}, \nabla \textbf{u})_{\Omega} - (\textrm{div}\; \textbf{v}, p)_{\Omega} - (q, \textrm{div}\; \textbf{u})_{\Omega} \\ - (\textbf{v}, \lbrack \nabla \textbf{u} \rbrack \cdot \textbf{n})_{\Gamma} + (\textbf{v}\cdot \textbf{n},\lbrack p \rbrack )_{\Gamma} \\ - (\lbrack \nabla\textbf{v} \rbrack \cdot \textbf{n},\textbf{u})_{\Gamma} + (\lbrack q \rbrack, \textbf{u} \cdot n)_{\Gamma} + 2\beta (\textbf{v},\textbf{u})_{\Gamma} \\ = - (\lbrack \nabla\textbf{v}\rbrack\cdot \textbf{n},\textbf{g})_{\Gamma} + (\lbrack q\rbrack, \textbf{g} \cdot n)_{\Gamma} + 2\beta (\textbf{v},\textbf{g})_{\Gamma}, \end{multline*}

where the jump terms, denoted with $$\lbrack \cdot \rbrack$$, are computed with respect to a fixed orientation of the normal vector $$\textbf{n}$$. The factor of 2 appears in front of $$\beta$$ since we see every part of $$\Gamma$$ twice, once from within the fluid and once from within the obstacle moving around in it. (For all of the other integrals over $$\Gamma$$, we visit each part of $$\Gamma$$ twice, but with opposite signs, and consequently get the jump terms.)

Here we notice that, unlike in discontinuous Galerkin methods, the test and trial functions are continuous across $$\Gamma$$. Moreover, if $$\Gamma$$ is not aligned with cell boundaries, all the jump terms are also zero, since, in general, finite element function spaces are smooth inside each cell, and if $$\Gamma$$ cuts through an element intersecting its boundary only at a finite number of points, all the contributions on $$\Gamma$$, with the exception of the stabilization ones, can be neglected from the formulation, resulting in the following final form of the variational formulation:

\begin{multline*} (\nabla \textbf{v}, \nabla \textbf{u})_{\Omega} - (\textrm{div}\; \textbf{v}, p)_{\Omega} - (q, \textrm{div}\; \textbf{u})_{\Omega} + 2\beta (\textbf{v},\textbf{u})_{\Gamma} \\ = 2\beta (\textbf{v},\textbf{g})_{\Gamma}. \end{multline*}

In step-60, the imposition of the constraint required the addition of new variables in the form of Lagrange multipliers. This is not the case for this tutorial program. The imposition of the boundary condition using Nitsche's method only modifies the system matrix and the right-hand side without adding additional unknowns. However, the velocity vector $$\textbf{u}$$ on the embedded domain will not match exactly the prescribed velocity $$\textbf{g}$$, but only up to a numerical error which is in the same order as the interpolation error of the finite element method. Furthermore, as in step-60, we still need to integrate over the non-matching embedded grid in order to construct the boundary term necessary to impose the boundary condition over $$\Gamma$$.

#### Co-dimension zero case

In this case, $$\Gamma$$ has the same dimension, but is embedded into $$\Omega$$. We can think of this as a thick object moving around in the fluid. In the case of $$\mathcal{L}^2$$ penalization, the additional penalization term can be interpreted as a Darcy term within $$\Gamma$$, resulting in:

\begin{eqnarray*} (\nabla \textbf{v}, \nabla \textbf{u})_{\Omega} - & (\textrm{div}\; \textbf{v}, p)_{\Omega} - (q, \textrm{div}\; \textbf{u})_{\Omega} + \beta (\textbf{v},\textbf{u})_{\Gamma} = \beta (\textbf{v},\textbf{g})_{\Gamma}. \end{eqnarray*}

Here, integrals over $$\Gamma$$ are simply integrals over a part of the volume. The $$\mathcal{L}^2$$ penalization thus consists in adding a volumetric term that constrains the velocity of the fluid to adhere to the velocity of the rigid body within $$\Gamma$$. Also in this case, $$\beta$$ must be chosen sufficiently large in order to ensure that the Dirichlet boundary condition in $$\Gamma$$ is sufficiently respected, but not too high in order to maintain the proper conditioning of the system matrix.

A $$\mathcal{H}^1$$ penalization may be constructed in a similar manner, with the addition of a viscous component to the penalization that dampens the velocity gradient within $$\Gamma$$:

\begin{eqnarray*} (\nabla \textbf{v}, \nabla \textbf{u})_{\Omega} - & (\textrm{div}\; \textbf{v}, p)_{\Omega} - (q, \textrm{div}\; \textbf{u})_{\Omega} + \beta_1 (\textbf{v},\textbf{u})_{\Gamma} + \beta_2 (\nabla \textbf{v}, \nabla \textbf{u})_{\Gamma} = \beta_1 (\textbf{v},\textbf{g})_{\Gamma} + \beta_2 (\nabla \textbf{v}, \nabla \textbf{g})_{\Gamma}. \end{eqnarray*}

Notice that the $$L^2$$ penalization (dim equal to spacedim) and the Nitsche penalization (dim equal to spacedim-1) result in the exact same numerical implementation, thanks to the dimension independent capabilities of deal.II.

#### Representation of Ω and Γ

In this tutorial, both the embedded grid $$\Gamma$$ and the embedding grid are described using a parallel::distributed::Triangulation. These two triangulations can be built from functions in the GridGenerator namespace or by reading a mesh file produced with another application (e.g. GMSH, see the discussion in step-49). This is slightly more general than what was previously done in step-60.

The addition of the immersed boundary method, whether it is in the dim=spacedim or dim<spacedim case, only introduces additional terms in the system matrix and the right-hand side of the system which result from the integration over $$\Gamma$$. This does not modify the number of variables for which the problem must be solved. The challenge is thus related to the integrals that must be carried over $$\Gamma$$.

As usual in finite elements we split this integral into contributions from all cells of the triangulation used to discretize $$\Gamma$$, we transform the integral on $$K$$ to an integral on the reference element $$\hat K$$, where $$F_{K}$$ is the mapping from $$\hat K$$ to $$K$$, and compute the integral on $$\hat K$$ using a quadrature formula. For example:

$\beta (\textbf{v},\textbf{u})_{\Gamma} = \sum_{K\in \Gamma} \int_{\hat K} \hat{\textbf{u}}(\hat x) (\textbf{v} \circ F_{K}) (\hat x) J_K (\hat x) \mathrm{d} \hat x = \sum_{K\in \Gamma} \sum_{i=1}^{n_q} \big(\hat{\textbf{u}}(\hat x_i) (\textbf{v} \circ F_{K}) (\hat x_i) J_K (\hat x_i) w_i \big)$

Computing this sum is non-trivial because we have to evaluate $$(v_j \circ F_{K}) (\hat x_i)$$. In general, if $$\Gamma$$ and $$\Omega$$ are not aligned, the point $$y_i = F_{K}(\hat x_i)$$ is completely arbitrary with respect to $$\Omega$$, and unless we figure out a way to interpolate all basis functions of $$V_h(\Omega)$$ on an arbitrary point on $$\Omega$$, we cannot compute the integral needed.

To evaluate $$(v_j \circ F_{K}) (\hat x_i)$$ the following steps needs to be taken (as shown in the picture below):

• For a given cell $$K$$ in $$\Gamma$$ compute the real point $$y_i \dealcoloneq F_{K} (\hat x_i)$$, where $$x_i$$ is one of the quadrature points used for the integral on $$K \subseteq \Gamma$$. This is the easy part: FEValues::quadrature_point() gives us the real-space locations of all quadrature points.
• Find the cell of $$\Omega$$ in which $$y_i$$ lies. We shall call this element $$T$$.
• Find the reference coordinates within $$T$$ of $$y_i$$. For this, we need the inverse of the mapping $$G_T$$ that transforms the reference element $$\hat T$$ into the element $$T$$: $$\hat y_i = G^{-1}_{T} (y_i)$$.
• Evaluate the basis function $$v_j$$ of the $$\Omega$$ mesh at this point $$\hat y_i$$. This is, again, relatively simple using FEValues.

In step-60, the second through fourth steps above were computed by calling, in turn,

Although this approach could work for the present case, it does not lends itself readily to parallel simulations using distributed triangulations. Indeed, since the position of the quadrature points on the cells of the embedded domain $$\Gamma$$ do not match that of the embedding triangulation and since $$\Gamma$$ is constantly moving, this would require that the triangulation representing $$\Gamma$$ be stored in it's entirety for all of the processors. As the number of processor and the number of cells in $$\Gamma$$ increases, this leads to a severe bottleneck in terms of memory. Consequently, an alternative strategy is sought in this step.

#### Using particles to track Γ

Remember that for both the penalization approach ( $$\mathcal{L}^2$$ or $$\mathcal{H}^1$$) and the Nitsche method, we want to compute integrals that are approximated by the quadrature. That is, we need to compute

$\beta (\textbf{v},\textbf{u})_{\Gamma} = \sum_{K\in \Gamma} \sum_{i=1}^{n_q} \big(\hat{\textbf{u}}(\hat x_i) (\textbf{v} \circ F_{K}) (\hat x_i) J_K (\hat x_i) w_i \big)$

If you followed the discussion above, then you will recall that $$\textbf{u}$$ and $$\textbf{v}$$ are shape functions defined on the fluid mesh. The only things defined on the solid mesh are: $$F_K(\hat x_i)$$, which is the location of a quadrature point on a solid cell that is part of $$\Gamma$$, $$J_K$$ is the determinant of its Jacobian, and $$w_i$$ the corresponding quadrature weight.

The important part to realize is now this: $$w_i$$ is a property of the quadrature formula and does not change with time. Furthermore, the Jacobian matrix of $$F_K$$ itself changes as the solid obstacle moves around in the fluid, but because the solid is considered non-deforming (it only translates and rotates, but doesn't dilate), the determinant of the Jacobian remains constant. As a consequence, the product $$J_K(\hat x_i) w_i$$ (which we typically denote by JxW) remains constant for each quadrature point. So the only thing we need keep track of are the positions $$x_i=F_K(\hat x_i)$$ – but these move with the velocity of the solid domain.

In other words, we don't actually need to keep the solid mesh at all. All we need is the positions $$x_i(t)$$ and corresponding JxW values. Since both of these properties are point-properties (or point-vectors) that are attached to the solid material, they can be idealized as a set of disconnected infinitesimally small "particles", which carry the required JxW information with the movement of the solid. deal.II has the ability to distribute and store such a set of particles in large-scale parallel computations in the form of the ParticleHandler class (for details on the implementation see [71]), and we will make use of this functionality in this tutorial.

Thus, the approach taken in this step is as follows:

This structure is relatively expensive to generate, but must only be generated once per simulation. Once the Particles::ParticleHandler is generated and the required information is attached to the particle, the integrals over $$\Gamma$$ can be carried out by exploiting the fact that particles are grouped cellwise inside ParticleHandler, allowing us to:

• Looping over all cells of $$\Omega$$ that contain at least one particle
• Looping over all particles in the given cell
• Compute the integrals and fill the global matrix.

Since the Particles::ParticleHandler can manage the exchange of particles from one processor to the other, the embedded triangulation can be moved or deformed by displacing the particles. The only constraint associated with this displacement is that particles should be displaced by a distance that is no larger than the size of one cell. That's because that is the limit to which Particles::ParticleHandler can track which cell a particle that leaves its current cell now resides in.

Once the entire problem (the Stokes problem and the immersed boundary imposition) is assembled, the final saddle point problem is solved by an iterative solver, applied to the Schur complement $$S$$ (whose construction is described, for example, in step-22), and we construct $$S$$ using LinearOperator classes.

### The testcase

The problem we solve here is a demonstration of the time-reversibility of Stokes flow. This is often illustrated in science education experiments with a Taylor-Couette flow and dye droplets that revert back to their original shape after the fluid has been displaced in a periodic manner.

In the present problem, a very viscous fluid is agitated by the rotation of an impeller, which, in 2D, is modeled by a rectangular grid. The impeller rotates for a given number of revolutions, after which the flow is reversed such that the same number of revolutions is carried out in the opposite direction. We recall that since the Stokes equations are self-adjoint, creeping flows are reversible. Consequently, if the impeller motion is reversed in the opposite direction, the fluid should return to its original position. In the present case, this is illustrated by inserting a circle of passive tracer particles that are advected by the fluid and which return to their original position, thus demonstrating the time-reversibility of the flow.

### More references

This tutorial program uses a number of techniques on imposing velocity conditions on non-matching interfaces in the interior of the fluid. For more background material, you may want to look up the following references: [68], [4], [75], [27], [88].

# The commented program

### Include files

Most of these have been introduced elsewhere, we'll comment only on the new ones. The switches close to the top that allow selecting between PETSc and Trilinos linear algebra capabilities are similar to the ones in step-40 and step-50.

#define FORCE_USE_OF_TRILINOS
namespace LA
{
#if defined(DEAL_II_WITH_PETSC) && !defined(DEAL_II_PETSC_WITH_COMPLEX) && \
!(defined(DEAL_II_WITH_TRILINOS) && defined(FORCE_USE_OF_TRILINOS))
using namespace dealii::LinearAlgebraPETSc;
# define USE_PETSC_LA
#elif defined(DEAL_II_WITH_TRILINOS)
using namespace dealii::LinearAlgebraTrilinos;
#else
# error DEAL_II_WITH_PETSC or DEAL_II_WITH_TRILINOS required
#endif
} // namespace LA

These are the only new include files with regard to step-60. In this tutorial, the non-matching coupling between the solid and the fluid is computed using an intermediate data structure that keeps track of how the locations of quadrature points of the solid evolve within the fluid mesh. This data structure needs to keep track of the position of the quadrature points on each cell describing the solid domain, of the quadrature weights, and possibly of the normal vector to each point, if the solid domain is of co-dimension one.

Deal.II offers these facilities in the Particles namespace, through the ParticleHandler class. ParticleHandler is a class that allows you to manage a collection of particles (objects of type Particles::Particle), representing a collection of points with some attached properties (e.g., an id) floating on a parallel::distributed::Triangulation. The methods and classes in the namespace Particles allows one to easily implement Particle-In-Cell methods and particle tracing on distributed triangulations.

We "abuse" this data structure to store information about the location of solid quadrature points embedded in the surrounding fluid grid, including integration weights, and possibly surface normals. The reason why we use this additional data structure is related to the fact that the solid and the fluid grids might be non-overlapping, and if we were using two separate triangulation objects, would be distributed independently among parallel processes.

In order to couple the two problems, we rely on the ParticleHandler class, storing in each particle the position of a solid quadrature point (which is in general not aligned to any of the fluid quadrature points), its weight, and any other information that may be required to couple the two problems. These locations are then propagated along with the (prescribed) velocity of the solid impeller.

Ownership of the solid quadrature points is initially inherited from the MPI partitioning on the solid mesh itself. The Particles so generated are later distributed to the fluid mesh using the methods of the ParticleHandler class. This allows transparent exchange of information between MPI processes about the overlapping pattern between fluid cells and solid quadrature points.

When generating the grids, we allow reading it from a file, and if deal.II has been built with OpenCASCADE support, we also allow reading CAD files and use them as manifold descriptors for the grid (see step-54 for a detailed description of the various Manifold descriptors that are available in the OpenCASCADE namespace)

# include <TopoDS.hxx>
#endif
#include <cmath>
#include <fstream>
#include <iostream>
#include <memory>
namespace Step70
{
using namespace dealii;

### Run-time parameter handling

Similarly to what we have done in step-60, we set up a class that holds all the parameters of our problem and derive it from the ParameterAcceptor class to simplify the management and creation of parameter files.

The ParameterAcceptor paradigm requires all parameters to be writable by the ParameterAcceptor methods. In order to avoid bugs that would be very difficult to track down (such as writing things like time = 0 instead of time == 0), we declare all the parameters in an external class, which is initialized before the actual StokesImmersedProblem class, and pass it to the main class as a const reference.

The constructor of the class is responsible for the connection between the members of this class and the corresponding entries in the ParameterHandler. Thanks to the use of the ParameterHandler::add_parameter() method, this connection is trivial, but requires all members of this class to be writeable.

template <int dim, int spacedim = dim>
class StokesImmersedProblemParameters : public ParameterAcceptor
{
public:
StokesImmersedProblemParameters();

however, since this class will be passed as a const reference to the StokesImmersedProblem class, we have to make sure we can still set the time correctly in the objects derived by the Function class defined herein. In order to do so, we declare both the StokesImmersedProblemParameters::rhs and StokesImmersedProblemParameters::angular_velocity members to be mutable, and define the following little helper method that sets their time to the correct value.

void set_time(const double &time) const
{
rhs.set_time(time);
angular_velocity.set_time(time);
}

The remainder of the class consists largely of member variables that describe the details of the simulation and its discretization. The following parameters are about where output should land, the spatial and temporal discretization (the default is the $$Q_2\times Q_1$$ Taylor-Hood discretization which uses a polynomial degree of 2 for the velocity), and how many time steps should elapse before we generate graphical output again:

std::string output_directory = ".";
unsigned int velocity_degree = 2;
unsigned int number_of_time_steps = 501;
double final_time = 1.0;
unsigned int output_frequency = 1;

We allow every grid to be refined independently. In this tutorial, no physics is resolved on the solid grid, and its velocity is given as a datum. However it is relatively straightforward to incorporate some elasticity model in this tutorial, and transform it into a fully fledged FSI solver.

unsigned int initial_fluid_refinement = 5;
unsigned int initial_solid_refinement = 5;
unsigned int particle_insertion_refinement = 3;

To provide a rough description of the fluid domain, we use the method extract_rtree_level() applied to the tree of bounding boxes of each locally owned cell of the fluid triangulation. The higher the level of the tree, the larger the number of extracted bounding boxes, and the more accurate is the description of the fluid domain. However, a large number of bounding boxes also implies a large communication cost, since the collection of bounding boxes is gathered by all processes.

unsigned int fluid_rtree_extraction_level = 1;

The only two numerical parameters used in the equations are the viscosity of the fluid, and the penalty term $$\beta$$ used in the Nitsche formulation:

double viscosity = 1.0;
double penalty_term = 100;

By default, we create a hyper_cube without colorization, and we use homogeneous Dirichlet boundary conditions. In this set we store the boundary ids to use when setting the boundary conditions:

std::list<types::boundary_id> homogeneous_dirichlet_ids{0};

We illustrate here another way to create a Triangulation from a parameter file, using the method GridGenerator::generate_from_name_and_arguments(), that takes the name of a function in the GridGenerator namespace, and its arguments as a single string representing the arguments as a tuple.

The mechanism with which the arguments are parsed from and to a string is explained in detail in the Patterns::Tools::Convert class, which is used to translate from strings to most of the basic STL types (vectors, maps, tuples) and basic deal.II types (Point, Tensor, BoundingBox, etc.).

In general objects that can be represented by rank 1 uniform elements (i.e., std::vector<double>, Point<dim>, std::set<int>, etc.) are comma separated. Additional ranks take a semicolon, allowing you to parse strings into objects of type std::vector<std::vector<double>>, or, for example, std::vector<Point<dim>>, as 0.0, 0.1; 0.1, 0.2. This string could be interpreted as a vector of two Point objects, or a vector of vector of doubles.

When the entries are not uniform, as in the tuple case, we use a colon to separate the various entries. For example, a string like 5: 0.1, 0.2 could be used to parse an object of type std::pair<int, Point<2>> or a std::tuple<int, std::vector<double>>.

In our case most of the arguments are Point objects (representing centers, corners, subdivision elements, etc.), integer values (number of subdivisions), double values (radius, lengths, etc.), or boolean options (such as the colorize option that many GridGenerator functions take).

In the example below, we set reasonable default values, but these can be changed at run time by selecting any other supported function of the GridGenerator namespace. If the GridGenerator function fails, this program will interpret the name of the grid as a vtk grid filename, and the arguments as a map from manifold_id to the CAD files describing the geometry of the domain. Every CAD file will be analyzed and a Manifold of the OpenCASCADE namespace will be generated according to the content of the CAD file itself.

To be as generic as possible, we do this for each of the generated grids: the fluid grid, the solid grid, but also the tracer particles which are also generated using a triangulation.

std::string name_of_fluid_grid = "hyper_cube";
std::string arguments_for_fluid_grid = "-1: 1: false";
std::string name_of_solid_grid = "hyper_rectangle";
std::string arguments_for_solid_grid = spacedim == 2 ?
"-.5, -.1: .5, .1: false" :
"-.5, -.1, -.1: .5, .1, .1: false";
std::string name_of_particle_grid = "hyper_ball";
std::string arguments_for_particle_grid =
spacedim == 2 ? "0.3, 0.3: 0.1: false" : "0.3, 0.3, 0.3 : 0.1: false";

Similarly, we allow for different local refinement strategies. In particular, we limit the maximum number of refinement levels, in order to control the minimum size of the fluid grid, and guarantee that it is compatible with the solid grid. The minimum number of refinement levels is also controlled to ensured sufficient accuracy in the bulk of the flow. Additionally, we perform local refinement based on standard error estimators on the fluid velocity field.

We permit the user to choose between the two most common refinement strategies, namely fixed_number or fixed_fraction, that refer to the methods GridRefinement::refine_and_coarsen_fixed_fraction() and GridRefinement::refine_and_coarsen_fixed_number().

Refinement may be done every few time steps, instead of continuously, and we control this value by the refinement_frequency parameter:

int max_level_refinement = 8;
int min_level_refinement = 5;
std::string refinement_strategy = "fixed_fraction";
double coarsening_fraction = 0.3;
double refinement_fraction = 0.3;
unsigned int max_cells = 20000;
int refinement_frequency = 5;

Finally, the following two function objects are used to control the source term of Stokes flow and the angular velocity at which we move the solid body. In a more realistic simulation, the solid velocity or its deformation would come from the solution of an auxiliary problem on the solid domain. In this example step we leave this part aside, and simply impose a fixed rotational velocity field along the z-axis on the immersed solid, governed by a function that can be specified in the parameter file :

angular_velocity;
};

There remains the task of declaring what run-time parameters we can accept in input files. We split the parameters in various categories, by putting them in different sections of the ParameterHandler class. We begin by declaring all the global parameters used by StokesImmersedProblem in the global scope:

template <int dim, int spacedim>
StokesImmersedProblemParameters<dim,
spacedim>::StokesImmersedProblemParameters()
: ParameterAcceptor("Stokes Immersed Problem/")
, rhs("Right hand side", spacedim + 1)
, angular_velocity("Angular velocity")
{
"Velocity degree", velocity_degree, "", this->prm, Patterns::Integer(1));
initial_fluid_refinement,
"Initial mesh refinement used for the fluid domain Omega");
initial_solid_refinement,
"Initial mesh refinement used for the solid domain Gamma");
fluid_rtree_extraction_level,
"Extraction level of the rtree used to construct global "
"bounding boxes");
"Particle insertion refinement",
particle_insertion_refinement,
"Refinement of the volumetric mesh used to insert the particles");
"Homogeneous Dirichlet boundary ids",
homogeneous_dirichlet_ids,
"Boundary Ids over which homogeneous Dirichlet boundary conditions are applied");

Next section is dedicated to the parameters used to create the various grids. We will need three different triangulations: Fluid grid is used to define the fluid domain, Solid grid defines the solid domain, and Particle grid is used to distribute some tracer particles, that are advected with the velocity and only used as passive tracers.

enter_subsection("Grid generation");
{
arguments_for_particle_grid);
}
leave_subsection();
enter_subsection("Refinement and remeshing");
{
refinement_strategy,
"",
this->prm,
Patterns::Selection("fixed_fraction|fixed_number"));
}
leave_subsection();

The final task is to correct the default dimension for the right hand side function and define a meaningful default angular velocity instead of zero.

rhs.declare_parameters_call_back.connect([&]() {
spacedim + 1);
});
angular_velocity.declare_parameters_call_back.connect([&]() {
this->prm.set("Function expression",
"t < .500001 ? 6.283185 : -6.283185");
});
}
static void declare_parameters(ParameterHandler &prm, const unsigned int n_components=1)

Once the angular velocity is provided as a Function object, we reconstruct the pointwise solid velocity through the following class which derives from the Function class. It provides the value of the velocity of the solid body at a given position by assuming that the body rotates around the origin (or the $$z$$ axis in 3d) with a given angular velocity.

template <int spacedim>
class SolidVelocity : public Function<spacedim>
{
public:
static_assert(spacedim > 1,
"Cannot instantiate SolidVelocity for spacedim == 1");
SolidVelocity(const Functions::ParsedFunction<spacedim> &angular_velocity)
: angular_velocity(angular_velocity)
{}
virtual double value(const Point<spacedim> &p,
unsigned int component = 0) const override
{
virtual RangeNumberType value(const Point< dim > &p, const unsigned int component=0) const

We assume that the angular velocity is directed along the z-axis, i.e., we model the actual angular velocity as if it was a two-dimensional rotation, irrespective of the actual value of spacedim.

const double omega = angular_velocity.value(p);
velocity[0] = -omega * p[1];
velocity[1] = omega * p[0];
return velocity[component];
}
private:
const Functions::ParsedFunction<spacedim> &angular_velocity;
};

Similarly, we assume that the solid position can be computed explicitly at each time step, exploiting the knowledge of the angular velocity. We compute the exact position of the solid particle assuming that the solid is rotated by an amount equal to the time step multiplied by the angular velocity computed at the point p:

template <int spacedim>
class SolidPosition : public Function<spacedim>
{
public:
static_assert(spacedim > 1,
"Cannot instantiate SolidPosition for spacedim == 1");
SolidPosition(const Functions::ParsedFunction<spacedim> &angular_velocity,
const double time_step)
: Function<spacedim>(spacedim)
, angular_velocity(angular_velocity)
, time_step(time_step)
{}
virtual double value(const Point<spacedim> &p,
unsigned int component = 0) const override
{
Point<spacedim> new_position = p;
double dtheta = angular_velocity.value(p) * time_step;
new_position[0] = std::cos(dtheta) * p[0] - std::sin(dtheta) * p[1];
new_position[1] = std::sin(dtheta) * p[0] + std::cos(dtheta) * p[1];
return new_position[component];
}
void set_time_step(const double new_time_step)
{
time_step = new_time_step;
}
private:
const Functions::ParsedFunction<spacedim> &angular_velocity;
double time_step;
};
::VectorizedArray< Number, width > cos(const ::VectorizedArray< Number, width > &)
::VectorizedArray< Number, width > sin(const ::VectorizedArray< Number, width > &)

### The StokesImmersedProblem class declaration

We are now ready to introduce the main class of our tutorial program. As usual, other than the constructor, we leave a single public entry point: the run() method. Everything else is left private, and accessed through the run method itself.

template <int dim, int spacedim = dim>
class StokesImmersedProblem
{
public:
StokesImmersedProblem(
const StokesImmersedProblemParameters<dim, spacedim> &par);
void run();
void run(const Iterator &begin, const typename identity< Iterator >::type &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)
Definition: work_stream.h:474

The next section contains the private members of the class. The first method is similar to what is present in previous example. However it not only takes care of generating the grid for the fluid, but also the grid for the solid. The second computes the largest time step that guarantees that each particle moves of at most one cell. This is important to ensure that the Particles::ParticleHandler can find which cell a particle ends up in, as it can only look from one cell to its immediate neighbors (because, in a parallel setting, every MPI process only knows about the cells it owns as well as their immediate neighbors).

private:
void make_grid();
double compute_time_step() const;

The next two functions initialize the Particles::ParticleHandler objects used in this class. We have two such objects: One represents passive tracers, used to plot the trajectories of fluid particles, while the other represents material particles of the solid, which are placed at quadrature points of the solid grid.

void setup_tracer_particles();
void setup_solid_particles();

The remainder of the set up is split in two parts: The first of the following two functions creates all objects that are needed once per simulation, whereas the other sets up all objects that need to be reinitialized at every refinement step.

void initial_setup();
void setup_dofs();

The assembly routine is very similar to other Stokes assembly routines, with the exception of the Nitsche restriction part, which exploits one of the particle handlers to integrate on a non-matching part of the fluid domain, corresponding to the position of the solid. We split these two parts into two separate functions.

void assemble_stokes_system();
void assemble_nitsche_restriction();

The remaining functions solve the linear system (which looks almost identical to the one in step-60) and then postprocess the solution: The refine_and_transfer() method is called only every refinement_frequency steps to adapt the mesh and also make sure that all the fields that were computed on the time step before refinement are transferred correctly to the new grid. This includes vector fields, as well as particle information. Similarly, we call the two output methods only every output_frequency steps.

void solve();
void refine_and_transfer();
void output_results(const unsigned int cycle, const double time) const;
void output_particles(const Particles::ParticleHandler<spacedim> &particles,
std::string fprefix,
const unsigned int iter,
const double time) const;

Let us then move on to the member functions of the class. The first deals with run-time parameters that are read from a parameter file. As noted before, we make sure we cannot modify this object from within this class, by making it a const reference.

const StokesImmersedProblemParameters<dim, spacedim> &par;

Then there is also the MPI communicator object that we will use to let processes send information across the network if the program runs in parallel, along with the pcout object and timer information that has also been employed by step-40, for example:

MPI_Comm mpi_communicator;
mutable TimerOutput computing_timer;

Next is one of the main novelties with regard to step-60. Here we assume that both the solid and the fluid are fully distributed triangulations. This allows the problem to scale to a very large number of degrees of freedom, at the cost of communicating all the overlapping regions between non matching triangulations. This is especially tricky, since we make no assumptions on the relative position or distribution of the various subdomains of the two triangulations. In particular, we assume that every process owns only a part of the solid_tria, and only a part of the fluid_tria, not necessarily in the same physical region, and not necessarily overlapping.

We could in principle try to create the initial subdivisions in such a way that each process's subdomains overlap between the solid and the fluid regions. However, this overlap would be destroyed during the simulation, and we would have to redistribute the DoFs again and again. The approach we follow in this tutorial is more flexible, and not much more expensive. We make two all-to-all communications at the beginning of the simulation to exchange information about an (approximate) information of the geometrical occupancy of each processor (done through a collection of bounding boxes).

This information is used by the Particles::ParticleHandler class to exchange (using a some-to-some communication pattern) all particles, so that every process knows about the particles that live on the region occupied by the fluid subdomain that it owns.

In order to couple the overlapping regions, we exploit the facilities implemented in the ParticleHandler class.

Next come descriptions of the finite elements in use, along with the corresponding DoFHandler objects. For the current implementation, only fluid_fe is really necessary. For completeness, and to allow easy extension, we also keep the solid_fe around, which is however initialized to a FE_Nothing finite element space, i.e., one that has no degrees of freedom.

We declare both finite element spaces as std::unique_ptr objects rather than regular member variables, to allow their generation after StokesImmersedProblemParameters has been initialized. In particular, they will be initialized in the initial_setup() method.

std::unique_ptr<FiniteElement<spacedim>> fluid_fe;
std::unique_ptr<FiniteElement<dim, spacedim>> solid_fe;
std::unique_ptr<MappingFEField<dim, spacedim>> solid_mapping;

Similarly to how things are done in step-22, we use a block system to treat the Stokes part of the problem, and follow very closely what was done there.

std::vector<IndexSet> fluid_owned_dofs;
std::vector<IndexSet> solid_owned_dofs;
std::vector<IndexSet> fluid_relevant_dofs;
std::vector<IndexSet> solid_relevant_dofs;

Using this partitioning of degrees of freedom, we can then define all of the objects necessary to describe the linear systems in question:

LA::MPI::BlockSparseMatrix preconditioner_matrix;
LA::MPI::BlockVector locally_relevant_solution;
BlockSparseMatrix< double > BlockSparseMatrix
BlockVector< double > BlockVector

Let us move to the particles side of this program. There are two Particles::ParticleHandler objects used to couple the solid with the fluid, and to describe the passive tracers. These, in many ways, play a role similar to the DoFHandler class used in the discretization, i.e., they provide for an enumeration of particles and allow querying information about each particle.

Particles::ParticleHandler<spacedim> tracer_particle_handler;
Particles::ParticleHandler<spacedim> solid_particle_handler;

For every tracer particle, we need to compute the velocity field in its current position, and update its position using a discrete time stepping scheme. We do this using distributed linear algebra objects that store the coordinates of each particle's location or velocity. That is, these vectors have tracer_particle_handler.n_global_particles() * spacedim entries that we will store in a way so that parts of the vector are partitioned across all processes. (Implicitly, we here make the assumption that the spacedim coordinates of each particle are stored in consecutive entries of the vector.) Thus, we need to determine who the owner of each vector entry is. We set this owner to be equal to the process that generated that particle at time $$t=0$$. This information is stored for every process in the locally_owned_tracer_particle_coordinates IndexSet.

Once the particles have been distributed around to match the process that owns the region where the particle lives, we will need read access from that process to the corresponding velocity field. We achieve this by filling a read only velocity vector field that contains the relevant information in ghost entries. This is achieved using the locally_relevant_tracer_particle_coordinates IndexSet, that keeps track of how things change during the simulation, i.e., it keeps track of where particles that the current process owns have ended up being, and who owns the particles that ended up in my subdomain.

While this is not the most efficient strategy, we keep it this way to illustrate how things would work in a real fluid-structure interaction (FSI) problem. If a particle is linked to a specific solid degree of freedom, we are not free to choose who owns it, and we have to communicate this information around. We illustrate this here, and show that the communication pattern is point-to-point, and negligible in terms of total cost of the algorithm.

The vectors defined based on these subdivisions are then used to store the particles velocities (read-only, with ghost entries) and their displacement (read/write, no ghost entries).

IndexSet locally_owned_tracer_particle_coordinates;
IndexSet locally_relevant_tracer_particle_coordinates;
LA::MPI::Vector tracer_particle_velocities;
LA::MPI::Vector relevant_tracer_particle_displacements;

One of the key points of this tutorial program is the coupling between two independent parallel::distributed::Triangulation objects, one of which may be moving and deforming (with possibly large deformations) with respect to the other. When both the fluid and the solid triangulations are of type parallel::distributed::Triangulation, every process has access only to its fraction of locally owned cells of each of the two triangulations. As mentioned above, in general, the locally owned domains are not overlapping.

In order to allow for the efficient exchange of information between non-overlapping parallel::distributed::Triangulation objects, some algorithms of the library require the user to provide a rough description of the area occupied by the locally owned part of the triangulation, in the form of a collection of axis-aligned bounding boxes for each process, that provide a full covering of the locally owned part of the domain. This kind of information can then be used in situations where one needs to send information to the owner of the cell surrounding a known location, without knowing who that owner may in fact be. But, if one knows a collection of bounding boxes for the geometric area or volume each process owns, then we can determine a subset of all processes that might possibly own the cell in which that location lies: namely, all of those processes whose bounding boxes contain that point. Instead of sending the information associated to that location to all processes, one can then get away with only sending it to a small subset of the processes with point-to-point communication primitives. (You will notice that this also allows for the typical time-vs-memory trade-off: The more data we are willing to store about each process's owned area – in the form of more refined bounding box information – the less communication we have to perform.)

We construct this information by gathering a vector (of length Utilities::MPI::n_mpi_processes()) of vectors of BoundingBox objects. We fill this vector using the extract_rtree_level() function, and allow the user to select what level of the tree to extract. The "level" corresponds to how coarse/fine the overlap of the area with bounding boxes should be.

As an example, this is what would be extracted by the extract_rtree_level() function applied to a two dimensional hyper ball, distributed over three processes. Each image shows in green the bounding boxes associated to the locally owned cells of the triangulation on each process, and in violet the bounding boxes extracted from the rtree:

We store these boxes in a global member variable, which is updated at every refinement step:

std::vector<std::vector<BoundingBox<spacedim>>> global_fluid_bounding_boxes;
};

### The StokesImmersedProblem class implementation

#### Object construction and mesh initialization functions

In the constructor, we create the mpi_communicator as well as the triangulations and dof_handler for both the fluid and the solid. Using the mpi_communicator, both the ConditionalOStream and TimerOutput object are constructed.

template <int dim, int spacedim>
StokesImmersedProblem<dim, spacedim>::StokesImmersedProblem(
const StokesImmersedProblemParameters<dim, spacedim> &par)
: par(par)
, mpi_communicator(MPI_COMM_WORLD)
, pcout(std::cout,
(Utilities::MPI::this_mpi_process(mpi_communicator) == 0))
, computing_timer(mpi_communicator,
pcout,
TimerOutput::summary,
TimerOutput::wall_times)
, fluid_tria(mpi_communicator,
typename Triangulation<spacedim>::MeshSmoothing(
Triangulation<spacedim>::smoothing_on_refinement |
Triangulation<spacedim>::smoothing_on_coarsening))
, solid_tria(mpi_communicator,
typename Triangulation<dim, spacedim>::MeshSmoothing(
Triangulation<dim, spacedim>::smoothing_on_refinement |
Triangulation<dim, spacedim>::smoothing_on_coarsening))
, fluid_dh(fluid_tria)
, solid_dh(solid_tria)
{}
unsigned int this_mpi_process(const MPI_Comm &mpi_communicator)
Definition: mpi.cc:159

In order to generate the grid, we first try to use the functions in the deal.II GridGenerator namespace, by leveraging the GridGenerator::generate_from_name_and_argument(). If this function fails, then we use the following method, where the name is interpreted as a filename, and the arguments are interpreted as a map from manifold ids to CAD files, and are converted to Manifold descriptors using the OpenCASCADE namespace facilities. At the top, we read the file into a triangulation:

template <int dim, int spacedim>
{
void attach_triangulation(Triangulation< dim, spacedim > &tria)
Definition: grid_in.cc:150
Definition: grid_in.cc:4122
const ::Triangulation< dim, spacedim > & tria

If we got to this point, then the Triangulation has been read, and we are ready to attach to it the correct manifold descriptions. We perform the next lines of code only if deal.II has been built with OpenCASCADE support. For each entry in the map, we try to open the corresponding CAD file, we analyze it, and according to its content, opt for either a OpenCASCADE::ArcLengthProjectionLineManifold (if the CAD file contains a single TopoDS_Edge or a single TopoDS_Wire) or a OpenCASCADE::NURBSPatchManifold, if the file contains a single face. Notice that if the CAD files do not contain single wires, edges, or faces, an assertion will be throw in the generation of the Manifold.

We use the Patterns::Tools::Convert class to do the conversion from the string to a map between manifold ids and file names for us:

using map_type = std::map<types::manifold_id, std::string>;
for (const auto &pair : Converter::to_value(ids_and_cad_file_names))
{
const auto &manifold_id = pair.first;
std::string extension =
std::transform(extension.begin(),
extension.end(),
extension.begin(),
[](const char c) -> char { return std::tolower(c); });
TopoDS_Shape shape;
if (extension == "iges" || extension == "igs")
else if (extension == "step" || extension == "stp")
else
AssertThrow(false,
ExcNotImplemented("We found an extension that we "
"do not recognize as a CAD file "
"extension. Bailing out."));
static ::ExceptionBase & ExcNotImplemented()
#define AssertThrow(cond, exc)
Definition: exceptions.h:1672
TopoDS_Shape read_STEP(const std::string &filename, const double scale_factor=1e-3)
Definition: utilities.cc:356
TopoDS_Shape read_IGES(const std::string &filename, const double scale_factor=1e-3)
Definition: utilities.cc:239
void to_value(const std::string &s, T &t)
Definition: patterns.h:2402
void transform(const InputIterator &begin_in, const InputIterator &end_in, OutputIterator out, const Predicate &predicate, const unsigned int grainsize)
Definition: parallel.h:135
unsigned int manifold_id
Definition: types.h:146

Now we check how many faces are contained in the Shape. OpenCASCADE is intrinsically 3D, so if this number is zero, we interpret this as a line manifold, otherwise as a OpenCASCADE::NormalToMeshProjectionManifold in spacedim = 3, or OpenCASCADE::NURBSPatchManifold in spacedim = 2.

if ((std::get<0>(n_elements) == 0))
else if (spacedim == 3)
{
void set_manifold(const types::manifold_id number, const Manifold< dim, spacedim > &manifold_object)
std::tuple< unsigned int, unsigned int, unsigned int > count_elements(const TopoDS_Shape &shape)
Definition: utilities.cc:92

We use this trick, because OpenCASCADE::NormalToMeshProjectionManifold is only implemented for spacedim = 3. The check above makes sure that things actually work correctly.

const auto t = reinterpret_cast<Triangulation<dim, 3> *>(&tria);
shape));
}
else

We also allow surface descriptions in two dimensional spaces based on single NURBS patches. For this to work, the CAD file must contain a single TopoDS_Face.

TopoDS::Face(shape)));
}
#else
AssertThrow(false, ExcNotImplemented("Generation of the grid failed."));
#endif
}

Now let's put things together, and make all the necessary grids. As mentioned above, we first try to generate the grid internally, and if we fail (i.e., if we end up in the catch clause), then we proceed with the above function.

We repeat this pattern for both the fluid and the solid mesh.

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::make_grid()
{
try
{
fluid_tria, par.name_of_fluid_grid, par.arguments_for_fluid_grid);
}
catch (...)
{
pcout << "Generating from name and argument failed." << std::endl
<< "Trying to read from file name." << std::endl;
par.arguments_for_fluid_grid,
fluid_tria);
}
fluid_tria.refine_global(par.initial_fluid_refinement);
try
{
solid_tria, par.name_of_solid_grid, par.arguments_for_solid_grid);
}
catch (...)
{
par.arguments_for_solid_grid,
solid_tria);
}
solid_tria.refine_global(par.initial_solid_refinement);
}
void generate_from_name_and_arguments(Triangulation< dim, spacedim > &tria, const std::string &grid_generator_function_name, const std::string &grid_generator_function_arguments)

#### Particle initialization functions

Once the solid and fluid grids have been created, we start filling the Particles::ParticleHandler objects. The first one we take care of is the one we use to keep track of passive tracers in the fluid. These are simply transported along, and in some sense their locations are unimportant: We just want to use them to see where flow is being transported. We could use any way we choose to determine where they are initially located. A convenient one is to create the initial locations as the vertices of a mesh in a shape of our choice – a choice determined by one of the run-time parameters in the parameter file.

In this implementation, we create tracers using the support points of a FE_Q finite element space defined on a temporary grid, which is then discarded. Of this grid, we only keep around the Particles::Particle objects (stored in a Particles::ParticleHandler class) associated to the support points.

The Particles::ParticleHandler class offers the possibility to insert a set of particles that live physically in the part of the domain owned by the active process. However, in this case this function would not suffice. The particles generated as the locally owned support points of an FE_Q object on an arbitrary grid (non-matching with regard to the fluid grid) have no reasons to lie in the same physical region of the locally owned subdomain of the fluid grid. In fact this will almost never be the case, especially since we want to keep track of what is happening to the particles themselves.

In particle-in-cell methods (PIC), it is often customary to assign ownership of the particles to the process where the particles lie. In this tutorial we illustrate a different approach, which is useful if one wants to keep track of information related to the particles (for example, if a particle is associated to a given degree of freedom, which is owned by a specific process and not necessarily the same process that owns the fluid cell where the particle happens to be at any given time). In the approach used here, ownership of the particles is assigned once at the beginning, and one-to-one communication happens whenever the original owner needs information from the process that owns the cell where the particle lives. We make sure that we set ownership of the particles using the initial particle distribution, and keep the same ownership throughout the execution of the program.

With this overview out of the way, let us see what the function does. At the top, we create a temporary triangulation and DoFHandler object from which we will take the node locations for initial particle locations:

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::setup_tracer_particles()
{
mpi_communicator);
particle_insert_tria,
par.name_of_particle_grid,
par.arguments_for_particle_grid);
particle_insert_tria.refine_global(par.particle_insertion_refinement);
FE_Q<spacedim> particles_fe(1);
DoFHandler<spacedim> particles_dof_handler(particle_insert_tria);
particles_dof_handler.distribute_dofs(particles_fe);
Definition: fe_q.h:551

This is where things start to get complicated. Since we may run this program in a parallel environment, every parallel process will now have created these temporary triangulations and DoFHandlers. But, in fully distributed triangulations, the active process only knows about the locally owned cells, and has no idea of how other processes have distributed their own cells. This is true for both the temporary triangulation created above as well as the fluid triangulation into which we want to embed the particles below. On the other hand, these locally known portions of the two triangulations will, in general, not overlap. That is, the locations of the particles we will create from the node locations of the temporary mesh are arbitrary, and may fall within a region of the fluid triangulation that the current process doesn't have access to (i.e., a region of the fluid domain where cells are artificial). In order to understand who to send those particles to, we need to have a (rough) idea of how the fluid grid is distributed among processors.

We construct this information by first building an index tree of boxes bounding the locally owned cells, and then extracting one of the first levels of the tree:

std::vector<BoundingBox<spacedim>> all_boxes;
all_boxes.reserve(fluid_tria.n_locally_owned_active_cells());
for (const auto &cell : fluid_tria.active_cell_iterators())
if (cell->is_locally_owned())
all_boxes.emplace_back(cell->bounding_box());
const auto tree = pack_rtree(all_boxes);
const auto local_boxes =
extract_rtree_level(tree, par.fluid_rtree_extraction_level);
std::vector< BoundingBox< boost::geometry::dimension< typename Rtree::indexable_type >::value > > extract_rtree_level(const Rtree &tree, const unsigned int level)
RTree< typename LeafTypeIterator::value_type, IndexType, IndexableGetter > pack_rtree(const LeafTypeIterator &begin, const LeafTypeIterator &end)

Each process now has a collection of bounding boxes that completely enclose all locally owned processes (but that may overlap the bounding boxes of other processes). We then exchange this information between all participating processes so that every process knows the bounding boxes of all other processes.

Equipped with this knowledge, we can then initialize the tracer_particle_handler to the fluid mesh and generate the particles from the support points of the (temporary) tracer particles triangulation. This function call uses the global_bounding_boxes object we just constructed to figure out where to send the particles whose locations were derived from the locally owned part of the particles_dof_handler. At the end of this call, every particle will have been distributed to the correct process (i.e., the process that owns the fluid cell where the particle lives). We also output their number to the screen at this point.

global_fluid_bounding_boxes =
Utilities::MPI::all_gather(mpi_communicator, local_boxes);
tracer_particle_handler.initialize(fluid_tria,
global_fluid_bounding_boxes,
tracer_particle_handler);
pcout << "Tracer particles: "
<< tracer_particle_handler.n_global_particles() << std::endl;
void dof_support_points(const DoFHandler< dim, spacedim > &dof_handler, const std::vector< std::vector< BoundingBox< spacedim >>> &global_bounding_boxes, ParticleHandler< dim, spacedim > &particle_handler, const Mapping< dim, spacedim > &mapping=(ReferenceCells::get_hypercube< dim >() .template get_default_linear_mapping< dim, spacedim >()), const ComponentMask &components=ComponentMask(), const std::vector< std::vector< double >> &properties={})
Definition: generators.cc:456
std::vector< T > all_gather(const MPI_Comm &comm, const T &object_to_send)

Each particle so created has a unique ID. At some point in the algorithm below, we will need vectors containing position and velocity information for each particle. This vector will have size n_particles * spacedim, and we will have to store the elements of this vector in a way so that each parallel process "owns" those elements that correspond to coordinates of the particles it owns. In other words, we have to partition the index space between zero and n_particles * spacedim among all processes. We can do this by querying the tracer_particle_handler for the IDs of its locally relevant particles, and construct the indices that would be needed to store in a (parallel distributed) vector of the position and velocity of all particles where we implicitly assume that we store the coordinates of each location or velocity in spacedim successive vector elements (this is what the IndexSet::tensor_priduct() function does).

locally_owned_tracer_particle_coordinates =
tracer_particle_handler.locally_owned_particle_ids().tensor_product(
complete_index_set(spacedim));
IndexSet complete_index_set(const IndexSet::size_type N)
Definition: index_set.h:1069

At the beginning of the simulation, all particles are in their original position. When particles move, they may traverse to a part of the domain which is owned by another process. If this happens, the current process keeps formally "ownership" of the particles, but may need read access from the process where the particle has landed. We keep this information in another index set, which stores the indices of all particles that are currently on the current process's subdomain, independently if they have always been here or not.

Keeping this index set around allows us to leverage linear algebra classes for all communications regarding positions and velocities of the particles. This mimics what would happen in the case where another problem was solved in the solid domain (as in fluid-structure interaction. In this latter case, additional DOFs on the solid domain would be coupled to what is occurring in the fluid domain.

locally_relevant_tracer_particle_coordinates =
locally_owned_tracer_particle_coordinates;
}

Similarly to what we have done for passive tracers, we next set up the particles that track the quadrature points of the solid mesh. The main difference here is that we also want to attach a weight value (the "JxW" value of the quadrature point) to each of particle, so that we can compute integrals even without direct access to the original solid grid.

This is achieved by leveraging the "properties" concept of the Particles::Particle class. It is possible to store (in a memory efficient way) an arbitrary number of double numbers for each of the Particles::Particle objects inside a Particles::ParticleHandler object. We use this possibility to store the JxW values of the quadrature points of the solid grid.

In our case, we only need to store one property per particle: the JxW value of the integration on the solid grid. This is passed at construction time to the solid_particle_handler object as the last argument

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::setup_solid_particles()
{
const unsigned int n_properties = 1;
solid_particle_handler.initialize(fluid_tria,
n_properties);

The number of particles that we generate locally is equal to the total number of locally owned cells times the number of quadrature points used in each cell. We store all these points in a vector, and their corresponding properties in a vector of vectors:

solid_tria.n_locally_owned_active_cells());
std::vector<std::vector<double>> properties;
solid_tria.n_locally_owned_active_cells());
FEValues<dim, spacedim> fe_v(*solid_fe,
for (const auto &cell : solid_dh.active_cell_iterators())
if (cell->is_locally_owned())
{
fe_v.reinit(cell);
const auto &JxW = fe_v.get_JxW_values();
for (unsigned int q = 0; q < points.size(); ++q)
{
properties.emplace_back(
std::vector<double>(n_properties, JxW[q]));
}
}
@ update_JxW_values

We proceed in the same way we did with the tracer particles, reusing the computed bounding boxes. However, we first check that the global_fluid_bounding_boxes object has been actually filled. This should certainly be the case here, since this method is called after the one that initializes the tracer particles. However, we want to make sure that if in the future someone decides (for whatever reason) to initialize first the solid particle handler, or to copy just this part of the tutorial, a meaningful exception is thrown when things don't work as expected

Since we have already stored the position of the quadrature points, we can use these positions to insert the particles directly using the solid_particle_handler instead of having to go through a Particles::Generators function:

Assert(!global_fluid_bounding_boxes.empty(),
"I was expecting the "
"global_fluid_bounding_boxes to be filled at this stage. "
"Make sure you fill this vector before trying to use it "
"here. Bailing out."));
global_fluid_bounding_boxes,
properties);
pcout << "Solid particles: " << solid_particle_handler.n_global_particles()
<< std::endl;
}
static ::ExceptionBase & ExcInternalError()
#define Assert(cond, exc)
Definition: exceptions.h:1583

#### DoF initialization functions

We set up the finite element space and the quadrature formula to be used throughout the step. For the fluid, we use Taylor-Hood elements (e.g. $$Q_k \times Q_{k-1}$$). Since we do not solve any equation on the solid domain, an empty finite element space is generated. A natural extension of this program would be to solve a fluid structure interaction problem, which would require that the solid_fe use more useful FiniteElement class.

Like for many other functions, we store the time necessary to carry out the operations we perform here. The current function puts its timing information into a section with label "Initial setup". Numerous other calls to this timer are made in various functions. They allow to monitor the absolute and relative cost of each individual function to identify bottlenecks.

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::initial_setup()
{
TimerOutput::Scope t(computing_timer, "Initial setup");
fluid_fe =
std::make_unique<FESystem<spacedim>>(FE_Q<spacedim>(par.velocity_degree),
spacedim,
FE_Q<spacedim>(par.velocity_degree -
1),
1);
solid_fe = std::make_unique<FE_Nothing<dim, spacedim>>();
solid_dh.distribute_dofs(*solid_fe);
}

We next construct the distributed block matrices and vectors which are used to solve the linear equations that arise from the problem. This function is adapted from step-55 and we refer to this step for a thorough explanation.

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::setup_dofs()
{
TimerOutput::Scope t(computing_timer, "Setup dofs");
fluid_dh.distribute_dofs(*fluid_fe);
std::vector<unsigned int> stokes_sub_blocks(spacedim + 1, 0);
stokes_sub_blocks[spacedim] = 1;
DoFRenumbering::component_wise(fluid_dh, stokes_sub_blocks);
auto dofs_per_block =
DoFTools::count_dofs_per_fe_block(fluid_dh, stokes_sub_blocks);
const unsigned int n_u = dofs_per_block[0], n_p = dofs_per_block[1];
pcout << " Number of degrees of freedom: " << fluid_dh.n_dofs() << " ("
<< n_u << '+' << n_p << " -- "
<< solid_particle_handler.n_global_particles() << '+'
<< tracer_particle_handler.n_global_particles() << ')' << std::endl;
fluid_owned_dofs.resize(2);
fluid_owned_dofs[0] = fluid_dh.locally_owned_dofs().get_view(0, n_u);
fluid_owned_dofs[1] =
fluid_dh.locally_owned_dofs().get_view(n_u, n_u + n_p);
const IndexSet locally_relevant_dofs =
fluid_relevant_dofs.resize(2);
fluid_relevant_dofs[0] = locally_relevant_dofs.get_view(0, n_u);
fluid_relevant_dofs[1] = locally_relevant_dofs.get_view(n_u, n_u + n_p);
{
constraints.reinit(locally_relevant_dofs);
const FEValuesExtractors::Vector velocities(0);
fluid_dh,
0,
constraints,
constraints.close();
}
auto locally_owned_dofs_per_processor =
Utilities::MPI::all_gather(mpi_communicator,
fluid_dh.locally_owned_dofs());
{
system_matrix.clear();
Table<2, DoFTools::Coupling> coupling(spacedim + 1, spacedim + 1);
for (unsigned int c = 0; c < spacedim + 1; ++c)
for (unsigned int d = 0; d < spacedim + 1; ++d)
if (c == spacedim && d == spacedim)
coupling[c][d] = DoFTools::none;
else if (c == spacedim || d == spacedim || c == d)
coupling[c][d] = DoFTools::always;
else
coupling[c][d] = DoFTools::none;
BlockDynamicSparsityPattern dsp(dofs_per_block, dofs_per_block);
fluid_dh, coupling, dsp, constraints, false);
dsp,
locally_owned_dofs_per_processor,
mpi_communicator,
locally_relevant_dofs);
system_matrix.reinit(fluid_owned_dofs, dsp, mpi_communicator);
}
{
preconditioner_matrix.clear();
Table<2, DoFTools::Coupling> coupling(spacedim + 1, spacedim + 1);
for (unsigned int c = 0; c < spacedim + 1; ++c)
for (unsigned int d = 0; d < spacedim + 1; ++d)
if (c == spacedim && d == spacedim)
coupling[c][d] = DoFTools::always;
else
coupling[c][d] = DoFTools::none;
BlockDynamicSparsityPattern dsp(dofs_per_block, dofs_per_block);
fluid_dh, coupling, dsp, constraints, false);
dsp,
locally_owned_dofs_per_processor,
mpi_communicator,
locally_relevant_dofs);
preconditioner_matrix.reinit(fluid_owned_dofs, dsp, mpi_communicator);
}
locally_relevant_solution.reinit(fluid_owned_dofs,
fluid_relevant_dofs,
mpi_communicator);
system_rhs.reinit(fluid_owned_dofs, mpi_communicator);
solution.reinit(fluid_owned_dofs, mpi_communicator);
}
IndexSet get_view(const size_type begin, const size_type end) const
Definition: index_set.cc:212
void make_hanging_node_constraints(const DoFHandler< dim, spacedim > &dof_handler, AffineConstraints< number > &constraints)
void make_sparsity_pattern(const DoFHandler< dim, spacedim > &dof_handler, SparsityPatternBase &sparsity_pattern, const AffineConstraints< number > &constraints=AffineConstraints< number >(), const bool keep_constrained_dofs=true, const types::subdomain_id subdomain_id=numbers::invalid_subdomain_id)
void component_wise(DoFHandler< dim, spacedim > &dof_handler, const std::vector< unsigned int > &target_component=std::vector< unsigned int >())
IndexSet extract_locally_relevant_dofs(const DoFHandler< dim, spacedim > &dof_handler)
Definition: dof_tools.cc:1140
std::vector< types::global_dof_index > count_dofs_per_fe_block(const DoFHandler< dim, spacedim > &dof, const std::vector< unsigned int > &target_block=std::vector< unsigned int >())
Definition: dof_tools.cc:1977
SymmetricTensor< 2, dim, Number > d(const Tensor< 2, dim, Number > &F, const Tensor< 2, dim, Number > &dF_dt)
void distribute_sparsity_pattern(DynamicSparsityPattern &dsp, const IndexSet &locally_owned_rows, const MPI_Comm &mpi_comm, const IndexSet &locally_relevant_rows)
void interpolate_boundary_values(const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const std::map< types::boundary_id, const Function< spacedim, number > * > &function_map, std::map< types::global_dof_index, number > &boundary_values, const ComponentMask &component_mask=ComponentMask())

#### Assembly functions

We assemble the system matrix, the preconditioner matrix, and the right hand side. The code is adapted from step-55, which is essentially what step-27 also has, and is pretty standard if you know what the Stokes equations look like.

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::assemble_stokes_system()
{
system_matrix = 0;
preconditioner_matrix = 0;
system_rhs = 0;
TimerOutput::Scope t(computing_timer, "Assemble Stokes terms");
FEValues<spacedim> fe_values(*fluid_fe,
const unsigned int dofs_per_cell = fluid_fe->n_dofs_per_cell();
const unsigned int n_q_points = quadrature_formula.size();
FullMatrix<double> cell_matrix(dofs_per_cell, dofs_per_cell);
FullMatrix<double> cell_matrix2(dofs_per_cell, dofs_per_cell);
Vector<double> cell_rhs(dofs_per_cell);
std::vector<Vector<double>> rhs_values(n_q_points,
Vector<double>(spacedim + 1));
std::vector<double> div_phi_u(dofs_per_cell);
std::vector<double> phi_p(dofs_per_cell);
std::vector<types::global_dof_index> local_dof_indices(dofs_per_cell);
const FEValuesExtractors::Vector velocities(0);
const FEValuesExtractors::Scalar pressure(spacedim);
for (const auto &cell : fluid_dh.active_cell_iterators())
if (cell->is_locally_owned())
{
cell_matrix2 = 0;
cell_rhs = 0;
fe_values.reinit(cell);
rhs_values);
for (unsigned int q = 0; q < n_q_points; ++q)
{
for (unsigned int k = 0; k < dofs_per_cell; ++k)
{
div_phi_u[k] = fe_values[velocities].divergence(k, q);
phi_p[k] = fe_values[pressure].value(k, q);
}
for (unsigned int i = 0; i < dofs_per_cell; ++i)
{
for (unsigned int j = 0; j < dofs_per_cell; ++j)
{
cell_matrix(i, j) +=
(par.viscosity *
div_phi_u[i] * phi_p[j] - phi_p[i] * div_phi_u[j]) *
fe_values.JxW(q);
cell_matrix2(i, j) += 1.0 / par.viscosity * phi_p[i] *
phi_p[j] * fe_values.JxW(q);
}
const unsigned int component_i =
fluid_fe->system_to_component_index(i).first;
cell_rhs(i) += fe_values.shape_value(i, q) *
rhs_values[q](component_i) * fe_values.JxW(q);
}
}
cell->get_dof_indices(local_dof_indices);
constraints.distribute_local_to_global(cell_matrix,
cell_rhs,
local_dof_indices,
system_matrix,
system_rhs);
constraints.distribute_local_to_global(cell_matrix2,
local_dof_indices,
preconditioner_matrix);
}
}
constexpr ProductType< Number, OtherNumber >::type scalar_product(const SymmetricTensor< 2, dim, Number > &t1, const SymmetricTensor< 2, dim, OtherNumber > &t2)
@ update_values
Shape function values.
void cell_matrix(FullMatrix< double > &M, const FEValuesBase< dim > &fe, const FEValuesBase< dim > &fetest, const ArrayView< const std::vector< double >> &velocity, const double factor=1.)

The following method is then the one that deals with the penalty terms that result from imposing the velocity on the impeller. It is, in a sense, the heart of the tutorial, but it is relatively straightforward. Here we exploit the solid_particle_handler to compute the Nitsche restriction or the penalization in the embedded domain.

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::assemble_nitsche_restriction()
{
TimerOutput::Scope t(computing_timer, "Assemble Nitsche terms");
const FEValuesExtractors::Vector velocities(0);
const FEValuesExtractors::Scalar pressure(spacedim);
SolidVelocity<spacedim> solid_velocity(par.angular_velocity);
std::vector<types::global_dof_index> fluid_dof_indices(
fluid_fe->n_dofs_per_cell());
FullMatrix<double> local_matrix(fluid_fe->n_dofs_per_cell(),
fluid_fe->n_dofs_per_cell());
Vector<double> local_rhs(fluid_fe->n_dofs_per_cell());
const auto penalty_parameter =
double minimal_cell_diameter(const Triangulation< dim, spacedim > &triangulation, const Mapping< dim, spacedim > &mapping=(ReferenceCells::get_hypercube< dim >() .template get_default_linear_mapping< dim, spacedim >()))
Definition: grid_tools.cc:4545

We loop over all the local particles. Although this could be achieved directly by looping over all the cells, this would force us to loop over numerous cells which do not contain particles. Consequently, we loop over all the particles, but, we get the reference of the cell in which the particle lies and then loop over all particles within that cell. This enables us to skip the cells which do not contain particles, yet to assemble the local matrix and rhs of each cell to apply the Nitsche restriction. Once we are done with all particles on one cell, we advance the particle iterator to the particle past the end of the ones on the current cell (this is the last line of the while loop's body).

auto particle = solid_particle_handler.begin();
while (particle != solid_particle_handler.end())
{
local_matrix = 0;
local_rhs = 0;

We get an iterator to the cell within which the particle lies from the particle itself. We can then assemble the additional terms in the system matrix and the right hand side as we would normally.

const auto &cell = particle->get_surrounding_cell();
const auto &dh_cell =
typename DoFHandler<spacedim>::cell_iterator(*cell, &fluid_dh);
dh_cell->get_dof_indices(fluid_dof_indices);
typename ActiveSelector::cell_iterator cell_iterator
Definition: dof_handler.h:465

So then let us get the collection of cells that are located on this cell and iterate over them. From each particle we gather the location and the reference location of the particle as well as the additional information that is attached to the particle. In the present case, this information is the "JxW" of the quadrature points which were used to generate the particles.

Using this information, we can add the contribution of the quadrature point to the local_matrix and local_rhs. We can evaluate the value of the shape function at the position of each particle easily by using its reference location.

const auto pic = solid_particle_handler.particles_in_cell(cell);
Assert(pic.begin() == particle, ExcInternalError());
for (const auto &p : pic)
{
const auto &ref_q = p.get_reference_location();
const auto &real_q = p.get_location();
const auto &JxW = p.get_properties()[0];
for (unsigned int i = 0; i < fluid_fe->n_dofs_per_cell(); ++i)
{
const auto comp_i =
fluid_fe->system_to_component_index(i).first;
if (comp_i < spacedim)
{
for (unsigned int j = 0; j < fluid_fe->n_dofs_per_cell();
++j)
{
const auto comp_j =
fluid_fe->system_to_component_index(j).first;
if (comp_i == comp_j)
local_matrix(i, j) +=
penalty_parameter * par.penalty_term *
fluid_fe->shape_value(i, ref_q) *
fluid_fe->shape_value(j, ref_q) * JxW;
}
local_rhs(i) += penalty_parameter * par.penalty_term *
solid_velocity.value(real_q, comp_i) *
fluid_fe->shape_value(i, ref_q) * JxW;
}
}
}
constraints.distribute_local_to_global(local_matrix,
local_rhs,
fluid_dof_indices,
system_matrix,
system_rhs);
particle = pic.end();
}
}

#### Solving the linear system

This function solves the linear system with FGMRES with a block diagonal preconditioner and an algebraic multigrid (AMG) method for the diagonal blocks. The preconditioner applies a V cycle to the $$(0,0)$$ (i.e., the velocity-velocity) block and a CG with the mass matrix for the $$(1,1)$$ block (which is our approximation to the Schur complement: the pressure mass matrix assembled above).

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::solve()
{
TimerOutput::Scope t(computing_timer, "Solve");
{
#ifdef USE_PETSC_LA
data.symmetric_operator = true;
#endif
prec_A.initialize(system_matrix.block(0, 0), data);
}
{
#ifdef USE_PETSC_LA
data.symmetric_operator = true;
#endif
prec_S.initialize(preconditioner_matrix.block(1, 1), data);
}
const auto A = linear_operator<LA::MPI::Vector>(system_matrix.block(0, 0));
const auto amgA = linear_operator(A, prec_A);
const auto S =
linear_operator<LA::MPI::Vector>(preconditioner_matrix.block(1, 1));
const auto amgS = linear_operator(S, prec_S);
ReductionControl inner_solver_control(100,
1e-8 * system_rhs.l2_norm(),
1.e-2);
SolverCG<LA::MPI::Vector> cg(inner_solver_control);
const auto invS = inverse_operator(S, cg, amgS);
const auto P = block_diagonal_operator<2, LA::MPI::BlockVector>(
{amgA, amgS}});
SolverControl solver_control(system_matrix.m(),
1e-10 * system_rhs.l2_norm());
SolverFGMRES<LA::MPI::BlockVector> solver(solver_control);
constraints.set_zero(solution);
solver.solve(system_matrix, solution, system_rhs, P);
pcout << " Solved in " << solver_control.last_step() << " iterations."
<< std::endl;
constraints.distribute(solution);
locally_relevant_solution = solution;
const double mean_pressure =
QGauss<spacedim>(par.velocity_degree + 2),
locally_relevant_solution,
spacedim);
locally_relevant_solution.block(1) = solution.block(1);
}
LinearOperator< Range, Domain, Payload > linear_operator(const Matrix &matrix)
LinearOperator< Domain, Range, Payload > inverse_operator(const LinearOperator< Range, Domain, Payload > &op, Solver &solver, const Preconditioner &preconditioner)
static const char A
PETScWrappers::PreconditionBoomerAMG PreconditionAMG
SymmetricTensor< 2, dim, Number > e(const Tensor< 2, dim, Number > &F)
VectorType::value_type compute_mean_value(const hp::MappingCollection< dim, spacedim > &mapping_collection, const DoFHandler< dim, spacedim > &dof, const hp::QCollection< dim > &q_collection, const VectorType &v, const unsigned int component)

#### Mesh refinement

We deal with mesh refinement in a completely standard way, except we now also transfer the particles of the two particle handlers from the existing to the refined mesh. When performing local refinement or coarsening, particles will land in another cell. We could in principle redistribute all particles after refining, however this would be overly expensive.

The Particles::ParticleHandler class has a way to transfer information from a cell to its children or to its parent upon refinement, without the need to reconstruct the entire data structure. This is done similarly to the SolutionTransfer class by calling two functions, one to prepare for refinement, and one to transfer the information after refinement.

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::refine_and_transfer()
{
TimerOutput::Scope t(computing_timer, "Refine");
const FEValuesExtractors::Vector velocity(0);
Vector<float> error_per_cell(fluid_tria.n_active_cells());
par.velocity_degree + 1),
{},
locally_relevant_solution,
error_per_cell,
if (par.refinement_strategy == "fixed_fraction")
{
error_per_cell,
par.refinement_fraction,
par.coarsening_fraction);
}
else if (par.refinement_strategy == "fixed_number")
{
fluid_tria,
error_per_cell,
par.refinement_fraction,
par.coarsening_fraction,
par.max_cells);
}
for (const auto &cell : fluid_tria.active_cell_iterators())
{
if (cell->refine_flag_set() &&
cell->level() == par.max_level_refinement)
cell->clear_refine_flag();
if (cell->coarsen_flag_set() &&
cell->level() == par.min_level_refinement)
cell->clear_coarsen_flag();
}
transfer(fluid_dh);
fluid_tria.prepare_coarsening_and_refinement();
transfer.prepare_for_coarsening_and_refinement(locally_relevant_solution);
tracer_particle_handler.prepare_for_coarsening_and_refinement();
solid_particle_handler.prepare_for_coarsening_and_refinement();
fluid_tria.execute_coarsening_and_refinement();
setup_dofs();
transfer.interpolate(solution);
tracer_particle_handler.unpack_after_coarsening_and_refinement();
solid_particle_handler.unpack_after_coarsening_and_refinement();
constraints.distribute(solution);
locally_relevant_solution = solution;
}
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, typename InputVector::value_type > * > &neumann_bc, const InputVector &solution, Vector< float > &error, const ComponentMask &component_mask=ComponentMask(), 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)
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::NormType::L1_norm)
void refine_and_coarsen_fixed_number(::Triangulation< dim, spacedim > &tria, const ::Vector< Number > &criteria, const double top_fraction_of_cells, const double bottom_fraction_of_cells, const types::global_cell_index max_n_cells=std::numeric_limits< types::global_cell_index >::max())

#### Creating output for visualization

We output the results (velocity and pressure) on the fluid domain using the standard parallel capabilities of deal.II. A single compressed vtu file is written that agglomerates the information of all processors. An additional .pvd record is written to associate the physical time to the vtu files.

template <int dim, int spacedim>
void
StokesImmersedProblem<dim, spacedim>::output_results(const unsigned int cycle,
double time) const
{
TimerOutput::Scope t(computing_timer, "Output fluid");
std::vector<std::string> solution_names(spacedim, "velocity");
solution_names.emplace_back("pressure");
std::vector<DataComponentInterpretation::DataComponentInterpretation>
data_component_interpretation(
data_component_interpretation.push_back(
data_out.attach_dof_handler(fluid_dh);
solution_names,
data_component_interpretation);
Vector<float> subdomain(fluid_tria.n_active_cells());
for (unsigned int i = 0; i < subdomain.size(); ++i)
subdomain(i) = fluid_tria.locally_owned_subdomain();
data_out.build_patches();
const std::string filename =
"solution-" + Utilities::int_to_string(cycle) + ".vtu";
data_out.write_vtu_in_parallel(par.output_directory + "/" + filename,
mpi_communicator);
static std::vector<std::pair<double, std::string>> times_and_names;
times_and_names.emplace_back(time, filename);
std::ofstream ofile(par.output_directory + "/" + "solution.pvd");
DataOutBase::write_pvd_record(ofile, times_and_names);
}
void write_vtu_in_parallel(const std::string &filename, const MPI_Comm &comm) const
void attach_dof_handler(const DoFHandler< dim, spacedim > &)
void add_data_vector(const VectorType &data, const std::vector< std::string > &names, const DataVectorType type=type_automatic, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretation={})
virtual void build_patches(const unsigned int n_subdivisions=0)
Definition: data_out.cc:1063
void write_pvd_record(std::ostream &out, const std::vector< std::pair< double, std::string >> &times_and_names)
std::string int_to_string(const unsigned int value, const unsigned int digits=numbers::invalid_unsigned_int)
Definition: utilities.cc:473

Similarly, we write the particles (either from the solid or the tracers) as a single compressed vtu file through the Particles::DataOut object. This simple object does not write the additional information attached as "properties" to the particles, but only writes their id – but then, we don't care about the "JxW" values of these particle locations anyway, so no information that we may have wanted to visualize is lost.

template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::output_particles(
std::string fprefix,
const unsigned int iter,
const double time) const
{
particles_out.build_patches(particles);
const std::string filename =
(fprefix + "-" + Utilities::int_to_string(iter) + ".vtu");
particles_out.write_vtu_in_parallel(par.output_directory + "/" + filename,
mpi_communicator);
static std::map<std::string, std::vector<std::pair<double, std::string>>>
times_and_names;
if (times_and_names.find(fprefix) != times_and_names.end())
times_and_names[fprefix].push_back(std::make_pair(time, filename));
else
times_and_names[fprefix] = {std::make_pair(time, filename)};
std::ofstream ofile(par.output_directory + "/" + fprefix + ".pvd");
DataOutBase::write_pvd_record(ofile, times_and_names[fprefix]);
}
void build_patches(const Particles::ParticleHandler< dim, spacedim > &particles, const std::vector< std::string > &data_component_names={}, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretations={})
Definition: data_out.cc:28

#### The "run" function

This function now orchestrates the entire simulation. It is very similar to the other time dependent tutorial programs – take step-21 or step-26 as an example. At the beginning, we output some status information and also save all current parameters to a file in the output directory, for reproducibility.

template <int dim, int spacedim>
{
#ifdef USE_PETSC_LA
pcout << "Running StokesImmersedProblem<"
<< Utilities::dim_string(dim, spacedim) << "> using PETSc."
<< std::endl;
#else
pcout << "Running StokesImmersedProblem<"
<< Utilities::dim_string(dim, spacedim) << "> using Trilinos."
<< std::endl;
#endif
par.prm.print_parameters(par.output_directory + "/" + "used_parameters_" +
std::to_string(dim) + std::to_string(spacedim) +
".prm",
std::string to_string(const T &t)
Definition: patterns.h:2394
std::string dim_string(const int dim, const int spacedim)
Definition: utilities.cc:558

We then start the time loop. We initialize all the elements of the simulation in the first cycle

const double time_step = par.final_time / (par.number_of_time_steps - 1);
double time = 0;
unsigned int output_cycle = 0;
for (unsigned int cycle = 0; cycle < par.number_of_time_steps;
++cycle, time += time_step)
{
par.set_time(time);
pcout << "Cycle " << cycle << ':' << std::endl
<< "Time : " << time << ", time step: " << time_step << std::endl;
if (cycle == 0)
{
make_grid();
initial_setup();
setup_dofs();
setup_tracer_particles();
setup_solid_particles();
tracer_particle_velocities.reinit(
locally_owned_tracer_particle_coordinates, mpi_communicator);
output_results(output_cycle, time);
{
TimerOutput::Scope t(computing_timer, "Output tracer particles");
output_particles(tracer_particle_handler,
"tracer",
output_cycle,
time);
}
{
TimerOutput::Scope t(computing_timer, "Output solid particles");
output_particles(solid_particle_handler,
"solid",
output_cycle,
time);
}
}

After the first time step, we displace the solid body at the beginning of each time step to take into account the fact that is has moved.

else
{
TimerOutput::Scope t(computing_timer,
"Set solid particle position");
SolidPosition<spacedim> solid_position(par.angular_velocity,
time_step);
solid_particle_handler.set_particle_positions(solid_position,
false);
}

In order to update the state of the system, we first interpolate the fluid velocity at the position of the tracer particles and, with a naive explicit Euler scheme, advect the massless tracer particles.

{
TimerOutput::Scope t(computing_timer, "Set tracer particle motion");
fluid_dh,
tracer_particle_handler,
locally_relevant_solution,
tracer_particle_velocities,
tracer_particle_velocities *= time_step;
locally_relevant_tracer_particle_coordinates =
tracer_particle_handler.locally_owned_particle_ids().tensor_product(
complete_index_set(spacedim));
relevant_tracer_particle_displacements.reinit(
locally_owned_tracer_particle_coordinates,
locally_relevant_tracer_particle_coordinates,
mpi_communicator);
relevant_tracer_particle_displacements = tracer_particle_velocities;
tracer_particle_handler.set_particle_positions(
relevant_tracer_particle_displacements);
}
void interpolate_field_on_particles(const DoFHandler< dim, spacedim > &field_dh, const Particles::ParticleHandler< dim, spacedim > &particle_handler, const InputVectorType &field_vector, OutputVectorType &interpolated_field, const ComponentMask &field_comps=ComponentMask())
Definition: utilities.h:184

Using these new locations, we can then assemble the Stokes system and solve it.

assemble_stokes_system();
assemble_nitsche_restriction();
solve();

With the appropriate frequencies, we then write the information of the solid particles, the tracer particles, and the fluid domain into files for visualization, and end the time step by adapting the mesh.

if (cycle % par.output_frequency == 0)
{
output_results(output_cycle, time);
{
TimerOutput::Scope t(computing_timer, "Output tracer particles");
output_particles(tracer_particle_handler,
"tracer",
output_cycle,
time);
}
{
TimerOutput::Scope t(computing_timer, "Output solid particles");
output_particles(solid_particle_handler,
"solid",
output_cycle,
time);
}
++output_cycle;
}
if (cycle % par.refinement_frequency == 0 &&
cycle != par.number_of_time_steps - 1)
refine_and_transfer();
}
}
} // namespace Step70

### The main() function

The remainder of the code, the main() function, is standard, with the exception of the handling of input parameter files. We allow the user to specify an optional parameter file as an argument to the program. If nothing is specified, we use the default file "parameters.prm", which is created if non existent. The file name is scanned for the string "23" first, and "3" afterwards. If the filename contains the string "23", the problem classes are instantiated with template arguments 2 and 3 respectively. If only the string "3" is found, then both template arguments are set to 3, otherwise both are set to 2.

If the program is called without any command line arguments (i.e., argc==1), then we just use "parameters.prm" by default.

int main(int argc, char *argv[])
{
using namespace Step70;
using namespace dealii;
try
{
Utilities::MPI::MPI_InitFinalize mpi_initialization(argc, argv, 1);
std::string prm_file;
if (argc > 1)
prm_file = argv[1];
else
prm_file = "parameters.prm";
if (prm_file.find("23") != std::string::npos)
{
StokesImmersedProblemParameters<2, 3> par;
StokesImmersedProblem<2, 3> problem(par);
problem.run();
}
else if (prm_file.find('3') != std::string::npos)
{
StokesImmersedProblemParameters<3> par;
StokesImmersedProblem<3> problem(par);
problem.run();
}
else
{
StokesImmersedProblemParameters<2> par;
StokesImmersedProblem<2> problem(par);
problem.run();
}
}
catch (std::exception &exc)
{
std::cerr << std::endl
<< std::endl
<< "----------------------------------------------------"
<< std::endl;
std::cerr << "Exception on processing: " << std::endl
<< exc.what() << std::endl
<< "Aborting!" << std::endl
<< "----------------------------------------------------"
<< std::endl;
return 1;
}
catch (...)
{
std::cerr << std::endl
<< std::endl
<< "----------------------------------------------------"
<< std::endl;
std::cerr << "Unknown exception!" << std::endl
<< "Aborting!" << std::endl
<< "----------------------------------------------------"
<< std::endl;
return 1;
}
return 0;
}
unsigned int depth_console(const unsigned int n)
Definition: logstream.cc:350
static void initialize(const std::string &filename="", const std::string &output_filename="", const ParameterHandler::OutputStyle output_style_for_output_filename=ParameterHandler::Short, ParameterHandler &prm=ParameterAcceptor::prm, const ParameterHandler::OutputStyle output_style_for_filename=ParameterHandler::DefaultStyle)
LogStream deallog
Definition: logstream.cc:37

# Results

The directory in which this program is run contains a number of sample parameter files that you can use to reproduce the results presented in this section. If you do not specify a parameter file as an argument on the command line, the program will try to read the file "parameters.prm" by default, and will execute the two dimensional version of the code. As explained in the discussion of the source code, if your file name contains the string "23", then the program will run a three dimensional problem, with immersed solid of co-dimension one. If it contains the string "3", it will run a three dimensional problem, with immersed solid of co-dimension zero, otherwise it will run a two dimensional problem with immersed solid of co-dimension zero.

Regardless of the specific parameter file name, if the specified file does not exist, when you execute the program you will get an exception that no such file can be found:

----------------------------------------------------
Exception on processing:
--------------------------------------------------------
An error occurred in line <74> of file <../source/base/parameter_acceptor.cc> in function
static void ::ParameterAcceptor::initialize(const std::string &, const std::string &, const ParameterHandler::OutputStyle, ::ParameterHandler &)
The violated condition was:
false
You specified <parameters.prm> as input parameter file, but it does not exist. We created it for you.
--------------------------------------------------------
Aborting!
----------------------------------------------------

However, as the error message already states, the code that triggers the exception will also generate the specified file ("parameters.prm" in this case) that simply contains the default values for all parameters this program cares about (for the correct dimension and co-dimension, according to the whether a string "23" or "3" is contained in the file name). By inspection of the default parameter file, we see the following:

# Listing of Parameters
# ---------------------
subsection Stokes Immersed Problem
set Final time = 1
# Extraction level of the rtree used to construct global bounding boxes
set Fluid bounding boxes extraction level = 1
# Boundary Ids over which homogeneous Dirichlet boundary conditions are
# applied
set Homogeneous Dirichlet boundary ids = 0
# Initial mesh refinement used for the fluid domain Omega
set Initial fluid refinement = 5
# Initial mesh refinement used for the solid domain Gamma
set Initial solid refinement = 5
set Nitsche penalty term = 100
set Number of time steps = 501
set Output directory = .
set Output frequency = 1
# Refinement of the volumetric mesh used to insert the particles
set Particle insertion refinement = 3
set Velocity degree = 2
set Viscosity = 1
subsection Angular velocity
# Sometimes it is convenient to use symbolic constants in the expression
# that describes the function, rather than having to use its numeric value
# everywhere the constant appears. These values can be defined using this
# parameter, in the form var1=value1, var2=value2, ...'.
#
# A typical example would be to set this runtime parameter to
# pi=3.1415926536' and then use pi' in the expression of the actual
# formula. (That said, for convenience this class actually defines both
# pi' and Pi' by default, but you get the idea.)
set Function constants =
# The formula that denotes the function you want to evaluate for
# particular values of the independent variables. This expression may
# contain any of the usual operations such as addition or multiplication,
# as well as all of the common functions such as sin' or cos'. In
# addition, it may contain expressions like if(x>0, 1, -1)' where the
# expression evaluates to the second argument if the first argument is
# true, and to the third argument otherwise. For a full overview of
# possible expressions accepted see the documentation of the muparser
# library at http://muparser.beltoforion.de/.
#
# If the function you are describing represents a vector-valued function
# with multiple components, then separate the expressions for individual
# components by a semicolon.
set Function expression = t < .500001 ? 6.283185 : -6.283185 # default: 0
# The names of the variables as they will be used in the function,
# separated by commas. By default, the names of variables at which the
# function will be evaluated are x' (in 1d), x,y' (in 2d) or x,y,z' (in
# 3d) for spatial coordinates and t' for time. You can then use these
# variable names in your function expression and they will be replaced by
# the values of these variables at which the function is currently
# evaluated. However, you can also choose a different set of names for the
# independent variables at which to evaluate your function expression. For
# example, if you work in spherical coordinates, you may wish to set this
# input parameter to r,phi,theta,t' and then use these variable names in
set Variable names = x,y,t
subsection Grid generation
set Fluid grid generator = hyper_cube
set Fluid grid generator arguments = -1: 1: false
set Particle grid generator = hyper_ball
set Particle grid generator arguments = 0.3, 0.3: 0.1: false
set Solid grid generator = hyper_rectangle
set Solid grid generator arguments = -.5, -.1: .5, .1: false
subsection Refinement and remeshing
set Maximum number of cells = 20000
set Refinement coarsening fraction = 0.3
set Refinement fraction = 0.3
set Refinement maximal level = 8
set Refinement minimal level = 5
set Refinement step frequency = 5
set Refinement strategy = fixed_fraction
subsection Right hand side
# Sometimes it is convenient to use symbolic constants in the expression
# that describes the function, rather than having to use its numeric value
# everywhere the constant appears. These values can be defined using this
# parameter, in the form var1=value1, var2=value2, ...'.
#
# A typical example would be to set this runtime parameter to
# pi=3.1415926536' and then use pi' in the expression of the actual
# formula. (That said, for convenience this class actually defines both
# pi' and Pi' by default, but you get the idea.)
set Function constants =
# The formula that denotes the function you want to evaluate for
# particular values of the independent variables. This expression may
# contain any of the usual operations such as addition or multiplication,
# as well as all of the common functions such as sin' or cos'. In
# addition, it may contain expressions like if(x>0, 1, -1)' where the
# expression evaluates to the second argument if the first argument is
# true, and to the third argument otherwise. For a full overview of
# possible expressions accepted see the documentation of the muparser
# library at http://muparser.beltoforion.de/.
#
# If the function you are describing represents a vector-valued function
# with multiple components, then separate the expressions for individual
# components by a semicolon.
set Function expression = 0; 0; 0
# The names of the variables as they will be used in the function,
# separated by commas. By default, the names of variables at which the
# function will be evaluated are x' (in 1d), x,y' (in 2d) or x,y,z' (in
# 3d) for spatial coordinates and t' for time. You can then use these
# variable names in your function expression and they will be replaced by
# the values of these variables at which the function is currently
# evaluated. However, you can also choose a different set of names for the
# independent variables at which to evaluate your function expression. For
# example, if you work in spherical coordinates, you may wish to set this
# input parameter to r,phi,theta,t' and then use these variable names in
set Variable names = x,y,t
unsigned int level
Definition: grid_out.cc:4608
__global__ void set(Number *val, const Number s, const size_type N)
void hyper_ball(Triangulation< dim > &tria, const Point< dim > &center=Point< dim >(), const double radius=1., const bool attach_spherical_manifold_on_boundary_cells=false)
void hyper_rectangle(Triangulation< dim, spacedim > &tria, const Point< dim > &p1, const Point< dim > &p2, const bool colorize=false)
void hyper_cube(Triangulation< dim, spacedim > &tria, const double left=0., const double right=1., const bool colorize=false)
VectorType::value_type * end(VectorType &V)

If you now run the program, you will get a file called parameters_22.prm in the directory specified by the parameter Output directory (which defaults to the current directory) containing a shorter version of the above parameters (without comments and documentation), documenting all parameters that were used to run your program:

subsection Stokes Immersed Problem
set Final time = 1
set Fluid bounding boxes extraction level = 1
set Homogeneous Dirichlet boundary ids = 0
set Initial fluid refinement = 5
set Initial solid refinement = 5
set Nitsche penalty term = 100
set Number of time steps = 501
set Output directory = .
set Output frequency = 1
set Particle insertion refinement = 3
set Velocity degree = 2
set Viscosity = 1
subsection Angular velocity
set Function constants =
set Function expression = t < .500001 ? 6.283185 : -6.283185
set Variable names = x,y,t
subsection Grid generation
set Fluid grid generator = hyper_cube
set Fluid grid generator arguments = -1: 1: false
set Particle grid generator = hyper_ball
set Particle grid generator arguments = 0.3, 0.3: 0.1: false
set Solid grid generator = hyper_rectangle
set Solid grid generator arguments = -.5, -.1: .5, .1: false
subsection Refinement and remeshing
set Maximum number of cells = 20000
set Refinement coarsening fraction = 0.3
set Refinement fraction = 0.3
set Refinement maximal level = 8
set Refinement minimal level = 5
set Refinement step frequency = 5
set Refinement strategy = fixed_fraction
subsection Right hand side
set Function constants =
set Function expression = 0; 0; 0
set Variable names = x,y,t

The rationale behind creating first parameters.prm file (the first time the program is run) and then a output/parameters_22.prm (every time you run the program with an existing input file), is because you may want to leave most parameters to their default values, and only modify a handful of them, while still being able to reproduce the results and inspect what parameters were used for a specific simulation. It is generally good scientific practice to store the parameter file you used for a simulation along with the simulation output so that you can repeat the exact same run at a later time if necessary.

Another reason is because the input file may only contain those parameters that differ from their defaults. For example, you could use the following (perfectly valid) parameter file with this tutorial program:

subsection Stokes Immersed Problem
set Final time = 1
set Nitsche penalty term = 10
set Number of time steps = 101
set Velocity degree = 3

and you would run the program with Q3/Q2 Taylor-Hood finite elements, for 101 steps, using a Nitsche penalty of 10, and leaving all the other parameters to their default value. The output directory then contains a record of not just these parameters, but indeed all parameters used in the simulation. You can inspect all the other parameters in the produced file parameters_22.prm.

### Two dimensional test case

The default problem generates a co-dimension zero impeller, consisting of a rotating rectangular grid, where the rotation is for half a time unit in one direction, and half a time unit in the opposite direction, with constant angular velocity equal to $$\approx 2\pi \frac{\text{rad}}{\text{time unit}}$$. Consequently, the impeller does half a rotation and returns to its original position. The following animation displays the velocity magnitude, the motion of the solid impeller and of the tracer particles.

On one core, the output of the program will look like the following:

bash@f\$ mpirun -np 1 ./step-70 test.prm
Running StokesImmersedProblem<2> using Trilinos.
Cycle 0:
Time : 0, time step: 0.002
Number of degrees of freedom: 9539 (8450+1089 -- 0+0)
Tracer particles: 337
Solid particles: 9216
Solved in 158 iterations.
Number of degrees of freedom: 9845 (8722+1123 -- 9216+337)
Cycle 1:
Time : 0.002, time step: 0.002
Solved in 142 iterations.
Cycle 2:
Time : 0.004, time step: 0.002
Solved in 121 iterations.
Cycle 3:
Time : 0.006, time step: 0.002
Solved in 121 iterations.
...
Cycle 499:
Time : 0.998, time step: 0.002
Solved in 199 iterations.
Cycle 500:
Time : 1, time step: 0.002
Solved in 196 iterations.
+---------------------------------------------+------------+------------+
| Total wallclock time elapsed since start | 302s | |
| | | |
| Section | no. calls | wall time | % of total |
+---------------------------------+-----------+------------+------------+
| Assemble Nitsche terms | 501 | 43.3s | 14% |
| Assemble Stokes terms | 501 | 21.5s | 7.1% |
| Initial setup | 1 | 0.000792s | 0% |
| Output fluid | 502 | 31.8s | 11% |
| Output solid particles | 502 | 32.2s | 11% |
| Output tracer particles | 502 | 0.61s | 0.2% |
| Refine | 100 | 4.68s | 1.5% |
| Set solid particle position | 500 | 3.34s | 1.1% |
| Set tracer particle motion | 501 | 0.729s | 0.24% |
| Setup dofs | 101 | 2.2s | 0.73% |
| Solve | 501 | 164s | 54% |
+---------------------------------+-----------+------------+------------+

You may notice that assembling the coupling system is more expensive than assembling the Stokes part. This depends highly on the number of Gauss points (solid particles) that are used to apply the Nitsche restriction. In the present case, a relatively low number of tracer particles are used. Consequently, tracking their motion is relatively cheap.

The following movie shows the evolution of the solution over time:

The movie shows the rotating obstacle in gray (actually a superposition of the solid particles plotted with large enough dots that they overlap), streamlines of the fluid flow in light colors (including the corner vertices that form at specific times during the simulation), and the tracer particles in bluish tones.

The simulation shows that at the end time, the tracer particles have somewhat returned to their original position, although they have been distorted by the flow field. The following image compares the initial and the final position of the particles after one time unit of flow.

In this case, we see that the tracer particles that were outside of the swept volume of the impeller have returned very close to their initial position, whereas those in the swept volume were slightly more deformed. This deformation is non-physical. It is caused by the numerical error induced by the explicit Euler scheme used to advect the particles, by the loss of accuracy due to the fictitious domain and, finally, by the discretization error on the Stokes equations. The first two errors are the leading cause of this deformation and they could be alleviated by the use of a finer mesh and a lower time step.

### Three dimensional test case

To play around a little bit, we complicate the fictitious domain (taken from https://grabcad.com/library/lungstors-blower-1), and run a co-dimension one simulation in three space dimensions, using the following "parameters_23.prm" file :

subsection Stokes Immersed Problem
set Final time = 1
set Homogeneous Dirichlet boundary ids = 0
set Fluid bounding boxes extraction level = 1
set Initial fluid refinement = 3
set Initial solid refinement = 0
set Nitsche penalty term = 10
set Number of time steps = 101
set Output frequency = 1
set Particle insertion refinement = 3
set Velocity degree = 2
set Viscosity = 1
subsection Angular velocity
set Function constants =
set Function expression = t < .500001 ? 5 : -5
set Variable names = x,y,z,t
subsection Grid generation
set Fluid grid generator = hyper_rectangle
set Fluid grid generator arguments = -50,-50, -10: 50, 50, 40: false
set Solid grid generator = impeller.vtk
set Solid grid generator arguments = 1:impeller.step
set Particle grid generator = hyper_ball
set Particle grid generator arguments = 30, 30, 20: 10: false
subsection Refinement and remeshing
set Maximum number of cells = 100000
set Refinement coarsening fraction = 0.3
set Refinement fraction = 0.3
set Refinement maximal level = 6
set Refinement step frequency = 5
set Refinement strategy = fixed_fraction
subsection Right hand side
set Function constants =
set Function expression = 0; 0; 0; 0
set Variable names = x,y,z,t

In this case, the timing outputs are a bit different:

+---------------------------------------------+------------+------------+
| Total wallclock time elapsed since start | 5.54e+03s | |
| | | |
| Section | no. calls | wall time | % of total |
+---------------------------------+-----------+------------+------------+
| Assemble Nitsche terms | 101 | 111s | 2% |
| Assemble Stokes terms | 101 | 208s | 3.8% |
| Initial setup | 1 | 0.00187s | 0% |
| Output fluid | 102 | 15.5s | 0.28% |
| Output solid particles | 102 | 2.63s | 0% |
| Output tracer particles | 102 | 2.49s | 0% |
| Refine | 20 | 18.4s | 0.33% |
| Set solid particle position | 100 | 6.1s | 0.11% |
| Set tracer particle motion | 101 | 10.8s | 0.2% |
| Setup dofs | 21 | 13.9s | 0.25% |
| Solve | 101 | 5.16e+03s | 93% |
+---------------------------------+-----------+------------+------------+

Now, the solver is taking most of the solution time in three dimensions, and the particle motion and Nitsche assembly remain relatively unimportant as far as run time is concerned.

### Possibilities for extensions

The current tutorial program shows a one-way coupling between the fluid and the solid, where the solid motion is imposed (and not solved for), and read in the solid domain by exploiting the location and the weights of the solid quadrature points.

The structure of the code already allows one to implement a two-way coupling, by exploiting the possibility to read values of the fluid velocity on the quadrature points of the solid grid. For this to be more efficient in terms of MPI communication patterns, one should maintain ownership of the quadrature points on the solid processor that owns the cells where they have been created. In the current code, it is sufficient to define the IndexSet of the vectors used to exchange information of the quadrature points by using the solid partition instead of the initial fluid partition.

This allows the combination of the technique used in this tutorial program with those presented in the tutorial step-60 to solve a fluid structure interaction problem with distributed Lagrange multipliers, on parallel::distributed::Triangulation objects.

The timings above show that the current preconditioning strategy does not work well for Nitsche penalization, and we should come up with a better preconditioner if we want to aim at larger problems. Moreover, a checkpoint restart strategy should be implemented to allow for longer simulations to be interrupted and restored, as it is done for example in the step-69 tutorial.

# The plain program

/* ---------------------------------------------------------------------
*
* Copyright (C) 2020 - 2022 by the deal.II authors
*
* This file is part of the deal.II library.
*
* The deal.II library is free software; you can use it, redistribute
* it, and/or modify it under the terms of the GNU Lesser General
* version 2.1 of the License, or (at your option) any later version.
* The full text of the license can be found in the file LICENSE.md at
* the top level directory of deal.II.
*
* ---------------------------------------------------------------------
*
* Authors: Luca Heltai, Bruno Blais, Rene Gassmoeller, 2020
*/
#define FORCE_USE_OF_TRILINOS
namespace LA
{
#if defined(DEAL_II_WITH_PETSC) && !defined(DEAL_II_PETSC_WITH_COMPLEX) && \
!(defined(DEAL_II_WITH_TRILINOS) && defined(FORCE_USE_OF_TRILINOS))
using namespace dealii::LinearAlgebraPETSc;
# define USE_PETSC_LA
#elif defined(DEAL_II_WITH_TRILINOS)
using namespace dealii::LinearAlgebraTrilinos;
#else
# error DEAL_II_WITH_PETSC or DEAL_II_WITH_TRILINOS required
#endif
} // namespace LA
# include <TopoDS.hxx>
#endif
#include <cmath>
#include <fstream>
#include <iostream>
#include <memory>
namespace Step70
{
using namespace dealii;
template <int dim, int spacedim = dim>
class StokesImmersedProblemParameters : public ParameterAcceptor
{
public:
StokesImmersedProblemParameters();
void set_time(const double &time) const
{
rhs.set_time(time);
angular_velocity.set_time(time);
}
std::string output_directory = ".";
unsigned int velocity_degree = 2;
unsigned int number_of_time_steps = 501;
double final_time = 1.0;
unsigned int output_frequency = 1;
unsigned int initial_fluid_refinement = 5;
unsigned int initial_solid_refinement = 5;
unsigned int particle_insertion_refinement = 3;
unsigned int fluid_rtree_extraction_level = 1;
double viscosity = 1.0;
double penalty_term = 100;
std::list<types::boundary_id> homogeneous_dirichlet_ids{0};
std::string name_of_fluid_grid = "hyper_cube";
std::string arguments_for_fluid_grid = "-1: 1: false";
std::string name_of_solid_grid = "hyper_rectangle";
std::string arguments_for_solid_grid = spacedim == 2 ?
"-.5, -.1: .5, .1: false" :
"-.5, -.1, -.1: .5, .1, .1: false";
std::string name_of_particle_grid = "hyper_ball";
std::string arguments_for_particle_grid =
spacedim == 2 ? "0.3, 0.3: 0.1: false" : "0.3, 0.3, 0.3 : 0.1: false";
int max_level_refinement = 8;
int min_level_refinement = 5;
std::string refinement_strategy = "fixed_fraction";
double coarsening_fraction = 0.3;
double refinement_fraction = 0.3;
unsigned int max_cells = 20000;
int refinement_frequency = 5;
angular_velocity;
};
template <int dim, int spacedim>
StokesImmersedProblemParameters<dim,
spacedim>::StokesImmersedProblemParameters()
: ParameterAcceptor("Stokes Immersed Problem/")
, rhs("Right hand side", spacedim + 1)
, angular_velocity("Angular velocity")
{
"Velocity degree", velocity_degree, "", this->prm, Patterns::Integer(1));
initial_fluid_refinement,
"Initial mesh refinement used for the fluid domain Omega");
initial_solid_refinement,
"Initial mesh refinement used for the solid domain Gamma");
fluid_rtree_extraction_level,
"Extraction level of the rtree used to construct global "
"bounding boxes");
"Particle insertion refinement",
particle_insertion_refinement,
"Refinement of the volumetric mesh used to insert the particles");
"Homogeneous Dirichlet boundary ids",
homogeneous_dirichlet_ids,
"Boundary Ids over which homogeneous Dirichlet boundary conditions are applied");
enter_subsection("Grid generation");
{
arguments_for_particle_grid);
}
leave_subsection();
enter_subsection("Refinement and remeshing");
{
refinement_strategy,
"",
this->prm,
Patterns::Selection("fixed_fraction|fixed_number"));
}
leave_subsection();
rhs.declare_parameters_call_back.connect([&]() {
spacedim + 1);
});
angular_velocity.declare_parameters_call_back.connect([&]() {
this->prm.set("Function expression",
"t < .500001 ? 6.283185 : -6.283185");
});
}
template <int spacedim>
class SolidVelocity : public Function<spacedim>
{
public:
static_assert(spacedim > 1,
"Cannot instantiate SolidVelocity for spacedim == 1");
SolidVelocity(const Functions::ParsedFunction<spacedim> &angular_velocity)
: angular_velocity(angular_velocity)
{}
virtual double value(const Point<spacedim> &p,
unsigned int component = 0) const override
{
const double omega = angular_velocity.value(p);
velocity[0] = -omega * p[1];
velocity[1] = omega * p[0];
return velocity[component];
}
private:
const Functions::ParsedFunction<spacedim> &angular_velocity;
};
template <int spacedim>
class SolidPosition : public Function<spacedim>
{
public:
static_assert(spacedim > 1,
"Cannot instantiate SolidPosition for spacedim == 1");
SolidPosition(const Functions::ParsedFunction<spacedim> &angular_velocity,
const double time_step)
: Function<spacedim>(spacedim)
, angular_velocity(angular_velocity)
, time_step(time_step)
{}
virtual double value(const Point<spacedim> &p,
unsigned int component = 0) const override
{
Point<spacedim> new_position = p;
double dtheta = angular_velocity.value(p) * time_step;
new_position[0] = std::cos(dtheta) * p[0] - std::sin(dtheta) * p[1];
new_position[1] = std::sin(dtheta) * p[0] + std::cos(dtheta) * p[1];
return new_position[component];
}
void set_time_step(const double new_time_step)
{
time_step = new_time_step;
}
private:
const Functions::ParsedFunction<spacedim> &angular_velocity;
double time_step;
};
template <int dim, int spacedim = dim>
class StokesImmersedProblem
{
public:
StokesImmersedProblem(
const StokesImmersedProblemParameters<dim, spacedim> &par);
void run();
private:
void make_grid();
double compute_time_step() const;
void setup_tracer_particles();
void setup_solid_particles();
void initial_setup();
void setup_dofs();
void assemble_stokes_system();
void assemble_nitsche_restriction();
void solve();
void refine_and_transfer();
void output_results(const unsigned int cycle, const double time) const;
void output_particles(const Particles::ParticleHandler<spacedim> &particles,
std::string fprefix,
const unsigned int iter,
const double time) const;
const StokesImmersedProblemParameters<dim, spacedim> &par;
MPI_Comm mpi_communicator;
mutable TimerOutput computing_timer;
std::unique_ptr<FiniteElement<spacedim>> fluid_fe;
std::unique_ptr<FiniteElement<dim, spacedim>> solid_fe;
std::unique_ptr<MappingFEField<dim, spacedim>> solid_mapping;
std::vector<IndexSet> fluid_owned_dofs;
std::vector<IndexSet> solid_owned_dofs;
std::vector<IndexSet> fluid_relevant_dofs;
std::vector<IndexSet> solid_relevant_dofs;
LA::MPI::BlockSparseMatrix preconditioner_matrix;
LA::MPI::BlockVector locally_relevant_solution;
Particles::ParticleHandler<spacedim> tracer_particle_handler;
Particles::ParticleHandler<spacedim> solid_particle_handler;
IndexSet locally_owned_tracer_particle_coordinates;
IndexSet locally_relevant_tracer_particle_coordinates;
LA::MPI::Vector tracer_particle_velocities;
LA::MPI::Vector relevant_tracer_particle_displacements;
std::vector<std::vector<BoundingBox<spacedim>>> global_fluid_bounding_boxes;
};
template <int dim, int spacedim>
StokesImmersedProblem<dim, spacedim>::StokesImmersedProblem(
const StokesImmersedProblemParameters<dim, spacedim> &par)
: par(par)
, mpi_communicator(MPI_COMM_WORLD)
, pcout(std::cout,
(Utilities::MPI::this_mpi_process(mpi_communicator) == 0))
, computing_timer(mpi_communicator,
pcout,
TimerOutput::summary,
TimerOutput::wall_times)
, fluid_tria(mpi_communicator,
typename Triangulation<spacedim>::MeshSmoothing(
Triangulation<spacedim>::smoothing_on_refinement |
Triangulation<spacedim>::smoothing_on_coarsening))
, solid_tria(mpi_communicator,
typename Triangulation<dim, spacedim>::MeshSmoothing(
Triangulation<dim, spacedim>::smoothing_on_refinement |
Triangulation<dim, spacedim>::smoothing_on_coarsening))
, fluid_dh(fluid_tria)
, solid_dh(solid_tria)
{}
template <int dim, int spacedim>
{
using map_type = std::map<types::manifold_id, std::string>;
for (const auto &pair : Converter::to_value(ids_and_cad_file_names))
{
const auto &manifold_id = pair.first;
std::string extension =
std::transform(extension.begin(),
extension.end(),
extension.begin(),
[](const char c) -> char { return std::tolower(c); });
TopoDS_Shape shape;
if (extension == "iges" || extension == "igs")
else if (extension == "step" || extension == "stp")
else
AssertThrow(false,
ExcNotImplemented("We found an extension that we "
"do not recognize as a CAD file "
"extension. Bailing out."));
if ((std::get<0>(n_elements) == 0))
else if (spacedim == 3)
{
const auto t = reinterpret_cast<Triangulation<dim, 3> *>(&tria);
shape));
}
else
TopoDS::Face(shape)));
}
#else
AssertThrow(false, ExcNotImplemented("Generation of the grid failed."));
#endif
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::make_grid()
{
try
{
fluid_tria, par.name_of_fluid_grid, par.arguments_for_fluid_grid);
}
catch (...)
{
pcout << "Generating from name and argument failed." << std::endl
<< "Trying to read from file name." << std::endl;
par.arguments_for_fluid_grid,
fluid_tria);
}
fluid_tria.refine_global(par.initial_fluid_refinement);
try
{
solid_tria, par.name_of_solid_grid, par.arguments_for_solid_grid);
}
catch (...)
{
par.arguments_for_solid_grid,
solid_tria);
}
solid_tria.refine_global(par.initial_solid_refinement);
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::setup_tracer_particles()
{
mpi_communicator);
particle_insert_tria,
par.name_of_particle_grid,
par.arguments_for_particle_grid);
particle_insert_tria.refine_global(par.particle_insertion_refinement);
FE_Q<spacedim> particles_fe(1);
DoFHandler<spacedim> particles_dof_handler(particle_insert_tria);
particles_dof_handler.distribute_dofs(particles_fe);
std::vector<BoundingBox<spacedim>> all_boxes;
all_boxes.reserve(fluid_tria.n_locally_owned_active_cells());
for (const auto &cell : fluid_tria.active_cell_iterators())
if (cell->is_locally_owned())
all_boxes.emplace_back(cell->bounding_box());
const auto tree = pack_rtree(all_boxes);
const auto local_boxes =
extract_rtree_level(tree, par.fluid_rtree_extraction_level);
global_fluid_bounding_boxes =
Utilities::MPI::all_gather(mpi_communicator, local_boxes);
tracer_particle_handler.initialize(fluid_tria,
global_fluid_bounding_boxes,
tracer_particle_handler);
pcout << "Tracer particles: "
<< tracer_particle_handler.n_global_particles() << std::endl;
locally_owned_tracer_particle_coordinates =
tracer_particle_handler.locally_owned_particle_ids().tensor_product(
complete_index_set(spacedim));
locally_relevant_tracer_particle_coordinates =
locally_owned_tracer_particle_coordinates;
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::setup_solid_particles()
{
const unsigned int n_properties = 1;
solid_particle_handler.initialize(fluid_tria,
n_properties);
solid_tria.n_locally_owned_active_cells());
std::vector<std::vector<double>> properties;
solid_tria.n_locally_owned_active_cells());
FEValues<dim, spacedim> fe_v(*solid_fe,
for (const auto &cell : solid_dh.active_cell_iterators())
if (cell->is_locally_owned())
{
fe_v.reinit(cell);
const auto &JxW = fe_v.get_JxW_values();
for (unsigned int q = 0; q < points.size(); ++q)
{
properties.emplace_back(
std::vector<double>(n_properties, JxW[q]));
}
}
Assert(!global_fluid_bounding_boxes.empty(),
"I was expecting the "
"global_fluid_bounding_boxes to be filled at this stage. "
"Make sure you fill this vector before trying to use it "
"here. Bailing out."));
global_fluid_bounding_boxes,
properties);
pcout << "Solid particles: " << solid_particle_handler.n_global_particles()
<< std::endl;
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::initial_setup()
{
TimerOutput::Scope t(computing_timer, "Initial setup");
fluid_fe =
std::make_unique<FESystem<spacedim>>(FE_Q<spacedim>(par.velocity_degree),
spacedim,
FE_Q<spacedim>(par.velocity_degree -
1),
1);
solid_fe = std::make_unique<FE_Nothing<dim, spacedim>>();
solid_dh.distribute_dofs(*solid_fe);
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::setup_dofs()
{
TimerOutput::Scope t(computing_timer, "Setup dofs");
fluid_dh.distribute_dofs(*fluid_fe);
std::vector<unsigned int> stokes_sub_blocks(spacedim + 1, 0);
stokes_sub_blocks[spacedim] = 1;
DoFRenumbering::component_wise(fluid_dh, stokes_sub_blocks);
auto dofs_per_block =
DoFTools::count_dofs_per_fe_block(fluid_dh, stokes_sub_blocks);
const unsigned int n_u = dofs_per_block[0], n_p = dofs_per_block[1];
pcout << " Number of degrees of freedom: " << fluid_dh.n_dofs() << " ("
<< n_u << '+' << n_p << " -- "
<< solid_particle_handler.n_global_particles() << '+'
<< tracer_particle_handler.n_global_particles() << ')' << std::endl;
fluid_owned_dofs.resize(2);
fluid_owned_dofs[0] = fluid_dh.locally_owned_dofs().get_view(0, n_u);
fluid_owned_dofs[1] =
fluid_dh.locally_owned_dofs().get_view(n_u, n_u + n_p);
const IndexSet locally_relevant_dofs =
fluid_relevant_dofs.resize(2);
fluid_relevant_dofs[0] = locally_relevant_dofs.get_view(0, n_u);
fluid_relevant_dofs[1] = locally_relevant_dofs.get_view(n_u, n_u + n_p);
{
constraints.reinit(locally_relevant_dofs);
const FEValuesExtractors::Vector velocities(0);
fluid_dh,
0,
constraints,
constraints.close();
}
auto locally_owned_dofs_per_processor =
Utilities::MPI::all_gather(mpi_communicator,
fluid_dh.locally_owned_dofs());
{
system_matrix.clear();
Table<2, DoFTools::Coupling> coupling(spacedim + 1, spacedim + 1);
for (unsigned int c = 0; c < spacedim + 1; ++c)
for (unsigned int d = 0; d < spacedim + 1; ++d)
if (c == spacedim && d == spacedim)
coupling[c][d] = DoFTools::none;
else if (c == spacedim || d == spacedim || c == d)
coupling[c][d] = DoFTools::always;
else
coupling[c][d] = DoFTools::none;
BlockDynamicSparsityPattern dsp(dofs_per_block, dofs_per_block);
fluid_dh, coupling, dsp, constraints, false);
dsp,
locally_owned_dofs_per_processor,
mpi_communicator,
locally_relevant_dofs);
system_matrix.reinit(fluid_owned_dofs, dsp, mpi_communicator);
}
{
preconditioner_matrix.clear();
Table<2, DoFTools::Coupling> coupling(spacedim + 1, spacedim + 1);
for (unsigned int c = 0; c < spacedim + 1; ++c)
for (unsigned int d = 0; d < spacedim + 1; ++d)
if (c == spacedim && d == spacedim)
coupling[c][d] = DoFTools::always;
else
coupling[c][d] = DoFTools::none;
BlockDynamicSparsityPattern dsp(dofs_per_block, dofs_per_block);
fluid_dh, coupling, dsp, constraints, false);
dsp,
locally_owned_dofs_per_processor,
mpi_communicator,
locally_relevant_dofs);
preconditioner_matrix.reinit(fluid_owned_dofs, dsp, mpi_communicator);
}
locally_relevant_solution.reinit(fluid_owned_dofs,
fluid_relevant_dofs,
mpi_communicator);
system_rhs.reinit(fluid_owned_dofs, mpi_communicator);
solution.reinit(fluid_owned_dofs, mpi_communicator);
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::assemble_stokes_system()
{
system_matrix = 0;
preconditioner_matrix = 0;
system_rhs = 0;
TimerOutput::Scope t(computing_timer, "Assemble Stokes terms");
FEValues<spacedim> fe_values(*fluid_fe,
const unsigned int dofs_per_cell = fluid_fe->n_dofs_per_cell();
const unsigned int n_q_points = quadrature_formula.size();
FullMatrix<double> cell_matrix(dofs_per_cell, dofs_per_cell);
FullMatrix<double> cell_matrix2(dofs_per_cell, dofs_per_cell);
Vector<double> cell_rhs(dofs_per_cell);
std::vector<Vector<double>> rhs_values(n_q_points,
Vector<double>(spacedim + 1));
std::vector<double> div_phi_u(dofs_per_cell);
std::vector<double> phi_p(dofs_per_cell);
std::vector<types::global_dof_index> local_dof_indices(dofs_per_cell);
const FEValuesExtractors::Vector velocities(0);
const FEValuesExtractors::Scalar pressure(spacedim);
for (const auto &cell : fluid_dh.active_cell_iterators())
if (cell->is_locally_owned())
{
cell_matrix2 = 0;
cell_rhs = 0;
fe_values.reinit(cell);
rhs_values);
for (unsigned int q = 0; q < n_q_points; ++q)
{
for (unsigned int k = 0; k < dofs_per_cell; ++k)
{
div_phi_u[k] = fe_values[velocities].divergence(k, q);
phi_p[k] = fe_values[pressure].value(k, q);
}
for (unsigned int i = 0; i < dofs_per_cell; ++i)
{
for (unsigned int j = 0; j < dofs_per_cell; ++j)
{
cell_matrix(i, j) +=
(par.viscosity *
div_phi_u[i] * phi_p[j] - phi_p[i] * div_phi_u[j]) *
fe_values.JxW(q);
cell_matrix2(i, j) += 1.0 / par.viscosity * phi_p[i] *
phi_p[j] * fe_values.JxW(q);
}
const unsigned int component_i =
fluid_fe->system_to_component_index(i).first;
cell_rhs(i) += fe_values.shape_value(i, q) *
rhs_values[q](component_i) * fe_values.JxW(q);
}
}
cell->get_dof_indices(local_dof_indices);
constraints.distribute_local_to_global(cell_matrix,
cell_rhs,
local_dof_indices,
system_matrix,
system_rhs);
constraints.distribute_local_to_global(cell_matrix2,
local_dof_indices,
preconditioner_matrix);
}
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::assemble_nitsche_restriction()
{
TimerOutput::Scope t(computing_timer, "Assemble Nitsche terms");
const FEValuesExtractors::Vector velocities(0);
const FEValuesExtractors::Scalar pressure(spacedim);
SolidVelocity<spacedim> solid_velocity(par.angular_velocity);
std::vector<types::global_dof_index> fluid_dof_indices(
fluid_fe->n_dofs_per_cell());
FullMatrix<double> local_matrix(fluid_fe->n_dofs_per_cell(),
fluid_fe->n_dofs_per_cell());
Vector<double> local_rhs(fluid_fe->n_dofs_per_cell());
const auto penalty_parameter =
auto particle = solid_particle_handler.begin();
while (particle != solid_particle_handler.end())
{
local_matrix = 0;
local_rhs = 0;
const auto &cell = particle->get_surrounding_cell();
const auto &dh_cell =
typename DoFHandler<spacedim>::cell_iterator(*cell, &fluid_dh);
dh_cell->get_dof_indices(fluid_dof_indices);
const auto pic = solid_particle_handler.particles_in_cell(cell);
Assert(pic.begin() == particle, ExcInternalError());
for (const auto &p : pic)
{
const auto &ref_q = p.get_reference_location();
const auto &real_q = p.get_location();
const auto &JxW = p.get_properties()[0];
for (unsigned int i = 0; i < fluid_fe->n_dofs_per_cell(); ++i)
{
const auto comp_i =
fluid_fe->system_to_component_index(i).first;
if (comp_i < spacedim)
{
for (unsigned int j = 0; j < fluid_fe->n_dofs_per_cell();
++j)
{
const auto comp_j =
fluid_fe->system_to_component_index(j).first;
if (comp_i == comp_j)
local_matrix(i, j) +=
penalty_parameter * par.penalty_term *
fluid_fe->shape_value(i, ref_q) *
fluid_fe->shape_value(j, ref_q) * JxW;
}
local_rhs(i) += penalty_parameter * par.penalty_term *
solid_velocity.value(real_q, comp_i) *
fluid_fe->shape_value(i, ref_q) * JxW;
}
}
}
constraints.distribute_local_to_global(local_matrix,
local_rhs,
fluid_dof_indices,
system_matrix,
system_rhs);
particle = pic.end();
}
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::solve()
{
TimerOutput::Scope t(computing_timer, "Solve");
{
#ifdef USE_PETSC_LA
data.symmetric_operator = true;
#endif
prec_A.initialize(system_matrix.block(0, 0), data);
}
{
#ifdef USE_PETSC_LA
data.symmetric_operator = true;
#endif
prec_S.initialize(preconditioner_matrix.block(1, 1), data);
}
const auto A = linear_operator<LA::MPI::Vector>(system_matrix.block(0, 0));
const auto amgA = linear_operator(A, prec_A);
const auto S =
linear_operator<LA::MPI::Vector>(preconditioner_matrix.block(1, 1));
const auto amgS = linear_operator(S, prec_S);
ReductionControl inner_solver_control(100,
1e-8 * system_rhs.l2_norm(),
1.e-2);
SolverCG<LA::MPI::Vector> cg(inner_solver_control);
const auto invS = inverse_operator(S, cg, amgS);
const auto P = block_diagonal_operator<2, LA::MPI::BlockVector>(
{amgA, amgS}});
SolverControl solver_control(system_matrix.m(),
1e-10 * system_rhs.l2_norm());
SolverFGMRES<LA::MPI::BlockVector> solver(solver_control);
constraints.set_zero(solution);
solver.solve(system_matrix, solution, system_rhs, P);
pcout << " Solved in " << solver_control.last_step() << " iterations."
<< std::endl;
constraints.distribute(solution);
locally_relevant_solution = solution;
const double mean_pressure =
QGauss<spacedim>(par.velocity_degree + 2),
locally_relevant_solution,
spacedim);
locally_relevant_solution.block(1) = solution.block(1);
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::refine_and_transfer()
{
TimerOutput::Scope t(computing_timer, "Refine");
const FEValuesExtractors::Vector velocity(0);
Vector<float> error_per_cell(fluid_tria.n_active_cells());
par.velocity_degree + 1),
{},
locally_relevant_solution,
error_per_cell,
if (par.refinement_strategy == "fixed_fraction")
{
error_per_cell,
par.refinement_fraction,
par.coarsening_fraction);
}
else if (par.refinement_strategy == "fixed_number")
{
fluid_tria,
error_per_cell,
par.refinement_fraction,
par.coarsening_fraction,
par.max_cells);
}
for (const auto &cell : fluid_tria.active_cell_iterators())
{
if (cell->refine_flag_set() &&
cell->level() == par.max_level_refinement)
cell->clear_refine_flag();
if (cell->coarsen_flag_set() &&
cell->level() == par.min_level_refinement)
cell->clear_coarsen_flag();
}
transfer(fluid_dh);
fluid_tria.prepare_coarsening_and_refinement();
transfer.prepare_for_coarsening_and_refinement(locally_relevant_solution);
tracer_particle_handler.prepare_for_coarsening_and_refinement();
solid_particle_handler.prepare_for_coarsening_and_refinement();
fluid_tria.execute_coarsening_and_refinement();
setup_dofs();
transfer.interpolate(solution);
tracer_particle_handler.unpack_after_coarsening_and_refinement();
solid_particle_handler.unpack_after_coarsening_and_refinement();
constraints.distribute(solution);
locally_relevant_solution = solution;
}
template <int dim, int spacedim>
void
StokesImmersedProblem<dim, spacedim>::output_results(const unsigned int cycle,
double time) const
{
TimerOutput::Scope t(computing_timer, "Output fluid");
std::vector<std::string> solution_names(spacedim, "velocity");
solution_names.emplace_back("pressure");
std::vector<DataComponentInterpretation::DataComponentInterpretation>
data_component_interpretation(
data_component_interpretation.push_back(
data_out.attach_dof_handler(fluid_dh);
solution_names,
data_component_interpretation);
Vector<float> subdomain(fluid_tria.n_active_cells());
for (unsigned int i = 0; i < subdomain.size(); ++i)
subdomain(i) = fluid_tria.locally_owned_subdomain();
data_out.build_patches();
const std::string filename =
"solution-" + Utilities::int_to_string(cycle) + ".vtu";
data_out.write_vtu_in_parallel(par.output_directory + "/" + filename,
mpi_communicator);
static std::vector<std::pair<double, std::string>> times_and_names;
times_and_names.emplace_back(time, filename);
std::ofstream ofile(par.output_directory + "/" + "solution.pvd");
DataOutBase::write_pvd_record(ofile, times_and_names);
}
template <int dim, int spacedim>
void StokesImmersedProblem<dim, spacedim>::output_particles(
std::string fprefix,
const unsigned int iter,
const double time) const
{
particles_out.build_patches(particles);
const std::string filename =
(fprefix + "-" + Utilities::int_to_string(iter) + ".vtu");
particles_out.write_vtu_in_parallel(par.output_directory + "/" + filename,
mpi_communicator);
static std::map<std::string, std::vector<std::pair<double, std::string>>>
times_and_names;
if (times_and_names.find(fprefix) != times_and_names.end())
times_and_names[fprefix].push_back(std::make_pair(time, filename));
else
times_and_names[fprefix] = {std::make_pair(time, filename)};
std::ofstream ofile(par.output_directory + "/" + fprefix + ".pvd");
DataOutBase::write_pvd_record(ofile, times_and_names[fprefix]);
}
template <int dim, int spacedim>
{
#ifdef USE_PETSC_LA
pcout << "Running StokesImmersedProblem<"
<< Utilities::dim_string(dim, spacedim) << "> using PETSc."
<< std::endl;
#else
pcout << "Running StokesImmersedProblem<"
<< Utilities::dim_string(dim, spacedim) << "> using Trilinos."
<< std::endl;
#endif
par.prm.print_parameters(par.output_directory + "/" + "used_parameters_" +
std::to_string(dim) + std::to_string(spacedim) +
".prm",
const double time_step = par.final_time / (par.number_of_time_steps - 1);
double time = 0;
unsigned int output_cycle = 0;
for (unsigned int cycle = 0; cycle < par.number_of_time_steps;
++cycle, time += time_step)
{
par.set_time(time);
pcout << "Cycle " << cycle << ':' << std::endl
<< "Time : " << time << ", time step: " << time_step << std::endl;
if (cycle == 0)
{
make_grid();
initial_setup();
setup_dofs();
setup_tracer_particles();
setup_solid_particles();
tracer_particle_velocities.reinit(
locally_owned_tracer_particle_coordinates, mpi_communicator);
output_results(output_cycle, time);
{
TimerOutput::Scope t(computing_timer, "Output tracer particles");
output_particles(tracer_particle_handler,
"tracer",
output_cycle,
time);
}
{
TimerOutput::Scope t(computing_timer, "Output solid particles");
output_particles(solid_particle_handler,
"solid",
output_cycle,
time);
}
}
else
{
TimerOutput::Scope t(computing_timer,
"Set solid particle position");
SolidPosition<spacedim> solid_position(par.angular_velocity,
time_step);
solid_particle_handler.set_particle_positions(solid_position,
false);
}
{
TimerOutput::Scope t(computing_timer, "Set tracer particle motion");
fluid_dh,
tracer_particle_handler,
locally_relevant_solution,
tracer_particle_velocities,
tracer_particle_velocities *= time_step;
locally_relevant_tracer_particle_coordinates =
tracer_particle_handler.locally_owned_particle_ids().tensor_product(
complete_index_set(spacedim));
relevant_tracer_particle_displacements.reinit(
locally_owned_tracer_particle_coordinates,
locally_relevant_tracer_particle_coordinates,
mpi_communicator);
relevant_tracer_particle_displacements = tracer_particle_velocities;
tracer_particle_handler.set_particle_positions(
relevant_tracer_particle_displacements);
}
assemble_stokes_system();
assemble_nitsche_restriction();
solve();
if (cycle % par.output_frequency == 0)
{
output_results(output_cycle, time);
{
TimerOutput::Scope t(computing_timer, "Output tracer particles");
output_particles(tracer_particle_handler,
"tracer",
output_cycle,
time);
}
{
TimerOutput::Scope t(computing_timer, "Output solid particles");
output_particles(solid_particle_handler,
"solid",
output_cycle,
time);
}
++output_cycle;
}
if (cycle % par.refinement_frequency == 0 &&
cycle != par.number_of_time_steps - 1)
refine_and_transfer();
}
}
} // namespace Step70
int main(int argc, char *argv[])
{
using namespace Step70;
using namespace dealii;
try
{
Utilities::MPI::MPI_InitFinalize mpi_initialization(argc, argv, 1);
std::string prm_file;
if (argc > 1)
prm_file = argv[1];
else
prm_file = "parameters.prm";
if (prm_file.find("23") != std::string::npos)
{
StokesImmersedProblemParameters<2, 3> par;
StokesImmersedProblem<2, 3> problem(par);
problem.run();
}
else if (prm_file.find('3') != std::string::npos)
{
StokesImmersedProblemParameters<3> par;
StokesImmersedProblem<3> problem(par);
problem.run();
}
else
{
StokesImmersedProblemParameters<2> par;
StokesImmersedProblem<2> problem(par);
problem.run();
}
}
catch (std::exception &exc)
{
std::cerr << std::endl
<< std::endl
<< "----------------------------------------------------"
<< std::endl;
std::cerr << "Exception on processing: " << std::endl
<< exc.what() << std::endl
<< "Aborting!" << std::endl
<< "----------------------------------------------------"
<< std::endl;
return 1;
}
catch (...)
{
std::cerr << std::endl
<< std::endl
<< "----------------------------------------------------"
<< std::endl;
std::cerr << "Unknown exception!" << std::endl
<< "Aborting!" << std::endl
<< "----------------------------------------------------"
<< std::endl;
return 1;
}
return 0;
}