Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / finiteVolume / fields / fvsPatchFields / constraint / nonuniformTransformCyclic / nonuniformTransformCyclicFvsPatchField.H
blobbb78c7cc0326399e68db71b9bbb05136b166af8c
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::nonuniformTransformCyclicFvsPatchField
27 Description
28     Foam::nonuniformTransformCyclicFvsPatchField
30 SourceFiles
31     nonuniformTransformCyclicFvsPatchField.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef nonuniformTransformCyclicFvsPatchField_H
36 #define nonuniformTransformCyclicFvsPatchField_H
38 #include "cyclicFvsPatchField.H"
39 #include "nonuniformTransformCyclicFvPatch.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47              Class nonuniformTransformCyclicFvsPatch Declaration
48 \*---------------------------------------------------------------------------*/
50 template<class Type>
51 class nonuniformTransformCyclicFvsPatchField
53     public cyclicFvsPatchField<Type>
56 public:
58     //- Runtime type information
59     TypeName(nonuniformTransformCyclicFvPatch::typeName_());
62     // Constructors
64         //- Construct from patch and internal field
65         nonuniformTransformCyclicFvsPatchField
66         (
67             const fvPatch&,
68             const DimensionedField<Type, surfaceMesh>&
69         );
71         //- Construct from patch, internal field and dictionary
72         nonuniformTransformCyclicFvsPatchField
73         (
74             const fvPatch&,
75             const DimensionedField<Type, surfaceMesh>&,
76             const dictionary&
77         );
79         //- Construct by mapping given
80         //  nonuniformTransformCyclicFvsPatchField onto a new patch
81         nonuniformTransformCyclicFvsPatchField
82         (
83             const nonuniformTransformCyclicFvsPatchField<Type>&,
84             const fvPatch&,
85             const DimensionedField<Type, surfaceMesh>&,
86             const fvPatchFieldMapper&
87         );
89         //- Construct as copy
90         nonuniformTransformCyclicFvsPatchField
91         (
92             const nonuniformTransformCyclicFvsPatchField<Type>&
93         );
95         //- Construct and return a clone
96         virtual tmp<fvsPatchField<Type> > clone() const
97         {
98             return tmp<fvsPatchField<Type> >
99             (
100                 new nonuniformTransformCyclicFvsPatchField<Type>(*this)
101             );
102         }
104         //- Construct as copy setting internal field reference
105         nonuniformTransformCyclicFvsPatchField
106         (
107             const nonuniformTransformCyclicFvsPatchField<Type>&,
108             const DimensionedField<Type, surfaceMesh>&
109         );
111         //- Construct and return a clone setting internal field reference
112         virtual tmp<fvsPatchField<Type> > clone
113         (
114             const DimensionedField<Type, surfaceMesh>& iF
115         ) const
116         {
117             return tmp<fvsPatchField<Type> >
118             (
119                 new nonuniformTransformCyclicFvsPatchField<Type>(*this, iF)
120             );
121         }
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 } // End namespace Foam
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 #ifdef NoRepository
132 #   include "nonuniformTransformCyclicFvsPatchField.C"
133 #endif
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 #endif
139 // ************************************************************************* //