Reference documentation for deal.II version Git aba33d3846 2022-01-19 21:43:57 -0500
\(\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 Attributes | List of all members
Utilities::MPI::MinMaxAvg Struct Reference

#include <deal.II/base/mpi.h>

Public Attributes

double sum
 
double min
 
double max
 
unsigned int min_index
 
unsigned int max_index
 
double avg
 

Detailed Description

A data structure to store the result of the min_max_avg() function. The structure stores the minimum, maximum, and average of one value contributed by each processor that participates in an MPI communicator. The structure also stores the indices (or, more precisely, the MPI rank) of the processors that hold the minimum and maximum values, as well as the sum over all values.

Note
This structure has no constructors because MPI requires it to be a POD type.

Definition at line 813 of file mpi.h.

Member Data Documentation

◆ sum

double Utilities::MPI::MinMaxAvg::sum

The sum over all values contributed by the processors that participate in the call to min_max_avg().

Definition at line 819 of file mpi.h.

◆ min

double Utilities::MPI::MinMaxAvg::min

The minimum value over all values contributed by the processors that participate in the call to min_max_avg().

Definition at line 825 of file mpi.h.

◆ max

double Utilities::MPI::MinMaxAvg::max

The maximum value over all values contributed by the processors that participate in the call to min_max_avg().

Definition at line 831 of file mpi.h.

◆ min_index

unsigned int Utilities::MPI::MinMaxAvg::min_index

One of the ranks (i.e., MPI rank within an MPI communicator) of the processors that hold the minimal value.

Definition at line 841 of file mpi.h.

◆ max_index

unsigned int Utilities::MPI::MinMaxAvg::max_index

One of the ranks (i.e., MPI rank within an MPI communicator) of the processors that hold the maximal value.

Definition at line 851 of file mpi.h.

◆ avg

double Utilities::MPI::MinMaxAvg::avg

The average of the values contributed by the processors that participate in the call to min_max_avg().

Definition at line 857 of file mpi.h.


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