fixedInternalValueFvPatchField.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-2019 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 Description
28  This boundary condition provides a mechanism to set boundary (cell) values
29  directly into a matrix, i.e. to set a constraint condition. Default
30  behaviour is to act as a zero gradient condition.
31 
32 Usage
33  Example of the boundary condition specification:
34  \verbatim
35  <patchName>
36  {
37  type fixedInternalValue;
38  value uniform 0; // place holder
39  }
40  \endverbatim
41 
42 Note
43  This is used as a base for conditions such as the turbulence \c epsilon
44  wall function, which applies a near-wall constraint for high Reynolds
45  number flows.
46 
47 See also
48  Foam::epsilonWallFunctionFvPatchScalarField
49 
50 SourceFiles
51  fixedInternalValueFvPatchField.C
52 
53 \*---------------------------------------------------------------------------*/
54 
55 #ifndef fixedInternalValueFvPatchField_H
56 #define fixedInternalValueFvPatchField_H
57 
59 
60 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 
62 namespace Foam
63 {
64 
65 /*---------------------------------------------------------------------------*\
66  Class fixedInternalValueFvPatchField Declaration
67 \*---------------------------------------------------------------------------*/
68 
69 template<class Type>
71 :
72  public zeroGradientFvPatchField<Type>
73 {
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("fixedInternalValue");
79 
80 
81  // Constructors
82 
83  //- Construct from patch and internal field
85  (
86  const fvPatch&,
88  );
89 
90  //- Construct from patch, internal field and dictionary
92  (
93  const fvPatch&,
95  const dictionary&
96  );
97 
98  //- Construct by mapping the given fixedInternalValueFvPatchField<Type>
99  // onto a new patch
101  (
103  const fvPatch&,
105  const fvPatchFieldMapper&
106  );
107 
108  //- Copy constructor
110  (
112  );
113 
114  //- Construct and return a clone
115  virtual tmp<fvPatchField<Type>> clone() const
116  {
117  return tmp<fvPatchField<Type>>
118  (
120  );
121  }
122 
123  //- Copy constructor setting internal field reference
125  (
128  );
129 
130  //- Construct and return a clone setting internal field reference
132  (
134  ) const
135  {
136  return tmp<fvPatchField<Type>>
137  (
139  );
140  }
141 
142 
143  // Member Functions
144 
145  // Evaluation functions
146 
147  //-Manipulate a matrix
148  virtual void manipulateMatrix(fvMatrix<Type>& matrix);
149 };
150 
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 } // End namespace Foam
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 #ifdef NoRepository
160 #endif
161 
162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
163 
164 #endif
165 
166 // ************************************************************************* //
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:158
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:72
This boundary condition applies a zero-gradient condition from the patch internal field onto the patc...
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:53
fixedInternalValueFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual tmp< fvPatchField< Type > > clone() const
Construct and return a clone.
Namespace for OpenFOAM.
TypeName("fixedInternalValue")
Runtime type information.