surfaceNormalFixedValueFvPatchVectorField.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::surfaceNormalFixedValueFvPatchVectorField
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 scalar field provided.
32 
33 Usage
34  \table
35  Property | Description | Required | Default value
36  refValue | reference value | yes |
37  \endtable
38 
39  Example of the boundary condition specification:
40  \verbatim
41  <patchName>
42  {
43  type surfaceNormalFixedValue;
44  refValue uniform -10; // 10 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  surfaceNormalFixedValueFvPatchVectorField.C
57 
58 \*---------------------------------------------------------------------------*/
59 
60 #ifndef surfaceNormalFixedValueFvPatchVectorField_H
61 #define surfaceNormalFixedValueFvPatchVectorField_H
62 
63 #include "fvPatchFields.H"
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 namespace Foam
69 {
70 
71 /*---------------------------------------------------------------------------*\
72  Class surfaceNormalFixedValueFvPatchVectorField Declaration
73 \*---------------------------------------------------------------------------*/
74 
75 class surfaceNormalFixedValueFvPatchVectorField
76 :
77  public fixedValueFvPatchVectorField
78 {
79  // Private Data
80 
81  scalarField refValue_;
82 
83 
84 public:
85 
86  //- Runtime type information
87  TypeName("surfaceNormalFixedValue");
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  // surfaceNormalFixedValueFvPatchVectorField
109  // onto a new patch
111  (
113  const fvPatch&,
115  const fvPatchFieldMapper&
116  );
117 
118  //- Disallow copy without setting internal field reference
120  (
122  ) = delete;
123 
124  //- Copy constructor setting internal field reference
126  (
129  );
130 
131  //- Construct and return a clone setting internal field reference
133  (
135  ) const
136  {
138  (
140  (
141  *this,
142  iF
143  )
144  );
145  }
146 
147 
148  // Member Functions
149 
150  // Mapping functions
151 
152  //- Map (and resize as needed) from self given a mapping object
153  // Used to update fields following mesh topology change
154  virtual void autoMap(const fvPatchFieldMapper&);
155 
156  //- Reverse map the given fvPatchField onto this fvPatchField
157  // Used to reconstruct fields
158  virtual void rmap(const fvPatchVectorField&, const labelList&);
159 
160 
161  // Evaluation functions
162 
163  //- Update the coefficients associated with the patch field
164  virtual void updateCoeffs();
165 
166 
167  //- Write
168  virtual void write(Ostream&) const;
169 };
170 
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 } // End namespace Foam
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 #endif
179 
180 // ************************************************************************* //
surfaceNormalFixedValueFvPatchVectorField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual tmp< fvPatchVectorField > clone(const DimensionedField< vector, volMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual void rmap(const fvPatchVectorField &, const labelList &)
Reverse map the given fvPatchField onto this fvPatchField.
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
Surface-normal fixed value vector boundary condition.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Foam::fvPatchFieldMapper.
TypeName("surfaceNormalFixedValue")
Runtime type information.
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 autoMap(const fvPatchFieldMapper &)
Map (and resize as needed) from self given a mapping object.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.