dune-vtk  0.2
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dune::Vtk::YaspDataCollector< GridView > Class Template Reference

#include <dune/vtk/datacollectors/yaspdatacollector.hh>

Inheritance diagram for Dune::Vtk::YaspDataCollector< GridView >:
Inheritance graph

Public Types

enum  
 The dimension of the grid. More...
 
enum  
 The dimension of the world. More...
 
using GridView = GridView
 

Public Member Functions

 YaspDataCollector (GridView const &gridView)
 
std::array< int, 6 > const & wholeExtentImpl () const
 
std::array< int, 6 > const & extentImpl () const
 
auto const & originImpl () const
 
auto const & spacingImpl () const
 
void updateImpl ()
 
void initGeometry (EquidistantCoordinates< ctype, dim > const &coords)
 
void initGeometry (EquidistantOffsetCoordinates< ctype, dim > const &coords)
 
void initGeometry (TensorProductCoordinates< ctype, dim > const &coords)
 
template<class T >
std::array< std::vector< T >, 3 > coordinatesImpl () const
 Extract the ordinates from the coordinates object of the current level. More...
 
std::array< int, 6 > wholeExtent () const
 Sequence of Index pairs [begin, end) for the cells in each direction. More...
 
std::array< int, 6 > extent () const
 Sequence of Index pairs [begin, end) for the cells in each direction of the local partition. More...
 
void writeLocalPiece (Writer const &writer) const
 Call the writer with extent. More...
 
void writePieces (Writer const &writer) const
 Call the writer with piece number and piece extent. More...
 
std::uint64_t numCellsImpl () const
 Return number of grid cells. More...
 
std::uint64_t numPointsImpl () const
 Return number of grid vertices. More...
 
std::vector< T > pointsImpl () const
 
std::vector< T > pointDataImpl (GlobalFunction const &fct) const
 
void writeLocalPieceImpl (Writer const &writer) const
 
void writePiecesImpl (Writer const &writer) const
 
void update ()
 Update the DataCollector on the current GridView. More...
 
int ghostLevel () const
 Return the number of ghost elements. More...
 
std::uint64_t numCells () const
 Return the number of cells in (this partition of the) grid. More...
 
std::uint64_t numPoints () const
 Return the number of points in (this partition of the) grid. More...
 
std::vector< T > points () const
 Return a flat vector of point coordinates. More...
 
std::vector< T > pointData (VtkFunction const &fct) const
 Return a flat vector of function values evaluated at the points. More...
 
std::vector< T > cellData (VtkFunction const &fct) const
 Return a flat vector of function values evaluated at the cells in the order of traversal. More...
 
int ghostLevelImpl () const
 
std::vector< T > cellDataImpl (VtkFunction const &fct) const
 
FieldVector< ctype, 3 > origin () const
 Lower left corner of the grid. More...
 
FieldVector< ctype, 3 > spacing () const
 Constant grid spacing in each coordinate direction. More...
 
std::array< std::vector< T >, 3 > coordinates () const
 The coordinates defines point coordinates for an extent by specifying the ordinate along each axis. More...
 

Static Public Attributes

static constexpr auto partition
 The partitionset to collect data from. More...
 

Protected Types

using SubDataCollector = ContinuousDataCollector< GridView >
 

Protected Member Functions

YaspDataCollector< GridView > & asDerived ()
 
const YaspDataCollector< GridView > & asDerived () const
 

Protected Attributes

std::array< int, 6 > wholeExtent_
 
std::array< int, 6 > extent_
 
FieldVector< ctype, 3 > origin_
 
FieldVector< ctype, 3 > spacing_
 
int level_
 
SubDataCollector subDataCollector_
 
std::vector< std::array< int, 6 > > extents_
 
std::vector< MPI_Request > requests_
 
MPI_Request sendRequest_
 
GridView gridView_
 

Member Typedef Documentation

◆ GridView

using Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::GridView = GridView
inherited

◆ SubDataCollector

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

The dimension of the grid.

◆ anonymous enum

anonymous enum
inherited

The dimension of the world.

Constructor & Destructor Documentation

◆ YaspDataCollector()

template<class GridView >
Dune::Vtk::YaspDataCollector< GridView >::YaspDataCollector ( GridView const &  gridView)
inline

Member Function Documentation

◆ asDerived() [1/2]

YaspDataCollector< GridView > & Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::asDerived ( )
inlineprotectedinherited

◆ asDerived() [2/2]

const YaspDataCollector< GridView > & Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::asDerived ( ) const
inlineprotectedinherited

◆ cellData()

std::vector<T> Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::cellData ( VtkFunction const &  fct) const
inlineinherited

Return a flat vector of function values evaluated at the cells in the order of traversal.

See also
pointData. Note: Cells might be described explicitly by connectivity, offsets, and types, e.g. in an UnstructuredGrid, or might be described implicitly by the grid type, e.g. in StructuredGrid.

◆ cellDataImpl()

std::vector< T > Dune::Vtk::DataCollectorInterface< GV, D, P >::cellDataImpl ( VtkFunction const &  fct) const
inherited

◆ coordinates()

std::array<std::vector<T>, 3> Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::coordinates ( ) const
inlineinherited

The coordinates defines point coordinates for an extent by specifying the ordinate along each axis.

Interface for RectilinearGrid

◆ coordinatesImpl()

template<class GridView >
template<class T >
std::array<std::vector<T>, 3> Dune::Vtk::YaspDataCollector< GridView >::coordinatesImpl ( ) const
inline

Extract the ordinates from the coordinates object of the current level.

◆ extent()

std::array<int, 6> Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::extent ( ) const
inlineinherited

Sequence of Index pairs [begin, end) for the cells in each direction of the local partition.

◆ extentImpl()

template<class GridView >
std::array<int, 6> const& Dune::Vtk::YaspDataCollector< GridView >::extentImpl ( ) const
inline

◆ ghostLevel()

int Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::ghostLevel ( ) const
inlineinherited

Return the number of ghost elements.

◆ ghostLevelImpl()

int Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::ghostLevelImpl ( ) const
inlineinherited

◆ initGeometry() [1/3]

template<class GridView >
void Dune::Vtk::YaspDataCollector< GridView >::initGeometry ( EquidistantCoordinates< ctype, dim > const &  coords)
inline

◆ initGeometry() [2/3]

template<class GridView >
void Dune::Vtk::YaspDataCollector< GridView >::initGeometry ( EquidistantOffsetCoordinates< ctype, dim > const &  coords)
inline

◆ initGeometry() [3/3]

template<class GridView >
void Dune::Vtk::YaspDataCollector< GridView >::initGeometry ( TensorProductCoordinates< ctype, dim > const &  coords)
inline

◆ numCells()

std::uint64_t Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::numCells ( ) const
inlineinherited

Return the number of cells in (this partition of the) grid.

◆ numCellsImpl()

std::uint64_t Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::numCellsImpl ( ) const
inlineinherited

Return number of grid cells.

◆ numPoints()

std::uint64_t Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::numPoints ( ) const
inlineinherited

Return the number of points in (this partition of the) grid.

◆ numPointsImpl()

std::uint64_t Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::numPointsImpl ( ) const
inlineinherited

Return number of grid vertices.

◆ origin()

Lower left corner of the grid.

Interface for ImageData:

◆ originImpl()

template<class GridView >
auto const& Dune::Vtk::YaspDataCollector< GridView >::originImpl ( ) const
inline

◆ pointData()

std::vector<T> Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::pointData ( VtkFunction const &  fct) const
inlineinherited

Return a flat vector of function values evaluated at the points.

In case of a vector valued function, flat the vector entries: [fct(p0)_0, fct(p0)_1, fct(p0)_2, fct(p1)_0, ...] where the vector dimension must be 3 (possible extended by 0s) In case of tensor valued function, flat the tensor row-wise: [fct(p0)_00, fct(p0)_01, fct(p0)_02, fct(p0)_10, fct(p0)_11, fct(p0)_12, fct(p0)_20...] where the tensor dimension must be 3x3 (possible extended by 0s)

◆ pointDataImpl()

std::vector<T> Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::pointDataImpl ( GlobalFunction const &  fct) const
inlineinherited

◆ points()

std::vector<T> Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::points ( ) const
inlineinherited

Return a flat vector of point coordinates.

All coordinates are extended to 3 components and concatenated. [p0_x, p0_y, p0_z, p1_x, p1_y, p1_z, ...] If the GridView::dimensionworld < 3, the remaining components are set to 0

◆ pointsImpl()

std::vector<T> Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::pointsImpl ( ) const
inlineinherited

◆ spacing()

FieldVector<ctype, 3> Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::spacing ( ) const
inlineinherited

Constant grid spacing in each coordinate direction.

◆ spacingImpl()

template<class GridView >
auto const& Dune::Vtk::YaspDataCollector< GridView >::spacingImpl ( ) const
inline

◆ update()

void Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::update ( )
inlineinherited

Update the DataCollector on the current GridView.

◆ updateImpl()

template<class GridView >
void Dune::Vtk::YaspDataCollector< GridView >::updateImpl ( )
inline

◆ wholeExtent()

std::array<int, 6> Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::wholeExtent ( ) const
inlineinherited

Sequence of Index pairs [begin, end) for the cells in each direction.

◆ wholeExtentImpl()

template<class GridView >
std::array<int, 6> const& Dune::Vtk::YaspDataCollector< GridView >::wholeExtentImpl ( ) const
inline

◆ writeLocalPiece()

void Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::writeLocalPiece ( Writer const &  writer) const
inlineinherited

Call the writer with extent.

◆ writeLocalPieceImpl()

void Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::writeLocalPieceImpl ( Writer const &  writer) const
inlineinherited

◆ writePieces()

void Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::writePieces ( Writer const &  writer) const
inlineinherited

Call the writer with piece number and piece extent.

◆ writePiecesImpl()

void Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::writePiecesImpl ( Writer const &  writer) const
inlineinherited

Member Data Documentation

◆ extent_

template<class GridView >
std::array<int, 6> Dune::Vtk::YaspDataCollector< GridView >::extent_
protected

◆ extents_

std::vector<std::array<int,6> > Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::extents_
mutableprotectedinherited

◆ gridView_

GridView Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::gridView_
protectedinherited

◆ level_

template<class GridView >
int Dune::Vtk::YaspDataCollector< GridView >::level_
protected

◆ origin_

template<class GridView >
FieldVector<ctype,3> Dune::Vtk::YaspDataCollector< GridView >::origin_
protected

◆ partition

constexpr auto Dune::Vtk::DataCollectorInterface< GridView , YaspDataCollector< GridView > , Partitions::InteriorBorder >::partition
staticconstexprinherited

The partitionset to collect data from.

◆ requests_

std::vector<MPI_Request> Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::requests_
mutableprotectedinherited

◆ sendRequest_

MPI_Request Dune::Vtk::StructuredDataCollectorInterface< GridView, YaspDataCollector< GridView > >::sendRequest_
mutableprotectedinherited

◆ spacing_

template<class GridView >
FieldVector<ctype,3> Dune::Vtk::YaspDataCollector< GridView >::spacing_
protected

◆ subDataCollector_

◆ wholeExtent_

template<class GridView >
std::array<int, 6> Dune::Vtk::YaspDataCollector< GridView >::wholeExtent_
protected

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