FreeFOAM The Cross-Platform CFD Toolkit
freestreamFvPatchField.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-2010 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::freestreamFvPatchField
26 
27 Description
28  Foam::freestreamFvPatchField
29 
30 SourceFiles
31  freestreamFvPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef freestreamFvPatchField_H
36 #define freestreamFvPatchField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class freestreamFvPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
51 :
52  public inletOutletFvPatchField<Type>
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("freestream");
59 
60 
61  // Constructors
62 
63  //- Construct from patch and internal field
65  (
66  const fvPatch&,
68  );
69 
70  //- Construct from patch, internal field and dictionary
72  (
73  const fvPatch&,
75  const dictionary&
76  );
77 
78  //- Construct by mapping given freestreamFvPatchField onto a new patch
80  (
82  const fvPatch&,
84  const fvPatchFieldMapper&
85  );
86 
87  //- Construct as copy
89  (
91  );
92 
93  //- Construct and return a clone
94  virtual tmp<fvPatchField<Type> > clone() const
95  {
96  return tmp<fvPatchField<Type> >
97  (
99  );
100  }
101 
102  //- Construct as copy setting internal field reference
104  (
107  );
108 
109  //- Construct and return a clone setting internal field reference
110  virtual tmp<fvPatchField<Type> > clone
111  (
113  ) const
114  {
115  return tmp<fvPatchField<Type> >
116  (
117  new freestreamFvPatchField<Type>(*this, iF)
118  );
119  }
120 
121 
122  // Member functions
123 
124  // Return defining fields
125 
127  {
128  return this->refValue();
129  }
130 
132  {
133  return this->refValue();
134  }
135 
136 
137  //- Write
138  virtual void write(Ostream&) const;
139 };
140 
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #ifdef NoRepository
150 #endif
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #endif
155 
156 // ************************ vim: set sw=4 sts=4 et: ************************ //