fixedInternalValueFvPatchField.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-2016 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::fixedInternalValueFvPatchField
26 
27 Group
28  grpGenericBoundaryConditions
29 
30 Description
31  This boundary condition provides a mechanism to set boundary (cell) values
32  directly into a matrix, i.e. to set a constraint condition. Default
33  behaviour is to act as a zero gradient condition.
34 
35 Usage
36  Example of the boundary condition specification:
37  \verbatim
38  <patchName>
39  {
40  type fixedInternalValue;
41  value uniform 0; // place holder
42  }
43  \endverbatim
44 
45 Note
46  This is used as a base for conditions such as the turbulence \c epsilon
47  wall function, which applies a near-wall constraint for high Reynolds
48  number flows.
49 
50 See also
51  Foam::epsilonWallFunctionFvPatchScalarField
52 
53 SourceFiles
54  fixedInternalValueFvPatchField.C
55 
56 \*---------------------------------------------------------------------------*/
57 
58 #ifndef fixedInternalValueFvPatchField_H
59 #define fixedInternalValueFvPatchField_H
60 
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 namespace Foam
66 {
67 
68 /*---------------------------------------------------------------------------*\
69  Class fixedInternalValueFvPatchField Declaration
70 \*---------------------------------------------------------------------------*/
71 
72 template<class Type>
74 :
75  public zeroGradientFvPatchField<Type>
76 {
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("fixedInternalValue");
82 
83 
84  // Constructors
85 
86  //- Construct from patch and internal field
88  (
89  const fvPatch&,
91  );
92 
93  //- Construct from patch, internal field and dictionary
95  (
96  const fvPatch&,
98  const dictionary&
99  );
100 
101  //- Construct by mapping the given fixedInternalValueFvPatchField<Type>
102  // onto a new patch
104  (
106  const fvPatch&,
108  const fvPatchFieldMapper&
109  );
110 
111  //- Construct as copy
113  (
115  );
116 
117  //- Construct and return a clone
118  virtual tmp<fvPatchField<Type>> clone() const
119  {
120  return tmp<fvPatchField<Type>>
121  (
123  );
124  }
125 
126  //- Construct as copy setting internal field reference
128  (
131  );
132 
133  //- Construct and return a clone setting internal field reference
135  (
137  ) const
138  {
139  return tmp<fvPatchField<Type>>
140  (
142  );
143  }
144 
145 
146  // Member functions
147 
148  // Evaluation functions
149 
150  //-Manipulate a matrix
151  virtual void manipulateMatrix(fvMatrix<Type>& matrix);
152 };
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #ifdef NoRepository
163 #endif
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #endif
168 
169 // ************************************************************************* //
This boundary condition provides a mechanism to set boundary (cell) values directly into a matrix...
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: fvPatchField.H:71
This boundary condition applies a zero-gradient condition from the patch internal field onto the patc...
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
virtual void manipulateMatrix(fvMatrix< Type > &matrix)
Manipulate a matrix.
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:54
fixedInternalValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.
TypeName("fixedInternalValue")
Runtime type information.