Chaste  Release::2018.1
SingleTraceOutputModifier.cpp
1 /*
2 
3 Copyright (c) 2005-2018, 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 #include "SingleTraceOutputModifier.hpp"
37 #include "HeartConfig.hpp"
38 #include "MathsCustomFunctions.hpp"
39 
40 void
42 {
43  // Collectively open the output directory - this might already be in place from creating the HDF5 file
44  OutputFileHandler output_handler(HeartConfig::Instance()->GetOutputDirectory(), false);
45 
46  // Only the node owner needs to proceed here
47  if (pVectorFactory->IsGlobalIndexLocal(mGlobalIndex))
48  {
49  // Set the local index correctly
50  mLocalIndex = mGlobalIndex - pVectorFactory->GetLow();
51  // Open the file as new
52  mFileStream = output_handler.OpenOutputFile(mFilename);
53  }
54 }
55 
56 void
58 {
59  if (mLocalIndex != UINT_MAX)
60  {
61  mFileStream->close();
62  }
63 }
64 
65 
66 void
67 SingleTraceOutputModifier::ProcessSolutionAtTimeStep(double time, Vec solution, unsigned problemDim)
68 {
69  if (mLocalIndex != UINT_MAX)
70  {
71  double* p_solution;
72  VecGetArray(solution, &p_solution); //This does not need to be collective
73  (*mFileStream) << time;
74  for (unsigned i=0; i<problemDim; ++i)
75  {
76  (*mFileStream) << "\t" << p_solution[mLocalIndex*problemDim+i];
77  }
78  (*mFileStream) << "\n";
79  VecRestoreArray(solution, &p_solution);
80 
81  if (mFlushTime > 0.0 && Divides(mFlushTime, time))
82  {
83  mFileStream->flush();
84  }
85  }
86 }
87 
virtual void ProcessSolutionAtTimeStep(double time, Vec solution, unsigned problemDim)
bool Divides(double smallerNumber, double largerNumber)
bool IsGlobalIndexLocal(unsigned globalIndex)
out_stream OpenOutputFile(const std::string &rFileName, std::ios_base::openmode mode=std::ios::out|std::ios::trunc) const
#define CHASTE_CLASS_EXPORT(T)
virtual void InitialiseAtStart(DistributedVectorFactory *pVectorFactory)
static HeartConfig * Instance()