FreeFOAM The Cross-Platform CFD Toolkit
processorGAMGInterface.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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::processorGAMGInterface
26 
27 Description
28  GAMG agglomerated processor interface.
29 
30 SourceFiles
31  processorGAMGInterface.C
32  processorGAMGInterfaceTemplates.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef processorGAMGInterface_H
37 #define processorGAMGInterface_H
38 
39 #include <OpenFOAM/GAMGInterface.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class processorGAMGInterface Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public GAMGInterface,
55 {
56  // Private data
57 
58  //- Reference tor the processorLduInterface from which this is
59  // agglomerated
60  const processorLduInterface& fineProcInterface_;
61 
62 
63  // Private Member Functions
64 
65  //- Disallow default bitwise copy construct
67 
68  //- Disallow default bitwise assignment
69  void operator=(const processorGAMGInterface&);
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("processor");
76 
77  // Constructors
78 
79  //- Construct from fine-level interface,
80  // local and neighbour restrict addressing
82  (
83  const lduInterface& fineInterface,
84  const labelField& restrictAddressing,
85  const labelField& neighbourRestrictAddressing
86  );
87 
88 
89  // Destructor
90 
91  virtual ~processorGAMGInterface();
92 
93 
94  // Member Functions
95 
96  // Interface transfer functions
97 
98  //- Initialise interface data transfer
99  virtual void initTransfer
100  (
101  const Pstream::commsTypes commsType,
102  const unallocLabelList& interfaceData
103  ) const;
104 
105  //- Transfer and return neighbour field
106  virtual tmp<labelField> transfer
107  (
108  const Pstream::commsTypes commsType,
109  const unallocLabelList& interfaceData
110  ) const;
111 
112  //- Initialise neighbour field transfer
113  virtual void initInternalFieldTransfer
114  (
115  const Pstream::commsTypes commsType,
116  const unallocLabelList& iF
117  ) const;
118 
119  //- Transfer and return internal field adjacent to the interface
121  (
122  const Pstream::commsTypes commsType,
123  const unallocLabelList& iF
124  ) const;
125 
126 
127  //- Processor interface functions
128 
129  //- Return processor number
130  virtual int myProcNo() const
131  {
132  return fineProcInterface_.myProcNo();
133  }
134 
135  //- Return neigbour processor number
136  virtual int neighbProcNo() const
137  {
138  return fineProcInterface_.neighbProcNo();
139  }
140 
141  //- Return face transformation tensor
142  virtual const tensorField& forwardT() const
143  {
144  return fineProcInterface_.forwardT();
145  }
146 };
147 
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 } // End namespace Foam
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 #endif
156 
157 // ************************ vim: set sw=4 sts=4 et: ************************ //