dune-vtk 2.12
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | List of all members
Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived > Class Template Reference

The Interface for structured data-collectors. More...

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

Inheritance diagram for Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >:
Inheritance graph

Public Types

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

Public Member Functions

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

Static Public Attributes

static constexpr auto partition
 The partitionset to collect data from.
 

Protected Types

using Super = DataCollectorInterface< GridView, Derived >
 
using SubDataCollector = ContinuousDataCollector< GridView >
 
using ctype = typename GridView::ctype
 

Protected Member Functions

Derived & asDerived ()
 
const Derived & asDerived () const
 

Detailed Description

template<class GridView, class Derived>
class Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >

The Interface for structured data-collectors.

Member Typedef Documentation

◆ ctype

template<class GridView , class Derived >
using Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::ctype = typename GridView::ctype
protected

◆ GridView

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

Type of the bound grid view.

◆ SubDataCollector

template<class GridView , class Derived >
using Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::SubDataCollector = ContinuousDataCollector<GridView>
protected

◆ Super

template<class GridView , class Derived >
using Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::Super = DataCollectorInterface<GridView, Derived>
protected

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

◆ StructuredDataCollectorInterface()

template<class GridView , class Derived >
Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::StructuredDataCollectorInterface ( GridView const &  gridView)
inline

Member Function Documentation

◆ asDerived() [1/2]

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

◆ asDerived() [2/2]

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

◆ cellData()

std::vector< T > Dune::Vtk::DataCollectorInterface< GridView , Derived, 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< GridView , D, P >::cellDataImpl ( VtkFunction const &  fct) const
inherited

◆ comm()

auto Dune::Vtk::DataCollectorInterface< GridView , Derived, Partitions::InteriorBorder >::comm ( ) const
inlineinherited

◆ coordinates()

template<class GridView , class Derived >
template<class T >
std::array< std::vector< T >, 3 > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::coordinates ( ) const
inline

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

Interface for RectilinearGrid

◆ coordinatesImpl()

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

◆ extent()

template<class GridView , class Derived >
std::array< int, 6 > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::extent ( ) const
inline

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

◆ ghostLevel()

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

Return the number of ghost elements.

◆ ghostLevelImpl()

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

◆ gridView()

GridView const & Dune::Vtk::DataCollectorInterface< GridView , Derived, Partitions::InteriorBorder >::gridView ( ) const
inlineinherited

Return the bound grid view.

◆ numCells()

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

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

◆ numCellsImpl()

template<class GridView , class Derived >
std::uint64_t Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::numCellsImpl ( ) const
inline

Return number of grid cells.

◆ numPoints()

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

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

◆ numPointsImpl()

template<class GridView , class Derived >
std::uint64_t Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::numPointsImpl ( ) const
inline

Return number of grid vertices.

◆ origin()

template<class GridView , class Derived >
FieldVector< ctype, 3 > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::origin ( ) const
inline

Lower left corner of the grid.

Interface for ImageData:

◆ originImpl()

template<class GridView , class Derived >
FieldVector< ctype, 3 > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::originImpl ( ) const
inline

◆ pointData()

std::vector< T > Dune::Vtk::DataCollectorInterface< GridView , Derived, 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()

template<class GridView , class Derived >
template<class T , class GlobalFunction >
std::vector< T > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::pointDataImpl ( GlobalFunction const &  fct) const
inline

◆ points()

std::vector< T > Dune::Vtk::DataCollectorInterface< GridView , Derived, 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()

template<class GridView , class Derived >
template<class T >
std::vector< T > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::pointsImpl ( ) const
inline

◆ spacing()

template<class GridView , class Derived >
FieldVector< ctype, 3 > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::spacing ( ) const
inline

Constant grid spacing in each coordinate direction.

◆ spacingImpl()

template<class GridView , class Derived >
FieldVector< ctype, 3 > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::spacingImpl ( ) const
inline

◆ update()

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

Update the DataCollector on the current GridView.

◆ updateImpl()

template<class GridView , class Derived >
void Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::updateImpl ( )
inline

\copyref DefaultDataCollector::update.

◆ wholeExtent()

template<class GridView , class Derived >
std::array< int, 6 > Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::wholeExtent ( ) const
inline

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

◆ writeLocalPiece()

template<class GridView , class Derived >
template<class Writer >
void Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::writeLocalPiece ( Writer const &  writer) const
inline

Call the writer with extent.

◆ writeLocalPieceImpl()

template<class GridView , class Derived >
template<class Writer >
void Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::writeLocalPieceImpl ( Writer const &  writer) const
inline

◆ writePieces()

template<class GridView , class Derived >
template<class Writer >
void Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::writePieces ( Writer const &  writer) const
inline

Call the writer with piece number and piece extent.

◆ writePiecesImpl()

template<class GridView , class Derived >
template<class Writer >
void Dune::Vtk::StructuredDataCollectorInterface< GridView, Derived >::writePiecesImpl ( Writer const &  writer) const
inline

Member Data Documentation

◆ partition

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

The partitionset to collect data from.

The documentation for this class was generated from the following file:
Legal Statements / Impressum   |  Hosted by TU Dresden & Uni Heidelberg  |  Generated by   doxygen 1.9.8