ParticleVtkWriter.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
#ifndef MERCURYDPM_VTKWRITER_H
#define MERCURYDPM_VTKWRITER_H
 
#include "VTKWriter/BaseVTKWriter.h"
#include "ParticleHandler.h"
 
class ParticleVtkWriter : public BaseVTKWriter<ParticleHandler>
{
 
public:
    
    explicit ParticleVtkWriter(ParticleHandler& particleHandler) : BaseVTKWriter(particleHandler)
    {}
    
    virtual ~ParticleVtkWriter() = default;
    
    virtual std::string getName() const = 0;
 
protected:
 
    void writeExtraFields(std::fstream& file) const;
 
    void writeVTKIndSpecies(std::fstream& file) const;
    
    void writeVTKPositions(std::fstream& file) const;
    
    bool particleMustBeWritten(BaseParticle* particle) const
    {
        return !(particle->isMPIParticle() || particle->isPeriodicGhostParticle());
    }
};
 
 
#endif //MERCURYDPM_VTKWRITER_H