Dune::DGFWriter< GV > Class Template Reference

write a GridView to a DGF file More...

#include <dune/grid/io/file/dgfparser/dgfwriter.hh>

Public Types
typedef GV	GridView
	type of grid view
typedef GridView::Grid	Grid
	type of underlying hierarchical grid

Public Member Functions
	DGFWriter (const GridView &gridView)
	constructor
template<class BoundaryData >
void	write (std::ostream &gridout, const std::vector< Index > &newElemOrder, BoundaryData &&boundaryData, const std::stringstream &addParams=std::stringstream()) const
	write the GridView into a std::ostream
template<class BoundaryData >
void	write (std::ostream &gridout, BoundaryData &&boundaryData, const std::stringstream &addParams=std::stringstream()) const
	write the GridView to a file
void	write (std::ostream &gridout, const std::vector< Index > &newElemOrder, const std::stringstream &addParams=std::stringstream()) const
	write the GridView into a std::ostream
void	write (std::ostream &gridout, const std::stringstream &addParams=std::stringstream()) const
	write the GridView into a std::ostream
template<class... Args>
auto	write (const std::string &fileName, Args &&... args) const -> std::void_t< decltype(this->write(std::declval< std::ostream & >(), std::declval< Args >()...)) >
	write the GridView to a file

Static Public Attributes
static const int	dimGrid = GridView::dimension
	dimension of the grid

Protected Member Functions
auto	elementsSeeds (const std::vector< Index > &newElemOrder) const -> std::vector< ElementSeed >
void	writeHeader (std::ostream &gridout) const
void	writeFooter (std::ostream &gridout) const
auto	writeVertices (std::ostream &gridout) const -> std::vector< Index >
void	writeElement (std::ostream &gridout, const std::vector< Index > &dgfIndices, const Element &element, const GeometryType &elementType) const
void	writeSimplices (std::ostream &gridout, const std::vector< Index > &dgfIndices) const
void	writeSimplices (std::ostream &gridout, const std::vector< Index > &dgfIndices, const std::vector< ElementSeed > &elementSeeds) const
void	writeCubes (std::ostream &gridout, const std::vector< Index > &dgfIndices) const
void	writeCubes (std::ostream &gridout, const std::vector< Index > &dgfIndices, const std::vector< ElementSeed > &elementSeeds) const
template<class... Args>
void	writeElements (std::ostream &gridout, const std::vector< Index > &dgfIndices, const Args &... args) const
template<class BoundaryData >
void	writeBoundaries (std::ostream &gridout, const std::vector< Index > &dgfIndices, BoundaryData &&boundaryData) const
void	writeBoundaries (std::ostream &gridout, const std::vector< Index > &dgfIndices) const

Static Protected Member Functions
static int	boundaryId (const Intersection &i)

Protected Attributes
GridView	gridView_

Detailed Description

template<class GV>
class Dune::DGFWriter< GV >

write a GridView to a DGF file

The DGFWriter allows create a DGF file from a given GridView. It allows for the easy creation of file format converters.

Template Parameters

GV	GridView to write in DGF format

Member Typedef Documentation

Grid

template<class GV >

typedef GridView::Grid Dune::DGFWriter< GV >::Grid

type of underlying hierarchical grid

GridView

template<class GV >

typedef GV Dune::DGFWriter< GV >::GridView

type of grid view

Constructor & Destructor Documentation

DGFWriter()

template<class GV >

Dune::DGFWriter< GV >::DGFWriter ( const GridView &  gridView )

inline

constructor

Parameters

[in]

gridView

grid view to operate on

Member Function Documentation

boundaryId()

template<class GV >

static int Dune::DGFWriter< GV >::boundaryId ( const Intersection &  i )

inlinestaticprotected

elementsSeeds()

template<class GV >

auto Dune::DGFWriter< GV >::elementsSeeds ( const std::vector< Index > &  newElemOrder ) const -> std::vector< ElementSeed >

inlineprotected

write() [1/5]

template<class GV >

template<class... Args>

auto Dune::DGFWriter< GV >::write ( const std::string &  fileName, Args &&...  args  ) const -> std::void_t< decltype( this->write( std::declval< std::ostream & >(), std::declval< Args >()... ) ) >

inline

write the GridView to a file

Parameters

[in]	fileName	name of the write to write the grid to
[in]	args	arguments for the write method with istream

write() [2/5]

template<class GV >

template<class BoundaryData >

void Dune::DGFWriter< GV >::write ( std::ostream &  gridout, BoundaryData &&  boundaryData, const std::stringstream &  addParams = std::stringstream()  ) const

inline

write the GridView to a file

Parameters

	gridout	std::ostream to write the grid to
[in]	boundaryData	callable attaching boundary data to each intersection
[in]	addParams	additional data to write to dgf file, such as projections, etc. (defaults to an empty data stream)

write() [3/5]

template<class GV >

void Dune::DGFWriter< GV >::write ( std::ostream &  gridout, const std::stringstream &  addParams = std::stringstream()  ) const

inline

write the GridView into a std::ostream

Parameters

	gridout	std::ostream to write the grid to
[in]	addParams	additional data to write to dgf file, such as projections, etc. (defaults to an empty data stream)

write() [4/5]

template<class GV >

template<class BoundaryData >

void Dune::DGFWriter< GV >::write ( std::ostream &  gridout, const std::vector< Index > &  newElemOrder, BoundaryData &&  boundaryData, const std::stringstream &  addParams = std::stringstream()  ) const

inline

write the GridView into a std::ostream

Parameters

	gridout	std::ostream to write the grid to
[in]	newElemOrder	vector providing a new ordering for the elements in the given GridView
[in]	boundaryData	callable attaching boundary data to each intersection
[in]	addParams	additional data to write to dgf file, such as projections etc. (defaults to an empty data stream)

write() [5/5]

template<class GV >

void Dune::DGFWriter< GV >::write ( std::ostream &  gridout, const std::vector< Index > &  newElemOrder, const std::stringstream &  addParams = std::stringstream()  ) const

inline

write the GridView into a std::ostream

Parameters

	gridout	std::ostream to write the grid to
[in]	newElemOrder	vector providing a new ordering for the elements in the given GridView
[in]	addParams	additional data to write to dgf file, such as projections etc. (defaults to an empty data stream)

writeBoundaries() [1/2]

template<class GV >

void Dune::DGFWriter< GV >::writeBoundaries ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices  ) const

inlineprotected

writeBoundaries() [2/2]

template<class GV >

template<class BoundaryData >

void Dune::DGFWriter< GV >::writeBoundaries ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices, BoundaryData &&  boundaryData  ) const

inlineprotected

writeCubes() [1/2]

template<class GV >

void Dune::DGFWriter< GV >::writeCubes ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices  ) const

inlineprotected

writeCubes() [2/2]

template<class GV >

void Dune::DGFWriter< GV >::writeCubes ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices, const std::vector< ElementSeed > &  elementSeeds  ) const

inlineprotected

writeElement()

template<class GV >

void Dune::DGFWriter< GV >::writeElement ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices, const Element &  element, const GeometryType &  elementType  ) const

inlineprotected

writeElements()

template<class GV >

template<class... Args>

void Dune::DGFWriter< GV >::writeElements ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices, const Args &...  args  ) const

inlineprotected

writeFooter()

template<class GV >

void Dune::DGFWriter< GV >::writeFooter ( std::ostream &  gridout ) const

inlineprotected

writeHeader()

template<class GV >

void Dune::DGFWriter< GV >::writeHeader ( std::ostream &  gridout ) const

inlineprotected

writeSimplices() [1/2]

template<class GV >

void Dune::DGFWriter< GV >::writeSimplices ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices  ) const

inlineprotected

writeSimplices() [2/2]

template<class GV >

void Dune::DGFWriter< GV >::writeSimplices ( std::ostream &  gridout, const std::vector< Index > &  dgfIndices, const std::vector< ElementSeed > &  elementSeeds  ) const

inlineprotected

writeVertices()

template<class GV >

auto Dune::DGFWriter< GV >::writeVertices ( std::ostream &  gridout ) const -> std::vector< Index >

inlineprotected

Member Data Documentation

dimGrid

template<class GV >

const int Dune::DGFWriter< GV >::dimGrid = GridView::dimension

static

dimension of the grid

gridView_

template<class GV >

GridView Dune::DGFWriter< GV >::gridView_

protected

---

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

• dgfwriter.hh