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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012-2016 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 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 inline const Foam::word&
32 {
33  return nbrRegionName_;
34 }
35 
36 
37 inline const Foam::meshToMesh&
39 {
40  if (!meshInterpPtr_.valid())
41  {
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_ == nullptr)
62  {
64  << "Neighbour model not set"
65  << abort(FatalError);
66  }
67 
68  return *nbrModel_;
69 }
70 
71 
74 {
75  if (nbrModel_ == nullptr)
76  {
78  << "Neighbour model not set"
79  << abort(FatalError);
80  }
81 
82  return *nbrModel_;
83 }
84 
85 
86 // ************************************************************************* //
Foam::fv::interRegionOption::nbrRegionName_
word nbrRegionName_
Name of the neighbour region to map.
Definition: interRegionOption.H:65
Foam::fv::interRegionHeatTransferModel::nbrRegionName
const word & nbrRegionName() const
Return const access to the neighbour region name.
Definition: interRegionHeatTransferModelI.H:31
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::fv::interRegionHeatTransferModel
Base class for inter region heat exchange. The derived classes must provide the heat transfer coeffis...
Definition: interRegionHeatTransferModel.H:59
Foam::meshToMesh
Class to calculate the cell-addressing between two overlapping meshes.
Definition: meshToMesh.H:64
Foam::fv::interRegionHeatTransferModel::nbrModel
const interRegionHeatTransferModel & nbrModel() const
Return const access to the neighbour model.
Definition: interRegionHeatTransferModelI.H:59
Foam::fv::interRegionHeatTransferModel::htc
const volScalarField & htc() const
Return the heat transfer coefficient.
Definition: interRegionHeatTransferModelI.H:52
Foam::FatalError
error FatalError
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:137
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:355
Foam::fv::interRegionHeatTransferModel::meshInterp
const meshToMesh & meshInterp() const
Return const access to the mapToMap pointer.
Definition: interRegionHeatTransferModelI.H:38
Foam::GeometricField< scalar, fvPatchField, volMesh >