wavePressureFvPatchScalarField.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::wavePressureFvPatchScalarField
26 
27 Description
28  This boundary condition provides a wavePressure condition. This sets the
29  pressure to a value specified by a superposition of wave models. All the
30  parameters are looked up from the corresponding velocity condition.
31 
32  This functions like an outletInlet condition. Faces on which the flow is
33  leaving the domain have a value set by the wave model. Faces on which the
34  flow is entering the domain have the gradient set. This gradient is
35  calculated numerically by evaluating the wave model on both the patch face
36  and the adjacent cell.
37 
38  Use of this boundary condition triggers a consistent behaviour in the
39  corresponding velocity and phase-fraction conditions.
40 
41 Usage
42  \table
43  Property | Description | Req'd? | Default
44  U | name of the velocity field | no | U
45  rho | name of the density field | no | rho
46  \endtable
47 
48  Example of the boundary condition specification:
49  \verbatim
50  <patchName>
51  {
52  type wavePressure;
53  U U;
54  rho rho;
55  }
56  \endverbatim
57 
58 
59 SourceFiles
60  wavePressureFvPatchScalarField.C
61 
62 \*---------------------------------------------------------------------------*/
63 
64 #ifndef wavePressureFvPatchScalarField_H
65 #define wavePressureFvPatchScalarField_H
66 
67 #include "mixedFvPatchFields.H"
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 namespace Foam
72 {
73 
74 /*---------------------------------------------------------------------------*\
75  Class wavePressureFvPatchScalarField Declaration
76 \*---------------------------------------------------------------------------*/
77 
78 class wavePressureFvPatchScalarField
79 :
80  public mixedFvPatchScalarField
81 {
82  // Private data
83 
84  //- Name of the velocity field
85  const word UName_;
86 
87  //- Name of the density field
88  const word rhoName_;
89 
90 
91 public:
92 
93  //- Runtime type information
94  TypeName("wavePressure");
95 
96 
97  // Constructors
98 
99  //- Construct from patch and internal field
101  (
102  const fvPatch&,
104  );
105 
106  //- Construct from patch, internal field and dictionary
108  (
109  const fvPatch&,
111  const dictionary&
112  );
113 
114  //- Construct by mapping given mixedTypeFvPatchField
115  // onto a new patch
117  (
119  const fvPatch&,
121  const fvPatchFieldMapper&
122  );
123 
124  //- Construct as copy
126  (
128  );
129 
130  //- Construct and return a clone
131  virtual tmp<fvPatchScalarField> clone() const
132  {
134  (
136  );
137  }
138 
139  //- Construct as copy setting internal field reference
141  (
144  );
146  //- Construct and return a clone setting internal field reference
148  (
150  ) const
151  {
153  (
155  (
156  *this,
157  iF
158  )
159  );
160  }
161 
163  // Member functions
164 
165  // Evaluation functions
166 
167  //- Return the current modelled pressure field on the patch faces
168  tmp<scalarField> p() const;
169 
170  //- Return the current modelled pressure field in the neighbour cell
171  tmp<scalarField> pn() const;
172 
173  //- Update the coefficients associated with the patch field
174  virtual void updateCoeffs();
175 
176 
177  //- Write
178  virtual void write(Ostream&) const;
179 };
180 
181 
182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183 
184 } // End namespace Foam
185 
186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
187 
188 
189 #endif
190 
191 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
tmp< scalarField > p() const
Return the current modelled pressure field on the patch faces.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
virtual void write(Ostream &) const
Write.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("wavePressure")
Runtime type information.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
wavePressureFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
tmp< scalarField > pn() const
Return the current modelled pressure field in the neighbour cell.
A class for managing temporary objects.
Definition: PtrList.H:53
This boundary condition provides a wavePressure condition. This sets the pressure to a value specifie...
Namespace for OpenFOAM.