interfaceCompressionFvPatchScalarField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2017-2018 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::interfaceCompressionFvPatchScalarField
26 
27 Description
28  Applies interface-compression to the phase-fraction distribution at the
29  patch by setting the phase-fraction to 0 if it is below 0.5, otherwise
30  to 1.
31 
32  This approach is useful to avoid unphysical "bleed" of the lighter phase
33  along the surface in regions of high shear adjacent to the surface which
34  is at a shallow angle to the interface.
35 
36 See also
37  Foam::fixedValueFvPatchScalarField
38 
39 SourceFiles
40  interfaceCompressionFvPatchScalarField.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef interfaceCompressionFvPatchScalarField_H
45 #define interfaceCompressionFvPatchScalarField_H
46 
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class interfaceCompressionFvPatchScalarField Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 :
60  public fixedValueFvPatchScalarField
61 {
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("interfaceCompression");
67 
68 
69  // Constructors
70 
71  //- Construct from patch and internal field
73  (
74  const fvPatch&,
76  );
77 
78  //- Construct from patch, internal field and dictionary
80  (
81  const fvPatch&,
83  const dictionary&
84  );
85 
86  //- Construct by mapping given
87  // interfaceCompressionFvPatchScalarField onto a new patch
89  (
91  const fvPatch&,
93  const fvPatchFieldMapper&
94  );
95 
96  //- Construct as copy
98  (
100  );
101 
102  //- Construct and return a clone
103  virtual tmp<fvPatchScalarField> clone() const
104  {
106  (
108  );
109  }
110 
111  //- Construct as copy setting internal field reference
113  (
116  );
117 
118  //- Construct and return a clone setting internal field reference
120  (
122  ) const
123  {
125  (
127  );
128  }
129 
130 
131  // Member functions
132 
133  // Evaluation functions
134 
135  //- Update the coefficients associated with the patch field
136  virtual void updateCoeffs();
137 
138 
139  //- Write
140  virtual void write(Ostream&) const;
141 };
142 
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 } // End namespace Foam
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 #endif
151 
152 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
TypeName("interfaceCompression")
Runtime type information.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
interfaceCompressionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Applies interface-compression to the phase-fraction distribution at the patch by setting the phase-fr...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.