alphatPhaseChangeWallFunctionFvPatchScalarField.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::compressible::alphatPhaseChangeWallFunctionFvPatchScalarField
26 
27 Group
28  grpCmpWallFunctions
29 
30 Description
31  Abstract base-class for all alphatWallFunctions supporting phase-change.
32 
33 SeeAlso
34  Foam::alphatWallFunction
35 
36 SourceFiles
37  alphatPhaseChangeWallFunctionFvPatchScalarField.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef compressibleAlphatPhaseChangeWallFunctionFvPatchScalarField_H
42 #define compressibleAlphatPhaseChangeWallFunctionFvPatchScalarField_H
43 
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace compressible
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class alphatPhaseChangeWallFunctionFvPatchScalarField Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public fixedValueFvPatchScalarField
60 {
61 protected:
62 
63  // Protected data
64 
65  //- Rate of phase-change
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("compressible::alphatPhaseChangeWallFunction");
73 
74 
75  // Constructors
76 
77  //- Construct from patch and internal field
79  (
80  const fvPatch&,
82  );
83 
84  //- Construct from patch, internal field and dictionary
86  (
87  const fvPatch&,
89  const dictionary&
90  );
91 
92  //- Construct by mapping given
93  // alphatPhaseChangeWallFunctionFvPatchScalarField
94  // onto a new patch
96  (
98  const fvPatch&,
100  const fvPatchFieldMapper&
101  );
102 
103  //- Construct as copy
105  (
107  );
108 
109  //- Construct as copy setting internal field reference
111  (
114  );
115 
116 
117  // Member functions
118 
119  //- Return the rate of phase-change
120  const scalarField& dmdt() const
121  {
122  return dmdt_;
123  }
124 
125  // Evaluation functions
126 
127  //- Update the coefficients associated with the patch field
128  virtual void updateCoeffs() = 0;
129 
130 
131  // I-O
132 
133  //- Write
134  virtual void write(Ostream&) const;
135 };
136 
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 } // End namespace compressible
141 } // End namespace Foam
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 #endif
146 
147 // ************************************************************************* //
Abstract base-class for all alphatWallFunctions supporting phase-change.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
TypeName("compressible::alphatPhaseChangeWallFunction")
Runtime type information.
virtual void updateCoeffs()=0
Update the coefficients associated with the patch field.
bool compressible
Definition: pEqn.H:40
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
alphatPhaseChangeWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.