cyclicLduInterface.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011 OpenFOAM Foundation
9 Copyright (C) 2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::cyclicLduInterface
29
30Description
31 An abstract base class for cyclic coupled interfaces.
32
33SourceFiles
34 cyclicLduInterface.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef cyclicLduInterface_H
39#define cyclicLduInterface_H
40
41#include "lduInterface.H"
42#include "primitiveFieldsFwd.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48
49/*---------------------------------------------------------------------------*\
50 Class cyclicLduInterface Declaration
51\*---------------------------------------------------------------------------*/
54{
55public:
56
57 //- Runtime type information
58 TypeName("cyclicLduInterface");
59
60 // Constructors
61
62 //- Construct null
63 cyclicLduInterface() = default;
64
65
66 //- Destructor
67 virtual ~cyclicLduInterface() = default;
68
69
70 // Member Functions
71
72 // Access
73
74 //- Return neighbour
75 virtual label neighbPatchID() const = 0;
77 virtual bool owner() const = 0;
78
79 //- Return processor number
80 virtual const cyclicLduInterface& neighbPatch() const = 0;
81
82 //- Return face transformation tensor
83 virtual const tensorField& forwardT() const = 0;
84
85 //- Return face reverse transformation tensor
86 virtual const tensorField& reverseT() const = 0;
87};
88
89
90// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91
92} // End namespace Foam
93
94// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95
96#endif
97
98// ************************************************************************* //
An abstract base class for cyclic coupled interfaces.
virtual const cyclicLduInterface & neighbPatch() const =0
Return processor number.
cyclicLduInterface()=default
Construct null.
virtual ~cyclicLduInterface()=default
Destructor.
TypeName("cyclicLduInterface")
Runtime type information.
virtual const tensorField & forwardT() const =0
Return face transformation tensor.
virtual bool owner() const =0
virtual label neighbPatchID() const =0
Return neighbour.
virtual const tensorField & reverseT() const =0
Return face reverse transformation tensor.
Namespace for OpenFOAM.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73