All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
waveInletOutletFvPatchField.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) 2019 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::waveInletOutletFvPatchField
26 
27 Description
28  This boundary condition provides an inlet-outlet condition with differing
29  inlet values on either side of a wave interface. All the wave modelling
30  parameters are obtained from a centrally registered waveSuperposition
31  class.
32 
33 Usage
34  \table
35  Property | Description | Req'd? | Default
36  phi | Name of the flux field | no | phi
37  inletValueAbove | inlet value above the wave | no | None
38  inletValueBelow | inlet value below the wave | no | None
39  \endtable
40 
41  Example of the boundary condition specification:
42  \verbatim
43  <patchName>
44  {
45  type waveInletOutlet;
46  phi phi;
47  inletValueAbove 0.01;
48  inletValueBelow table ((0 0.01) (10 0.1));
49  }
50  \endverbatim
51 
52 See also
53  Foam::waveSuperposition
54 
55 SourceFiles
56  waveInletOutletFvPatchField.C
57 
58 \*---------------------------------------------------------------------------*/
59 
60 #ifndef waveInletOutletFvPatchField_H
61 #define waveInletOutletFvPatchField_H
62 
63 #include "mixedFvPatchField.H"
64 #include "Function1.H"
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 namespace Foam
69 {
70 
71 /*---------------------------------------------------------------------------*\
72  Class waveInletOutletFvPatchField Declaration
73 \*---------------------------------------------------------------------------*/
74 
75 template<class Type>
76 class waveInletOutletFvPatchField
77 :
78  public mixedFvPatchField<Type>
79 {
80  // Private Data
81 
82  //- Inlet value above the wave
83  const autoPtr<Function1<Type>> inletValueAbove_;
84 
85  //- Inlet value below the wave
86  const autoPtr<Function1<Type>> inletValueBelow_;
87 
88  //- Name of flux field
89  const word phiName_;
90 
91 
92 public:
93 
94  //- Runtime type information
95  TypeName("waveInletOutlet");
96 
97 
98  // Constructors
99 
100  //- Construct from patch and internal field
102  (
103  const fvPatch&,
105  );
106 
107  //- Construct from patch, internal field and dictionary
109  (
110  const fvPatch&,
112  const dictionary&
113  );
114 
115  //- Construct by mapping the given field onto a new patch
117  (
119  const fvPatch&,
121  const fvPatchFieldMapper&
122  );
123 
124  //- Copy constructor
126  (
128  );
129 
130  //- Construct and return a clone
131  virtual tmp<fvPatchField<Type>> clone() const
132  {
133  return tmp<fvPatchField<Type>>
134  (
136  );
137  }
138 
139  //- Copy constructor setting internal field reference
141  (
144  );
145 
146  //- Construct and return a clone setting internal field reference
148  (
150  ) const
151  {
152  return tmp<fvPatchField<Type>>
153  (
155  (
156  *this,
157  iF
158  )
159  );
160  }
161 
162 
163  // Member Functions
164 
165  //- Update the coefficients associated with the patch field
166  virtual void updateCoeffs();
168  //- Write
169  virtual void write(Ostream&) const;
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace Foam
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #ifdef NoRepository
181 #endif
182 
183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
184 
185 #endif
186 
187 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
This boundary condition provides an inlet-outlet condition with differing inlet values on either side...
Foam::fvPatchFieldMapper.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
waveInletOutletFvPatchField(const fvPatch &, const DimensionedField< Type, 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...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A class for managing temporary objects.
Definition: PtrList.H:53
TypeName("waveInletOutlet")
Runtime type information.
virtual void write(Ostream &) const
Write.
Namespace for OpenFOAM.