Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
RepulsionForce.cpp
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#include "RepulsionForce.hpp"
37
38template<unsigned DIM>
43
44template<unsigned DIM>
46{
47 // Throw an exception message if not using a NodeBasedCellPopulation
48 if (dynamic_cast<NodeBasedCellPopulation<DIM>*>(&rCellPopulation) == nullptr)
49 {
50 EXCEPTION("RepulsionForce is to be used with a NodeBasedCellPopulation only");
51 }
52
53 std::vector< std::pair<Node<DIM>*, Node<DIM>* > >& r_node_pairs = (static_cast<NodeBasedCellPopulation<DIM>*>(&rCellPopulation))->rGetNodePairs();
54
55 for (typename std::vector< std::pair<Node<DIM>*, Node<DIM>* > >::iterator iter = r_node_pairs.begin();
56 iter != r_node_pairs.end();
57 iter++)
58 {
59 std::pair<Node<DIM>*, Node<DIM>* > pair = *iter;
60
61 Node<DIM>* p_node_a = pair.first;
62 Node<DIM>* p_node_b = pair.second;
63
64 // Get the node locations
65 const c_vector<double, DIM>& r_node_a_location = p_node_a->rGetLocation();
66 const c_vector<double, DIM>& r_node_b_location = p_node_b->rGetLocation();
67
68 // Get the node radii
69 double node_a_radius = p_node_a->GetRadius();
70 double node_b_radius = p_node_b->GetRadius();
71
72 // Get the unit vector parallel to the line joining the two nodes
73 c_vector<double, DIM> unit_difference;
74
75 unit_difference = (static_cast<NodeBasedCellPopulation<DIM>*>(&rCellPopulation))->rGetMesh().GetVectorFromAtoB(r_node_a_location, r_node_b_location);
76
77 // Calculate the value of the rest length
78 double rest_length = node_a_radius+node_b_radius;
79
80 if (norm_2(unit_difference) < rest_length)
81 {
82 // Calculate the force between nodes
83 c_vector<double, DIM> force = this->CalculateForceBetweenNodes(p_node_a->GetIndex(), p_node_b->GetIndex(), rCellPopulation);
84 c_vector<double, DIM> negative_force = -1.0 * force;
85 for (unsigned j=0; j<DIM; j++)
86 {
87 assert(!std::isnan(force[j]));
88 }
89 // Add the force contribution to each node
90 p_node_a->AddAppliedForceContribution(force);
91 p_node_b->AddAppliedForceContribution(negative_force);
92 }
93 }
94}
95
96template<unsigned DIM>
97void RepulsionForce<DIM>::OutputForceParameters(out_stream& rParamsFile)
98{
99 // Call direct parent class
101}
102
103// Explicit instantiation
104template class RepulsionForce<1>;
105template class RepulsionForce<2>;
106template class RepulsionForce<3>;
107
108// Serialization for Boost >= 1.36
#define EXCEPTION(message)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
virtual void OutputForceParameters(out_stream &rParamsFile)
Definition Node.hpp:59
const c_vector< double, SPACE_DIM > & rGetLocation() const
Definition Node.cpp:139
unsigned GetIndex() const
Definition Node.cpp:158
void AddAppliedForceContribution(const c_vector< double, SPACE_DIM > &rForceContribution)
Definition Node.cpp:224
double GetRadius()
Definition Node.cpp:248
virtual void OutputForceParameters(out_stream &rParamsFile)
void AddForceContribution(AbstractCellPopulation< DIM > &rCellPopulation)