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  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 inline const Foam::word&
33 {
34  return nbrRegionName_;
35 }
36 
37 
38 inline const Foam::meshToMesh&
40 {
41  if (!meshInterpPtr_)
42  {
44  << "Interpolation object not set"
45  << abort(FatalError);
46  }
47 
48  return *meshInterpPtr_;
49 }
50 
51 
52 inline const Foam::volScalarField&
54 {
55  return htc_;
56 }
57 
58 
61 {
62  if (nbrModel_ == nullptr)
63  {
65  << "Neighbour model not set"
66  << abort(FatalError);
67  }
68 
69  return *nbrModel_;
70 }
71 
72 
75 {
76  if (nbrModel_ == nullptr)
77  {
79  << "Neighbour model not set"
80  << abort(FatalError);
81  }
82 
83  return *nbrModel_;
84 }
85 
86 
87 // ************************************************************************* //
Foam::fv::interRegionOption::nbrRegionName_
word nbrRegionName_
Name of the neighbour region to map.
Definition: interRegionOption.H:119
Foam::fv::interRegionHeatTransferModel::nbrRegionName
const word & nbrRegionName() const
Return const access to the neighbour region name.
Definition: interRegionHeatTransferModelI.H:32
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::fv::interRegionHeatTransferModel
Intermediate class for handling inter-region heat exchanges.
Definition: interRegionHeatTransferModel.H:142
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:60
Foam::fv::interRegionHeatTransferModel::htc
const volScalarField & htc() const
Return the heat transfer coefficient.
Definition: interRegionHeatTransferModelI.H:53
Foam::FatalError
error FatalError
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Foam::fv::interRegionHeatTransferModel::meshInterp
const meshToMesh & meshInterp() const
Return const access to the mapToMap pointer.
Definition: interRegionHeatTransferModelI.H:39
Foam::GeometricField< scalar, fvPatchField, volMesh >