GAMGInterfaceField.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::GAMGInterfaceField
26 
27 Description
28  Abstract base class for GAMG agglomerated interface fields.
29 
30 SourceFiles
31  GAMGInterfaceField.C
32  GAMGInterfaceFieldNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef GAMGInterfaceField_H
37 #define GAMGInterfaceField_H
38 
39 #include "lduInterfaceField.H"
40 #include "GAMGInterface.H"
41 #include "autoPtr.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class GAMGInterfaceField Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public lduInterfaceField
55 {
56  // Private Data
57 
58  //- Local reference cast into the interface
59  const GAMGInterface& interface_;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("GAMGInterfaceField");
66 
67 
68  // Declare run-time constructor selection tables
69 
71  (
72  autoPtr,
75  (
76  const GAMGInterface& GAMGCp,
77  const lduInterfaceField& fineInterface
78  ),
79  (GAMGCp, fineInterface)
80  );
81 
83  (
84  autoPtr,
87  (
88  const GAMGInterface& GAMGCp,
89  const int rank
90  ),
91  (GAMGCp, rank)
92  );
93 
94 
95  // Selectors
96 
97  //- Return a pointer to a new interface created on freestore given
98  // the fine interface
100  (
101  const GAMGInterface& GAMGCp,
102  const lduInterfaceField& fineInterface
103  );
104 
105  //- Return a pointer to a new interface created on freestore given
106  // the fine interface
108  (
109  const GAMGInterface& GAMGCp,
110  const int rank
111  );
112 
113 
114  // Constructors
115 
116  //- Construct from GAMG interface and fine level interface field
118  (
119  const GAMGInterface& GAMGCp,
120  const lduInterfaceField&
121  )
122  :
123  lduInterfaceField(GAMGCp),
124  interface_(GAMGCp)
125  {}
126 
127  //- Construct from GAMG interface and fine level interface field
129  (
130  const GAMGInterface& GAMGCp,
131  const int rank
132  )
133  :
134  lduInterfaceField(GAMGCp),
135  interface_(GAMGCp)
136  {}
137 
138  //- Disallow default bitwise copy construction
139  GAMGInterfaceField(const GAMGInterfaceField&) = delete;
140 
141 
142  // Member Functions
143 
144  // Access
145 
146  //- Return interface
147  const GAMGInterface& interface() const
148  {
149  return interface_;
150  }
151 
152 
153  // Member Operators
154 
155  //- Disallow default bitwise assignment
156  void operator=(const GAMGInterfaceField&) = delete;
157 };
158 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 } // End namespace Foam
163 
164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
165 
166 #endif
167 
168 // ************************************************************************* //
Abstract base class for GAMG agglomerated interface fields.
GAMGInterfaceField(const GAMGInterface &GAMGCp, const lduInterfaceField &)
Construct from GAMG interface and fine level interface field.
declareRunTimeSelectionTable(autoPtr, GAMGInterfaceField, lduInterfaceField,(const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface),(GAMGCp, fineInterface))
void operator=(const GAMGInterfaceField &)=delete
Disallow default bitwise assignment.
TypeName("GAMGInterfaceField")
Runtime type information.
static autoPtr< GAMGInterfaceField > New(const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
Return a pointer to a new interface created on freestore given.
const GAMGInterface & interface() const
Return interface.
Abstract base class for GAMG agglomerated interfaces.
Definition: GAMGInterface.H:54
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields...
An abstract base class for implicitly-coupled interfaces e.g. processor and cyclic patches.
Definition: lduInterface.H:54
Namespace for OpenFOAM.