Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
SingleTraceOutputModifier.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 SINGLETRACEOUTPUTMODIFIER_HPP_
37#define SINGLETRACEOUTPUTMODIFIER_HPP_
38
40#include <boost/serialization/base_object.hpp>
41
42#include "AbstractOutputModifier.hpp"
43#include "OutputFileHandler.hpp"
44
55{
56private:
65 unsigned mGlobalIndex;
66 unsigned mLocalIndex;
67 out_stream mFileStream;
69 friend class TestOutputModifiers;
70
77 template<class Archive>
78 void serialize(Archive & archive, const unsigned int version)
79 {
80 // This calls serialize on the base class.
81 archive & boost::serialization::base_object<AbstractOutputModifier>(*this);
82 archive & mGlobalIndex;
83 // This one would need re-calculating, so we don't archive it... archive & mLocalIndex;
84 }
85
88 : mLocalIndex(UINT_MAX),
89 mFileStream(NULL)
90 {}
91
92public:
109 SingleTraceOutputModifier(const std::string& rFilename, unsigned globalIndex, double flushTime=0.0)
110 : AbstractOutputModifier(rFilename, flushTime),
111 mGlobalIndex(globalIndex),
112 mLocalIndex(UINT_MAX),
113 mFileStream(NULL)
114 {
115 }
116
125 virtual void InitialiseAtStart(DistributedVectorFactory* pVectorFactory, const std::vector<unsigned>& rNodePermutation);
126
130 virtual void FinaliseAtEnd();
131
138 virtual void ProcessSolutionAtTimeStep(double time, Vec solution, unsigned problemDim);
139};
140
143
144#endif // SINGLETRACEOUTPUTMODIFIER_HPP_
gcov doesn't like this file...
#define CHASTE_CLASS_EXPORT(T)
void serialize(Archive &archive, const unsigned int version)
virtual void InitialiseAtStart(DistributedVectorFactory *pVectorFactory, const std::vector< unsigned > &rNodePermutation)
friend class boost::serialization::access
SingleTraceOutputModifier(const std::string &rFilename, unsigned globalIndex, double flushTime=0.0)
virtual void ProcessSolutionAtTimeStep(double time, Vec solution, unsigned problemDim)