summaryrefslogtreecommitdiff
path: root/src/particles/twoWayCouplings/forwardCouplingModels3D.h
blob: 17ff63c0165f0a9cd09813e2f159595abae0ca49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*  Lattice Boltzmann sample, written in C++, using the OpenLB
 *  library
 *
 *  Copyright (C) 2019 Davide Dapelo
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public
 *  License along with this program; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
 */

/* Models for Lagrangian forward-coupling methods -- header file.
 */

#ifndef LB_FORWARD_COUPLING_MODELS_H
#define LB_FORWARD_COUPLING_MODELS_H

#include "functors/lattice/reductionF3D.h"
#include "twoWayHelperFunctionals.h"

namespace olb {

/** Abstact base class for LocalBaseCouplingModel.
  * Its raison d'etre consists of not being templetized in Lattice.
  */
template<typename T, template<typename V> class Particle>
class ForwardCouplingModel {
public:
  /// Class operator to apply the coupling, for overload.
  virtual bool operator() (Particle<T>* p, int globic)=0;
};

/** Abstact class for all the local forward-coupling models,
  * viz., momentum coupling from fluid to particle.
  * Input parameters in attice units.
  */
template<typename T, typename Lattice, template<typename V> class Particle>
class LocalBaseForwardCouplingModel : public ForwardCouplingModel<T,Particle> {
public:
  /// Class operator to apply the coupling, for overload.
  virtual bool operator() (Particle<T>* p, int globic) override;
protected:
  /// Constructor
  LocalBaseForwardCouplingModel ( UnitConverter<T, Lattice>& converter,
                         SuperLattice3D<T, Lattice>& sLattice,
                         SuperGeometry3D<T>& sGeometry,
                         DragModel<T, Particle>& dragModel );
  SuperGeometry3D<T>& _sGeometry;
  UnitConverter<T, Lattice>& _converter; // reference to a UnitConverter
  SuperLattice3D<T, Lattice>& _sLattice; // reference to a lattice
  DragModel<T, Particle>& _dragModel; // reference to a drag model
  // Functional to interpolate lattice density at particle's location
  std::shared_ptr<SuperLatticeInterpDensity3Degree3D<T, Lattice> > _interpLatticeDensity;
  // Functional to interpolate lattice velocity at particle's location
  std::shared_ptr<SuperLatticeInterpPhysVelocity3D<T, Lattice> > _interpLatticeVelocity;
  // Momentum-exchange helper functional
  std::shared_ptr<TwoWayHelperFunctional<T, Lattice> > _momentumExchange;
};

/** Class for a naive forward-coupling model.
  * Input parameters in attice units.
  */
template<typename T, typename Lattice, template<typename V> class Particle>
class NaiveForwardCouplingModel : public LocalBaseForwardCouplingModel<T,Lattice,Particle> {
public:
  /// Constructor
  NaiveForwardCouplingModel ( UnitConverter<T, Lattice>& converter,
                              SuperLattice3D<T, Lattice>& sLattice,
                              SuperGeometry3D<T>& sGeometry,
                              DragModel<T, Particle>& dragModel );
};

/** Class for a forward-coupling model following the Ladd's mechanism.
  * Input parameters in attice units.
  */
template<typename T, typename Lattice, template<typename V> class Particle>
class LaddForwardCouplingModel : public LocalBaseForwardCouplingModel<T,Lattice,Particle> {
public:
  /// Constructor
  LaddForwardCouplingModel ( UnitConverter<T, Lattice>& converter,
                             SuperLattice3D<T, Lattice>& sLattice,
                             SuperGeometry3D<T>& sGeometry,
                             DragModel<T, Particle>& dragModel );
};

/** Abstact class for all the non-local forward-coupling models,
  * viz., momentum coupling from fluid to particle.
  * Input parameters in attice units.
  */
template<typename T, typename Lattice, template<typename V> class Particle>
class NonLocalBaseForwardCouplingModel : public ForwardCouplingModel<T,Particle> {
public:
  /// Class operator to apply the coupling, for overload.
  virtual bool operator() (Particle<T>* p, int globic) override;
protected:
  /// Constructor
  NonLocalBaseForwardCouplingModel ( UnitConverter<T, Lattice>& converter,
                              SuperLattice3D<T, Lattice>& sLattice,
                              SuperGeometry3D<T>& sGeometry,
                              DragModel<T, Particle>& dragModel,
                              SmoothingFunctional<T, Lattice>& smoothingFunctional );
  SuperGeometry3D<T>& _sGeometry;
  UnitConverter<T, Lattice>& _converter; // reference to a UnitConverter
  SuperLattice3D<T, Lattice>& _sLattice; // reference to a lattice
  DragModel<T, Particle>& _dragModel; // reference to a drag model
  SmoothingFunctional<T, Lattice>& _smoothingFunctional; // Functional to treat non-local smoothing
  // Functional to interpolate lattice density at particle's location.
  // It is assumed that it returns the exact value for the exact cell's location!
  std::shared_ptr<SuperLatticeInterpDensity3Degree3D<T, Lattice> > _interpLatticeDensity;
  // Functional to interpolate lattice velocity at particle's location
  // It is assumed that it returns the exact value for the exact cell's location!
  std::shared_ptr<SuperLatticeInterpPhysVelocity3D<T, Lattice> > _interpLatticeVelocity;
  // Momentum-exchange helper functional
  std::shared_ptr<TwoWayHelperFunctional<T, Lattice> > _momentumExchange;
};

/** Class for a naive, non-local forward-coupling model as in Sungkorn et al. (2011), but with
  * an extra-normalization of the smoothing function.
  * Input parameters in attice units.
  */
template<typename T, typename Lattice, template<typename V> class Particle>
class NaiveNonLocalForwardCouplingModel : public NonLocalBaseForwardCouplingModel<T,Lattice,Particle> {
public:
  /// Constructor
  NaiveNonLocalForwardCouplingModel ( UnitConverter<T, Lattice>& converter,
                                 SuperLattice3D<T, Lattice>& sLattice,
                                 SuperGeometry3D<T>& sGeometry,
                                 DragModel<T, Particle>& dragModel,
                                 SmoothingFunctional<T, Lattice>& smoothingFunctional );
};


}

#endif