Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
CellDataItemWriter.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef CELLDATAITEMWRITER_HPP_
37#define CELLDATAITEMWRITER_HPP_
38
40#include <boost/serialization/base_object.hpp>
41#include "AbstractCellWriter.hpp"
42
54template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
55class CellDataItemWriter : public AbstractCellWriter<ELEMENT_DIM, SPACE_DIM>
56{
57private:
66 template<class Archive>
67 void serialize(Archive & archive, const unsigned int version)
68 {
69 archive & boost::serialization::base_object<AbstractCellWriter<ELEMENT_DIM, SPACE_DIM> >(*this);
70 // archive & mCellDataVariableName; not done here as need to pass to constructor so using same load methods.
71 }
72
77
78public:
79
85 CellDataItemWriter(std::string cellDataVariableName = "");
86
98 double GetCellDataForVtkOutput(CellPtr pCell, AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>* pCellPopulation);
99
115 virtual void VisitCell(CellPtr pCell, AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM>* pCellPopulation);
116
120 std::string GetCellDataVariableName() const;
121};
122
125
126namespace boost
127{
128namespace serialization
129{
133template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
134inline void save_construct_data(
135 Archive & ar, const CellDataItemWriter<ELEMENT_DIM, SPACE_DIM>* t, const unsigned int file_version)
136{
137 // Save data required to construct instance
138 const std::string variable_name = t->GetCellDataVariableName();
139 ar & variable_name;
140}
141
145template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
146inline void load_construct_data(
147 Archive & ar, CellDataItemWriter<ELEMENT_DIM, SPACE_DIM>* t, const unsigned int file_version)
148{
149 // Retrieve data from archive required to construct new instance
150 std::string variable_name;
151 ar >> variable_name;
152
153 // Invoke inplace constructor to initialise instance
154 ::new(t)CellDataItemWriter<ELEMENT_DIM, SPACE_DIM>(variable_name);
155}
156}
157} // namespace ...
158
159
160#endif /* CELLDATAITEMWRITER_HPP_ */
gcov doesn't like this file...
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
std::string GetCellDataVariableName() const
void serialize(Archive &archive, const unsigned int version)
double GetCellDataForVtkOutput(CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
virtual void VisitCell(CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
std::string mCellDataVariableName
friend class boost::serialization::access