Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
CellId.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 CELLID_HPP_
37#define CELLID_HPP_
38
39#include <boost/shared_ptr.hpp>
40#include "AbstractCellProperty.hpp"
42#include <boost/serialization/base_object.hpp>
43#include "Exception.hpp"
44#include "PetscTools.hpp"
45
46class CellId;
47
58{
59private:
60
64 unsigned mCellId;
65
67 static unsigned mMaxCellId;
68
77 template<class Archive>
78 void serialize(Archive & archive, const unsigned int version)
79 {
80 archive & boost::serialization::base_object<AbstractCellProperty>(*this);
81 archive & mCellId;
82 if (!PetscTools::IsParallel()) // This is to avoid changing the static i.d. in parallel simulations
83 {
84 archive & mMaxCellId;
85 }
86 }
87
88public:
89
95 CellId();
96
100 virtual ~CellId();
101
106 void AssignCellId();
107
111 unsigned GetMaxCellId() const;
112
116 unsigned GetCellId() const;
117
121 static void ResetMaxCellId();
122};
123
125// Declare identifier for the serializer
127
128#endif /* CELLID_HPP_ */
gcov doesn't like this file...
#define CHASTE_CLASS_EXPORT(T)
unsigned GetCellId() const
Definition CellId.cpp:57
virtual ~CellId()
Definition CellId.cpp:47
static unsigned mMaxCellId
Definition CellId.hpp:67
unsigned mCellId
Definition CellId.hpp:64
static void ResetMaxCellId()
Definition CellId.cpp:75
void serialize(Archive &archive, const unsigned int version)
Definition CellId.hpp:78
CellId()
Definition CellId.cpp:41
friend class boost::serialization::access
Definition CellId.hpp:70
unsigned GetMaxCellId() const
Definition CellId.cpp:66
void AssignCellId()
Definition CellId.cpp:51
static bool IsParallel()