linear.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 | Copyright (C) 2014-2015 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::linear
26 
27 Description
28 
29 SourceFiles
30  linear.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef linear_H
35 #define linear_H
36 
37 #include "blendingMethod.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace blendingMethods
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class linear Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class linear
51 :
52  public blendingMethod
53 {
54  // Private data
55 
56  //- Minimum fraction of phases which can be considered fully continuous
58  minFullyContinuousAlpha_;
59 
60  //- Minimum fraction of phases which can be considered partly continuous
62  minPartlyContinuousAlpha_;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("linear");
69 
70 
71  // Constructors
72 
73  //- Construct from a dictionary and two phases
74  linear
75  (
76  const dictionary& dict,
77  const wordList& phaseNames
78  );
79 
80 
81  //- Destructor
82  ~linear();
83 
84 
85  // Member Functions
86 
87  //- Factor for primary phase
88  virtual tmp<volScalarField> f1
89  (
90  const phaseModel& phase1,
91  const phaseModel& phase2
92  ) const;
93 
94  //- Factor for secondary phase
95  virtual tmp<volScalarField> f2
96  (
97  const phaseModel& phase1,
98  const phaseModel& phase2
99  ) const;
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace blendingMethods
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
phaseModel & phase1
Definition: createFields.H:12
phaseModel & phase2
Definition: createFields.H:13
An STL-conforming hash table.
Definition: HashTable.H:61
linear(const dictionary &dict, const wordList &phaseNames)
Construct from a dictionary and two phases.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual tmp< volScalarField > f1(const phaseModel &phase1, const phaseModel &phase2) const
Factor for primary phase.
dictionary dict
virtual tmp< volScalarField > f2(const phaseModel &phase1, const phaseModel &phase2) const
Factor for secondary phase.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
TypeName("linear")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:118