Chaste  Release::2017.1
AbstractCellWriter.hpp
1 /*
2 
3 Copyright (c) 2005-2017, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef ABSTRACTCELLWRITER_HPP_
37 #define ABSTRACTCELLWRITER_HPP_
38 
39 #include "ChasteSerialization.hpp"
40 #include <boost/serialization/base_object.hpp>
41 #include "AbstractCellBasedWriter.hpp"
42 #include "Cell.hpp"
43 #include "UblasVectorInclude.hpp"
44 
45 // Forward declaration prevents circular include chain
46 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM> class AbstractCellPopulation;
47 
51 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
52 class AbstractCellWriter : public AbstractCellBasedWriter<ELEMENT_DIM, SPACE_DIM>
53 {
54 private:
55 
58 
65  template<class Archive>
66  void serialize(Archive & archive, const unsigned int version)
67  {
68  archive & boost::serialization::base_object<AbstractCellBasedWriter<ELEMENT_DIM, SPACE_DIM> >(*this);
69  archive & mOutputScalarData;
70  archive & mOutputVectorData;
71  archive & mVtkCellDataName;
72  archive & mVtkVectorCellDataName;
73  }
74 
75 protected:
76 
79 
82 
84  std::string mVtkCellDataName;
85 
88 
89 public:
90 
95  AbstractCellWriter(const std::string& rFileName);
96 
108  virtual double GetCellDataForVtkOutput(CellPtr pCell, AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>* pCellPopulation);
109 
121  virtual c_vector<double, SPACE_DIM> GetVectorCellDataForVtkOutput(CellPtr pCell, AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>* pCellPopulation);
122 
132  virtual void VisitCell(CellPtr pCell, AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>* pCellPopulation)=0;
133 
139  bool GetOutputScalarData();
140 
146  bool GetOutputVectorData();
147 
156  void SetVtkCellDataName(std::string vtkCellDataName);
157 
166  void SetVtkVectorCellDataName(std::string vtkCellDataName);
167 
171  std::string GetVtkCellDataName();
172 
176  std::string GetVtkVectorCellDataName();
177 };
178 
179 #endif /*ABSTRACTCELLWRITER_HPP_*/
AbstractCellWriter(const std::string &rFileName)
virtual void VisitCell(CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)=0
void SetVtkCellDataName(std::string vtkCellDataName)
virtual double GetCellDataForVtkOutput(CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
void SetVtkVectorCellDataName(std::string vtkCellDataName)
virtual c_vector< double, SPACE_DIM > GetVectorCellDataForVtkOutput(CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
friend class boost::serialization::access
std::string mVtkVectorCellDataName
void serialize(Archive &archive, const unsigned int version)
std::string GetVtkVectorCellDataName()
std::string GetVtkCellDataName()