Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
ImmersedBoundaryElement.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 IMMERSEDBOUNDARYELEMENT_HPP_
37#define IMMERSEDBOUNDARYELEMENT_HPP_
38
39#include "MutableElement.hpp"
40#include "FluidSource.hpp"
41
43#include <boost/serialization/base_object.hpp>
44#include <boost/serialization/vector.hpp>
45
52template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
53class ImmersedBoundaryElement : public MutableElement<ELEMENT_DIM, SPACE_DIM>
54{
55private:
56
58 std::shared_ptr<FluidSource<SPACE_DIM>> mpFluidSource;
59
61 std::vector<Node<SPACE_DIM>*> mCornerNodes;
62
65
68
71
83 template<class Archive>
84 void serialize(Archive & archive, const unsigned int version)
85 {
86 // This needs to be first so that MeshBasedCellPopulation::Validate() doesn't go mental.
87 archive & boost::serialization::base_object<MutableElement<ELEMENT_DIM, SPACE_DIM> >(*this);
88 }
89
90public:
91
98 ImmersedBoundaryElement(unsigned index,
99 const std::vector<Node<SPACE_DIM>*>& rNodes);
100
104 virtual ~ImmersedBoundaryElement();
105
111 void SetFluidSource(std::shared_ptr<FluidSource<SPACE_DIM>> fluidSource);
112
118 std::shared_ptr<FluidSource<SPACE_DIM>> GetFluidSource();
119
125 std::vector<Node<SPACE_DIM>*>& rGetCornerNodes();
126
130 double GetAverageNodeSpacing();
131
135 void SetAverageNodeSpacing(double averageNodeSpacing);
136
142 virtual bool IsElementOnBoundary() const;
143
145 void SetIsBoundaryElement(bool isBoundaryElement);
146
150 void AddCornerNode(Node<SPACE_DIM>* node);
151};
152
154// Specialization for 1d elements //
155// //
156// 1d elements are just edges (lines) //
158
163template<unsigned SPACE_DIM>
164class ImmersedBoundaryElement<1, SPACE_DIM> : public MutableElement<1,SPACE_DIM>
165{
166private:
167
169 std::shared_ptr<FluidSource<SPACE_DIM>> mpFluidSource;
170
172 std::vector<Node<SPACE_DIM>*> mCornerNodes;
173
176
179
180public:
181
188 ImmersedBoundaryElement(unsigned index, const std::vector<Node<SPACE_DIM>*>& rNodes);
189
195 void SetFluidSource(std::shared_ptr<FluidSource<SPACE_DIM>> fluidSource);
196
202 std::shared_ptr<FluidSource<SPACE_DIM>> GetFluidSource(void);
203
209 std::vector<Node<SPACE_DIM>*>& rGetCornerNodes();
210
214 double GetAverageNodeSpacing();
215
219 void SetAverageNodeSpacing(double averageNodeSpacing);
220
226 virtual bool IsElementOnBoundary() const;
227
229 void SetIsBoundaryElement(bool isBoundaryElement);
230
231};
232
233#endif /*IMMERSEDBOUNDARYELEMENT_HPP_*/
std::vector< Node< SPACE_DIM > * > mCornerNodes
std::shared_ptr< FluidSource< SPACE_DIM > > mpFluidSource
void SetAverageNodeSpacing(double averageNodeSpacing)
std::shared_ptr< FluidSource< SPACE_DIM > > GetFluidSource()
std::vector< Node< SPACE_DIM > * > & rGetCornerNodes()
void SetFluidSource(std::shared_ptr< FluidSource< SPACE_DIM > > fluidSource)
void AddCornerNode(Node< SPACE_DIM > *node)
friend class boost::serialization::access
std::shared_ptr< FluidSource< SPACE_DIM > > mpFluidSource
virtual bool IsElementOnBoundary() const
void serialize(Archive &archive, const unsigned int version)
void SetIsBoundaryElement(bool isBoundaryElement)
std::vector< Node< SPACE_DIM > * > mCornerNodes
Definition Node.hpp:59