FreeFOAM The Cross-Platform CFD Toolkit
SRFVelocityFvPatchVectorField.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) 1991-2011 OpenCFD Ltd.
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::SRFVelocityFvPatchVectorField
26 
27 Description
28  Velocity patch to be used with SRF model
29 
30 SourceFiles
31  SRFVelocityFvPatchVectorField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef SRFVelocityFvPatchVectorField_H
36 #define SRFVelocityFvPatchVectorField_H
37 
39 #include <OpenFOAM/Switch.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class SRFVelocityFvPatchVectorField Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public fixedValueFvPatchVectorField
53 {
54  // Private data
55 
56  //- Is the supplied inlet value already in the SRF
57  Switch relative_;
58 
59  //- Inlet value
60  vectorField inletValue_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("SRFVelocity");
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 SRFVelocityFvPatchVectorField
87  // 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
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  (
126  new SRFVelocityFvPatchVectorField(*this, iF)
127  );
128  }
129 
130 
131  // Member functions
132 
133  // Access
134 
135  //- Return const access to the relative flag
136  const Switch& relative() const
137  {
138  return relative_;
139  }
140 
141 
142  // Mapping functions
143 
144  //- Map (and resize as needed) from self given a mapping object
145  virtual void autoMap
146  (
147  const fvPatchFieldMapper&
148  );
149 
150  //- Reverse map the given fvPatchField onto this fvPatchField
151  virtual void rmap
152  (
153  const fvPatchVectorField&,
154  const labelList&
155  );
156 
157 
158  // Evaluation functions
159 
160  //- Update the coefficients associated with the patch field
161  virtual void updateCoeffs();
162 
163 
164  //- Write
165  virtual void write(Ostream&) const;
166 };
167 
168 
169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
170 
171 } // End namespace Foam
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 #endif
176 
177 // ************************ vim: set sw=4 sts=4 et: ************************ //