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-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::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 public:
62 
63  //- Runtime type information
64  TypeName("regionCoupled");
65 
66 
67  // Constructors
68 
69  //- Construct from GAMG interface and fine level interface field
71  (
72  const GAMGInterface& GAMGCp,
73  const lduInterfaceField& fineInterfaceField
74  );
75 
76  //- Construct from GAMG interface and fine level interface field
78  (
79  const GAMGInterface& GAMGCp,
80  const int rank
81  );
82 
83  //- Disallow default bitwise copy construction
85  (
87  );
88 
89 
90  //- Destructor
92 
93 
94  // Member Functions
95 
96  // Access
97 
98  //- Return size
99  label size() const
100  {
101  return regionCoupledGAMGInterface_.size();
102  }
103 
104 
105  //- Interface matrix update
107  (
108  scalarField&,
109  const scalarField&,
110  const scalarField&,
111  const direction,
112  const Pstream::commsTypes commsType
113  ) const
114  {}
115 
116 
117  // Member Operators
118 
119  //- Disallow default bitwise assignment
120  void operator=(const regionCoupledGAMGInterfaceField&) = delete;
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
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.
regionCoupledGAMGInterfaceField(const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterfaceField)
Construct from GAMG interface and fine level 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
void operator=(const regionCoupledGAMGInterfaceField &)=delete
Disallow default bitwise assignment.
Abstract base class for GAMG agglomerated interface fields.
Namespace for OpenFOAM.
GAMG agglomerated coupled region interface.