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