All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cyclicLduInterface.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-2023 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::cyclicLduInterface
26 
27 Description
28  An abstract base class for cyclic coupled interfaces.
29 
30 SourceFiles
31  cyclicLduInterface.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicLduInterface_H
36 #define cyclicLduInterface_H
37 
38 #include "lduInterface.H"
39 #include "transformer.H"
40 #include "primitiveFieldsFwd.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class cyclicLduInterface Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("cyclicLduInterface");
58 
59  // Constructors
60 
61  //- Destructor
62  virtual ~cyclicLduInterface();
63 
64 
65  // Member Functions
66 
67  // Access
68 
69  //- Return neighbour
70  virtual label nbrPatchIndex() const = 0;
71 
72  virtual bool owner() const = 0;
73 
74  //- Return processor number
75  virtual const cyclicLduInterface& nbrPatch() const = 0;
76 
77  //- Return transformation between the coupled patches
78  virtual const transformer& transform() const = 0;
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #endif
89 
90 // ************************************************************************* //
An abstract base class for cyclic coupled interfaces.
virtual ~cyclicLduInterface()
Destructor.
TypeName("cyclicLduInterface")
Runtime type information.
virtual label nbrPatchIndex() const =0
Return neighbour.
virtual bool owner() const =0
virtual const cyclicLduInterface & nbrPatch() const =0
Return processor number.
virtual const transformer & transform() const =0
Return transformation between the coupled patches.
Vector-tensor class used to perform translations, rotations and scaling operations in 3D space.
Definition: transformer.H:84
Namespace for OpenFOAM.
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
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.