interface.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::dragModels::interface
26 
27 Description
28  Drag between phase separated by a VoF resolved interface.
29 
30 SourceFiles
31  interface.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef interface_H
36 #define interface_H
37 
38 #include "dragModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace dragModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class interface Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class interface
52 :
53  public dragModel
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("interface");
60 
61 
62  // Constructors
63 
64  //- Construct from components
65  interface
66  (
67  const dictionary& interfaceDict,
68  const phaseModel& phase1,
69  const phaseModel& phase2
70  );
71 
72 
73  //- Destructor
74  virtual ~interface();
75 
76 
77  // Member Functions
78 
79  tmp<volScalarField> K(const volScalarField& Ur) const;
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace dragModels
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
const phaseModel & phase1() const
Definition: dragModel.H:110
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const phaseModel & phase2() const
Definition: dragModel.H:115
virtual tmp< volScalarField > K() const
Return the drag coefficient K.
virtual ~interface()
Destructor.
TypeName("interface")
Runtime type information.
Drag between phase separated by a VoF resolved interface.
Definition: interface.H:50
A class for managing temporary objects.
Definition: PtrList.H:53
interface(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)
Construct from components.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
Namespace for OpenFOAM.