Implementation of the Dune::Fem::IOInterface. This class manages data output. Available output formats are GRAPE, VTK and VTK Vertex projected using the VtxProjection operator. Details can be found in DiscFuncIO.
More...
#include <dune/fem/io/file/dataoutput.hh>
|
| DataOutput (const GridType &grid, OutPutDataType &data, std::unique_ptr< const DataOutputParameters > parameters) |
| Constructor creating data output class.
|
|
| DataOutput (const GridType &grid, OutPutDataType &data, const DataOutputParameters ¶meter) |
| Constructor creating data output class.
|
|
| DataOutput (const GridType &grid, OutPutDataType &data, const ParameterReader ¶meter=Parameter::container()) |
|
| DataOutput (const GridType &grid, OutPutDataType &data, const TimeProviderBase &tp, std::unique_ptr< const DataOutputParameters > parameters) |
| Constructor creating data writer.
|
|
| DataOutput (const GridType &grid, OutPutDataType &data, const TimeProviderBase &tp, const DataOutputParameters ¶meter) |
| Constructor creating data writer.
|
|
| DataOutput (const GridType &grid, OutPutDataType &data, const TimeProviderBase &tp, const ParameterReader ¶meter=Parameter::container()) |
|
void | consistentSaveStep (const TimeProviderBase &tp) const |
|
virtual bool | willWrite (const TimeProviderBase &tp) const |
| returns true if data will be written on next write call
|
|
virtual bool | willWrite () const |
| returns true if data will be written on next write call
|
|
void | write (const std::string &outstring) const |
| write given data to disc, evaluates parameter savecount
|
|
void | write () const |
| write given data to disc, evaluates parameter savecount
|
|
void | write (const TimeProviderBase &tp, const std::string &outstring) const |
| write given data to disc, evaluates parameter savecount and savestep
|
|
void | write (const TimeProviderBase &tp) const |
| write given data to disc, evaluates parameter savecount and savestep
|
|
void | writeData (double sequenceStamp, const std::string &outstring) const |
| write data with a given sequence stamp and outstring
|
|
void | writeData (double sequenceStamp) const |
| write data with a given sequence stamp
|
|
virtual const char * | myClassName () const |
| print class name
|
|
const std::string & | path () const |
| return output path name
|
|
int | writeStep () const |
| return write step
|
|
int | writeCalls () const |
| return write calls
|
|
double | saveTime () const |
| return save time
|
|
|
static std::string | defaultGridKey (int dimension, bool check=true) |
| return FEM key for macro grid reading
|
|
static std::string | defaultGridKey (int dimension, const ParameterReader ¶meter, bool check=true) |
|
static std::string | defaultGridKey (std::string base, int dimension, bool check=true) |
|
static std::string | defaultGridKey (std::string base, int dimension, const ParameterReader ¶meter, bool check=true) |
| return FEM key for macro grid reading
|
|
static void | createPath (const std::string &path) |
| create given path in combination with rank
|
|
template<class CommunicatorType > |
static std::string | createPath (const CommunicatorType &comm, const std::string &pathPrefix, const std::string &dataPrefix, const int step, const bool alsoCreateRankPath=true) |
|
static std::string | createPathName (const std::string &pathPref, int rank) |
| create given path in combination with rank
|
|
static std::string | readPath () |
|
template<class CommunicatorType > |
static void | createGlobalPath (const CommunicatorType &comm, const std::string &path) |
| create global path for data output
|
|
static std::string | copyPathToFilename (const std::string &path) |
|
static std::string | createRecoverPath (const std::string &pathPrefix, const int rank, const std::string &dataPrefix, const int step, const bool alsoUseRankPath=true) |
|
template<class GridImp > |
static void | writeMacroGrid (const GridImp &grid, std::ostream &out, const std::string ¯oname, const std::string &path, const std::string &prefix, const bool writeSubFiles=false) |
| if grid is structured grid, write macro file
|
|
template<class GridImp > |
static void | copyMacroGrid (const GridImp &g, const std::string ¯oGrid, const std::string &orgPath, const std::string &destPath, const std::string &prefix) |
| if grid is structured grid, write macro file
|
|
|
static std::string | strRank (const int rank) |
| create string containing rank
|
|
template<class GridImp > |
static void | saveCartesianGrid (const GridImp &grid, std::ostream &out, dgf::IntervalBlock &intervalBlock, std::string filename, const bool writeSubFiles) |
| write my partition as macro grid
|
|
template<int dimension> |
static void | writeToStream (std::ostream &file, const FieldVector< double, dimension > &origin, const FieldVector< double, dimension > &lang, const FieldVector< int, dimension > &anz) |
|
template<int dimension> |
static void | writeStructuredGrid (const std::string &filename, std::ostream &out, const FieldVector< double, dimension > &origin, const FieldVector< double, dimension > &lang, const FieldVector< int, dimension > &anz) |
| write structured grid as DGF file
|
|
template<class GridImp, class DataImp>
class Dune::Fem::DataOutput< GridImp, DataImp >
Implementation of the Dune::Fem::IOInterface. This class manages data output. Available output formats are GRAPE, VTK and VTK Vertex projected using the VtxProjection operator. Details can be found in DiscFuncIO.
◆ GridType
template<class GridImp , class DataImp >
◆ OutPutDataType
template<class GridImp , class DataImp >
◆ OutputFormat
template<class GridImp , class DataImp >
Enumerator |
---|
vtk | |
vtkvtx | |
subvtk | |
binary | |
gnuplot | |
none | |
◆ DataOutput() [1/6]
template<class GridImp , class DataImp >
Constructor creating data output class.
- Parameters
-
grid | corresponding grid |
data | Tuple containing discrete functions to write |
parameters | structure for tuning the behavior of the Dune::DataOutput defaults to Dune::DataOutputParameters |
◆ DataOutput() [2/6]
template<class GridImp , class DataImp >
Constructor creating data output class.
- Parameters
-
grid | corresponding grid |
data | Tuple containing discrete functions to write |
parameter | structure for tuning the behavior of the Dune::DataOutput defaults to Dune::DataOutputParameters |
◆ DataOutput() [3/6]
template<class GridImp , class DataImp >
◆ DataOutput() [4/6]
template<class GridImp , class DataImp >
Constructor creating data writer.
- Parameters
-
grid | corresponding grid |
data | Tuple containing discrete functions to write |
tp | a time provider to set time (e.g. for restart) |
parameters | structure for tuning the behavior of the Dune::DataOutput defaults to Dune::DataOutputParameters |
◆ DataOutput() [5/6]
template<class GridImp , class DataImp >
Constructor creating data writer.
- Parameters
-
grid | corresponding grid |
data | Tuple containing discrete functions to write |
tp | a time provider to set time (e.g. for restart) |
parameter | structure for tuning the behavior of the Dune::DataOutput defaults to Dune::DataOutputParameters |
◆ DataOutput() [6/6]
template<class GridImp , class DataImp >
◆ consistentSaveStep()
template<class GridImp , class DataImp >
◆ copyMacroGrid()
template<class GridImp >
static void Dune::Fem::IOInterface::copyMacroGrid |
( |
const GridImp & |
g, |
|
|
const std::string & |
macroGrid, |
|
|
const std::string & |
orgPath, |
|
|
const std::string & |
destPath, |
|
|
const std::string & |
prefix |
|
) |
| |
|
inlinestaticinherited |
if grid is structured grid, write macro file
◆ copyPathToFilename()
static std::string Dune::Fem::IOInterface::copyPathToFilename |
( |
const std::string & |
path | ) |
|
|
inlinestaticinherited |
◆ createGlobalPath()
template<class CommunicatorType >
static void Dune::Fem::IOInterface::createGlobalPath |
( |
const CommunicatorType & |
comm, |
|
|
const std::string & |
path |
|
) |
| |
|
inlinestaticinherited |
create global path for data output
◆ createPath() [1/2]
template<class CommunicatorType >
static std::string Dune::Fem::IOInterface::createPath |
( |
const CommunicatorType & |
comm, |
|
|
const std::string & |
pathPrefix, |
|
|
const std::string & |
dataPrefix, |
|
|
const int |
step, |
|
|
const bool |
alsoCreateRankPath = true |
|
) |
| |
|
inlinestaticinherited |
◆ createPath() [2/2]
static void Dune::Fem::IOInterface::createPath |
( |
const std::string & |
path | ) |
|
|
inlinestaticinherited |
create given path in combination with rank
◆ createPathName()
static std::string Dune::Fem::IOInterface::createPathName |
( |
const std::string & |
pathPref, |
|
|
int |
rank |
|
) |
| |
|
inlinestaticinherited |
create given path in combination with rank
◆ createRecoverPath()
static std::string Dune::Fem::IOInterface::createRecoverPath |
( |
const std::string & |
pathPrefix, |
|
|
const int |
rank, |
|
|
const std::string & |
dataPrefix, |
|
|
const int |
step, |
|
|
const bool |
alsoUseRankPath = true |
|
) |
| |
|
inlinestaticinherited |
◆ defaultGridKey() [1/4]
static std::string Dune::Fem::IOInterface::defaultGridKey |
( |
int |
dimension, |
|
|
bool |
check = true |
|
) |
| |
|
inlinestaticinherited |
return FEM key for macro grid reading
◆ defaultGridKey() [2/4]
static std::string Dune::Fem::IOInterface::defaultGridKey |
( |
int |
dimension, |
|
|
const ParameterReader & |
parameter, |
|
|
bool |
check = true |
|
) |
| |
|
inlinestaticinherited |
◆ defaultGridKey() [3/4]
static std::string Dune::Fem::IOInterface::defaultGridKey |
( |
std::string |
base, |
|
|
int |
dimension, |
|
|
bool |
check = true |
|
) |
| |
|
inlinestaticinherited |
◆ defaultGridKey() [4/4]
static std::string Dune::Fem::IOInterface::defaultGridKey |
( |
std::string |
base, |
|
|
int |
dimension, |
|
|
const ParameterReader & |
parameter, |
|
|
bool |
check = true |
|
) |
| |
|
inlinestaticinherited |
return FEM key for macro grid reading
◆ display()
template<class GridImp , class DataImp >
◆ getGridPart() [1/3]
template<class GridImp , class DataImp >
◆ getGridPart() [2/3]
template<class GridImp , class DataImp >
auto Dune::Fem::DataOutput< GridImp, DataImp >::getGridPart |
( |
std::integral_constant< bool, false > |
| ) |
const |
|
inlineprotected |
◆ getGridPart() [3/3]
template<class GridImp , class DataImp >
auto Dune::Fem::DataOutput< GridImp, DataImp >::getGridPart |
( |
std::integral_constant< bool, true > |
| ) |
const |
|
inlineprotected |
◆ grapeDisplay()
template<class GridImp , class DataImp >
template<class OutputTupleType >
◆ myClassName()
template<class GridImp , class DataImp >
◆ path()
template<class GridImp , class DataImp >
◆ readPath()
static std::string Dune::Fem::IOInterface::readPath |
( |
| ) |
|
|
inlinestaticinherited |
standard path reading and creation method rank is added to output path
◆ saveCartesianGrid()
template<class GridImp >
static void Dune::Fem::IOInterface::saveCartesianGrid |
( |
const GridImp & |
grid, |
|
|
std::ostream & |
out, |
|
|
dgf::IntervalBlock & |
intervalBlock, |
|
|
std::string |
filename, |
|
|
const bool |
writeSubFiles |
|
) |
| |
|
inlinestaticprotectedinherited |
write my partition as macro grid
◆ saveTime()
template<class GridImp , class DataImp >
◆ strRank()
static std::string Dune::Fem::IOInterface::strRank |
( |
const int |
rank | ) |
|
|
inlinestaticprotectedinherited |
create string containing rank
◆ willWrite() [1/2]
template<class GridImp , class DataImp >
returns true if data will be written on next write call
◆ willWrite() [2/2]
template<class GridImp , class DataImp >
◆ write() [1/4]
template<class GridImp , class DataImp >
◆ write() [2/4]
template<class GridImp , class DataImp >
write given data to disc, evaluates parameter savecount
- Parameters
-
outstring | pass additional string for naming |
◆ write() [3/4]
template<class GridImp , class DataImp >
write given data to disc, evaluates parameter savecount and savestep
- Parameters
-
tp | time provider for time and step |
Implements Dune::Fem::IOInterface.
◆ write() [4/4]
template<class GridImp , class DataImp >
write given data to disc, evaluates parameter savecount and savestep
- Parameters
-
tp | time provider for time and step |
outstring | pass additional string for naming |
◆ writeBinaryData()
template<class GridImp , class DataImp >
◆ writeCalls()
template<class GridImp , class DataImp >
◆ writeData() [1/2]
template<class GridImp , class DataImp >
write data with a given sequence stamp
- Parameters
-
sequenceStamp | stamp for the data set |
Implements Dune::Fem::IOInterface.
◆ writeData() [2/2]
template<class GridImp , class DataImp >
void Dune::Fem::DataOutput< GridImp, DataImp >::writeData |
( |
double |
sequenceStamp, |
|
|
const std::string & |
outstring |
|
) |
| const |
|
inline |
write data with a given sequence stamp and outstring
- Parameters
-
sequenceStamp | stamp for the data set |
outstring | pass additional string for naming |
◆ writeGnuPlotOutput()
template<class GridImp , class DataImp >
◆ writeMacroGrid()
template<class GridImp >
static void Dune::Fem::IOInterface::writeMacroGrid |
( |
const GridImp & |
grid, |
|
|
std::ostream & |
out, |
|
|
const std::string & |
macroname, |
|
|
const std::string & |
path, |
|
|
const std::string & |
prefix, |
|
|
const bool |
writeSubFiles = false |
|
) |
| |
|
inlinestaticinherited |
if grid is structured grid, write macro file
◆ writeStep()
template<class GridImp , class DataImp >
◆ writeStructuredGrid()
template<int dimension>
static void Dune::Fem::IOInterface::writeStructuredGrid |
( |
const std::string & |
filename, |
|
|
std::ostream & |
out, |
|
|
const FieldVector< double, dimension > & |
origin, |
|
|
const FieldVector< double, dimension > & |
lang, |
|
|
const FieldVector< int, dimension > & |
anz |
|
) |
| |
|
inlinestaticprotectedinherited |
write structured grid as DGF file
◆ writeToStream()
template<int dimension>
static void Dune::Fem::IOInterface::writeToStream |
( |
std::ostream & |
file, |
|
|
const FieldVector< double, dimension > & |
origin, |
|
|
const FieldVector< double, dimension > & |
lang, |
|
|
const FieldVector< int, dimension > & |
anz |
|
) |
| |
|
inlinestaticprotectedinherited |
◆ conformingOutput_
template<class GridImp , class DataImp >
◆ data_
template<class GridImp , class DataImp >
◆ datapref_
template<class GridImp , class DataImp >
◆ grapeDisplay_
template<class GridImp , class DataImp >
◆ grid_
template<class GridImp , class DataImp >
◆ outputFormat_
template<class GridImp , class DataImp >
◆ param_
template<class GridImp , class DataImp >
◆ path_
template<class GridImp , class DataImp >
◆ pvd_
template<class GridImp , class DataImp >
◆ saveCount_
template<class GridImp , class DataImp >
◆ saveStep_
template<class GridImp , class DataImp >
◆ saveTime_
template<class GridImp , class DataImp >
◆ sequence_
template<class GridImp , class DataImp >
◆ writeCalls_
template<class GridImp , class DataImp >
◆ writeStep_
template<class GridImp , class DataImp >
The documentation for this class was generated from the following file: