mirrorFvMesh.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-2017 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::mirrorFvMesh
28 
29 Description
30 
31 SourceFiles
32  mirrorFvMesh.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef mirrorFvMesh_H
37 #define mirrorFvMesh_H
38 
39 #include "fvMesh.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class mirrorFvMesh Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class mirrorFvMesh
51 :
52  public fvMesh
53 {
54  // Private data
55 
56  //- Mirrored mesh
57  autoPtr<fvMesh> mirrorMeshPtr_;
58 
59  //- Cell map
60  autoPtr<labelList> cellMapPtr_;
61 
62  //- Point map
63  autoPtr<labelList> pointMapPtr_;
64 
65 
66  // Private Member Functions
67 
68  //- No copy construct
69  mirrorFvMesh(const mirrorFvMesh&) = delete;
70 
71  //- No copy assignment
72  void operator=(const mirrorFvMesh&) = delete;
73 
74 
75 public:
76 
77  // Constructors
78 
79  //- Construct from IOobject, using system mirrorMeshDict
80  explicit mirrorFvMesh(const IOobject& io);
81 
82  //- Construct from IOobject and specified mirrorMeshDict
83  mirrorFvMesh(const IOobject& io, const IOdictionary& mirrorDict);
84 
85 
86  //- Destructor
87  ~mirrorFvMesh() = default;
88 
89 
90  // Member Functions
91 
92  //- Return reference to mirror mesh
93  const fvMesh& mirrorMesh() const
94  {
95  return mirrorMeshPtr_();
96  }
97 
98  //- Mirrorred to original cell
99  const labelList& cellMap() const
100  {
101  return cellMapPtr_();
102  }
103 
104  //- Mirrorred to original point
105  const labelList& pointMap() const
106  {
107  return pointMapPtr_();
108  }
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:54
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
Foam::mirrorFvMesh::~mirrorFvMesh
~mirrorFvMesh()=default
Destructor.
Foam::mirrorFvMesh
Definition: mirrorFvMesh.H:49
Foam::mirrorFvMesh::cellMap
const labelList & cellMap() const
Mirrorred to original cell.
Definition: mirrorFvMesh.H:98
Foam::mirrorFvMesh::mirrorMesh
const fvMesh & mirrorMesh() const
Return reference to mirror mesh.
Definition: mirrorFvMesh.H:92
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
fvMesh.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::List< label >
Foam::mirrorFvMesh::pointMap
const labelList & pointMap() const
Mirrorred to original point.
Definition: mirrorFvMesh.H:104