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