interRegionModelI.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) 2012-2021 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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
27 
29 {
30  return master_;
31 }
32 
33 
35 {
36  return nbrRegionName_;
37 }
38 
39 
41 {
42  return mesh().time().lookupObject<fvMesh>(nbrRegionName_);
43 }
44 
45 
47 {
48  if (!meshInterpPtr_.valid())
49  {
50  setMapper();
51  }
52 
53  return meshInterpPtr_();
54 }
55 
56 
57 // ************************************************************************* //
const word & nbrRegionName() const
Return const access to the neighbour region name.
Class to calculate the cell-addressing between two overlapping meshes.
Definition: meshToMesh.H:60
const Time & time() const
Return the top-level database.
Definition: fvMesh.H:372
const Type & lookupObject(const word &name) const
Lookup and return the object of the given Type.
const fvMesh & mesh() const
Return const access to the mesh database.
Definition: fvModelI.H:34
const fvMesh & nbrMesh() const
Return const access to the neighbour mesh.
A class for handling words, derived from string.
Definition: word.H:59
bool master() const
Return whether the master region.
const meshToMesh & meshInterp() const
Return const access to the mapToMap pointer.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95