procLduInterface.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) 2011-2016 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::procLduInterface
26 
27 Description
28  IO interface for processorLduInterface
29 
30 SourceFiles
31  procLduInterface.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef procLduInterface_H
36 #define procLduInterface_H
37 
38 #include "labelList.H"
39 #include "scalarField.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class lduInterfaceField;
47 
48 
49 // Forward declaration of friend functions and operators
50 
51 class procLduInterface;
52 
53 Ostream& operator<<(Ostream&, const procLduInterface&);
54 
55 
56 /*---------------------------------------------------------------------------*\
57  Class procLduInterface Declaration
58 \*---------------------------------------------------------------------------*/
59 
60 class procLduInterface
61 {
62  // Private data
63 
64  labelList faceCells_;
65  scalarField coeffs_;
66  label myProcNo_;
67  label neighbProcNo_;
68  label tag_;
69  label comm_;
70 
71 
72  // Private Member Functions
73 
74  //- Dissallow construction as copy
76 
77 
78 public:
79 
80  friend class LUscalarMatrix;
81 
82 
83  // Constructors
84 
86  (
88  const scalarField& coeffs
89  );
90 
92 
94  {
96  return autoPtr<procLduInterface>(nullptr);
97  }
98 
100  {
102  }
103 
104 
105  // Ostream operator
106 
107  friend Ostream& operator<<(Ostream&, const procLduInterface&);
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
IO interface for processorLduInterface.
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
interfaceProperties interface(alpha1, U, mixture())
Class to perform the LU decomposition on a symmetric matrix.
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...
friend Ostream & operator<<(Ostream &, const procLduInterface &)
autoPtr< procLduInterface > clone()
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
Ostream & operator<<(Ostream &, const ensightPart &)
static autoPtr< procLduInterface > New(Istream &is)
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
Namespace for OpenFOAM.