From 426a14d905413bd298616df445ebcafdbbb6342e Mon Sep 17 00:00:00 2001
From: graham <g.macpherson@opencfd.co.uk>
Date: Mon, 21 Sep 2009 20:25:24 +0100
Subject: [PATCH] Moving all parts of the collision to separate private member
 functions.

---
 .../PairCollision/PairCollision.C             | 249 ++++++++++--------
 .../PairCollision/PairCollision.H             |  15 ++
 2 files changed, 158 insertions(+), 106 deletions(-)

diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.C b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.C
index 0f2fd94588..3be79ab797 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.C
+++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.C
@@ -30,107 +30,8 @@ License
 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
 
 template<class CloudType>
-void Foam::PairCollision<CloudType>::buildCellOccupancy()
+void Foam::PairCollision<CloudType>::preInteraction()
 {
-    Info<< "    Build cell occupancy" << endl;
-
-    forAll(cellOccupancy_, cO)
-    {
-        cellOccupancy_[cO].clear();
-    }
-
-    forAllIter(typename CloudType, this->owner(), iter)
-    {
-        cellOccupancy_[iter().cell()].append(&iter());
-    }
-
-    il_.ril().referParticles(cellOccupancy_);
-}
-
-
-template<class CloudType>
-void Foam::PairCollision<CloudType>::evaluatePair
-(
-    typename CloudType::parcelType& pA,
-    typename CloudType::parcelType& pB
-) const
-{
-    pairModel_->evaluatePair(pA, pB);
-}
-
-// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
-
-template<class CloudType>
-Foam::PairCollision<CloudType>::PairCollision
-(
-    const dictionary& dict,
-    CloudType& owner
-)
-:
-    CollisionModel<CloudType>(dict, owner, typeName),
-    cellOccupancy_(owner.mesh().nCells()),
-    pairModel_
-    (
-        PairModel<CloudType>::New
-        (
-            this->coeffDict(),
-            this->owner()
-        )
-    ),
-    il_
-    (
-        owner.mesh(),
-        sqr(readScalar(this->coeffDict().lookup("maxInteractionDistance"))),
-        true
-    )
-{}
-
-
-// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
-
-template<class CloudType>
-Foam::PairCollision<CloudType>::~PairCollision()
-{}
-
-
-// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
-
-template<class CloudType>
-Foam::label Foam::PairCollision<CloudType>::nSubCycles() const
-{
-    if (pairModel_->controlsTimestep())
-    {
-        label nSubCycles = returnReduce
-        (
-            pairModel_->nSubCycles(), maxOp<label>()
-        );
-
-        if(nSubCycles > 1)
-        {
-            Info<< nSubCycles << " move-collide subCycles" << endl;
-        }
-
-        return nSubCycles;
-    }
-    else
-    {
-        return 1;
-    }
-}
-
-
-template<class CloudType>
-bool Foam::PairCollision<CloudType>::active() const
-{
-    return true;
-}
-
-
-template<class CloudType>
-void Foam::PairCollision<CloudType>::collide()
-{
-    Info<< "Calculating collisions" << endl;
-
     // Set accumulated quantities to zero
     forAllIter(typename CloudType, this->owner(), iter)
     {
@@ -142,17 +43,18 @@ void Foam::PairCollision<CloudType>::collide()
     }
 
     buildCellOccupancy();
+}
 
+
+template<class CloudType>
+void Foam::PairCollision<CloudType>::realRealInteraction()
+{
     const DirectInteractionList<typename CloudType::parcelType>& dil =
         il_.dil();
 
-    const polyMesh& mesh = this->owner().mesh();
-
     typename CloudType::parcelType* pA_ptr = NULL;
     typename CloudType::parcelType* pB_ptr = NULL;
 
-    // real-real interactions
-
     forAll(dil, realCellI)
     {
         // Loop over all Parcels in cell A (a)
@@ -188,9 +90,12 @@ void Foam::PairCollision<CloudType>::collide()
             }
         }
     }
+}
 
-    // real-referred interactions
 
+template<class CloudType>
+void Foam::PairCollision<CloudType>::realReferredInteraction()
+{
     ReferredCellList<typename CloudType::parcelType>& ril = il_.ril();
 
     // Loop over all referred cells
@@ -228,6 +133,18 @@ void Foam::PairCollision<CloudType>::collide()
             }
         }
     }
+}
+
+
+template<class CloudType>
+void Foam::PairCollision<CloudType>::wallInteraction()
+{
+    const polyMesh& mesh = this->owner().mesh();
+
+    const DirectInteractionList<typename CloudType::parcelType>& dil =
+        il_.dil();
+
+    ReferredCellList<typename CloudType::parcelType>& ril = il_.ril();
 
     DynamicList<point> allWallInteractionSites;
     DynamicList<point> flatWallInteractionSites;
@@ -240,7 +157,7 @@ void Foam::PairCollision<CloudType>::collide()
 
         // The labels of referred cells in range of this real cell
         const labelList& referredCellsInRange =
-            dil.referredCellsForInteraction()[realCellI];
+        dil.referredCellsForInteraction()[realCellI];
 
         // Loop over all Parcels in cell
         forAll(cellOccupancy_[realCellI], cellParticleI)
@@ -357,7 +274,12 @@ void Foam::PairCollision<CloudType>::collide()
             }
         }
     }
+}
 
+
+template<class CloudType>
+void Foam::PairCollision<CloudType>::postInteraction()
+{
     // Delete any collision records where no collision occurred this step
 
     Info<< "    Update collision records" << endl;
@@ -371,4 +293,119 @@ void Foam::PairCollision<CloudType>::collide()
 }
 
 
+template<class CloudType>
+void Foam::PairCollision<CloudType>::buildCellOccupancy()
+{
+    Info<< "    Build cell occupancy" << endl;
+
+    forAll(cellOccupancy_, cO)
+    {
+        cellOccupancy_[cO].clear();
+    }
+
+    forAllIter(typename CloudType, this->owner(), iter)
+    {
+        cellOccupancy_[iter().cell()].append(&iter());
+    }
+
+    il_.ril().referParticles(cellOccupancy_);
+}
+
+
+template<class CloudType>
+void Foam::PairCollision<CloudType>::evaluatePair
+(
+    typename CloudType::parcelType& pA,
+    typename CloudType::parcelType& pB
+) const
+{
+    pairModel_->evaluatePair(pA, pB);
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+template<class CloudType>
+Foam::PairCollision<CloudType>::PairCollision
+(
+    const dictionary& dict,
+    CloudType& owner
+)
+:
+    CollisionModel<CloudType>(dict, owner, typeName),
+    cellOccupancy_(owner.mesh().nCells()),
+    pairModel_
+    (
+        PairModel<CloudType>::New
+        (
+            this->coeffDict(),
+            this->owner()
+        )
+    ),
+    il_
+    (
+        owner.mesh(),
+        sqr(readScalar(this->coeffDict().lookup("maxInteractionDistance"))),
+        true
+    )
+{}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+template<class CloudType>
+Foam::PairCollision<CloudType>::~PairCollision()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+template<class CloudType>
+Foam::label Foam::PairCollision<CloudType>::nSubCycles() const
+{
+    if (pairModel_->controlsTimestep())
+    {
+        label nSubCycles = returnReduce
+        (
+            pairModel_->nSubCycles(), maxOp<label>()
+        );
+
+        if(nSubCycles > 1)
+        {
+            Info<< nSubCycles << " move-collide subCycles" << endl;
+        }
+
+        return nSubCycles;
+    }
+    else
+    {
+        return 1;
+    }
+}
+
+
+template<class CloudType>
+bool Foam::PairCollision<CloudType>::active() const
+{
+    return true;
+}
+
+
+template<class CloudType>
+void Foam::PairCollision<CloudType>::collide()
+{
+    Info<< "Calculating collisions" << endl;
+
+    preInteraction();
+
+    realRealInteraction();
+
+    realReferredInteraction();
+
+    wallInteraction();
+
+    postInteraction();
+}
+
+
 // ************************************************************************* //
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H
index e0337a2536..3ec3ccc25a 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H
@@ -73,6 +73,21 @@ class PairCollision
 
     // Private member functions
 
+        //- Pre collision tasks
+        void preInteraction();
+
+        //- Interactions between real (on-processor) particles
+        void realRealInteraction();
+
+        //- Interactions between real and referred (off processor) particles
+        void realReferredInteraction();
+
+        //- Interactions with walls
+        void wallInteraction();
+
+        //- Post collision tasks
+        void postInteraction();
+
         //- Build the cell occupancy information for each parcel
         void buildCellOccupancy();