Reference documentation for deal.II version Git f44ff8fda9 2021-02-26 21:14:49 +0100
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Public Attributes | List of all members
MeshWorker::LoopControl Class Reference

#include <deal.II/meshworker/loop.h>

Public Types

enum  FaceOption { never, one, both }

Public Member Functions

 LoopControl ()

Public Attributes

bool own_cells
bool ghost_cells
FaceOption faces_to_ghost
FaceOption own_faces
bool cells_first

Detailed Description

Collection of parameters to control the execution of MeshWorker loops.

Definition at line 84 of file loop.h.

Member Enumeration Documentation

◆ FaceOption

Enumeration describing when to do assembly on a face: see, e.g., MeshWorker::LoopControl::faces_to_ghost for an example of how the value of this enumeration is interpreted in a particular circumstance.


Do not perform assembly on a face.


Perform assembly on one face.


Perform assembly on both faces.

Definition at line 114 of file loop.h.

Constructor & Destructor Documentation

◆ LoopControl()

MeshWorker::LoopControl::LoopControl ( )


Definition at line 90 of file loop.h.

Member Data Documentation

◆ own_cells

bool MeshWorker::LoopControl::own_cells

Loop over cells owned by this process. Defaults to true.

Definition at line 101 of file loop.h.

◆ ghost_cells

bool MeshWorker::LoopControl::ghost_cells

Loop over cells not owned by this process. Defaults to false.

Definition at line 107 of file loop.h.

◆ faces_to_ghost

FaceOption MeshWorker::LoopControl::faces_to_ghost

Control for looping over faces between a locally owned cell and a ghost cell:

  • never: Do not assembly these faces.
  • one: Only one of the processes will assemble these faces (from the finer side or the process with the lower MPI rank).
  • both: Both processes will assemble these faces. Note that these faces are never assembled from both sides on a single process.

The default is one.

Definition at line 142 of file loop.h.

◆ own_faces

FaceOption MeshWorker::LoopControl::own_faces

Control for looping over faces between two locally owned cells:

  • never: Do not assemble face terms.
  • one: Assemble once (always coming from the finer side).
  • both: Assemble each face twice (not implemented for hanging nodes!).

The default is one.

Definition at line 153 of file loop.h.

◆ cells_first

bool MeshWorker::LoopControl::cells_first

A flag to determine if cells integrals should be done before or after face integrals. The default is true.

Definition at line 159 of file loop.h.

The documentation for this class was generated from the following file: