surfaceNormalUniformFixedValueFvPatchVectorField.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) 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::surfaceNormalUniformFixedValueFvPatchVectorField
26 
27 Description
28  Surface-normal fixed value vector boundary condition
29 
30  in which the vector field is obtained by scaling the patch normals
31  by the evaluated scalar Function1 provided.
32 
33 Usage
34  \table
35  Property | Description | Required | Default value
36  uniformValue | uniform value | yes |
37  \endtable
38 
39  Example of the boundary condition specification:
40  \verbatim
41  <patchName>
42  {
43  type surfaceNormalUniformFixedValue;
44  uniformValue constant -0.2; // 0.2 INTO the domain
45  }
46  \endverbatim
47 
48 Note
49  Sign conventions:
50  - the value is positive for outward-pointing vectors
51 
52 See also
53  Foam::fixedValueFvPatchField
54 
55 SourceFiles
56  surfaceNormalUniformFixedValueFvPatchVectorField.C
57 
58 \*---------------------------------------------------------------------------*/
59 
60 #ifndef surfaceNormalUniformFixedValueFvPatchVectorField_H
61 #define surfaceNormalUniformFixedValueFvPatchVectorField_H
62 
64 #include "Function1.H"
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 namespace Foam
69 {
70 
71 /*---------------------------------------------------------------------------*\
72  Class surfaceNormalUniformFixedValueFvPatchVectorField Declaration
73 \*---------------------------------------------------------------------------*/
74 
75 class surfaceNormalUniformFixedValueFvPatchVectorField
76 :
77  public fixedValueFvPatchVectorField
78 {
79  // Private Data
80 
81  autoPtr<Function1<scalar>> uniformValue_;
82 
83 
84 public:
85 
86  //- Runtime type information
87  TypeName("surfaceNormalUniformFixedValue");
88 
89 
90  // Constructors
91 
92  //- Construct from patch and internal field
94  (
95  const fvPatch&,
97  );
98 
99  //- Construct from patch, internal field and dictionary
101  (
102  const fvPatch&,
104  const dictionary&
105  );
106 
107  //- Construct by mapping given
108  // surfaceNormalUniformFixedValueFvPatchVectorField
109  // onto a new patch
111  (
113  const fvPatch&,
115  const fvPatchFieldMapper&
116  );
117 
118  //- Copy constructor
120  (
122  );
123 
124  //- Construct and return a clone
125  virtual tmp<fvPatchVectorField> clone() const
126  {
128  (
130  );
131  }
132 
133  //- Copy constructor setting internal field reference
135  (
138  );
139 
140  //- Construct and return a clone setting internal field reference
142  (
144  ) const
145  {
147  (
149  (
150  *this,
151  iF
152  )
153  );
154  }
155 
156 
157  // Member Functions
158 
159  // Evaluation functions
160 
161  //- Update the coefficients associated with the patch field
162  virtual void updateCoeffs();
163 
164 
165  //- Write
166  virtual void write(Ostream&) const;
167 };
168 
169 
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
171 
172 } // End namespace Foam
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 #endif
177 
178 // ************************************************************************* //
TypeName("surfaceNormalUniformFixedValue")
Runtime type information.
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
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
surfaceNormalUniformFixedValueFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.