MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ParticleVtkWriter.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 
27 #ifndef MERCURY_VTKWRITER_H
28 #define MERCURY_VTKWRITER_H
29 
31 #include "ParticleHandler.h"
32 
33 class ParticleVtkWriter : public BaseVTKWriter<ParticleHandler>
34 {
35 
36 public:
37 
38  explicit ParticleVtkWriter(ParticleHandler& particleHandler) : BaseVTKWriter(particleHandler)
39  {}
40 
41  virtual ~ParticleVtkWriter() = default;
42 
43  virtual std::string getName() const = 0;
44 
45 protected:
46 
47  void writeExtraFields(std::fstream& file) const;
48 
49  void writeVTKIndSpecies(std::fstream& file) const;
50 
51  void writeVTKPositions(std::fstream& file) const;
52 
53  bool particleMustBeWritten(BaseParticle* particle) const
54  {
55  return !(particle->isMPIParticle() || particle->isPeriodicGhostParticle());
56  }
57 };
58 
59 
60 #endif //MERCURY_VTKWRITER_H
void writeVTKPositions(std::fstream &file) const
virtual std::string getName() const =0
void writeVTKIndSpecies(std::fstream &file) const
bool particleMustBeWritten(BaseParticle *particle) const
ParticleVtkWriter(ParticleHandler &particleHandler)
void writeExtraFields(std::fstream &file) const
bool isPeriodicGhostParticle() const
Indicates if this particle is a ghost in the periodic boundary.
Container to store all BaseParticle.
bool isMPIParticle() const
Indicates if this particle is a ghost in the MPI domain.
virtual ~ParticleVtkWriter()=default