surfaceTensionModel.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) 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::surfaceTensionModel
26 
27 Description
28 
29 SourceFiles
30  surfaceTensionModel.C
31  newAspectRatioModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef surfaceTensionModel_H
36 #define surfaceTensionModel_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 #include "volFields.H"
41 #include "dictionary.H"
42 #include "runTimeSelectionTables.H"
43 
44 namespace Foam
45 {
46 
47 class phasePair;
48 
49 /*---------------------------------------------------------------------------*\
50  Class surfaceTensionModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public regIOobject
56 {
57 protected:
58 
59  // Protected data
60 
61  //- Phase pair
62  const phasePair& pair_;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("surfaceTensionModel");
69 
70 
71  // Declare runtime construction
73  (
74  autoPtr,
76  dictionary,
77  (
78  const dictionary& dict,
79  const phasePair& pair,
80  const bool registerObject
81  ),
82  (dict, pair, registerObject)
83  );
84 
85 
86  // Static data members
87 
88  //- Coefficient dimensions
89  static const dimensionSet dimSigma;
90 
91 
92  // Constructors
93 
94  //- Construct from a dictionary and a phase pair
96  (
97  const dictionary& dict,
98  const phasePair& pair,
99  const bool registerObject
100  );
101 
102 
103  //- Destructor
104  virtual ~surfaceTensionModel();
105 
106 
107  // Selectors
108 
110  (
111  const dictionary& dict,
112  const phasePair& pair
113  );
114 
115 
116  // Member Functions
117 
118  //- Aspect ratio
119  virtual tmp<volScalarField> sigma() const = 0;
120 
121  //- Dummy write for regIOobject
122  bool writeData(Ostream& os) const;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
const phasePair & pair_
Phase pair.
bool writeData(Ostream &os) const
Dummy write for regIOobject.
Macros to ease declaration of run-time selection tables.
virtual ~surfaceTensionModel()
Destructor.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
bool & registerObject()
Register object created from this IOobject with registry if true.
Definition: IOobject.H:290
Namespace for OpenFOAM.
dictionary dict
declareRunTimeSelectionTable(autoPtr, surfaceTensionModel, dictionary,( const dictionary &dict, const phasePair &pair, const bool registerObject ),(dict, pair, registerObject))
Dimension set for the base types.
Definition: dimensionSet.H:116
static autoPtr< surfaceTensionModel > New(const dictionary &dict, const phasePair &pair)
surfaceTensionModel(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
TypeName("surfaceTensionModel")
Runtime type information.
virtual tmp< volScalarField > sigma() const =0
Aspect ratio.
static const dimensionSet dimSigma
Coefficient dimensions.
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:60
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118