zeroGradientFvPatchField.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::zeroGradientFvPatchField
26 
27 Group
28  grpGenericBoundaryConditions
29 
30 Description
31  This boundary condition applies a zero-gradient condition from the patch
32  internal field onto the patch faces.
33 
34  \heading Patch usage
35 
36  Example of the boundary condition specification:
37  \verbatim
38  myPatch
39  {
40  type zeroGradient;
41  }
42  \endverbatim
43 
44 SourceFiles
45  zeroGradientFvPatchField.C
46 
47 \*---------------------------------------------------------------------------*/
48 
49 #ifndef zeroGradientFvPatchField_H
50 #define zeroGradientFvPatchField_H
51 
52 #include "fvPatchField.H"
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 
59 /*---------------------------------------------------------------------------*\
60  Class zeroGradientFvPatchField Declaration
61 \*---------------------------------------------------------------------------*/
62 
63 template<class Type>
65 :
66  public fvPatchField<Type>
67 {
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("zeroGradient");
73 
74 
75  // Constructors
76 
77  //- Construct from patch and internal field
79  (
80  const fvPatch&,
82  );
83 
84  //- Construct from patch, internal field and dictionary
86  (
87  const fvPatch&,
89  const dictionary&
90  );
91 
92  //- Construct by mapping the given zeroGradientFvPatchField<Type>
93  // onto a new patch
95  (
97  const fvPatch&,
99  const fvPatchFieldMapper&
100  );
101 
102  //- Construct as copy
104  (
106  );
107 
108  //- Construct and return a clone
109  virtual tmp<fvPatchField<Type> > clone() const
110  {
111  return tmp<fvPatchField<Type> >
112  (
114  );
115  }
116 
117  //- Construct as copy setting internal field reference
119  (
122  );
123 
124  //- Construct and return a clone setting internal field reference
126  (
128  ) const
129  {
130  return tmp<fvPatchField<Type> >
131  (
132  new zeroGradientFvPatchField<Type>(*this, iF)
133  );
134  }
135 
136 
137  // Member functions
138 
139  // Evaluation functions
140 
141  //- Return gradient at boundary
142  virtual tmp<Field<Type> > snGrad() const
143  {
144  return tmp<Field<Type> >
145  (
146  new Field<Type>(this->size(), pTraits<Type>::zero)
147  );
148  }
149 
150  //- Evaluate the patch field
151  virtual void evaluate
152  (
153  const Pstream::commsTypes commsType=Pstream::blocking
154  );
155 
156  //- Return the matrix diagonal coefficients corresponding to the
157  // evaluation of the value of this patchField with given weights
159  (
160  const tmp<scalarField>&
161  ) const;
162 
163  //- Return the matrix source coefficients corresponding to the
164  // evaluation of the value of this patchField with given weights
166  (
167  const tmp<scalarField>&
168  ) const;
169 
170  //- Return the matrix diagonal coefficients corresponding to the
171  // evaluation of the gradient of this patchField
172  virtual tmp<Field<Type> > gradientInternalCoeffs() const;
173 
174  //- Return the matrix source coefficients corresponding to the
175  // evaluation of the gradient of this patchField
176  virtual tmp<Field<Type> > gradientBoundaryCoeffs() const;
177 };
178 
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 } // End namespace Foam
183 
184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
185 
186 #ifdef NoRepository
187 # include "zeroGradientFvPatchField.C"
188 #endif
189 
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191 
192 #endif
193 
194 // ************************************************************************* //
TypeName("zeroGradient")
Runtime type information.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
zeroGradientFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::blocking)
Evaluate the patch field.
Namespace for OpenFOAM.
This boundary condition applies a zero-gradient condition from the patch internal field onto the patc...
virtual tmp< Field< Type > > valueBoundaryCoeffs(const tmp< scalarField > &) const
Return the matrix source coefficients corresponding to the.
commsTypes
Types of communications.
Definition: UPstream.H:64
virtual tmp< Field< Type > > gradientInternalCoeffs() 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
Pre-declare SubField and related Field type.
Definition: Field.H:57
virtual tmp< Field< Type > > valueInternalCoeffs(const tmp< scalarField > &) const
Return the matrix diagonal coefficients corresponding to the.
Traits class for primitives.
Definition: pTraits.H:50
label size() const
Return the number of elements in the UList.
virtual tmp< Field< Type > > gradientBoundaryCoeffs() const
Return the matrix source coefficients corresponding to the.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
virtual tmp< Field< Type > > snGrad() const
Return gradient at boundary.
A class for managing temporary objects.
Definition: PtrList.H:118