genericFvPatchField.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) 2011-2012 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::genericFvPatchField
26 
27 Description
28  This boundary condition provides a generic version of the \c calculated
29  condition, useful as a fallback for handling unknown patch types. Not
30  generally applicable as a user-specified condition.
31 
32 SeeAlso
33  Foam::calculatedFvPatchField
34 
35 SourceFiles
36  genericFvPatchField.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef genericFvPatchField_H
41 #define genericFvPatchField_H
42 
43 #include "calculatedFvPatchField.H"
44 #include "HashPtrTable.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class genericFvPatch Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 template<class Type>
57 :
58  public calculatedFvPatchField<Type>
59 {
60  // Private data
61 
62  word actualTypeName_;
63  dictionary dict_;
64 
65  HashPtrTable<scalarField> scalarFields_;
66  HashPtrTable<vectorField> vectorFields_;
67  HashPtrTable<sphericalTensorField> sphericalTensorFields_;
68  HashPtrTable<symmTensorField> symmTensorFields_;
69  HashPtrTable<tensorField> tensorFields_;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("generic");
76 
77 
78  // Constructors
79 
80  //- Construct from patch and internal field
82  (
83  const fvPatch&,
85  );
86 
87  //- Construct from patch, internal field and dictionary
89  (
90  const fvPatch&,
92  const dictionary&
93  );
94 
95  //- Construct by mapping given patchField<Type> onto a new patch
97  (
99  const fvPatch&,
101  const fvPatchFieldMapper&
102  );
103 
104  //- Construct as copy
106  (
108  );
109 
110  //- Construct and return a clone
111  virtual tmp<fvPatchField<Type> > clone() const
112  {
113  return tmp<fvPatchField<Type> >
114  (
115  new genericFvPatchField<Type>(*this)
116  );
117  }
118 
119  //- Construct as copy setting internal field reference
121  (
124  );
125 
126  //- Construct and return a clone setting internal field reference
128  (
130  ) const
131  {
132  return tmp<fvPatchField<Type> >
133  (
134  new genericFvPatchField<Type>(*this, iF)
135  );
136  }
137 
138 
139  // Member functions
140 
141  // Mapping functions
142 
143  //- Map (and resize as needed) from self given a mapping object
144  virtual void autoMap
145  (
146  const fvPatchFieldMapper&
147  );
148 
149  //- Reverse map the given fvPatchField onto this fvPatchField
150  virtual void rmap
151  (
152  const fvPatchField<Type>&,
153  const labelList&
154  );
155 
156 
157  // Evaluation functions
158 
159  //- Return the matrix diagonal coefficients corresponding to the
160  // evaluation of the value of this patchField with given weights
162  (
163  const tmp<scalarField>&
164  ) const;
165 
166  //- Return the matrix source coefficients corresponding to the
167  // evaluation of the value of this patchField with given weights
169  (
170  const tmp<scalarField>&
171  ) const;
172 
173  //- Return the matrix diagonal coefficients corresponding to the
174  // evaluation of the gradient of this patchField
176 
177  //- Return the matrix source coefficients corresponding to the
178  // evaluation of the gradient of this patchField
180 
181 
182  //- Write
183  virtual void write(Ostream&) const;
184 };
185 
186 
187 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
188 
189 } // End namespace Foam
190 
191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 
193 #ifdef NoRepository
194 # include "genericFvPatchField.C"
195 #endif
196 
197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
198 
199 #endif
200 
201 // ************************************************************************* //
This boundary condition is not designed to be evaluated; it is assmued that the value is assigned via...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
genericFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
A class for handling words, derived from string.
Definition: word.H:59
Foam::fvPatchFieldMapper.
TypeName("generic")
Runtime type information.
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
This boundary condition provides a generic version of the calculated condition, useful as a fallback ...
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:65
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
virtual void write(Ostream &) const
Write.
A class for managing temporary objects.
Definition: PtrList.H:118
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
A HashTable specialization for hashing pointers.
Definition: HashPtrTable.H:50