mirrorFvMesh.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-2019 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::mirrorFvMesh
26 
27 Description
28 
29 SourceFiles
30  mirrorFvMesh.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef mirrorFvMesh_H
35 #define mirrorFvMesh_H
36 
37 #include "fvMesh.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class mirrorFvMesh Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 class mirrorFvMesh
49 :
50  public fvMesh
51 {
52  // Private Data
53 
54  //- Mirror dictionary
55  IOdictionary mirrorMeshDict_;
56 
57  //- Mirrored mesh
58  autoPtr<fvMesh> mirrorMeshPtr_;
59 
60  //- Cell map
61  autoPtr<labelList> cellMapPtr_;
62 
63  //- Point map
64  autoPtr<labelList> pointMapPtr_;
65 
66 
67 public:
68 
69 
70  // Constructors
71 
72  //- Construct from IOobject
73  mirrorFvMesh(const IOobject& io, const word& dictName);
74 
75  //- Disallow default bitwise copy construction
76  mirrorFvMesh(const mirrorFvMesh&) = delete;
77 
78 
79  //- Destructor
80  ~mirrorFvMesh();
81 
82 
83  // Member Functions
84 
85  //- Return reference to mirror mesh
86  const fvMesh& mirrorMesh() const
87  {
88  return mirrorMeshPtr_();
89  }
90 
91  //- Mirrored to original cell
92  const labelList& cellMap() const
93  {
94  return cellMapPtr_();
95  }
96 
97  //- Mirrored to original point
98  const labelList& pointMap() const
99  {
100  return pointMapPtr_();
101  }
102 
103 
104  // Member Operators
105 
106  //- Disallow default bitwise assignment
107  void operator=(const mirrorFvMesh&) = delete;
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
mirrorFvMesh(const IOobject &io, const word &dictName)
Construct from IOobject.
const fvMesh & mirrorMesh() const
Return reference to mirror mesh.
Definition: mirrorFvMesh.H:85
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:52
const word dictName() const
Return the local dictionary name (final part of scoped name)
Definition: dictionary.H:123
void operator=(const mirrorFvMesh &)=delete
Disallow default bitwise assignment.
A class for handling words, derived from string.
Definition: word.H:59
const labelList & pointMap() const
Mirrored to original point.
Definition: mirrorFvMesh.H:97
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
const labelList & cellMap() const
Mirrored to original cell.
Definition: mirrorFvMesh.H:91
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
~mirrorFvMesh()
Destructor.
Namespace for OpenFOAM.