processorCyclicGAMGInterfaceField.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2013 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::processorCyclicGAMGInterfaceField
28 
29 Description
30  GAMG agglomerated processor interface field.
31 
32 SourceFiles
33  processorCyclicGAMGInterfaceField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef processorCyclicGAMGInterfaceField_H
38 #define processorCyclicGAMGInterfaceField_H
39 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class processorCyclicGAMGInterfaceField Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
54 {
55  // Private Member Functions
56 
57  //- No copy construct
59  (
61  ) = delete;
62 
63  //- No copy assignment
64  void operator=(const processorCyclicGAMGInterfaceField&) = delete;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("processorCyclic");
71 
72 
73  // Constructors
74 
75  //- Construct from GAMG interface and fine level interface field
77  (
78  const GAMGInterface& GAMGCp,
79  const lduInterfaceField& fineInterface
80  );
81 
82  //- Construct from GAMG interface and fine level interface field
84  (
85  const GAMGInterface& GAMGCp,
86  const bool doTransform,
87  const int rank
88  );
89 
90  //- Construct from GAMG interface and Istream
92  (
93  const GAMGInterface& GAMGCp,
94  Istream& is
95  );
96 
97  //- Construct by assembling and return a clone.
99  (
100  const GAMGInterface& GAMGCp,
101  const UPtrList<lduInterfaceField>& other
102  ) const
103  {
105  return autoPtr<GAMGInterfaceField>(nullptr);
106  }
107 
109  // Destructor
110 
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
virtual autoPtr< GAMGInterfaceField > clone(const GAMGInterface &GAMGCp, const UPtrList< lduInterfaceField > &other) const
Construct by assembling and return a clone.
virtual int rank() const
Return rank of component for transform.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields...
A list of pointers to objects of type <T>, without allocation/deallocation management of the pointers...
Definition: HashTable.H:106
GAMG agglomerated processor interface field.
Abstract base class for GAMG agglomerated interfaces.
Definition: GAMGInterface.H:50
TypeName("processorCyclic")
Runtime type information.
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
GAMG agglomerated processor interface field.
virtual bool doTransform() const
Does the interface field perform the transformation.
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:686
Namespace for OpenFOAM.