All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cyclicAMILduInterface.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-2020 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"
39 #include "AMIInterpolation.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 nbrPatchID() const = 0;
76 
77  //- Does this side own the interface?
78  virtual bool owner() const = 0;
79 
80  //- Return processor number
81  virtual const cyclicAMILduInterface& nbrPatch() const = 0;
82 
83  //- Return a reference to the AMI interpolators
84  virtual const PtrList<AMIInterpolation>& AMIs() const = 0;
85 
86  // Return a reference to the AMI transformations
87  virtual const List<transformer>&
88  AMITransforms() const = 0;
89 
90  //- Return transformation between the coupled patches
91  virtual const transformer& transform() const = 0;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
virtual const PtrList< AMIInterpolation > & AMIs() const =0
Return a reference to the AMI interpolators.
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
Vector-tensor class used to perform translations and rotations in 3D space.
Definition: transformer.H:83
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
TypeName("cyclicAMILduInterface")
Runtime type information.
virtual label nbrPatchID() const =0
Return neighbour.
virtual bool owner() const =0
Does this side own the interface?
An abstract base class for cyclic AMI coupled interfaces.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
virtual const transformer & transform() const =0
Return transformation between the coupled patches.
virtual const List< transformer > & AMITransforms() const =0
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
virtual const cyclicAMILduInterface & nbrPatch() const =0
Return processor number.
virtual ~cyclicAMILduInterface()
Destructor.
Namespace for OpenFOAM.
cyclicAMILduInterface()
Construct null.