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