olb::BlockVTKwriter3D< T > Class Template Reference

BlockVTKwriter3D writes any BLockF3D to vtk-based output files. More...

#include <blockVtkWriter3D.h>

Collaboration diagram for olb::BlockVTKwriter3D< T >:

Public Member Functions
	BlockVTKwriter3D (std::string name, bool binary=true)
	~BlockVTKwriter3D ()
void	write (BlockF3D< T > &f, int iT=0)
	method calls preamble(), pointData(), data() and coresponding closing methods.
void	write (int iT=0)
	writes functors stored at pointerVec
void	addFunctor (BlockF3D< T > &f)
	put functor to _pointerVec to simplify writing process of several functors
void	clearAddedFunctors ()
	to clear stored functors

Detailed Description

template<typename T>
class olb::BlockVTKwriter3D< T >

BlockVTKwriter3D writes any BLockF3D to vtk-based output files.

One can add functors via addFunctors. To write added functors call write(int iT=0).

To write a functor without adding him, call call write(BlockF3D<T>& f, int iT).

Default output type is binary, to change it have a look on the constructor.

Definition at line 49 of file blockVtkWriter3D.h.

Constructor & Destructor Documentation

BlockVTKwriter3D()

template<typename T >

olb::BlockVTKwriter3D< T >::BlockVTKwriter3D	(	std::string	name,
		bool	binary = true )

Definition at line 43 of file blockVtkWriter3D.hh.

  : clout( std::cout,"BlockVTKwriter3D" ), _name(name), _binary(binary)
{}

~BlockVTKwriter3D()

template<typename T >

olb::BlockVTKwriter3D< T >::~BlockVTKwriter3D

(

)

Definition at line 48 of file blockVtkWriter3D.hh.

{
  clearAddedFunctors();
}

Member Function Documentation

addFunctor()

template<typename T >

void olb::BlockVTKwriter3D< T >::addFunctor

(

BlockF3D< T > &

f

)

put functor to _pointerVec to simplify writing process of several functors

Definition at line 113 of file blockVtkWriter3D.hh.

{
  _pointerVec.push_back(&f);
}

clearAddedFunctors()

template<typename T >

void olb::BlockVTKwriter3D< T >::clearAddedFunctors

(

)

to clear stored functors

Definition at line 119 of file blockVtkWriter3D.hh.

{
  _pointerVec.clear();
}

write() [1/2]

template<typename T >

void olb::BlockVTKwriter3D< T >::write	(	BlockF3D< T > &	f,
		int	iT = 0 )

method calls preamble(), pointData(), data() and coresponding closing methods.

writes given functor

Definition at line 90 of file blockVtkWriter3D.hh.

{
  T originX = 0;
  T originY = 0;
  T originZ = 0;
  int nx = f.getBlockStructure().getNx() -1;
  int ny = f.getBlockStructure().getNy() -1;
  int nz = f.getBlockStructure().getNz() -1;
 
  std::string fullNameVti = singleton::directories().getVtkOutDir()
                            + createFileName( f.getName(), iT ) + ".vti";
 
  preamble( fullNameVti, nx,ny,nz, originX,originY,originZ );
  if ( _binary ) {
    writeRawData( fullNameVti, f, nx,ny,nz );
  }
  else {
    writeRawDataBinary( fullNameVti, f, nx,ny,nz );
  }
  closePreamble( fullNameVti );
}

References olb::createFileName(), olb::singleton::directories(), olb::BlockF3D< T >::getBlockStructure(), olb::GenericF< T, S >::getName(), olb::BlockStructureD< D >::getNx(), olb::BlockStructureD< D >::getNy(), olb::BlockStructureD< D >::getNz(), and olb::singleton::Directories::getVtkOutDir().

Here is the call graph for this function:

write() [2/2]

template<typename T >

void olb::BlockVTKwriter3D< T >::write

(

int

iT = 0

)

writes functors stored at pointerVec

Definition at line 54 of file blockVtkWriter3D.hh.

{
  if ( _pointerVec.empty() ) {
    clout << "Error: Please add functor via addFunctor()";
  }
  else {
    // get first functor
    auto it = _pointerVec.cbegin();
 
    T originX = 0;
    T originY = 0;
    T originZ = 0;
    int nx = (**it).getBlockStructure().getNx() -1;
    int ny = (**it).getBlockStructure().getNy() -1;
    int nz = (**it).getBlockStructure().getNz() -1;
 
    std::string fullNameVti = singleton::directories().getVtkOutDir()
                              + createFileName( _name, iT ) + ".vti";
 
    preamble( fullNameVti, nx,ny,nz, originX,originY,originZ );
    if ( _binary ) {
      // iterate on functors
      for ( auto functor = _pointerVec.cbegin(); functor != _pointerVec.cend(); ++functor) {
        writeRawDataBinary( fullNameVti, **functor, nx, ny, nz);
      }
    }
    else {
      for ( auto functor = _pointerVec.cbegin(); functor != _pointerVec.cend(); ++functor) {
        writeRawData( fullNameVti, **functor, nx, ny, nz);
      }
    }
    closePreamble( fullNameVti );
  }
}

References olb::createFileName(), olb::singleton::directories(), and olb::singleton::Directories::getVtkOutDir().

Here is the call graph for this function:

---

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

• src/io/blockVtkWriter3D.h
• src/io/blockVtkWriter3D.hh