cyclicAMIFvsPatchField.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::cyclicAMIFvsPatchField
28
29Description
30 Foam::cyclicAMIFvsPatchField
31
32SourceFiles
33 cyclicAMIFvsPatchField.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef cyclicAMIFvsPatchField_H
38#define cyclicAMIFvsPatchField_H
39
41#include "cyclicAMIFvPatch.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48/*---------------------------------------------------------------------------*\
49 Class cyclicAMIFvsPatchField Declaration
50\*---------------------------------------------------------------------------*/
51
52template<class Type>
54:
55 public coupledFvsPatchField<Type>
56{
57 // Private data
58
59 //- Local reference cast into the cyclic patch
60 const cyclicAMIFvPatch& cyclicAMIPatch_;
61
62
63public:
64
65 //- Runtime type information
66 TypeName(cyclicAMIFvPatch::typeName_());
67
68
69 // Constructors
70
71 //- Construct from patch and internal field
73 (
74 const fvPatch&,
76 );
77
78 //- Construct from patch, internal field and dictionary
80 (
81 const fvPatch&,
83 const dictionary&
84 );
85
86 //- Construct by mapping given cyclicAMIFvsPatchField onto a new patch
88 (
90 const fvPatch&,
93 );
94
95 //- Construct as copy
97 (
99 );
100
101 //- Construct and return a clone
102 virtual tmp<fvsPatchField<Type>> clone() const
103 {
105 (
107 );
108 }
109
110 //- Construct as copy setting internal field reference
112 (
115 );
116
117 //- Construct and return a clone setting internal field reference
119 (
121 ) const
122 {
124 (
125 new cyclicAMIFvsPatchField<Type>(*this, iF)
126 );
127 }
128
129 // Member functions
130
131 // Access
132
133 //- Return true if running parallel
134 virtual bool coupled() const;
135
136};
137
138
139// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140
141} // End namespace Foam
142
143// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144
145#ifdef NoRepository
146 #include "cyclicAMIFvsPatchField.C"
147#endif
148
149// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150
151#endif
152
153// ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::coupledFvsPatchField.
Cyclic patch for Arbitrary Mesh Interface (AMI)
Foam::cyclicAMIFvsPatchField.
virtual tmp< fvsPatchField< Type > > clone(const DimensionedField< Type, surfaceMesh > &iF) const
Construct and return a clone setting internal field reference.
virtual tmp< fvsPatchField< Type > > clone() const
Construct and return a clone.
virtual bool coupled() const
Return true if running parallel.
TypeName(cyclicAMIFvPatch::typeName_())
Runtime type information.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A FieldMapper for finite-volume patch fields.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:71
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73