diff options
Diffstat (limited to 'src/particles/twoWayCouplings/forwardCouplingModels3D.h')
-rw-r--r-- | src/particles/twoWayCouplings/forwardCouplingModels3D.h | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/src/particles/twoWayCouplings/forwardCouplingModels3D.h b/src/particles/twoWayCouplings/forwardCouplingModels3D.h new file mode 100644 index 0000000..17ff63c --- /dev/null +++ b/src/particles/twoWayCouplings/forwardCouplingModels3D.h @@ -0,0 +1,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 |