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-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::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 
54  // Private Member Functions
55 
56  //- Disallow default bitwise copy construct
58 
59  //- Disallow default bitwise assignment
60  void operator=(const regionCoupledGAMGInterface&);
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("regionCoupled");
67 
68  // Constructors
69 
70  //- Construct from fine level interface,
71  // local and neighbour restrict addressing
73  (
74  const label index,
76  const lduInterface& fineInterface,
77  const labelField& restrictAddressing,
78  const labelField& neighbourRestrictAddressing,
79  const label fineLevelIndex,
80  const label coarseComm
81  );
82 
83 
84  //- Destructor
86 
87 
88  // I/O
89 
90  //- Write to stream
91  virtual void write(Ostream&) const
92  {
93  // TBD. How to serialise the AMI such that we can stream
94  // regionCoupledGAMGInterface.
96  }
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
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
virtual label index() const
virtual void write(Ostream &) const
Write to stream.
TypeName("regionCoupled")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
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:366
Namespace for OpenFOAM.
GAMG agglomerated coupled region interface.