coupledFvsPatchField.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-2018 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::coupledFvsPatchField
26 
27 Description
28  Foam::coupledFvsPatchField
29 
30 SourceFiles
31  coupledFvsPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef coupledFvsPatchField_H
36 #define coupledFvsPatchField_H
37 
38 #include "fvsPatchField.H"
39 #include "coupledFvPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class coupledFvsPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public fvsPatchField<Type>
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName(coupledFvPatch::typeName_());
60 
61 
62  // Constructors
63 
64  //- Construct from patch and internal field
66  (
67  const fvPatch&,
69  );
70 
71  //- Construct from patch and internal field and patch field
73  (
74  const fvPatch&,
76  const Field<Type>&
77  );
78 
79  //- Construct from patch, internal field and dictionary
81  (
82  const fvPatch&,
84  const dictionary&
85  );
86 
87  //- Construct by mapping the given coupledFvsPatchField onto a new patch
89  (
91  const fvPatch&,
93  const fvPatchFieldMapper&
94  );
95 
96  //- Construct as copy
98  (
100  );
101 
102  //- Construct and return a clone
103  virtual tmp<fvsPatchField<Type>> clone() const = 0;
104 
105  //- Construct as copy setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone
114  (
116  ) const = 0;
117 
118 
119  // Member functions
120 
121  // Access
122 
123  //- Return true if this patch field is derived from
124  // coupledFvsPatchField<Type>.
125  virtual bool coupled() const
126  {
127  return true;
128  }
129 };
130 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #ifdef NoRepository
139  #include "coupledFvsPatchField.C"
140 #endif
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #endif
145 
146 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
TypeName(coupledFvPatch::typeName_())
Runtime type information.
Pre-declare SubField and related Field type.
Definition: Field.H:57
coupledFvsPatchField(const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
virtual tmp< fvsPatchField< Type > > clone() const =0
Construct and return a clone.
Foam::coupledFvsPatchField.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
virtual bool coupled() const
Return true if this patch field is derived from.
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:65
Namespace for OpenFOAM.