emptyFvPatchField.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::emptyFvPatchField
28 
29 Group
30  grpConstraintBoundaryConditions
31 
32 Description
33  This boundary condition provides an 'empty' condition for reduced
34  dimensions cases, i.e. 1- and 2-D geometries. Apply this condition to
35  patches whose normal is aligned to geometric directions that do not
36  constitue solution directions.
37 
38 Usage
39  Example of the boundary condition specification:
40  \verbatim
41  <patchName>
42  {
43  type empty;
44  }
45  \endverbatim
46 
47 SourceFiles
48  emptyFvPatchField.C
49 
50 \*---------------------------------------------------------------------------*/
51 
52 #ifndef emptyFvPatchField_H
53 #define emptyFvPatchField_H
54 
55 #include "fvPatchField.H"
56 #include "emptyFvPatch.H"
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 namespace Foam
61 {
62 
63 /*---------------------------------------------------------------------------*\
64  Class emptyFvPatchField Declaration
65 \*---------------------------------------------------------------------------*/
66 
67 template<class Type>
69 :
70  public fvPatchField<Type>
71 {
72 
73 public:
74 
75  //- Runtime type information
76  TypeName(emptyFvPatch::typeName_());
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 emptyFvPatchField onto a new patch
98  (
100  const fvPatch&,
102  const fvPatchFieldMapper&
103  );
104 
105  //- Construct as copy
107  (
109  );
110 
111  //- Construct and return a clone
112  virtual tmp<fvPatchField<Type>> clone() const
113  {
114  return tmp<fvPatchField<Type>>
115  (
116  new emptyFvPatchField<Type>(*this)
117  );
118  }
119 
120  //- Construct as copy setting internal field reference
122  (
125  );
126 
127  //- Construct and return a clone setting internal field reference
129  (
131  ) const
132  {
133  return tmp<fvPatchField<Type>>
134  (
135  new emptyFvPatchField<Type>(*this, iF)
136  );
137  }
138 
139 
140  // Member functions
141 
142  // Mapping functions
143 
144  //- Map (and resize as needed) from self given a mapping object
145  virtual void autoMap
146  (
147  const fvPatchFieldMapper&
148  )
149  {}
150 
151  //- Reverse map the given fvPatchField onto this fvPatchField
152  virtual void rmap
153  (
154  const fvPatchField<Type>&,
155  const labelList&
156  )
157  {}
158 
159 
160  // Evaluation functions
161 
162  //- Update the coefficients associated with the patch field
163  // This only checks to see the case is actually 1D or 2D
164  // for which this boundary condition is valid
165  void updateCoeffs();
166 
167 
168  //- Return the matrix diagonal coefficients corresponding to the
169  // evaluation of the value of this patchField with given weights
171  (
172  const tmp<scalarField>&
173  ) const
174  {
175  return tmp<Field<Type>>::New();
176  }
177 
178  //- Return the matrix source coefficients corresponding to the
179  // evaluation of the value of this patchField with given weights
181  (
182  const tmp<scalarField>&
183  ) const
184  {
185  return tmp<Field<Type>>::New();
186  }
187 
188  //- Return the matrix diagonal coefficients corresponding to the
189  // evaluation of the gradient of this patchField
191  {
192  return tmp<Field<Type>>::New();
193  }
194 
195  //- Return the matrix source coefficients corresponding to the
196  // evaluation of the gradient of this patchField
198  {
199  return tmp<Field<Type>>::New();
200  }
201 };
202 
203 
204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
205 
206 } // End namespace Foam
207 
208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
209 
210 #ifdef NoRepository
211  #include "emptyFvPatchField.C"
212 #endif
213 
214 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
215 
216 #endif
217 
218 // ************************************************************************* //
Foam::fvPatchField
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: volSurfaceMapping.H:51
Foam::emptyFvPatchField::updateCoeffs
void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: emptyFvPatchField.C:119
Foam::emptyFvPatchField::valueInternalCoeffs
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Definition: emptyFvPatchField.H:170
Foam::emptyFvPatchField::autoMap
virtual void autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
Definition: emptyFvPatchField.H:145
Foam::emptyFvPatchField::TypeName
TypeName(emptyFvPatch::typeName_())
Runtime type information.
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::emptyFvPatchField::gradientBoundaryCoeffs
tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
Definition: emptyFvPatchField.H:196
Foam::emptyFvPatchField::emptyFvPatchField
emptyFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Definition: emptyFvPatchField.C:35
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::emptyFvPatchField
This boundary condition provides an 'empty' condition for reduced dimensions cases,...
Definition: emptyFvPatchField.H:67
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::emptyFvPatchField::valueBoundaryCoeffs
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
Definition: emptyFvPatchField.H:180
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::emptyFvPatchField::clone
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Definition: emptyFvPatchField.H:111
emptyFvPatch.H
emptyFvPatchField.C
Foam::fvPatchField::New
static tmp< fvPatchField< Type > > New(const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
Return a pointer to a new patchField created on freestore given.
Definition: fvPatchFieldNew.C:88
Foam::emptyFvPatchField::rmap
virtual void rmap(const fvPatchField< Type > &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
Definition: emptyFvPatchField.H:152
Foam::List< label >
Foam::emptyFvPatchField::gradientInternalCoeffs
tmp< Field< Type > > gradientInternalCoeffs() const
Return the matrix diagonal coefficients corresponding to the.
Definition: emptyFvPatchField.H:189
Foam::fvPatchFieldMapper
Foam::fvPatchFieldMapper.
Definition: fvPatchFieldMapper.H:47
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54
fvPatchField.H