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 | Copyright (C) 2011 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  fvMesh* mirrorMeshPtr_;
59 
60 
61  // Private Member Functions
62 
63  //- Disallow default bitwise copy construct
64  mirrorFvMesh(const mirrorFvMesh&);
65 
66  //- Disallow default bitwise assignment
67  void operator=(const mirrorFvMesh&);
68 
69 
70 public:
71 
72 
73  // Constructors
74 
75  //- Construct from IOobject
76  mirrorFvMesh(const IOobject& io);
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 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
const fvMesh & mirrorMesh() const
Return reference to mirror mesh.
Definition: mirrorFvMesh.H:85
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
~mirrorFvMesh()
Destructor.
Namespace for OpenFOAM.