calculatedFvsPatchField.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-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::calculatedFvsPatchField
26 
27 Description
28  Foam::calculatedFvsPatchField
29 
30 SourceFiles
31  calculatedFvsPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef calculatedFvsPatchField_H
36 #define calculatedFvsPatchField_H
37 
38 #include "fvsPatchField.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class calculatedFvsPatch Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class Type>
51 :
52  public fvsPatchField<Type>
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("calculated");
59 
60 
61  // Constructors
62 
63  //- Construct from patch and internal field
65  (
66  const fvPatch&,
68  );
69 
70  //- Construct from patch, internal field and dictionary
72  (
73  const fvPatch&,
75  const dictionary&
76  );
77 
78  //- Construct by mapping given patchField<Type> onto a new patch
80  (
82  const fvPatch&,
84  const fvPatchFieldMapper&
85  );
86 
87  //- Disallow copy without setting internal field reference
89 
90  //- Copy constructor setting internal field reference
92  (
95  );
96 
97  //- Construct and return a clone setting internal field reference
99  (
101  ) const
102  {
104  (
105  new calculatedFvsPatchField<Type>(*this, iF)
106  );
107  }
108 
109  // Member Functions
110 
111  //- Write
112  virtual void write(Ostream&) const;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #ifdef NoRepository
123  #include "calculatedFvsPatchField.C"
124 #endif
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #endif
129 
130 // ************************************************************************* //
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
Foam::calculatedFvsPatchField.
virtual void write(Ostream &) const
Write.
calculatedFvsPatchField(const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
Construct from patch and internal field.
TypeName("calculated")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
Foam::fvPatchFieldMapper.
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:82
tmp< fvsPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.