interRegionHeatTransferModelI.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) 2012-2015 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 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
27 
28 inline const Foam::word&
30 {
31  return nbrRegionName_;
32 }
33 
34 
35 inline const Foam::meshToMesh&
37 {
38  if (!meshInterpPtr_.valid())
39  {
41  (
42  "const meshToMesh& interRegionHeatTransferModel::meshInterp() const"
43  ) << "Interpolation object not set"
44  << abort(FatalError);
45  }
46 
47  return meshInterpPtr_();
48 }
49 
50 
51 inline const Foam::volScalarField&
53 {
54  return htc_;
55 }
56 
57 
60 {
61  if (nbrModel_ == NULL)
62  {
63  FatalErrorIn("const interRegionHeatTransferModel& nbrModel() const")
64  << "Neighbour model not set"
65  << abort(FatalError);
66  }
67 
68  return *nbrModel_;
69 }
70 
71 
74 {
75  if (nbrModel_ == NULL)
76  {
77  FatalErrorIn("interRegionHeatTransferModel& nbrModel()")
78  << "Neighbour model not set"
79  << abort(FatalError);
80  }
81 
82  return *nbrModel_;
83 }
84 
85 
86 // ************************************************************************* //
volScalarField htc_
Heat transfer coefficient [W/m2/k] times area/volume [1/m].
autoPtr< meshToMesh > meshInterpPtr_
Mesh to mesh interpolation object.
interRegionHeatTransferModel * nbrModel_
Pointer to neighbour interRegionHeatTransferModel.
A class for handling words, derived from string.
Definition: word.H:59
const interRegionHeatTransferModel & nbrModel() const
Return const access to the neighbour model.
const volScalarField & htc() const
Return the heat transfer coefficient.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
const meshToMesh & meshInterp() const
Return const access to the mapToMap pointer.
word nbrRegionName_
Name of the neighbour region to map.
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
error FatalError
const word & nbrRegionName() const
Return const access to the neighbour region name.
Base class for inter region heat exchange. The derived classes must provide the heat transfer coeffis...
Class to calculate the cell-addressing between two overlapping meshes.
Definition: meshToMesh.H:60