mappedVelocityFluxFixedValueFvPatchField.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::mappedVelocityFluxFixedValueFvPatchField
26 
27 Description
28  This boundary condition maps the velocity and flux from a neighbour patch
29  to this patch
30 
31 Usage
32  \table
33  Property | Description | Required | Default value
34  phi | flux field name | no | phi
35  \endtable
36 
37  Example of the boundary condition specification:
38  \verbatim
39  <patchName>
40  {
41  type mappedVelocityFlux;
42  phi phi;
43  value uniform 0; // place holder
44  }
45  \endverbatim
46 
47  The underlying sample mode should be set to \c nearestPatchFace or
48  \c nearestFace
49 
50 Note
51  This boundary condition can only be applied to patches that are of
52  the \c mappedPolyPatch type.
53 
54 See also
55  Foam::mappedPatchBase
56  Foam::mappedPolyPatch
57  Foam::mappedFvPatch
58  Foam::fixedValueFvPatchVectorField
59 
60 SourceFiles
61  mappedVelocityFluxFixedValueFvPatchField.C
62 
63 \*---------------------------------------------------------------------------*/
64 
65 #ifndef mappedVelocityFluxFixedValueFvPatchField_H
66 #define mappedVelocityFluxFixedValueFvPatchField_H
67 
69 #include "mappedFvPatch.H"
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 namespace Foam
74 {
75 
76 /*---------------------------------------------------------------------------*\
77  Class mappedVelocityFluxFixedValueFvPatch Declaration
78 \*---------------------------------------------------------------------------*/
79 
80 class mappedVelocityFluxFixedValueFvPatchField
81 :
82  public fixedValueFvPatchVectorField
83 {
84  // Private Data
85 
86  //- Name of flux field
87  word phiName_;
88 
89 public:
90 
91  //- Runtime type information
92  TypeName("mappedVelocityFlux");
93 
94 
95  // Constructors
96 
97  //- Construct from patch and internal field
99  (
100  const fvPatch&,
102  );
103 
104  //- Construct from patch, internal field and dictionary
106  (
107  const fvPatch&,
109  const dictionary&
110  );
111 
112  //- Construct by mapping given
113  // mappedVelocityFluxFixedValueFvPatchField
114  // onto a new patch
116  (
118  const fvPatch&,
120  const fvPatchFieldMapper&
121  );
122 
123  //- Copy constructor
125  (
127  );
128 
129  //- Construct and return a clone
130  virtual tmp<fvPatchVectorField> clone() const
131  {
133  (
135  );
136  }
137 
138  //- Copy constructor setting internal field reference
140  (
143  );
144 
145  //- Construct and return a clone setting internal field reference
147  (
149  ) const
150  {
152  (
154  );
155  }
157 
158  // Member Functions
159 
160  // Evaluation functions
161 
162  //- Update the coefficients associated with the patch field
163  virtual void updateCoeffs();
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 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
mappedVelocityFluxFixedValueFvPatchField(const fvPatch &, const DimensionedField< vector, volMesh > &)
Construct from patch and internal field.
This boundary condition maps the velocity and flux from a neighbour patch to this patch...
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Foam::fvPatchFieldMapper.
virtual tmp< fvPatchVectorField > clone() const
Construct and return a clone.
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
TypeName("mappedVelocityFlux")
Runtime type information.
Namespace for OpenFOAM.