BaseVTKWriter< H > Class Template Reference

#include <BaseVTKWriter.h>

Public Member Functions
	BaseVTKWriter (H &handler)
	BaseVTKWriter (const BaseVTKWriter &other)
virtual void	writeVTK () const =0
unsigned	getFileCounter () const
void	setFileCounter (unsigned fileCounter)

Protected Member Functions
std::fstream	makeVTKFileWithHeader () const
void	writeVTKFooterAndClose (std::fstream &file) const

Protected Attributes
H &	handler_
	particle handler from which the particles should be written More...
unsigned int	fileCounter

Detailed Description

template<typename H>
class BaseVTKWriter< H >

Template Parameters

H	some handler, e.g. particleHandler

Constructor & Destructor Documentation

BaseVTKWriter() [1/2]

template<typename H >

BaseVTKWriter< H >::BaseVTKWriter ( H &  handler )

inline

                              : handler_(handler)
    {
        fileCounter = 0;
    }

References BaseVTKWriter< H >::fileCounter.

BaseVTKWriter() [2/2]

template<typename H >

BaseVTKWriter< H >::BaseVTKWriter ( const BaseVTKWriter< H > &  other )

inline

                                              : handler_(other.handler_)
    {
        fileCounter = other.fileCounter;
    }

References BaseVTKWriter< H >::fileCounter.

Member Function Documentation

getFileCounter()

template<typename H >

unsigned BaseVTKWriter< H >::getFileCounter ( ) const

inline

    {
        return fileCounter;
    }

References BaseVTKWriter< H >::fileCounter.

Referenced by DPMBase::write(), and DPMBase::writeVTKFiles().

makeVTKFileWithHeader()

template<typename T >

std::fstream BaseVTKWriter< T >::makeVTKFileWithHeader

protected

Todo:

vtw wall files only need to be written by one processor

{
    //extract the word "Wall" or "Particle" from the VTK writer name
    std::string name = handler_.getName();
    name = name.substr(0, name.length() - 7);
 
    //determine name of output file
    std::string fileName;
#ifdef MERCURYDPM_USE_MPI
    if (NUMBER_OF_PROCESSORS > 1 && name != "Wall")
    {
        fileName = handler_.getDPMBase()->getName() + "Processor_" + std::to_string(PROCESSOR_ID) +
        '_' + name + '_' + std::to_string(fileCounter++)  + ".vtu";
    }
    else
    {
        fileName = handler_.getDPMBase()->getName() +
                                 name + '_' +
                                 std::to_string(fileCounter++) + ".vtu";
    }
#else
    fileName = handler_.getDPMBase()->getName() +
               name + '_' +
               std::to_string(fileCounter++) + ".vtu";
#endif
 
    //open output file
    std::fstream file;
    file.open(fileName.c_str(), std::ios_base::out);
    if (file.fail())
    {
        logger(WARN, "File % could not be opened", fileName);
    }
 
    // write output file header
    file << "<?xml version=\"1.0\"?>\n";
    file << "<!-- time " << handler_.getDPMBase()->getTime() << "-->\n";
    file << "<VTKFile type=\"UnstructuredGrid\" version=\"0.1\" byte_order=\"LittleEndian\">\n";
    file << "<UnstructuredGrid>\n";
    return file;
}

References logger, units::name, NUMBER_OF_PROCESSORS, PROCESSOR_ID, and WARN.

setFileCounter()

template<typename H >

void BaseVTKWriter< H >::setFileCounter ( unsigned  fileCounter )

inline

    {
        this->fileCounter = fileCounter;
    }

References BaseVTKWriter< H >::fileCounter.

Referenced by DPMBase::read(), and DPMBase::resetFileCounter().

writeVTK()

template<typename H >

virtual void BaseVTKWriter< H >::writeVTK ( ) const

pure virtual

Implemented in WallVTKWriter, WallDetailsVTKWriter, SuperQuadricParticleVtkWriter, SphericalParticleVtkWriter, InteractionVTKWriter, and BoundaryVTKWriter.

Referenced by DPMBase::writeVTKFiles().

writeVTKFooterAndClose()

template<typename T >

void BaseVTKWriter< T >::writeVTKFooterAndClose ( std::fstream &  file ) const

protected

{
    // write output file footer
    file << "<Cells>\n";
    file << "  <DataArray type=\"Int32\" Name=\"connectivity\" format=\"ascii\">\n";
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"Int32\" Name=\"offsets\" format=\"ascii\">\n";
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"UInt8\"  Name=\"types\" format=\"ascii\">\n";
    file << "  </DataArray>\n";
    file << "</Cells>\n";
    file << "</Piece>\n";
    file << "</UnstructuredGrid>\n";
    file << "</VTKFile>\n";
    // close output file
    file.close();
}

Member Data Documentation

fileCounter

template<typename H >

unsigned int BaseVTKWriter< H >::fileCounter

mutableprotected

Referenced by BaseVTKWriter< H >::BaseVTKWriter(), BaseVTKWriter< H >::getFileCounter(), and BaseVTKWriter< H >::setFileCounter().

handler_

template<typename H >

H& BaseVTKWriter< H >::handler_

protected

particle handler from which the particles should be written

---

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

• BaseVTKWriter.h