All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
emptyFvPatchField.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-2021 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::emptyFvPatchField
26 
27 Description
28  This boundary condition provides an 'empty' condition for reduced
29  dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to
30  patches whose normal is aligned to geometric directions that do not
31  constitue solution directions.
32 
33 Usage
34  Example of the boundary condition specification:
35  \verbatim
36  <patchName>
37  {
38  type empty;
39  }
40  \endverbatim
41 
42 SourceFiles
43  emptyFvPatchField.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef emptyFvPatchField_H
48 #define emptyFvPatchField_H
49 
50 #include "fvPatchField.H"
51 #include "emptyFvPatch.H"
52 
53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
54 
55 namespace Foam
56 {
57 
58 /*---------------------------------------------------------------------------*\
59  Class emptyFvPatchField Declaration
60 \*---------------------------------------------------------------------------*/
61 
62 template<class Type>
64 :
65  public fvPatchField<Type>
66 {
67 
68 public:
69 
70  //- Runtime type information
71  TypeName(emptyFvPatch::typeName_());
72 
73 
74  // Constructors
75 
76  //- Construct from patch and internal field
78  (
79  const fvPatch&,
81  );
82 
83  //- Construct from patch, internal field and dictionary
85  (
86  const fvPatch&,
88  const dictionary&
89  );
90 
91  //- Construct by mapping given emptyFvPatchField onto a new patch
93  (
95  const fvPatch&,
97  const fvPatchFieldMapper&
98  );
99 
100  //- Disallow copy without setting internal field reference
102 
103  //- Copy constructor setting internal field reference
105  (
108  );
109 
110  //- Construct and return a clone setting internal field reference
112  (
114  ) const
115  {
116  return tmp<fvPatchField<Type>>
117  (
118  new emptyFvPatchField<Type>(*this, iF)
119  );
120  }
121 
122 
123  // Member Functions
124 
125  // Mapping functions
126 
127  //- Map (and resize as needed) from self given a mapping object
128  // Used to update fields following mesh topology change
129  virtual void autoMap( const fvPatchFieldMapper&)
130  {}
131 
132  //- Reverse map the given fvPatchField onto this fvPatchField
133  // Used to reconstruct fields
134  virtual void rmap(const fvPatchField<Type>&, const labelList&)
135  {}
136 
137 
138  // Evaluation functions
139 
140  //- Return the matrix diagonal coefficients corresponding to the
141  // evaluation of the value of this patchField with given weights
143  (
144  const tmp<scalarField>&
145  ) const
146  {
147  return tmp<Field<Type>>(new Field<Type>(0));
148  }
149 
150  //- Return the matrix source coefficients corresponding to the
151  // evaluation of the value of this patchField with given weights
153  (
154  const tmp<scalarField>&
155  ) const
156  {
157  return tmp<Field<Type>>(new Field<Type>(0));
158  }
159 
160  //- Return the matrix diagonal coefficients corresponding to the
161  // evaluation of the gradient of this patchField
163  {
164  return tmp<Field<Type>>(new Field<Type>(0));
165  }
166 
167  //- Return the matrix source coefficients corresponding to the
168  // evaluation of the gradient of this patchField
170  {
171  return tmp<Field<Type>>(new Field<Type>(0));
172  }
173 };
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #ifdef NoRepository
183  #include "emptyFvPatchField.C"
184 #endif
185 
186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
187 
188 #endif
189 
190 // ************************************************************************* //
TypeName(emptyFvPatch::typeName_())
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Pre-declare SubField and related Field type.
Definition: Field.H:56
emptyFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
Foam::fvPatchFieldMapper.
tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
This boundary condition provides an &#39;empty&#39; condition for reduced dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to patches whose normal is aligned to geometric directions that do not constitue solution directions.
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.