Dune Core Modules (2.4.2)

Dune::SubsamplingVTKWriter< GridView > Class Template Reference

Writer for the output of subsampled grid functions in the vtk format. More...

#include <dune/grid/io/file/vtk/subsamplingvtkwriter.hh>

Public Member Functions

 SubsamplingVTKWriter (const GridView &gridView, int level_, bool coerceToSimplex_=false)
 Construct a SubsamplingVTKWriter working on a specific GridView. More...
 
void addVertexData (VTKFunction *p) DUNE_DEPRECATED_MSG("Don't pass raw pointers
 Add a grid function that lives on the vertices of the grid to the visualization. More...
 
void addVertexData (const VTKFunctionPtr &p)
 Add a grid function that lives on the vertices of the grid to the visualization. More...
 
template<class V >
void addVertexData (const V &v, const std::string &name, int ncomps=1)
 Add a grid function (represented by container) that lives on the vertices of the grid to the visualization output. More...
 
void addCellData (const VTKFunctionPtr &p)
 Add a grid function that lives on the cells of the grid to the visualization. More...
 
void addCellData (VTKFunction *p) DUNE_DEPRECATED_MSG("Don't pass raw pointers
 Add a grid function that lives on the cells of the grid to the visualization. More...
 
template<class V >
void addCellData (const V &v, const std::string &name, int ncomps=1)
 Add a grid function (represented by container) that lives on the cells of the grid to the visualization. More...
 
void addCellData (const VTKFunctionPtr &p)
 Add a grid function that lives on the cells of the grid to the visualization. More...
 
void addCellData (VTKFunction *p) DUNE_DEPRECATED_MSG("Don't pass raw pointers
 Add a grid function that lives on the cells of the grid to the visualization. More...
 
void addVertexData (VTKFunction *p) DUNE_DEPRECATED_MSG("Don't pass raw pointers
 Add a grid function that lives on the vertices of the grid to the visualization. More...
 
void addVertexData (const VTKFunctionPtr &p)
 Add a grid function that lives on the vertices of the grid to the visualization. More...
 
void clear ()
 clear list of registered functions
 
std::string write (const std::string &name, VTK::OutputType type=VTK::ascii)
 write output (interface might change later) More...
 
std::string pwrite (const std::string &name, const std::string &path, const std::string &extendpath, VTK::OutputType type=VTK::ascii)
 write output (interface might change later) More...
 

Protected Member Functions

virtual void countEntities (int &nvertices, int &ncells, int &ncorners)
 count the vertices, cells and corners
 
virtual void writeCellData (VTK::VTUWriter &writer)
 write cell data
 
virtual void writeVertexData (VTK::VTUWriter &writer)
 write vertex data
 
virtual void writeGridPoints (VTK::VTUWriter &writer)
 write the positions of vertices
 
virtual void writeGridCells (VTK::VTUWriter &writer)
 write the connectivity array
 
std::string write (const std::string &name, VTK::OutputType type, const int commRank, const int commSize)
 write output (interface might change later) More...
 
std::string pwrite (const std::string &name, const std::string &path, const std::string &extendpath, VTK::OutputType ot, const int commRank, const int commSize)
 write output; interface might change later More...
 
std::string getParallelPieceName (const std::string &name, const std::string &path, int commRank, int commSize) const
 return name of a parallel piece file More...
 
std::string getParallelHeaderName (const std::string &name, const std::string &path, int commSize) const
 return name of a parallel header file More...
 
std::string getSerialPieceName (const std::string &name, const std::string &path) const
 return name of a serial piece file More...
 

Detailed Description

template<class GridView>
class Dune::SubsamplingVTKWriter< GridView >

Writer for the output of subsampled grid functions in the vtk format.

Writes arbitrary grid functions (living on cells or vertices of a grid) to a file suitable for easy visualization with The Visualization Toolkit (VTK). In contrast to the regular VTKWriter, this Writer allows subsampling of the elements via VirtualRefinement. The SubSamplingVTKWriter always writes nonconforming data.

Constructor & Destructor Documentation

◆ SubsamplingVTKWriter()

template<class GridView >
Dune::SubsamplingVTKWriter< GridView >::SubsamplingVTKWriter ( const GridView gridView,
int  level_,
bool  coerceToSimplex_ = false 
)
inlineexplicit

Construct a SubsamplingVTKWriter working on a specific GridView.

Parameters
gridViewThe gridView the grid functions live on. (E. g. a LevelGridView.)
level_The level for the subrefinement.
coerceToSimplex_Set this to true to always triangulate elements into simplices, even where it's not necessary (i.e. for hypercubes).

The datamode is always nonconforming.

References DUNE_THROW.

Member Function Documentation

◆ addCellData() [1/5]

template<class GridView >
template<class V >
void Dune::VTKWriter< GridView >::addCellData ( class V  )
inline

Add a grid function (represented by container) that lives on the cells of the grid to the visualization.

The container has to have random access via operator[] (e. g. std::vector). The value of the grid function for an arbitrary element will be accessed by calling operator[] with the index (corresponding to the index from the MGMC mapper on the grid view) of the element. For vector valued data all components for an element are assumed to be consecutive.

Parameters
vThe container with the values of the grid function for each cell.
nameA name to identify the grid function.
ncompsNumber of components (default is 1).

◆ addCellData() [2/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addCellData
inline

Add a grid function that lives on the cells of the grid to the visualization.

Parameters
pDune::shared_ptr to the function to visualize

◆ addCellData() [3/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addCellData ( const VTKFunctionPtr &  p)
inlineinherited

Add a grid function that lives on the cells of the grid to the visualization.

Parameters
pDune::shared_ptr to the function to visualize

◆ addCellData() [4/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addCellData

Add a grid function that lives on the cells of the grid to the visualization.

Parameters
pThe function to visualize. The VTKWriter object will take ownership of the VTKFunction *p and delete it when it's done.

◆ addCellData() [5/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addCellData ( VTKFunction p)
inherited

Add a grid function that lives on the cells of the grid to the visualization.

Parameters
pThe function to visualize. The VTKWriter object will take ownership of the VTKFunction *p and delete it when it's done.

◆ addVertexData() [1/5]

template<class GridView >
template<class V >
void Dune::VTKWriter< GridView >::addVertexData ( class V  )
inline

Add a grid function (represented by container) that lives on the vertices of the grid to the visualization output.

The container has to have random access via operator[] (e. g. std::vector). The value of the grid function for an arbitrary element will be accessed by calling operator[] with the index (corresponding to the index from the MGMC mapper on the grid view) of the vertex. For vector valued data all components for a vertex are assumed to be consecutive.

Parameters
vThe container with the values of the grid function for each vertex.
nameA name to identify the grid function.
ncompsNumber of components (default is 1).

◆ addVertexData() [2/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addVertexData
inline

Add a grid function that lives on the vertices of the grid to the visualization.

Parameters
pDune::shared_ptr to the function to visualize

◆ addVertexData() [3/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addVertexData ( const VTKFunctionPtr &  p)
inlineinherited

Add a grid function that lives on the vertices of the grid to the visualization.

Parameters
pDune::shared_ptr to the function to visualize

◆ addVertexData() [4/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addVertexData

Add a grid function that lives on the vertices of the grid to the visualization.

Parameters
pThe function to visualize. The VTKWriter object will take ownership of the VTKFunction *p and delete it when it's done.

◆ addVertexData() [5/5]

template<class GridView >
void Dune::VTKWriter< GridView >::addVertexData ( VTKFunction p)
inherited

Add a grid function that lives on the vertices of the grid to the visualization.

Parameters
pThe function to visualize. The VTKWriter object will take ownership of the VTKFunction *p and delete it when it's done.

◆ getParallelHeaderName()

template<class GridView >
std::string Dune::VTKWriter< GridView >::getParallelHeaderName ( const std::string &  name,
const std::string &  path,
int  commSize 
) const
inlineprotectedinherited

return name of a parallel header file

Parameters
nameBase name of the VTK output. This should be without any directory parts and without a filename extension.
pathDirectory part of the resulting header name. May be empty, in which case the resulting name will not have a directory part. If non-empty, may or may not have a trailing '/'. If a trailing slash is missing, one is appended implicitly.
commSizeNumber of processes writing a parallel vtk output.

References Dune::GridView< ViewTraits >::dimension.

Referenced by Dune::VTKWriter< GridView >::pwrite().

◆ getParallelPieceName()

template<class GridView >
std::string Dune::VTKWriter< GridView >::getParallelPieceName ( const std::string &  name,
const std::string &  path,
int  commRank,
int  commSize 
) const
inlineprotectedinherited

return name of a parallel piece file

Parameters
nameBase name of the VTK output. This should be without any directory parts and without a filename extension.
pathDirectory part of the resulting piece name. May be empty, in which case the resulting name will not have a directory part. If non-empty, may or may not have a trailing '/'. If a trailing slash is missing, one is appended implicitly.
commRankRank of the process to generate a piece name for.
commSizeNumber of processes writing a parallel vtk output.

References Dune::GridView< ViewTraits >::dimension.

Referenced by Dune::VTKWriter< GridView >::pwrite().

◆ getSerialPieceName()

template<class GridView >
std::string Dune::VTKWriter< GridView >::getSerialPieceName ( const std::string &  name,
const std::string &  path 
) const
inlineprotectedinherited

return name of a serial piece file

This is similar to getParallelPieceName, but skips the prefixes for commSize ("s####-") and commRank ("p####-").

Parameters
nameBase name of the VTK output. This should be without any directory parts and without a filename extension.
pathDirectory part of the resulting piece name. May be empty, in which case the resulting name will not have a directory part. If non-empty, may or may not have a trailing '/'. If a trailing slash is missing, one is appended implicitly.

References Dune::concatPaths(), and Dune::GridView< ViewTraits >::dimension.

Referenced by Dune::VTKWriter< GridView >::write().

◆ pwrite() [1/2]

template<class GridView >
std::string Dune::VTKWriter< GridView >::pwrite ( const std::string &  name,
const std::string &  path,
const std::string &  extendpath,
VTK::OutputType  ot,
const int  commRank,
const int  commSize 
)
inlineprotectedinherited

write output; interface might change later

Parameters
nameBase name of the output files. This should not contain any directory part and not filename extensions. It will be used both for each processes piece as well as the parallel collection file.
pathDirectory where to put the parallel collection (.pvtu/.pvtp) file. If it is relative, it is taken realtive to the current directory.
extendpathDirectory where to put the piece file (.vtu/.vtp) of this process. If it is relative, it is taken relative to the directory denoted by path.
otHow to encode the data in the file.
commRankRank of the current process.
commSizeNumber of processes taking part in this write operation.
Note
Currently, extendpath may not be absolute unless path is absolute, because that would require the value of the current directory.
Exceptions
NotImplementedExtendpath is absolute but path is relative.
IOErrorFailed to open a file.

References Dune::GridView< ViewTraits >::comm(), Dune::concatPaths(), DUNE_THROW, Dune::VTKWriter< GridView >::getParallelHeaderName(), Dune::VTKWriter< GridView >::getParallelPieceName(), and Dune::relativePath().

◆ pwrite() [2/2]

template<class GridView >
std::string Dune::VTKWriter< GridView >::pwrite ( const std::string &  name,
const std::string &  path,
const std::string &  extendpath,
VTK::OutputType  type = VTK::ascii 
)
inlineinherited

write output (interface might change later)

"pwrite" means "path write" (i.e. write somewhere else than the current directory). The "p" does not mean this method has a monopoly on parallel writing, the regular write(const std::string &, VTK::OutputType) method can do that just fine.

Parameters
nameBase name of the output files. This should not contain any directory part and not filename extensions. It will be used both for each processes piece as well as the parallel collection file.
pathDirectory where to put the parallel collection (.pvtu/.pvtp) file. If it is relative, it is taken realtive to the current directory.
extendpathDirectory where to put the piece file (.vtu/.vtp) of this process. If it is relative, it is taken relative to the directory denoted by path.
typeHow to encode the data in the file.
Note
Currently, extendpath may not be absolute unless path is absolute, because that would require the value of the current directory.
Exceptions
NotImplementedExtendpath is absolute but path is relative.
IOErrorFailed to open a file.

References Dune::GridView< ViewTraits >::comm().

Referenced by Dune::VTKWriter< GridView >::write().

◆ write() [1/2]

template<class GridView >
std::string Dune::VTKWriter< GridView >::write ( const std::string &  name,
VTK::OutputType  type,
const int  commRank,
const int  commSize 
)
inlineprotectedinherited

write output (interface might change later)

This method can be used in parallel as well as in serial programs. For serial runs (commSize=1) it chooses other names without the "s####-p####-" prefix for the .vtu/.vtp files and omits writing of the .pvtu/pvtp file however. For parallel runs (commSize > 1) it is the same as a call to pwrite() with path="" and extendpath="".

Parameters
nameBase name of the output files. This should not contain any directory part and no filename extensions.
typeHow to encode the data in the file.
commRankRank of the current process.
commSizeNumber of processes taking part in this write operation.

References DUNE_THROW, Dune::VTKWriter< GridView >::getSerialPieceName(), and Dune::VTKWriter< GridView >::pwrite().

◆ write() [2/2]

template<class GridView >
std::string Dune::VTKWriter< GridView >::write ( const std::string &  name,
VTK::OutputType  type = VTK::ascii 
)
inlineinherited

write output (interface might change later)

This method can be used in parallel as well as in serial programs. For serial runs (commSize=1) it chooses other names without the "s####-p####-" prefix for the .vtu/.vtp files and omits writing of the .pvtu/pvtp file however. For parallel runs (commSize > 1) it is the same as a call to pwrite() with path="" and extendpath="".

Parameters
[in]namebasic name to write (may not contain a path)
[in]typetype of output (e.g,, ASCII) (optional)

References Dune::GridView< ViewTraits >::comm().


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 18, 22:30, 2024)