Reference documentation for deal.II version Git 34859fde61 2019-12-10 11:26:22 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
DataOutBase::Patch< 0, spacedim > Struct Template Reference

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

Public Member Functions

 Patch ()
 
bool operator== (const Patch &patch) const
 
std::size_t memory_consumption () const
 
void swap (Patch< 0, spacedim > &other_patch)
 

Static Public Member Functions

static ::ExceptionBaseExcInvalidCombinationOfDimensions (int arg1, int arg2)
 

Public Attributes

Point< spacedim > vertices [1]
 
unsigned int patch_index
 
Table< 2, float > data
 
bool points_are_available
 

Static Public Attributes

static const unsigned int space_dim = spacedim
 
static unsigned int neighbors [1]
 
static unsigned int n_subdivisions = 1
 
static const unsigned int no_neighbor = numbers::invalid_unsigned_int
 

Detailed Description

template<int spacedim>
struct DataOutBase::Patch< 0, spacedim >

A specialization of the general Patch<dim,spacedim> template that is tailored to the case of points, i.e., zero-dimensional objects embedded in spacedim dimensional space.

The current class is compatible with the general template to allow for using the same functions accessing patches of arbitrary dimensionality in a generic way. However, it makes some variables that are nonsensical for zero-dimensional patches into static variables that exist only once in the entire program, as opposed to once per patch. Specifically, this is the case for the neighbors array and the n_subdivisions member variable that make no sense for zero-dimensional patches because points have no natural neighbors across their non-existent faces, nor can they reasonably be subdivided.

Author
Wolfgang Bangerth, 2017.

Definition at line 397 of file data_out_base.h.

Constructor & Destructor Documentation

◆ Patch()

template<int spacedim>
DataOutBase::Patch< 0, spacedim >::Patch ( )

Default constructor. Sets points_are_available to false, and patch_index to no_neighbor.

Definition at line 1857 of file data_out_base.cc.

Member Function Documentation

◆ operator==()

template<int spacedim>
bool DataOutBase::Patch< 0, spacedim >::operator== ( const Patch< 0, spacedim > &  patch) const

Compare the present patch for equality with another one. This is used in a few of the automated tests in our testsuite.

Definition at line 1868 of file data_out_base.cc.

◆ memory_consumption()

template<int spacedim>
std::size_t DataOutBase::Patch< 0, spacedim >::memory_consumption ( ) const

Return an estimate for the memory consumption, in bytes, of this object. This is not exact (but will usually be close) because calculating the memory usage of trees (e.g., std::map) is difficult.

Definition at line 1902 of file data_out_base.cc.

◆ swap()

template<int spacedim>
void DataOutBase::Patch< 0, spacedim >::swap ( Patch< 0, spacedim > &  other_patch)

Swap the current object's contents with those of the given argument.

Definition at line 1913 of file data_out_base.cc.

Member Data Documentation

◆ space_dim

template<int spacedim>
const unsigned int DataOutBase::Patch< 0, spacedim >::space_dim = spacedim
static

Make the spacedim template parameter available.

Definition at line 402 of file data_out_base.h.

◆ vertices

template<int spacedim>
Point<spacedim> DataOutBase::Patch< 0, spacedim >::vertices[1]

Corner points of a patch. For the current class of zero-dimensional patches, there is of course only a single vertex.

If points_are_available==true, then the coordinates of the point at which output is to be generated is attached as an additional row to the data table.

Definition at line 412 of file data_out_base.h.

◆ neighbors

template<int spacedim>
unsigned int DataOutBase::Patch< 0, spacedim >::neighbors
static
Initial value:

An unused, static variable that exists only to allow access from general code in a generic fashion.

Definition at line 418 of file data_out_base.h.

◆ patch_index

template<int spacedim>
unsigned int DataOutBase::Patch< 0, spacedim >::patch_index

Number of this patch. Since we are not sure patches are always handled in the same order, we better store this.

Definition at line 424 of file data_out_base.h.

◆ n_subdivisions

template<int spacedim>
unsigned int DataOutBase::Patch< 0, spacedim >::n_subdivisions = 1
static

Number of subdivisions with which this patch is to be written. 1 means no subdivision, 2 means bisection, 3 trisection, etc.

Since subdivision makes no sense for zero-dimensional patches, this variable is not used but exists only to allow access from general code in a generic fashion.

Definition at line 435 of file data_out_base.h.

◆ data

template<int spacedim>
Table<2, float> DataOutBase::Patch< 0, spacedim >::data

Data vectors. The format is as follows: data(i,.) denotes the data belonging to the ith data vector. data.n_cols() therefore equals the number of output points; this number is of course one for the current class, given that we produce output on points. data.n_rows() equals the number of data vectors. For the current purpose, a data vector equals one scalar, even if multiple scalars may later be interpreted as vectors.

Within each column, data(.,j) are the data values at the output point j; for the current class, j can only be zero.

Since the number of data vectors is usually the same for all patches to be printed, data.size() should yield the same value for all patches provided. The exception are patches for which points_are_available are set, where the actual coordinates of the point are appended to the 'data' field, see the documentation of the points_are_available flag.

Definition at line 457 of file data_out_base.h.

◆ points_are_available

template<int spacedim>
bool DataOutBase::Patch< 0, spacedim >::points_are_available

A flag indicating whether the coordinates of the interior patch points (assuming that the patch is supposed to be subdivided further) are appended to the data table (true) or not (false). The latter is the default and in this case the locations of the points interior to this patch are computed by (bi-, tri-)linear interpolation from the vertices of the patch.

This option exists since patch points may be evaluated using a Mapping (rather than by a linear interpolation) and therefore have to be stored in the Patch structure.

Definition at line 471 of file data_out_base.h.

◆ no_neighbor

template<int spacedim>
const unsigned int DataOutBase::Patch< 0, spacedim >::no_neighbor = numbers::invalid_unsigned_int
static

Value to be used if this patch has no neighbor on one side.

Definition at line 503 of file data_out_base.h.


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