Chaste  Release::2018.1
CellVecData.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 "CellVecData.hpp"
37 
39  : mFreeVecs(false)
40 {
41 }
42 
43 CellVecData::CellVecData(const CellVecData& rAnotherCellVecData)
44  : mFreeVecs(true)
45 {
46  std::vector<std::string> keys = rAnotherCellVecData.GetKeys();
47 
48  for (std::vector<std::string>::iterator iter = keys.begin(); iter != keys.end(); ++iter)
49  {
50  std::string map_key = *iter;
51  Vec map_value = rAnotherCellVecData.GetItem(map_key);
52 
53  Vec map_value_copy;
54  VecDuplicate(map_value, &map_value_copy);
55  VecCopy(map_value, map_value_copy);
56 
57  mCellVecData[map_key] = map_value_copy;
58  }
59 }
60 
61 CellVecData::CellVecData(const std::map<std::string, Vec>& rCellVecDataMap)
62  : mCellVecData(rCellVecDataMap),
63  mFreeVecs(true)
64 {
65 }
66 
68 {
69  // If the object was loaded from a checkpoint, the Vecs in the map need freeing. Otherwise is the user's responsibility.
70  if (mFreeVecs)
71  {
72  for (std::map<std::string, Vec>::iterator iter = mCellVecData.begin(); iter != mCellVecData.end(); ++iter)
73  {
74  PetscTools::Destroy(iter->second);
75  }
76  }
77 }
78 
79 void CellVecData::SetItem(const std::string& rVariableName, Vec data)
80 {
81  mCellVecData[rVariableName] = data;
82 }
83 
84 Vec CellVecData::GetItem(const std::string& rVariableName) const
85 {
86  /*
87  * Note that mCellVecData[rVariableName] is not const. If rVariableName is not
88  * a key, then mCellVecData[rVariableName] will create a new item in the map
89  * and increase the size by one. Using a const_iterator ensures that the
90  * map remains const.
91  */
92  std::map<std::string, Vec>::const_iterator it = mCellVecData.find(rVariableName);
93  if (it == mCellVecData.end())
94  {
95  EXCEPTION("The item " << rVariableName << " is not stored");
96  }
97  return it->second;
98 }
99 
100 unsigned CellVecData::GetNumItems() const
101 {
102  return mCellVecData.size();
103 }
104 
105 std::vector<std::string> CellVecData::GetKeys() const
106 {
107  std::vector<std::string> keys;
108  for (std::map<std::string, Vec>::const_iterator it = mCellVecData.begin(); it != mCellVecData.end(); ++it)
109  {
110  keys.push_back(it->first);
111  }
112 
113  // From STL documentation we assume that the iterator is returning sorted keys sort(keys.begin(), keys.end());
114  return keys;
115 }
116 
118 // Declare identifier for the serializer
std::map< std::string, Vec > mCellVecData
Definition: CellVecData.hpp:69
Vec GetItem(const std::string &rVariableName) const
Definition: CellVecData.cpp:84
#define EXCEPTION(message)
Definition: Exception.hpp:143
void SetItem(const std::string &rVariableName, Vec data)
Definition: CellVecData.cpp:79
std::vector< std::string > GetKeys() const
virtual ~CellVecData()
Definition: CellVecData.cpp:67
static void Destroy(Vec &rVec)
Definition: PetscTools.hpp:352
#define CHASTE_CLASS_EXPORT(T)
unsigned GetNumItems() const