Dune Core Modules (unstable)

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 More...
 
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 More...
 
template<class BoundaryData >
void write (std::ostream &gridout, BoundaryData &&boundaryData, const std::stringstream &addParams=std::stringstream()) const
 write the GridView to a file More...
 
void write (std::ostream &gridout, const std::vector< Index > &newElemOrder, const std::stringstream &addParams=std::stringstream()) const
 write the GridView into a std::ostream More...
 
void write (std::ostream &gridout, const std::stringstream &addParams=std::stringstream()) const
 write the GridView into a std::ostream More...
 
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 More...
 

Static Public Attributes

static const int dimGrid = GridView::dimension
 dimension of the grid
 

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
GVGridView to write in DGF format

Constructor & Destructor Documentation

◆ DGFWriter()

template<class GV >
Dune::DGFWriter< GV >::DGFWriter ( const GridView gridView)
inline

constructor

Parameters
[in]gridViewgrid view to operate on

Member Function Documentation

◆ 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]fileNamename of the write to write the grid to
[in]argsarguments for the write method with istream

References Dune::DGFWriter< GV >::write().

◆ 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
gridoutstd::ostream to write the grid to
[in]boundaryDatacallable attaching boundary data to each intersection
[in]addParamsadditional 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
gridoutstd::ostream to write the grid to
[in]addParamsadditional data to write to dgf file, such as projections, etc. (defaults to an empty data stream)

References Dune::DGFWriter< GV >::write().

◆ 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
gridoutstd::ostream to write the grid to
[in]newElemOrdervector providing a new ordering for the elements in the given GridView
[in]boundaryDatacallable attaching boundary data to each intersection
[in]addParamsadditional data to write to dgf file, such as projections etc. (defaults to an empty data stream)

Referenced by Dune::DGFWriter< GV >::write().

◆ 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
gridoutstd::ostream to write the grid to
[in]newElemOrdervector providing a new ordering for the elements in the given GridView
[in]addParamsadditional data to write to dgf file, such as projections etc. (defaults to an empty data stream)

References Dune::DGFWriter< GV >::write().


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 (Mar 28, 23:30, 2024)