All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
regionCoupledLduInterface.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::regionCoupledLduInterface
26 
27 Description
28  An abstract base class for region coupled interfaces
29 
30 SourceFiles
31  regionCoupledLduInterface.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef regionCoupledLduInterface_H
36 #define regionCoupledLduInterface_H
37 
38 #include "primitiveFieldsFwd.H"
39 #include "AMIInterpolation.H"
40 #include "polyMesh.H"
41 
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class regionCoupledLduInterface Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("regionCoupledLduInterface");
59 
60 
61  // Constructors
62 
63  //- Construct null
65  {}
66 
67 
68  //- Destructor
70 
71 
72  // Member Functions
73 
74  // Access
75 
76  //- Return neighbour
77  virtual label nbrPatchID() const = 0;
78 
79  //- Is it owner?
80  virtual bool owner() const = 0;
81 
82  //- Return neighb regionCoupledLduInterface
83  virtual const regionCoupledLduInterface& nbrPatch() const = 0;
84 
85  //- Return AMI
86  // virtual const AMIInterpolation& AMI() const = 0;
87 
88  //- Return nbrMesh
89  virtual const polyMesh& nbrMesh() const = 0;
90 
91 
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
virtual bool owner() const =0
Is it owner?
An abstract base class for region coupled interfaces.
TypeName("regionCoupledLduInterface")
Runtime type information.
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 polyMesh & nbrMesh() const =0
Return AMI.
virtual label nbrPatchID() const =0
Return neighbour.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
virtual const regionCoupledLduInterface & nbrPatch() const =0
Return neighb regionCoupledLduInterface.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.
virtual ~regionCoupledLduInterface()
Destructor.