FreeFOAM The Cross-Platform CFD Toolkit
cyclicLduInterfaceField.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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::cyclicLduInterfaceField
26 
27 Description
28  Abstract base class for cyclic coupled interfaces.
29 
30 SourceFiles
31  cyclicLduInterfaceField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicLduInterfaceField_H
36 #define cyclicLduInterfaceField_H
37 
39 #include <OpenFOAM/typeInfo.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicLduInterfaceField Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52 
53 public:
54 
55  //- Runtime type information
56  TypeName("cyclicLduInterfaceField");
57 
58 
59  // Constructors
60 
61  //- Construct given coupled patch
63  {}
64 
65 
66  // Destructor
67 
68  virtual ~cyclicLduInterfaceField();
69 
70 
71  // Member Functions
72 
73  // Access
74 
75  //- Is the transform required
76  virtual bool doTransform() const = 0;
77 
78  //- Return face transformation tensor
79  virtual const tensorField& forwardT() const = 0;
80 
81  //- Return neighbour-cell transformation tensor
82  virtual const tensorField& reverseT() const = 0;
83 
84  //- Return rank of component for transform
85  virtual int rank() const = 0;
86 
87 
88  //- Transform given patch internal field
90  (
91  scalarField& psiInternal,
92  const direction cmpt
93  ) const;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************ vim: set sw=4 sts=4 et: ************************ //