WallHandler Class Reference

Container to store all BaseWall. More...

#include <WallHandler.h>

Inheritance diagram for WallHandler:

Public Member Functions
	WallHandler ()
	Default constructor, it creates an empty WallHandler. More...
	WallHandler (const WallHandler &BH)
	Constructor that copies a pointer to the DPMBase and all BaseWall in the given WallHandler. More...
WallHandler	operator= (const WallHandler &rhs)
	Assignment operator that copies the pointer to the DPMBase and all BaseWall in the given WallHandler. More...
	~WallHandler ()
	Destructor, it destructs the WallHandler and all BaseWall it contains. More...
void	addObject (BaseWall *W)
	Adds a BaseWall to the WallHandler. More...
void	readObject (std::istream &is)
	Reads BaseWall into the WallHandler from restart data. More...
void	readOldObject (std::istream &is)
	Reads a BaseWall into the WallHandler from old-style restart data. More...
std::string	getName () const
	Returns the name of the handler, namely the string "WallHandler". More...
void	writeVTKFile (const VTKContainer vtk) const
	Writes the data collected in writeVTK into vtk files, one per timestep. More...
void	writeVTKBoundingBox () const
	Writes a bounding box around the domain into a vtk file. More...
void	writeVTK () const
	Writes all walls into a vtk format, consisting of points (edges) and cells (faces). More...
Public Member Functions inherited from BaseHandler< BaseWall >
	BaseHandler ()
	Default BaseHandler constructor, it creates an empty BaseHandler and assigns DPMBase_ to a null pointer. More...
	BaseHandler (const BaseHandler< BaseWall > &BH)
	Constructor that copies the objects of the given handler into itself and sets other variables to 0/nullptr. More...
virtual	~BaseHandler ()
	Destructor, it destructs the BaseHandler and all Object it contains. More...
void	copyContentsFromOtherHandler (const BaseHandler< BaseWall > &BH)
	Function that copies the contents (vector of pointers, maxObject_, nextId_, DPMBase_) from one handler (container) to the other. More...
std::enable_if <!std::is_pointer< U >::value, U * >::type	copyAndAddObject (const U &object)
	Creates a copy of a Object and adds it to the BaseHandler. More...
std::enable_if < std::is_pointer< U >::value, U >::type	copyAndAddObject (const U object)
	Creates a copy of a Object and adds it to the BaseHandler. More...
virtual void	removeObject (unsigned const int id)
	Removes an Object from the BaseHandler. More...
void	removeLastObject ()
	Removes the last Object from the BaseHandler. More...
void	clear ()
	Empties the whole BaseHandler by removing all Objects and setting all other variables to 0. More...
void	read (std::istream &is)
	Reads all objects from restart data. More...
BaseWall *	getObjectById (const unsigned int id)
	Gets a pointer to the Object at the specified index in the BaseHandler. More...
BaseWall *	getObject (const unsigned int id)
	Gets a pointer to the Object at the specified index in the BaseHandler. More...
const BaseWall *	getObject (const unsigned int id) const
	Gets a constant pointer to the Object at the specified index in the BaseHandler. More...
BaseWall *	getLastObject ()
	Gets a pointer to the last Object in this BaseHandler. More...
const BaseWall *	getLastObject () const
	Gets a constant pointer to the last Object in this BaseHandler. More...
unsigned int	getNumberOfObjects () const
	Gets the number of Object in this BaseHandler. More...
unsigned int	getStorageCapacity () const
	Gets the storage capacity of this BaseHandler. More...
void	setStorageCapacity (const unsigned int N)
	Sets the storage capacity of this BaseHandler. More...
const std::vector< BaseWall * > ::const_iterator	begin () const
	Gets the begin of the const_iterator over all Object in this BaseHandler. More...
const std::vector< BaseWall * > ::iterator	begin ()
	Gets the begin of the iterator over all BaseBoundary in this BaseHandler. More...
const std::vector< BaseWall * > ::const_iterator	end () const
	Gets the end of the const_iterator over all BaseBoundary in this BaseHandler. More...
const std::vector< BaseWall * > ::iterator	end ()
	Gets the end of the iterator over all BaseBoundary in this BaseHandler. More...
void	setDPMBase (DPMBase *DPMBase)
	Sets the problem that is solved using this handler. More...
void	setId (BaseWall *object, unsigned int id)
	This function sets the id and ensures that nextId is a bigger value than id. More...
DPMBase *	getDPMBase ()
	Gets the problem that is solved using this handler. More...
DPMBase *	getDPMBase () const
	Gets the problem that is solved using this handler and does not change the class. More...
virtual void	writeVTK ()
	Over written in WallHandler and ParticleHandler. More...

Additional Inherited Members
Protected Attributes inherited from BaseHandler< BaseWall >
std::vector< BaseWall * >	objects_
	The actual list of Object pointers. More...

Detailed Description

Container to store all BaseWall.

The WallHandler is a container to store all BaseWall. It is implemented by a vector of pointers to BaseWall.

Definition at line 42 of file WallHandler.h.

Constructor & Destructor Documentation

WallHandler::WallHandler

(

)

Default constructor, it creates an empty WallHandler.

Constructor of the WallHandler class. It creates an empty WallHandler.

Todo:

why is this being done?

Definition at line 42 of file WallHandler.cc.

References BaseHandler< BaseWall >::clear(), DEBUG, and logger.

{
    clear();
    logger(DEBUG, "WallHandler::WallHandler() finished");
}

WallHandler::WallHandler

(

const WallHandler &

WH

)

Constructor that copies a pointer to the DPMBase and all BaseWall in the given WallHandler.

Parameters

[in]

WH

The WallHandler that has to be copied.

This is not a copy constructor! It only copies the pointer to the DPMBase and the BaseWall in objects_, it sets the other data members to 0 or nullptr.

Todo:

why is this being done?

Definition at line 55 of file WallHandler.cc.

References BaseHandler< BaseWall >::clear(), BaseHandler< BaseWall >::copyContentsFromOtherHandler(), DEBUG, BaseHandler< T >::getDPMBase(), logger, and BaseHandler< BaseWall >::setDPMBase().

{
    clear();
    setDPMBase(WH.getDPMBase());
    copyContentsFromOtherHandler(WH);
    logger(DEBUG, "WallHandler::WallHandler(const WallHandler &WH) finished");
}

WallHandler::~WallHandler

(

)

Destructor, it destructs the WallHandler and all BaseWall it contains.

Definition at line 82 of file WallHandler.cc.

References DEBUG, and logger.

{
    logger(DEBUG, "WallHandler::~WallHandler() finished");
}

Member Function Documentation

void WallHandler::addObject ( BaseWall *  W )

virtual

Adds a BaseWall to the WallHandler.

Parameters

[in]

W

A pointer to the BaseWall (or derived class) that has to be added.

First the new BaseWall is added to the vector of BaseWall, then it is told that this is its handler.

Reimplemented from BaseHandler< BaseWall >.

Definition at line 92 of file WallHandler.cc.

References BaseHandler< T >::addObject(), BaseObject::getId(), BaseInteractable::getSpecies(), logger, BaseWall::setHandler(), and WARN.

{
    if (W->getSpecies() == nullptr)
    {
        logger(WARN, "WARNING: The wall with ID % that is added in WallHandler::addObject "
                "does not have a species yet. Please make sure that you have "
                "set the species somewhere in the driver code.", W->getId());
    }
    //Puts the wall in the Wall list
    BaseHandler<BaseWall>::addObject(W);
    //set the particleHandler pointer
    W->setHandler(this);
}

std::string WallHandler::getName ( ) const

virtual

Returns the name of the handler, namely the string "WallHandler".

Returns

The string "WallHandler".

Implements BaseHandler< BaseWall >.

Definition at line 227 of file WallHandler.cc.

{
    return "WallHandler";
}

WallHandler WallHandler::operator=

(

const WallHandler &

rhs

)

Assignment operator that copies the pointer to the DPMBase and all BaseWall in the given WallHandler.

Parameters

[in]

rhs

The WallHandler on the right hand side of the assignment.

This is not a copy assignment operator! It only copies the pointer to the DPMBase and the BaseWall in objects_, it sets the other data members to 0 or nullptr.

Definition at line 70 of file WallHandler.cc.

References BaseHandler< BaseWall >::clear(), BaseHandler< BaseWall >::copyContentsFromOtherHandler(), DEBUG, BaseHandler< T >::getDPMBase(), logger, and BaseHandler< BaseWall >::setDPMBase().

{
    if(this != &rhs)
    {
        clear();
        setDPMBase(rhs.getDPMBase());
        copyContentsFromOtherHandler(rhs);
    }
    logger(DEBUG, "WallHandler::operator = (const WallHandler& rhs) finished");
    return *this;
}

void WallHandler::readObject ( std::istream &  is )

virtual

Reads BaseWall into the WallHandler from restart data.

Parameters

[in]

is

The input stream from which the information is read.

Implements BaseHandler< BaseWall >.

Definition at line 109 of file WallHandler.cc.

References BaseHandler< BaseWall >::copyAndAddObject(), DEBUG, ERROR, BaseHandler< BaseWall >::getDPMBase(), BaseHandler< T >::getObject(), logger, readOldObject(), IntersectionOfWalls::setSpecies(), BaseWall::setSpecies(), DPMBase::speciesHandler, and WARN.

Referenced by DPMBase::read().

{
    std::string type;
    is >> type;

    logger.log(Log::DEBUG, "WallHandler::readObject(is): reading type %.", type);
    const SpeciesHandler& sH = getDPMBase()->speciesHandler;

    if (type == "CylindricalWall")
    {
        CylindricalWall wall;
        is >> wall;
        wall.setSpecies(sH.getObject(wall.getIndSpecies()));
        copyAndAddObject(wall);
    }
    else if (type == "AxisymmetricIntersectionOfWalls")
    {
        AxisymmetricIntersectionOfWalls wall;
        is >> wall;
        wall.setSpecies(sH.getObject(wall.getIndSpecies()));
        copyAndAddObject(wall);
    }
    else if (type == "IntersectionOfWalls")
    {
        IntersectionOfWalls wall;
        is >> wall;
        wall.setSpecies(sH.getObject(wall.getIndSpecies()));
        copyAndAddObject(wall);
    }
    else if (type == "InfiniteWall")
    {
        InfiniteWall wall;
        is >> wall;
        wall.setSpecies(sH.getObject(wall.getIndSpecies()));
        copyAndAddObject(wall);
    }
    else if (type == "InfiniteWallWithHole")
    {
        InfiniteWallWithHole wall;
        is >> wall;
        wall.setSpecies(sH.getObject(wall.getIndSpecies()));
        copyAndAddObject(wall);
    }
    else if (type == "Screw")
    {
        Screw wall;
        is >> wall;
        wall.setSpecies(sH.getObject(wall.getIndSpecies()));
        copyAndAddObject(wall);
    }
    else if (type == "Coil")
    {
        Coil wall;
        is >> wall;
        wall.setSpecies(sH.getObject(wall.getIndSpecies()));
        copyAndAddObject(wall);
    }
    //for backward compatibility (before svnversion ~2360)
    else if (type == "numFiniteWalls")
    {
        readOldObject(is);
    }
    else if (type == "TriolietScrew"||type == "TriolietBaseScrew"||type=="RestrictedWall") {
        logger(WARN, "Wall type: % cannot be restarted and is ignored", type);
        InfiniteWall wall;
        wall.setSpecies(sH.getObject(0));
        copyAndAddObject(wall);
    }
    else if (!getDPMBase()->readUserDefinedWall(type,is))
    {
        logger(ERROR, "Wall type: % not understood in restart file", type);
    }
}

void WallHandler::readOldObject

(

std::istream &

is

)

Reads a BaseWall into the WallHandler from old-style restart data.

First determine whether or not the wall is an infinite wall. If it is an infinite wall, read the normal and position and add the wall to the handler. If it is a finite wall, read the normal and position of each part and construct an IntersectionOfWalls from it, which can then be added to the handler.

Parameters

[in,out]

is

The input stream from which the information is read.

Definition at line 190 of file WallHandler.cc.

References IntersectionOfWalls::addObject(), BaseHandler< BaseWall >::copyAndAddObject(), BaseHandler< BaseWall >::getDPMBase(), helpers::getLineFromStringStream(), logger, InfiniteWall::set(), IntersectionOfWalls::setSpecies(), BaseWall::setSpecies(), and VERBOSE.

Referenced by readObject().

{
    //read in next line
    std::stringstream line(std::stringstream::in | std::stringstream::out);
    helpers::getLineFromStringStream(is, line);
    logger(VERBOSE, line.str());

    std::string dummy;
    unsigned int numWalls;
    Mdouble position;
    Vec3D normal;
    line >> numWalls;

    if (numWalls == 0)
    {
        InfiniteWall wall;
        wall.setSpecies(getDPMBase()->speciesHandler.getObject(0));        
        line >> dummy >> normal >> dummy >> position;
        wall.set(normal, position*normal);
        copyAndAddObject(wall);
    }
    else
    {
        IntersectionOfWalls wall;
        wall.setSpecies(getDPMBase()->speciesHandler.getObject(0));        
        for (unsigned int i = 0; i < numWalls; ++i)
        {
            line >> dummy >> normal >> dummy >> position;
            wall.addObject(normal, position*normal);
        }
        copyAndAddObject(wall);
    }
}

void WallHandler::writeVTK

(

)

const

Writes all walls into a vtk format, consisting of points (edges) and cells (faces).

Writes the VTK file for all walls: it asks every wall for its points and cells, which they will append in their output parameters. Cells are lists of point indices that will be visualised in form of triangle strips (vtk type 6).

Todo:

Check if the documentation is correct

Definition at line 239 of file WallHandler.cc.

References DEBUG, logger, VTKContainer::points, VTKContainer::triangleStrips, and writeVTKFile().

Referenced by main(), and DPMBase::writeVTK().

{
    VTKContainer vtk;
    
    //set capacity of points and cells based on the previous time step
    static unsigned int capacityPoints = 0;
    static unsigned int capacityTriangleStrips = 0;

    vtk.triangleStrips.reserve(capacityPoints);
    vtk.points.reserve(capacityTriangleStrips);
    
    //add all wall data to the point and cell arrays
    for (const auto& w: *this)
    {
        w->writeVTK(vtk);
        logger(DEBUG, "points: %, cells: ", vtk.points.size(), vtk.triangleStrips.size());
    }    

    //write
    writeVTKFile(vtk);
}

void WallHandler::writeVTKBoundingBox

(

)

const

Writes a bounding box around the domain into a vtk file.

Writes a box around all the data to a vtk file. The filename is hard-coded and depends on the DPMBase. Note that there is no static counter that makes sure new files don't have the same name as the old ones.

Todo:

Check that this should indeed be WARN

000 001 010 011 ...

Definition at line 341 of file WallHandler.cc.

References BaseHandler< BaseWall >::getDPMBase(), DPMBase::getMax(), DPMBase::getMin(), Files::getName(), INFO, logger, WARN, X, Y, and Z.

{
    const std::string fileName = getDPMBase()->getName() + "BoundingBox.vtu";
    logger(INFO, "% writing vtk file for bounding box: %",
           getDPMBase()->getTime(), fileName);
    std::fstream file;
    file.open(fileName.c_str(), std::ios::out);
    if (file.fail())
    {
        logger(WARN, "Error in writeToFile: file could not be opened");
    }
    file << "<?xml version=\"1.0\"?>\n\n";
    file << "<VTKFile type=\"UnstructuredGrid\" version=\"0.1\" byte_order=\"LittleEndian\">\n";
    file << "<UnstructuredGrid>\n";
    file << "<Piece NumberOfPoints=\"8\" NumberOfCells=\"1\">\n";
    file << "<Points>\n";
    file << "  <DataArray type=\"Float32\" Name=\"Position\" NumberOfComponents=\"3\" format=\"ascii\">\n";
    Vec3D P[2] = {getDPMBase()->getMax(), getDPMBase()->getMin()};
    for (unsigned i = 0; i < 2; i++)
    {
        for (unsigned j = 0; j < 2; j++)
        {
            for (unsigned k = 0; k < 2; k++)
            {
                Vec3D p = Vec3D(P[i].X, P[j].Y, P[k].Z);
                file << '\t' << p << '\n';
            }
        }
    }
    file << "  </DataArray>\n";
    file << "</Points>\n";
    file << "<Cells>\n";
    file <<
    "  <DataArray type=\"Int32\" Name=\"connectivity\" format=\"ascii\">\n";
    file << "\t0 1 3 2 0 4 5 1 5 7 3 7 6 2 6 4\n";
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"Int32\" Name=\"offsets\" format=\"ascii\">\n";
    file <<
    "\t16\n"; //offset into the connectivity array for the end of each cell.
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"UInt8\"  Name=\"types\" format=\"ascii\">\n";
    file << "\t4\n";
    file << "  </DataArray>\n";
    file << "</Cells>\n";
    file << "</Piece>\n";
    file << "</UnstructuredGrid>\n";
    file << "</VTKFile>\n";
    file.close();
}

void WallHandler::writeVTKFile

(

const VTKContainer

vtk

)

const

Writes the data collected in writeVTK into vtk files, one per timestep.

Writes all points ans cells to a file in the VTK format. The filename is hard-coded in this method, and is based on the name of the DPMBase and has a unique counter in it to ensure there are no two files with the same name.

Todo:

Check if this should indeed be a WARN

Definition at line 267 of file WallHandler.cc.

References BaseHandler< BaseWall >::getDPMBase(), Files::getName(), BaseHandler< BaseWall >::getNumberOfObjects(), INFO, logger, VTKContainer::points, helpers::to_string(), VTKContainer::triangleStrips, and WARN.

Referenced by writeVTK().

{
//    logger(INFO, "%, writing vtk file, points: %, cells: %",
//           getDPMBase()->getTime(), vtk.points.size(), vtk.triangleStrips.size());
    static unsigned fileCounter = 0;
    const std::string fileName = getDPMBase()->getName() + "Wall_" +
            std::to_string(fileCounter++) + ".vtu";
    logger(INFO, "writing % (t=%, N=%)", fileName, getDPMBase()->getTime(), this->getNumberOfObjects());

    std::fstream file;
    file.open(fileName.c_str(), std::ios::out);
    if (file.fail())
    {
        logger(WARN,  "Error in writeToFile: file % could not be opened", fileName);
    }
    file << "<?xml version=\"1.0\"?>\n\n";
    file << "<VTKFile type=\"UnstructuredGrid\" version=\"0.1\" byte_order=\"LittleEndian\">\n";
    file << "<UnstructuredGrid>\n";
    file << "<Piece NumberOfPoints=\"" << vtk.points.size() << "\" NumberOfCells=\"" << vtk.triangleStrips.size() << "\">\n";
    file << "<Points>\n";
    file << "  <DataArray type=\"Float32\" Name=\"Position\" NumberOfComponents=\"3\" format=\"ascii\">\n";
    for (const Vec3D& p : vtk.points)
    {
        file << '\t' << p << '\n';
    }
    file << "  </DataArray>\n";
    file << "</Points>\n";
    file << "<Cells>\n";
    file << "  <DataArray type=\"Int32\" Name=\"connectivity\" format=\"ascii\">\n";
    for (const std::vector<double>& c : vtk.triangleStrips)
    {
        file << '\t';
        for (const double& i : c)
        {
            file << i << ' ';
        }
        file << '\n';
    }
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"Int32\" Name=\"offsets\" format=\"ascii\">\n";
    unsigned count = 0;
    for (const std::vector<double>& c : vtk.triangleStrips)
    {
        count += c.size();
        file << '\t' << count << '\n';
    }
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"UInt8\"  Name=\"types\" format=\"ascii\">\n";
    for (const std::vector<double>& c : vtk.triangleStrips)
    {
        if (c.front()==c.back())
        {
            //polygon
            file << "\t7\n";
        } else
        {
            //triangle strips 
            file << "\t6\n";
        }
    }
    file << "  </DataArray>\n";
    file << "</Cells>\n";
    file << "</Piece>\n";
    file << "</UnstructuredGrid>\n";
    file << "</VTKFile>\n";
    file.close();
}

---

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

• WallHandler.h
• WallHandler.cc