Chaste  Release::2018.1
MixedDimensionMesh.hpp
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 #ifndef MIXEDDIMENSIONMESH_HPP_
37 #define MIXEDDIMENSIONMESH_HPP_
38 
39 #include "DistributedTetrahedralMesh.hpp"
40 #include "AbstractMeshReader.hpp"
41 
42 #include "ChasteSerialization.hpp"
43 #include <boost/serialization/base_object.hpp>
44 
50 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
51 class MixedDimensionMesh : public DistributedTetrahedralMesh<ELEMENT_DIM, SPACE_DIM>
52 {
53 public:
54 
60  MixedDimensionMesh(DistributedTetrahedralMeshPartitionType::type partitioningMethod=DistributedTetrahedralMeshPartitionType::METIS_LIBRARY);
61 
67 
74 
80  void RegisterCableElement(unsigned index);
81 
85  unsigned GetNumCableElements() const;
86 
90  unsigned GetNumLocalCableElements() const;
91 
98  Element<1u, SPACE_DIM>* GetCableElement(unsigned globalElementIndex) const;
99 
106  bool CalculateDesignatedOwnershipOfCableElement( unsigned globalElementIndex );
107 
109  typedef typename std::multimap<const Node<SPACE_DIM>*, Element<1u, SPACE_DIM>*>::iterator NodeCableIterator;
110 
112  typedef std::pair<NodeCableIterator, NodeCableIterator> CableRangeAtNode;
113 
121 
122 private:
124  std::vector<Element<1u, SPACE_DIM>*> mCableElements;
125 
128 
130  std::map<unsigned, unsigned> mCableElementsMapping;
131 
133  std::multimap<const Node<SPACE_DIM>*, Element<1u, SPACE_DIM>*> mNodeToCablesMapping;
134 
143  template<class Archive>
144  void serialize(Archive & archive, const unsigned int version)
145  {
146  archive & boost::serialization::base_object<DistributedTetrahedralMesh<ELEMENT_DIM, SPACE_DIM> >(*this);
147  }
148 
149 public:
150 
152  // Iterators //
154 
156  typedef typename std::vector<Element<1, SPACE_DIM> *>::const_iterator CableElementIterator;
157 
162 
168 };
169 
172 
173 namespace boost
174 {
175 namespace serialization
176 {
180 template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
181 inline void save_construct_data(
182  Archive & ar, const MixedDimensionMesh<ELEMENT_DIM, SPACE_DIM> * t, const unsigned int file_version)
183 {
184  unsigned num_procs = PetscTools::GetNumProcs();
186  ar << num_procs;
187  ar << partition_type;
188 }
189 
194 template<class Archive, unsigned ELEMENT_DIM, unsigned SPACE_DIM>
195 inline void load_construct_data(
196  Archive & ar, MixedDimensionMesh<ELEMENT_DIM, SPACE_DIM> * t, const unsigned int file_version)
197 {
198  unsigned num_procs;
200 
201  ar >> num_procs;
202  ar >> partition_type;
203 
204  // Invoke inplace constructor to initialise instance
206  //::new(t)MixedDimensionMesh<ELEMENT_DIM, SPACE_DIM>(partition_type);
207  ::new(t)MixedDimensionMesh<ELEMENT_DIM, SPACE_DIM>(DistributedTetrahedralMeshPartitionType::DUMB);
208 
209  /*
210  * The exception needs to be thrown after the call to ::new(t), or Boost will try
211  * to free non-allocated memory when the exception is thrown.
212  */
213  if (DistributedVectorFactory::CheckNumberOfProcessesOnLoad() &&
214  num_procs != PetscTools::GetNumProcs())
215  {
216  EXCEPTION("This archive was written for a different number of processors");
217  }
218 
219 }
220 }
221 } // namespace ...
222 
223 #endif /*MIXEDDIMENSIONMESH_HPP_*/
CableElementIterator GetCableElementIteratorEnd() const
unsigned GetNumLocalCableElements() const
Definition: Node.hpp:58
void RegisterCableElement(unsigned index)
std::pair< NodeCableIterator, NodeCableIterator > CableRangeAtNode
DistributedTetrahedralMeshPartitionType::type GetPartitionType() const
std::map< unsigned, unsigned > mCableElementsMapping
#define EXCEPTION(message)
Definition: Exception.hpp:143
void ConstructFromMeshReader(AbstractMeshReader< ELEMENT_DIM, SPACE_DIM > &rMeshReader)
std::multimap< const Node< SPACE_DIM > *, Element< 1u, SPACE_DIM > * > mNodeToCablesMapping
CableElementIterator GetCableElementIteratorBegin() const
unsigned GetNumCableElements() const
std::multimap< const Node< SPACE_DIM > *, Element< 1u, SPACE_DIM > * >::iterator NodeCableIterator
bool CalculateDesignatedOwnershipOfCableElement(unsigned globalElementIndex)
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
std::vector< Element< 1u, SPACE_DIM > * > mCableElements
MixedDimensionMesh(DistributedTetrahedralMeshPartitionType::type partitioningMethod=DistributedTetrahedralMeshPartitionType::METIS_LIBRARY)
static unsigned GetNumProcs()
Definition: PetscTools.cpp:108
CableRangeAtNode GetCablesAtNode(const Node< SPACE_DIM > *pNode)
friend class boost::serialization::access
void serialize(Archive &archive, const unsigned int version)
gcov doesn't like this file...
Element< 1u, SPACE_DIM > * GetCableElement(unsigned globalElementIndex) const
std::vector< Element< 1, SPACE_DIM > * >::const_iterator CableElementIterator