Chaste  Release::3.4
VertexCryptBoundaryForce.cpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 "VertexCryptBoundaryForce.hpp"
37 #include "MathsCustomFunctions.hpp"
38 
39 template<unsigned DIM>
41  : AbstractForce<DIM>(),
42  mForceStrength(forceStrength)
43 {
44  // We don't want the force to act in the wrong direction
45  assert(mForceStrength > 0.0);
46 }
47 
48 template<unsigned DIM>
50 {
51 }
52 
53 template<unsigned DIM>
55 {
56  // Helper variable that is a static cast of the cell population
57  VertexBasedCellPopulation<DIM>* p_cell_population = static_cast<VertexBasedCellPopulation<DIM>*>(&rCellPopulation);
58 
59  // Throw an exception message if not using a VertexBasedCellPopulation
60  if (dynamic_cast<VertexBasedCellPopulation<DIM>*>(&rCellPopulation) == NULL)
61  {
62  EXCEPTION("VertexCryptBoundaryForce is to be used with VertexBasedCellPopulations only");
63  }
64 
65  // Iterate over nodes
66  for (typename AbstractMesh<DIM,DIM>::NodeIterator node_iter = p_cell_population->rGetMesh().GetNodeIteratorBegin();
67  node_iter != p_cell_population->rGetMesh().GetNodeIteratorEnd();
68  ++node_iter)
69  {
70  double y = node_iter->rGetLocation()[1]; // y-coordinate of node
71 
72  // If the node lies below the line y=0, then add the boundary force contribution to the node forces
73  if (y < 0.0)
74  {
75  c_vector<double, DIM> boundary_force = zero_vector<double>(DIM);
76  boundary_force[1] = mForceStrength*SmallPow(y, 2);
77 
78  node_iter->AddAppliedForceContribution(boundary_force);
79  }
80  }
81 }
82 
83 template<unsigned DIM>
85 {
86  return mForceStrength;
87 }
88 
89 template<unsigned DIM>
91 {
92  *rParamsFile << "\t\t\t<ForceStrength>" << mForceStrength << "</ForceStrength>\n";
93 
94  // Call method on direct parent class
96 }
97 
99 template class VertexCryptBoundaryForce<1>;
100 template class VertexCryptBoundaryForce<2>;
101 template class VertexCryptBoundaryForce<3>;
102 
103 // Serialization for Boost >= 1.36
void OutputForceParameters(out_stream &rParamsFile)
void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)
double SmallPow(double x, unsigned exponent)
#define EXCEPTION(message)
Definition: Exception.hpp:143
NodeIterator GetNodeIteratorEnd()
VertexCryptBoundaryForce(double forceStrength=1.0)
MutableVertexMesh< DIM, DIM > & rGetMesh()
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
NodeIterator GetNodeIteratorBegin(bool skipDeletedNodes=true)
virtual void OutputForceParameters(out_stream &rParamsFile)=0