internalFvsPatchField.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) 2021-2023 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::internalFvsPatchField
26 
27 Description
28  Constraint fvsPatchField to hold values for internal face exposed by
29  sub-setting.
30 
31 SourceFiles
32  internalFvsPatchField.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef internalFvsPatchField_H
37 #define internalFvsPatchField_H
38 
39 #include "fvsPatchField.H"
40 #include "internalFvPatch.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class internalFvsPatch Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type>
53 :
54  public fvsPatchField<Type>
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName(internalFvPatch::typeName_());
61 
62 
63  // Constructors
64 
65  //- Construct from patch and internal field
67  (
68  const fvPatch&,
70  );
71 
72  //- Construct from patch, internal field and dictionary
74  (
75  const fvPatch&,
77  const dictionary&
78  );
79 
80  //- Construct by mapping given internalFvsPatchField onto a new patch
82  (
84  const fvPatch&,
86  const fieldMapper&
87  );
88 
89  //- Disallow copy without setting internal field reference
91 
92  //- Copy constructor setting internal field reference
94  (
97  );
98 
99  //- Construct and return a clone setting internal field reference
101  (
103  ) const
104  {
106  (
107  new internalFvsPatchField<Type>(*this, iF)
108  );
109  }
110 
111 
112  // Member Functions
113 
114  //- Write
115  virtual void write(Ostream&) const;
116 };
117 
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #ifdef NoRepository
126  #include "internalFvsPatchField.C"
127 #endif
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:83
tmp< fvsPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Constraint fvsPatchField to hold values for internal face exposed by sub-setting.
virtual void write(Ostream &) const
Write.
internalFvsPatchField(const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
Construct from patch and internal field.
TypeName(internalFvPatch::typeName_())
Runtime type information.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.