regionCoupledGAMGInterface.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::regionCoupledGAMGInterface
26 
27 Description
28  GAMG agglomerated coupled region interface.
29 
30 SourceFiles
31  regionCoupledGAMGInterface.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef regionCoupledGAMGInterface_H
36 #define regionCoupledGAMGInterface_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class regionCoupledGAMGInterface Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
52 {
53 public:
54 
55  //- Runtime type information
56  TypeName("regionCoupled");
57 
58  // Constructors
59 
60  //- Construct from fine level interface,
61  // local and neighbour restrict addressing
63  (
64  const label index,
66  const lduInterface& fineInterface,
67  const labelField& restrictAddressing,
68  const labelField& neighbourRestrictAddressing,
69  const label fineLevelIndex,
70  const label coarseComm
71  );
72 
73  //- Disallow default bitwise copy construction
75 
76 
77  //- Destructor
79 
80 
81  // Member Functions
82 
83  // I/O
84 
85  //- Write to stream
86  virtual void write(Ostream&) const
87  {
88  // TBD. How to serialise the AMI such that we can stream
89  // regionCoupledGAMGInterface.
91  }
92 
93 
94  // Member Operators
95 
96  //- Disallow default bitwise assignment
97  void operator=(const regionCoupledGAMGInterface&) = delete;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
Base class for GAMG agglomerated coupled region interface.
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
regionCoupledGAMGInterface(const label index, const lduInterfacePtrsList &coarseInterfaces, const lduInterface &fineInterface, const labelField &restrictAddressing, const labelField &neighbourRestrictAddressing, const label fineLevelIndex, const label coarseComm)
Construct from fine level interface,.
virtual label index() const
virtual void write(Ostream &) const
Write to stream.
TypeName("regionCoupled")
Runtime type information.
void operator=(const regionCoupledGAMGInterface &)=delete
Disallow default bitwise assignment.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual const lduInterfacePtrsList & coarseInterfaces() const
An abstract base class for implicitly-coupled interfaces e.g. processor and cyclic patches...
Definition: lduInterface.H:53
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:370
Namespace for OpenFOAM.
GAMG agglomerated coupled region interface.