interface.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) 2011 OpenFOAM Foundation
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::dragModels::interface
28 
29 Description
30  Drag between phase separated by a VoF resolved interface.
31 
32 SourceFiles
33  interface.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef interface_H
38 #define interface_H
39 
40 #include "dragModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace dragModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class interface Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class interface
54 :
55  public dragModel
56 {
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("interface");
62 
63 
64  // Constructors
65 
66  //- Construct from components
67  interface
68  (
69  const dictionary& interfaceDict,
70  const phaseModel& phase1,
71  const phaseModel& phase2
72  );
73 
74 
75  //- Destructor
76  virtual ~interface() = default;
77 
78 
79  // Member Functions
80 
81  tmp<volScalarField> K(const volScalarField& Ur) const;
82 };
83 
84 
85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 
87 } // End namespace dragModels
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
Foam::dragModels::interface::TypeName
TypeName("interface")
Runtime type information.
Foam::phaseModel
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:54
Foam::dragModels::interface::~interface
virtual ~interface()=default
Destructor.
Foam::dragModel::phase1
const phaseModel & phase1() const
Definition: dragModel.H:111
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::dragModel::K
virtual tmp< volScalarField > K() const
Return the drag coefficient K.
Definition: dragModel.C:153
Foam::dragModel::phase2
const phaseModel & phase2() const
Definition: dragModel.H:116
Foam::dragModels::interface
Drag between phase separated by a VoF resolved interface.
Definition: interface.H:52
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::dragModels::interface::interface
interface(const dictionary &interfaceDict, const phaseModel &phase1, const phaseModel &phase2)
Construct from components.
Definition: interface.C:53
Foam::dragModel
Definition: dragModel.H:51
Foam::GeometricField< scalar, fvPatchField, volMesh >