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-2020 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  //- Disallow copy without setting internal field reference
100  (
102  ) = delete;
103 
104  //- Copy constructor setting internal field reference
106  (
109  );
110 
111  //- Construct and return a clone setting internal field reference
113  (
115  ) const
116  {
117  return tmp<fvPatchField<Type>>
118  (
119  new zeroGradientFvPatchField<Type>(*this, iF)
120  );
121  }
122 
123 
124  // Member Functions
125 
126  // Evaluation functions
127 
128  //- Return gradient at boundary
129  virtual tmp<Field<Type>> snGrad() const
130  {
131  return tmp<Field<Type>>
132  (
133  new Field<Type>(this->size(), Zero)
134  );
135  }
136 
137  //- Evaluate the patch field
138  virtual void evaluate
139  (
140  const Pstream::commsTypes commsType =
142  );
143 
144  //- Return the matrix diagonal coefficients corresponding to the
145  // evaluation of the value of this patchField with given weights
147  (
148  const tmp<scalarField>&
149  ) const;
150 
151  //- Return the matrix source coefficients corresponding to the
152  // evaluation of the value of this patchField with given weights
154  (
155  const tmp<scalarField>&
156  ) const;
157 
158  //- Return the matrix diagonal coefficients corresponding to the
159  // evaluation of the gradient of this patchField
160  virtual tmp<Field<Type>> gradientInternalCoeffs() const;
161 
162  //- Return the matrix source coefficients corresponding to the
163  // evaluation of the gradient of this patchField
164  virtual tmp<Field<Type>> gradientBoundaryCoeffs() const;
165 };
166 
167 
168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
169 
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 #ifdef NoRepository
175  #include "zeroGradientFvPatchField.C"
176 #endif
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 #endif
181 
182 // ************************************************************************* //
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:156
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:62
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:56
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...
A class for managing temporary objects.
Definition: PtrList.H:53
label size() const
Return the number of elements in the UList.
Definition: ListI.H:171
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:199
Namespace for OpenFOAM.