regionCoupledGAMGInterfaceField.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-2018 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::regionCoupledGAMGInterfaceField
26 
27 Description
28  GAMG agglomerated region coupled interface field.
29 
30 SourceFiles
31  regionCoupledGAMGInterfaceField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef regionCoupledGAMGInterfaceField_H
36 #define regionCoupledGAMGInterfaceField_H
37 
38 #include "GAMGInterfaceField.H"
40 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class regionCoupledGAMGInterfaceField Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public GAMGInterfaceField
54 {
55  // Private data
56 
57  //- Local reference cast into the cyclic interface
58  const regionCoupledGAMGInterface& regionCoupledGAMGInterface_;
59 
60 
61  // Private Member Functions
62 
63  //- Disallow default bitwise copy construct
65  (
67  );
68 
69  //- Disallow default bitwise assignment
70  void operator=(const regionCoupledGAMGInterfaceField&);
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("regionCoupled");
77 
78 
79  // Constructors
80 
81  //- Construct from GAMG interface and fine level interface field
83  (
84  const GAMGInterface& GAMGCp,
85  const lduInterfaceField& fineInterfaceField
86  );
87 
88  //- Construct from GAMG interface and fine level interface field
90  (
91  const GAMGInterface& GAMGCp,
92  const bool doTransform,
93  const int rank
94  );
95 
96  //- Destructor
98 
99 
100  // Member Functions
101 
102  // Access
103 
104  //- Return size
105  label size() const
106  {
107  return regionCoupledGAMGInterface_.size();
108  }
109 
110 
111  //- Interface matrix update
113  (
114  scalarField&,
115  const scalarField&,
116  const scalarField&,
117  const direction,
118  const Pstream::commsTypes commsType
119  ) const
120  {}
121 
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace Foam
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
virtual label size() const
Return size.
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
commsTypes
Types of communications.
Definition: UPstream.H:64
uint8_t direction
Definition: direction.H:45
TypeName("regionCoupled")
Runtime type information.
An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields...
GAMG agglomerated region coupled interface field.
virtual void updateInterfaceMatrix(scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
Interface matrix update.
Abstract base class for GAMG agglomerated interfaces.
Definition: GAMGInterface.H:51
Abstract base class for GAMG agglomerated interface fields.
Namespace for OpenFOAM.
GAMG agglomerated coupled region interface.