olb::SuperVTMwriter2D< T, OUT_T, W > Class Template Reference

SuperVTMwriter2D writes any SuperF2D to vtk-based output files. More...

#include <superVtmWriter2D.h>

Collaboration diagram for olb::SuperVTMwriter2D< T, OUT_T, W >:

Public Member Functions
	SuperVTMwriter2D (std::string name, int overlap=1, bool binary=true)
void	write (int iT=0)
	writes functors stored in pointerVec every thread writes a vti file with data from his cuboids the vti files are linked in a pvd file
void	write (SuperF2D< T, W > &f, int iT=0)
	writes functor instantaneously, same vti-pvd file structure as above
void	write (std::shared_ptr< SuperF2D< T, W > > ptr_f, int iT=0)
void	createMasterFile ()
	have to be called before calling write(int iT=0), since it creates
void	addFunctor (SuperF2D< T, W > &f)
	put functor to _pointerVec to simplify writing process of several functors
void	addFunctor (SuperF2D< T, W > &f, const std::string &functorName)
	put functor with specific name to _pointerVec to simplify writing process of several functors
void	clearAddedFunctors ()
	to clear stored functors, not yet used due to lack of necessity
std::string	getName () const
	getter for _name

Detailed Description

template<typename T, typename OUT_T = float, typename W = T>
class olb::SuperVTMwriter2D< T, OUT_T, W >

SuperVTMwriter2D writes any SuperF2D to vtk-based output files.

In .pvd files, there are only links/references to a VTKmultiblock file 'vtm'

.pvd file structur the time series is represented by different 'vtm' files.

.vtm file This file links cuboids ('vti') and represents the entire data of a single timestep.

Definition at line 51 of file superVtmWriter2D.h.

Constructor & Destructor Documentation

SuperVTMwriter2D()

template<typename T , typename OUT_T , typename W >

olb::SuperVTMwriter2D< T, OUT_T, W >::SuperVTMwriter2D	(	std::string	name,
		int	overlap = 1,
		bool	binary = true )

Definition at line 49 of file superVtmWriter2D.hh.

  : clout( std::cout,"SuperVTMwriter2D" ), _createFile(false), _name(name), _overlap(overlap), _binary(binary)
{
  static_assert(std::is_same_v<OUT_T, float> || std::is_same_v<OUT_T, double>,
              "OUT_T must be either float or double");
}

Member Function Documentation

addFunctor() [1/2]

template<typename T , typename OUT_T , typename W >

void olb::SuperVTMwriter2D< T, OUT_T, W >::addFunctor

(

SuperF2D< T, W > &

f

)

put functor to _pointerVec to simplify writing process of several functors

Definition at line 211 of file superVtmWriter2D.hh.

{
  _pointerVec.push_back(&f);
}

addFunctor() [2/2]

template<typename T , typename OUT_T , typename W >

void olb::SuperVTMwriter2D< T, OUT_T, W >::addFunctor	(	SuperF2D< T, W > &	f,
		const std::string &	functorName )

put functor with specific name to _pointerVec to simplify writing process of several functors

Definition at line 217 of file superVtmWriter2D.hh.

{
  f.getName() = functorName;
  _pointerVec.push_back(&f);
}

References olb::GenericF< T, S >::getName().

Here is the call graph for this function:

clearAddedFunctors()

template<typename T , typename OUT_T , typename W >

void olb::SuperVTMwriter2D< T, OUT_T, W >::clearAddedFunctors

(

)

to clear stored functors, not yet used due to lack of necessity

Definition at line 224 of file superVtmWriter2D.hh.

{
  _pointerVec.clear();
}

createMasterFile()

template<typename T , typename OUT_T , typename W >

void olb::SuperVTMwriter2D< T, OUT_T, W >::createMasterFile

(

)

have to be called before calling write(int iT=0), since it creates

Definition at line 195 of file superVtmWriter2D.hh.

{
  int rank = 0;
#ifdef PARALLEL_MODE_MPI
  rank = singleton::mpi().getRank();
#endif
  if ( rank == 0 ) {
    std::string fullNamePVDmaster = singleton::directories().getVtkOutDir()
                                    + createFileName( _name ) + ".pvd";
    preamblePVD(fullNamePVDmaster);
    closePVD(fullNamePVDmaster);
    _createFile = true;
  }
}

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

Here is the call graph for this function:

getName()

template<typename T , typename OUT_T , typename W >

std::string olb::SuperVTMwriter2D< T, OUT_T, W >::getName

(

)

const

getter for _name

Definition at line 230 of file superVtmWriter2D.hh.

{
  return _name;
}

write() [1/3]

template<typename T , typename OUT_T , typename W >

void olb::SuperVTMwriter2D< T, OUT_T, W >::write

(

int

iT = 0

)

writes functors stored in pointerVec every thread writes a vti file with data from his cuboids the vti files are linked in a pvd file

Definition at line 57 of file superVtmWriter2D.hh.

{
  int rank = 0;
#ifdef PARALLEL_MODE_MPI
  rank = singleton::mpi().getRank();
#endif
 
  //  !!!!!!!!!!! check whether _pointerVec is empty
  if ( _pointerVec.empty() ) {
    clout << "Error: Did you add a Functor ?";
  }
  else {
    // no gaps between vti files (cuboids)
    for (SuperF2D<T,W>* f : _pointerVec) {
      f->getSuperStructure().communicate();
    }
 
    // to get first element _pointerVec
    // problem if functors with different SuperStructure are stored
    // since till now, there is only one origin
    auto it_begin = _pointerVec.cbegin();
    if (it_begin == _pointerVec.end()) {
      throw std::runtime_error("No functor to write");
    }
    CuboidGeometry2D<T> const& cGeometry = (**it_begin).getSuperStructure().getCuboidGeometry();
    // no gaps between vti files (cuboids)
    LoadBalancer<T>& load = (**it_begin).getSuperStructure().getLoadBalancer();
 
    // PVD, owns all
    if ( rank == 0 ) {
      std::string pathPVD = singleton::directories().getVtkOutDir()
                            + createFileName( _name ) + ".pvd";
      dataPVDmaster( iT, pathPVD,  "data/" + createFileName( _name, iT ) + ".vtm" );
 
      std::string pathVTM = singleton::directories().getVtkOutDir()
                            + "data/" + createFileName( _name, iT ) + ".vtm";
      preambleVTM(pathVTM);
      for (int iC = 0; iC < cGeometry.getNc(); iC++) {
        dataVTM( iC, pathVTM, createFileName( _name, iT, iC) + ".vti" );
      }
      closeVTM(pathVTM);
    }
    // VTI, each process writes his cuboids
    int originLatticeR[3] = {int()};
    for (int iCloc = 0; iCloc < load.size(); iCloc++) {
      int nx = cGeometry.get(load.glob(iCloc)).getNx();
      int ny = cGeometry.get(load.glob(iCloc)).getNy();
      // to be changed into the following line once local refinement has been implemented
      // double deltaX = cGeometry.get(load.glob(iCloc)).getDeltaR();
      T delta = cGeometry.getMotherCuboid().getDeltaR();
 
      std::string fullNameVTI = singleton::directories().getVtkOutDir() + "data/"
                                + createFileName( _name, iT, load.glob(iCloc) ) + ".vti";
 
      // get dimension/extent for each cuboid
      originLatticeR[0] = load.glob(iCloc);
      T originPhysR[2] = {T()};
      cGeometry.getPhysR(originPhysR,originLatticeR);
 
      preambleVTI(fullNameVTI, -_overlap,-_overlap, nx+_overlap-1, ny+_overlap-1, originPhysR[0],originPhysR[1], delta);
      for (auto it : _pointerVec) {
        if (_binary) {
          dataArrayBinary(fullNameVTI, (*it), load.glob(iCloc), nx,ny);
        }
        else {
          dataArray(fullNameVTI, (*it), load.glob(iCloc), nx,ny);
        }
      }
      closePiece(fullNameVTI);
      closeVTI(fullNameVTI);
    }
  }
}

References olb::createFileName(), olb::singleton::directories(), olb::CuboidGeometry2D< T >::get(), olb::CuboidGeometry2D< T >::getMotherCuboid(), olb::CuboidGeometry2D< T >::getNc(), olb::CuboidGeometry2D< T >::getPhysR(), olb::singleton::MpiManager::getRank(), olb::singleton::Directories::getVtkOutDir(), olb::LoadBalancer< T >::glob(), olb::singleton::mpi(), and olb::LoadBalancer< T >::size().

Here is the call graph for this function:

write() [2/3]

template<typename T , typename OUT_T , typename W >

void olb::SuperVTMwriter2D< T, OUT_T, W >::write	(	std::shared_ptr< SuperF2D< T, W > >	ptr_f,
		int	iT = 0 )

Definition at line 189 of file superVtmWriter2D.hh.

{
  write(*ptr_f, iT);
}

write() [3/3]

template<typename T , typename OUT_T , typename W >

void olb::SuperVTMwriter2D< T, OUT_T, W >::write	(	SuperF2D< T, W > &	f,
		int	iT = 0 )

writes functor instantaneously, same vti-pvd file structure as above

Definition at line 132 of file superVtmWriter2D.hh.

{
  CuboidGeometry2D<T> const& cGeometry = f.getSuperStructure().getCuboidGeometry();
  LoadBalancer<T>& load = f.getSuperStructure().getLoadBalancer();
  // no gaps between vti files (cuboids)
  f.getSuperStructure().communicate();
  T delta = cGeometry.getMotherCuboid().getDeltaR();
 
  int rank = 0;
#ifdef PARALLEL_MODE_MPI
  rank = singleton::mpi().getRank();
#endif
 
  // write a pvd file, which links all vti files
  // each vti file is written by one thread, which may own severals cuboids
  if ( rank == 0 ) {
    // master only
    std::string pathVTM = singleton::directories().getVtkOutDir()
                          + createFileName( f.getName(), iT )  + ".vtm";
 
    preambleVTM(pathVTM);
    for (int iC = 0; iC < cGeometry.getNc(); iC++) {
      std::string nameVTI = "data/" + createFileName( f.getName(), iT, iC) + ".vti";
      // puts name of .vti piece to a .pvd file [fullNamePVD]
      dataVTM( iC, pathVTM, nameVTI );
    }
    closeVTM(pathVTM);
  } // master only
 
  for (int iCloc = 0; iCloc < load.size(); iCloc++) {
    // cuboid
    int nx = cGeometry.get(load.glob(iCloc)).getNx();
    int ny = cGeometry.get(load.glob(iCloc)).getNy();
    // to be changed into the following line once local refinement has been implemented
    // double deltaX = cGeometry.get(load.glob(iCloc)).getDeltaR();
 
    std::string fullNameVTI = singleton::directories().getVtkOutDir() + "data/"
                              + createFileName( f.getName(), iT, load.glob(iCloc) ) + ".vti";
 
    // get dimension/extent for each cuboid
    int const originLatticeR[3] = {load.glob(iCloc),0,0};
    T originPhysR[2] = {T()};
    cGeometry.getPhysR(originPhysR,originLatticeR);
 
    preambleVTI(fullNameVTI, -_overlap,-_overlap, nx+_overlap-1, ny+_overlap-1, originPhysR[0],originPhysR[1], delta);
    if (_binary) {
      dataArrayBinary(fullNameVTI, f, load.glob(iCloc), nx,ny);
    }
    else {
      dataArray(fullNameVTI, f, load.glob(iCloc), nx,ny);
    }
    closePiece(fullNameVTI);
    closeVTI(fullNameVTI);
  } // cuboid
}

References olb::SuperStructure< T, D >::communicate(), olb::createFileName(), olb::singleton::directories(), olb::CuboidGeometry2D< T >::get(), olb::SuperStructure< T, D >::getCuboidGeometry(), olb::SuperStructure< T, D >::getLoadBalancer(), olb::CuboidGeometry2D< T >::getMotherCuboid(), olb::GenericF< T, S >::getName(), olb::CuboidGeometry2D< T >::getNc(), olb::CuboidGeometry2D< T >::getPhysR(), olb::singleton::MpiManager::getRank(), olb::SuperF2D< T, W >::getSuperStructure(), olb::singleton::Directories::getVtkOutDir(), olb::LoadBalancer< T >::glob(), olb::singleton::mpi(), and olb::LoadBalancer< T >::size().

Here is the call graph for this function:

---

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

• src/io/superVtmWriter2D.h
• src/io/superVtmWriter2D.hh