dune-grid 2.9.0
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
Dune::VTK::NonConformingBoundaryWriter< GV > Class Template Reference

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

Inheritance diagram for Dune::VTK::NonConformingBoundaryWriter< GV >:
Inheritance graph

Public Types

typedef GV::Intersection Cell
 
typedef BoundaryIterator< GV > CellIterator
 
typedef VTK::Corner< CellCorner
 
typedef VTK::CornerIterator< CellIteratorCornerIterator
 
typedef Corner Point
 
typedef CornerIterator PointIterator
 
typedef NonConformingConnectivityWriter< CellConnectivityWriter
 
typedef GV::Communication Communication
 
typedef FunctionWriterBase< CellFunctionWriter
 

Public Member Functions

 NonConformingBoundaryWriter (const GV &gv_)
 
template<typename Func >
void addCellData (const std::shared_ptr< Func > &p, const std::string &name)
 
template<typename Func >
void addCellData (Func *p, const std::string &name)
 
template<typename Func >
void addPointData (const std::shared_ptr< Func > &p, const std::string &name)
 
template<typename Func >
void addPointData (Func *p, const std::string &name)
 
void addCellData (const std::shared_ptr< FunctionWriter > &writer)
 
void addPointData (const std::shared_ptr< FunctionWriter > &writer)
 
CellIterator beginCells () const
 
CellIterator endCells () const
 
CornerIterator beginCorners () const
 
CornerIterator endCorners () const
 
PointIterator beginPoints () const
 
PointIterator endPoints () const
 
ConnectivityWriter makeConnectivity () const
 
const Communicationcomm () const
 
void clear ()
 
void writePiece (const std::string &filename, OutputType outputType)
 
void writeCollection (const std::string name, const std::string &piecename, const std::string &piecepath)
 write header file in parallel case to stream More...
 
std::string getParallelPieceName (const std::string &name, const std::string &path, int rank) const
 return name of a parallel piece file More...
 
std::string getParallelHeaderName (const std::string &name, const std::string &path) 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...
 
std::string pwrite (const std::string &name, const std::string &path, const std::string &extendpath, OutputType outputType)
 write output; interface might change later More...
 
std::string write (const std::string &name, OutputType outputType)
 write output (interface might change later) More...
 

Static Public Attributes

static const unsigned dimCell = GV::dimension-1
 

Protected Member Functions

void writeCellFunction (VTUWriter &vtuWriter, FunctionWriter &functionWriter, unsigned ncells) const
 
void writePointFunction (VTUWriter &vtuWriter, FunctionWriter &functionWriter, unsigned npoints) const
 
void writeCornerFunction (VTUWriter &vtuWriter, FunctionWriter &functionWriter, unsigned ncorners) const
 
void writeCellData (VTUWriter &vtuWriter, unsigned ncells) const
 
void writePointData (VTUWriter &vtuWriter, unsigned npoints) const
 
void writeGrid (VTUWriter &vtuWriter, unsigned ncells, unsigned npoints, unsigned ncorners)
 
void writeAll (VTUWriter &vtuWriter, unsigned ncells, unsigned npoints, unsigned ncorners)
 

Static Protected Member Functions

static std::string getFirstScalar (const WriterList &data)
 
static std::string getFirstVector (const WriterList &data)
 

Member Typedef Documentation

◆ Cell

template<typename GV >
typedef GV::Intersection Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::Cell
inherited

◆ CellIterator

template<typename GV >
typedef BoundaryIterator<GV> Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::CellIterator
inherited

◆ Communication

template<typename GV >
typedef GV::Communication Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::Communication
inherited

◆ ConnectivityWriter

template<typename GV >
typedef NonConformingConnectivityWriter<Cell> Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::ConnectivityWriter
inherited

◆ Corner

template<typename GV >
typedef VTK::Corner<Cell> Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::Corner
inherited

◆ CornerIterator

template<typename GV >
typedef VTK::CornerIterator<CellIterator> Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::CornerIterator
inherited

◆ FunctionWriter

◆ Point

template<typename GV >
typedef Corner Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::Point
inherited

◆ PointIterator

template<typename GV >
typedef CornerIterator Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::PointIterator
inherited

Constructor & Destructor Documentation

◆ NonConformingBoundaryWriter()

template<typename GV >
Dune::VTK::NonConformingBoundaryWriter< GV >::NonConformingBoundaryWriter ( const GV &  gv_)
inline

Member Function Documentation

◆ addCellData() [1/3]

template<typename GV >
template<typename Func >
void Dune::VTK::NonConformingBoundaryWriter< GV >::addCellData ( const std::shared_ptr< Func > &  p,
const std::string &  name 
)
inline

◆ addCellData() [2/3]

template<typename GV >
void Dune::VTK::BasicWriter< IteratorFactory >::addCellData ( const std::shared_ptr< FunctionWriter > &  writer)
inline

◆ addCellData() [3/3]

template<typename GV >
template<typename Func >
void Dune::VTK::NonConformingBoundaryWriter< GV >::addCellData ( Func *  p,
const std::string &  name 
)
inline

◆ addPointData() [1/3]

template<typename GV >
template<typename Func >
void Dune::VTK::NonConformingBoundaryWriter< GV >::addPointData ( const std::shared_ptr< Func > &  p,
const std::string &  name 
)
inline

◆ addPointData() [2/3]

template<typename GV >
void Dune::VTK::BasicWriter< IteratorFactory >::addPointData ( const std::shared_ptr< FunctionWriter > &  writer)
inline

◆ addPointData() [3/3]

template<typename GV >
template<typename Func >
void Dune::VTK::NonConformingBoundaryWriter< GV >::addPointData ( Func *  p,
const std::string &  name 
)
inline

◆ beginCells()

template<typename GV >
CellIterator Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::beginCells ( ) const
inlineinherited

◆ beginCorners()

template<typename GV >
CornerIterator Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::beginCorners ( ) const
inlineinherited

◆ beginPoints()

template<typename GV >
PointIterator Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::beginPoints ( ) const
inlineinherited

◆ clear()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::clear ( )
inlineinherited

◆ comm()

template<typename GV >
const Communication & Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::comm ( ) const
inlineinherited

◆ endCells()

template<typename GV >
CellIterator Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::endCells ( ) const
inlineinherited

◆ endCorners()

template<typename GV >
CornerIterator Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::endCorners ( ) const
inlineinherited

◆ endPoints()

template<typename GV >
PointIterator Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::endPoints ( ) const
inlineinherited

◆ getFirstScalar()

static std::string Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::getFirstScalar ( const WriterList &  data)
inlinestaticprotectedinherited

◆ getFirstVector()

static std::string Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::getFirstVector ( const WriterList &  data)
inlinestaticprotectedinherited

◆ getParallelHeaderName()

std::string Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::getParallelHeaderName ( const std::string &  name,
const std::string &  path 
) const
inlineinherited

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.

◆ getParallelPieceName()

std::string Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::getParallelPieceName ( const std::string &  name,
const std::string &  path,
int  rank 
) const
inlineinherited

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.
rankRank of the process to generate a piece name for.

◆ getSerialPieceName()

std::string Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::getSerialPieceName ( const std::string &  name,
const std::string &  path 
) const
inlineinherited

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.

◆ makeConnectivity()

template<typename GV >
ConnectivityWriter Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::makeConnectivity ( ) const
inlineinherited

◆ pwrite()

std::string Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::pwrite ( const std::string &  name,
const std::string &  path,
const std::string &  extendpath,
OutputType  outputType 
)
inlineinherited

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.
outputTypeHow 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.
MPIGuardErrorAn exception was thrown during this method in one of the other processes.

◆ write()

std::string Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::write ( const std::string &  name,
OutputType  outputType 
)
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
nameBase name of the output files. This should not contain any directory part and no filename extensions.
outputTypeHow to encode the data in the file.

◆ writeAll()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writeAll ( VTUWriter vtuWriter,
unsigned  ncells,
unsigned  npoints,
unsigned  ncorners 
)
inlineprotectedinherited

◆ writeCellData()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writeCellData ( VTUWriter vtuWriter,
unsigned  ncells 
) const
inlineprotectedinherited

◆ writeCellFunction()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writeCellFunction ( VTUWriter vtuWriter,
FunctionWriter functionWriter,
unsigned  ncells 
) const
inlineprotectedinherited

◆ writeCollection()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writeCollection ( const std::string  name,
const std::string &  piecename,
const std::string &  piecepath 
)
inlineinherited

write header file in parallel case to stream

Writes a .pvtu/.pvtp file for a collection of concurrently written .vtu/.vtp files.

Parameters
nameName of file to write contents to,
piecenameBase name of the pieces. Should not contain a directory part or filename extension.
piecepathDirectory part of the pieces. Since paraview does not support absolute paths in parallel collection files, this should be a path relative to the directory the collection file resides in. A trailing '/' is optional, and an empty value "" is equivalent to the value "." except it will look nicer in the collection file.

◆ writeCornerFunction()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writeCornerFunction ( VTUWriter vtuWriter,
FunctionWriter functionWriter,
unsigned  ncorners 
) const
inlineprotectedinherited

◆ writeGrid()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writeGrid ( VTUWriter vtuWriter,
unsigned  ncells,
unsigned  npoints,
unsigned  ncorners 
)
inlineprotectedinherited

◆ writePiece()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writePiece ( const std::string &  filename,
OutputType  outputType 
)
inlineinherited

◆ writePointData()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writePointData ( VTUWriter vtuWriter,
unsigned  npoints 
) const
inlineprotectedinherited

◆ writePointFunction()

void Dune::VTK::BasicWriter< NonConformingBoundaryIteratorFactory< GV > >::writePointFunction ( VTUWriter vtuWriter,
FunctionWriter functionWriter,
unsigned  npoints 
) const
inlineprotectedinherited

Member Data Documentation

◆ dimCell

template<typename GV >
const unsigned Dune::VTK::NonConformingBoundaryIteratorFactory< GV >::dimCell = GV::dimension-1
staticinherited

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