genericFvPatchField.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) 2011-2022 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 See also
33  Foam::calculatedFvPatchField
34 
35 SourceFiles
36  genericFvPatchField.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef genericFvPatchField_H
41 #define genericFvPatchField_H
42 
43 #include "genericPatchField.H"
44 #include "calculatedFvPatchField.H"
45 #include "HashPtrTable.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class genericFvPatch Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 template<class Type>
58 :
59  public genericPatchField,
60  public calculatedFvPatchField<Type>
61 {
62  // Private Data
63 
64  dictionary dict_;
65 
66  HashPtrTable<scalarField> scalarFields_;
67  HashPtrTable<vectorField> vectorFields_;
68  HashPtrTable<sphericalTensorField> sphericalTensorFields_;
69  HashPtrTable<symmTensorField> symmTensorFields_;
70  HashPtrTable<tensorField> tensorFields_;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("generic");
77 
78 
79  // Constructors
80 
81  //- Construct from patch and internal field
83  (
84  const fvPatch&,
86  );
87 
88  //- Construct from patch, internal field and dictionary
90  (
91  const fvPatch&,
93  const dictionary&
94  );
95 
96  //- Construct by mapping given patchField<Type> onto a new patch
98  (
100  const fvPatch&,
102  const fvPatchFieldMapper&
103  );
104 
105  //- Disallow copy without setting internal field reference
107 
108  //- Copy constructor setting internal field reference
110  (
113  );
114 
115  //- Construct and return a clone setting internal field reference
117  (
119  ) const
120  {
121  return tmp<fvPatchField<Type>>
122  (
123  new genericFvPatchField<Type>(*this, iF)
124  );
125  }
126 
127 
128  // Member Functions
129 
130  // Mapping functions
131 
132  //- Map (and resize as needed) from self given a mapping object
133  // Used to update fields following mesh topology change
134  virtual void autoMap(const fvPatchFieldMapper&);
135 
136  //- Reverse map the given fvPatchField onto this fvPatchField
137  // Used to reconstruct fields
138  virtual void rmap(const fvPatchField<Type>&, const labelList&);
139 
140  //- Reset the fvPatchField to the given fvPatchField
141  // Used for mesh to mesh mapping
142  virtual void reset(const fvPatchField<Type>&);
143 
144 
145  // Evaluation functions
146 
147  //- Return the matrix diagonal coefficients corresponding to the
148  // evaluation of the value of this patchField with given weights
150  (
151  const tmp<scalarField>&
152  ) const;
153 
154  //- Return the matrix source coefficients corresponding to the
155  // evaluation of the value of this patchField with given weights
157  (
158  const tmp<scalarField>&
159  ) const;
160 
161  //- Return the matrix diagonal coefficients corresponding to the
162  // evaluation of the gradient of this patchField
164 
165  //- Return the matrix source coefficients corresponding to the
166  // evaluation of the gradient of this patchField
168 
169 
170  //- Write
171  virtual void write(Ostream&) const;
172 };
173 
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 } // End namespace Foam
178 
179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 
181 #ifdef NoRepository
182  #include "genericFvPatchField.C"
183 #endif
184 
185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
186 
187 #endif
188 
189 // ************************************************************************* //
tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
TypeName("generic")
Runtime type information.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
This boundary condition provides a generic version of the calculated condition, useful as a fallback ...
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
virtual void write(Ostream &) const
Write.
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
A HashTable specialisation for hashing pointers.
Definition: HashPtrTable.H:50
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
virtual void reset(const fvPatchField< Type > &)
Reset the fvPatchField to the given fvPatchField.
Foam::fvPatchFieldMapper.
tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
genericFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
This boundary condition is not designed to be evaluated; it is assumed that the value is assigned via...
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
A class for managing temporary objects.
Definition: PtrList.H:53
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:199
Namespace for OpenFOAM.