InterfaceForce.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::InterfaceForce
28 
29 Description
30  Vector force apply to particles to avoid the crossing of particles from
31  one phase to the other. The magnitude is calculated as C*mass*grad(alpha)
32 
33 SourceFiles
34  InterfaceForce.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef InterfaceForce_H
39 #define InterfaceForce_H
40 
41 #include "ParticleForce.H"
42 #include "interpolation.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 class fvMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class InterfaceForce Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class CloudType>
56 class InterfaceForce
57 :
58  public ParticleForce<CloudType>
59 {
60  // Private data
61 
62  //- Name of phase fraction field
63  const word alphaName_;
64 
65  //- Model constant
66  const scalar C_;
67 
68  //- Interpolator for gradInterForce
69  autoPtr<interpolation<vector>> gradInterForceInterpPtr_;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("interface");
76 
77 
78  // Constructors
79 
80  //- Construct from mesh
82  (
84  const fvMesh& mesh,
85  const dictionary& dict
86  );
87 
88  //- Construct copy
89  InterfaceForce(const InterfaceForce& gf);
90 
91  //- Construct and return a clone
93  {
95  (
96  new InterfaceForce<CloudType>(*this)
97  );
98  }
99 
100 
101  //- Destructor
102  virtual ~InterfaceForce();
103 
104 
105  // Evaluation
106 
107  //- Cache fields
108  virtual void cacheFields(const bool store);
109 
110  //- Calculate the non-coupled force
111  virtual forceSuSp calcNonCoupled
112  (
113  const typename CloudType::parcelType& p,
114  const typename CloudType::parcelType::trackingData& td,
115  const scalar dt,
116  const scalar mass,
117  const scalar Re,
118  const scalar muc
119  ) const;
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #ifdef NoRepository
130  #include "InterfaceForce.C"
131 #endif
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
Foam::ParticleForce::owner
const CloudType & owner() const
Definition: ParticleForceI.H:24
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:63
Foam::InterfaceForce::cacheFields
virtual void cacheFields(const bool store)
Definition: InterfaceForce.C:61
interpolation.H
Foam::InterfaceForce::InterfaceForce
InterfaceForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict)
Definition: InterfaceForce.C:28
Foam::InterfaceForce::clone
virtual autoPtr< ParticleForce< CloudType > > clone() const
Definition: InterfaceForce.H:87
Foam::InterfaceForce::calcNonCoupled
virtual forceSuSp calcNonCoupled(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Definition: InterfaceForce.C:110
Foam::forceSuSp
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:60
Foam::ParticleForce
Abstract base class for particle forces.
Definition: ParticleForce.H:55
ParticleForce.H
InterfaceForce.C
Foam::DSMCCloud
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:67
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:119
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:81
Foam
Definition: atmBoundaryLayer.C:26
Foam::InterfaceForce
Vector force apply to particles to avoid the crossing of particles from one phase to the other....
Definition: InterfaceForce.H:51
Foam::InterfaceForce::~InterfaceForce
virtual ~InterfaceForce()
Definition: InterfaceForce.C:54
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:49
Foam::Re
scalarField Re(const UList< complex > &cf)
Definition: complexField.C:152
Foam::InterfaceForce::TypeName
TypeName("interface")
Foam::DSMCCloud::parcelType
ParcelType parcelType
Definition: DSMCCloud.H:216
Foam::ParticleForce::mesh
const fvMesh & mesh() const
Definition: ParticleForceI.H:38