extrapolatedCalculatedFvPatchField.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) 2016-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::extrapolatedCalculatedFvPatchField
26 
27 Description
28  This boundary condition applies a zero-gradient condition from the patch
29  internal field onto the patch faces when \c evaluated but may also be
30  assigned. \c snGrad returns the patch gradient evaluated from the current
31  internal and patch field values rather than returning zero.
32 
33 Usage
34  Example of the boundary condition specification:
35  \verbatim
36  <patchName>
37  {
38  type extrapolatedCalculated;
39  }
40  \endverbatim
41 
42 SourceFiles
43  extrapolatedCalculatedFvPatchField.C
44 
45 \*---------------------------------------------------------------------------*/
46 
47 #ifndef extrapolatedCalculatedFvPatchField_H
48 #define extrapolatedCalculatedFvPatchField_H
49 
50 #include "calculatedFvPatchField.H"
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 /*---------------------------------------------------------------------------*\
58  Class extrapolatedCalculatedFvPatchField Declaration
59 \*---------------------------------------------------------------------------*/
60 
61 template<class Type>
63 :
64  public calculatedFvPatchField<Type>
65 {
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("extrapolatedCalculated");
71 
72 
73  // Constructors
74 
75  //- Construct from patch and internal field
77  (
78  const fvPatch&,
80  );
81 
82  //- Construct from patch, internal field and dictionary
84  (
85  const fvPatch&,
87  const dictionary&
88  );
89 
90  //- Construct by mapping given patchField<Type> onto a new patch
92  (
94  const fvPatch&,
96  const fieldMapper&
97  );
98 
99  //- Disallow copy without setting internal field reference
101  (
103  ) = delete;
104 
105  //- Copy constructor setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone setting internal field reference
114  (
116  ) const
117  {
118  return tmp<fvPatchField<Type>>
119  (
121  );
122  }
123 
124 
125  // Member Functions
126 
127  // Mapping functions
128 
129  //- Map the given fvPatchField onto this fvPatchField
130  virtual void map(const fvPatchField<Type>&, const fieldMapper&);
131 
132 
133  // Evaluation functions
134 
135  //- Evaluate the patch field
136  virtual void evaluate
137  (
138  const Pstream::commsTypes commsType =
140  );
141 };
142 
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 } // End namespace Foam
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 #ifdef NoRepository
152 #endif
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
156 #endif
157 
158 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
commsTypes
Types of communications.
Definition: UPstream.H:65
This boundary condition is not designed to be evaluated; it is assumed that the value is assigned via...
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
This boundary condition applies a zero-gradient condition from the patch internal field onto the patc...
extrapolatedCalculatedFvPatchField(const fvPatch &, const DimensionedField< Type, volMesh > &)
Construct from patch and internal field.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
TypeName("extrapolatedCalculated")
Runtime type information.
virtual void map(const fvPatchField< Type > &, const fieldMapper &)
Map the given fvPatchField onto this fvPatchField.
Abstract base class for field mapping.
Definition: fieldMapper.H:48
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:88
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:204
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.