cyclicFvsPatchField.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-2021 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::cyclicFvsPatchField
26 
27 Description
28  Foam::cyclicFvsPatchField
29 
30 SourceFiles
31  cyclicFvsPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicFvsPatchField_H
36 #define cyclicFvsPatchField_H
37 
38 #include "coupledFvsPatchField.H"
39 #include "cyclicFvPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicFvsPatch Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public coupledFvsPatchField<Type>
54 {
55  // Private Data
56 
57  //- Local reference cast into the cyclic patch
58  const cyclicFvPatch& cyclicPatch_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName(cyclicFvPatch::typeName_());
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const fvPatch&,
74  );
75 
76  //- Construct from patch, internal field and dictionary
78  (
79  const fvPatch&,
81  const dictionary&
82  );
83 
84  //- Construct by mapping given cyclicFvsPatchField onto a new patch
86  (
88  const fvPatch&,
90  const fvPatchFieldMapper&
91  );
92 
93  //- Disallow copy without setting internal field reference
95 
96  //- Copy constructor setting internal field reference
98  (
101  );
102 
103  //- Construct and return a clone setting internal field reference
105  (
107  ) const
108  {
110  (
111  new cyclicFvsPatchField<Type>(*this, iF)
112  );
113  }
114 
115 
116  // Member Functions
117 
118  // Evaluation functions
119 
120  //- Return patchField on the opposite patch of a coupled patch
122  (
123  const Pstream::commsTypes commsType
124  ) const;
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #ifdef NoRepository
135  #include "cyclicFvsPatchField.C"
136 #endif
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
141 
142 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual tmp< Field< Type > > patchNeighbourField(const Pstream::commsTypes commsType) const
Return patchField on the opposite patch of a coupled patch.
commsTypes
Types of communications.
Definition: UPstream.H:64
Foam::cyclicFvsPatchField.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
TypeName(cyclicFvPatch::typeName_())
Runtime type information.
tmp< fvsPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Foam::fvPatchFieldMapper.
Cyclic-plane patch.
Definition: cyclicFvPatch.H:51
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
cyclicFvsPatchField(const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.