cyclicAMILduInterface.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) 2011-2013 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::cyclicAMILduInterface
26 
27 Description
28  An abstract base class for cyclic AMI coupled interfaces
29 
30 SourceFiles
31  cyclicAMILduInterface.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicAMILduInterface_H
36 #define cyclicAMILduInterface_H
37 
38 #include "primitiveFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicAMILduInterface Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52 
53 public:
54 
55  //- Runtime type information
56  TypeName("cyclicAMILduInterface");
57 
58 
59  // Constructors
60 
61  //- Construct null
63  {}
64 
65 
66  //- Destructor
67  virtual ~cyclicAMILduInterface();
68 
69 
70  // Member Functions
71 
72  // Access
73 
74  //- Return neighbour
75  virtual label neighbPatchID() const = 0;
76 
77  virtual bool owner() const = 0;
78 
79  //- Return processor number
80  virtual const cyclicAMILduInterface& neighbPatch() const = 0;
81 
82  virtual const AMIPatchToPatchInterpolation& AMI() const = 0;
83 
84  //- Return face transformation tensor
85  virtual const tensorField& forwardT() const = 0;
86 
87  //- Return face reverse transformation tensor
88  virtual const tensorField& reverseT() const = 0;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
virtual const AMIPatchToPatchInterpolation & AMI() const =0
virtual const tensorField & forwardT() const =0
Return face transformation tensor.
TypeName("cyclicAMILduInterface")
Runtime type information.
virtual const cyclicAMILduInterface & neighbPatch() const =0
Return processor number.
virtual bool owner() const =0
An abstract base class for cyclic AMI coupled interfaces.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
virtual label neighbPatchID() const =0
Return neighbour.
virtual const tensorField & reverseT() const =0
Return face reverse transformation tensor.
Interpolation class dealing with transfer of data between two primitive patches with an arbitrary mes...
virtual ~cyclicAMILduInterface()
Destructor.
Namespace for OpenFOAM.
cyclicAMILduInterface()
Construct null.