File size: 5,011 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fv::interRegionModel
Description
Base class for inter-region exchange.
\*---------------------------------------------------------------------------*/
#ifndef interRegionModel_H
#define interRegionModel_H
#include "fvModel.H"
#include "volFields.H"
#include "cellsToCells.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace fv
{
/*---------------------------------------------------------------------------*\
Class interRegionModel Declaration
\*---------------------------------------------------------------------------*/
class interRegionModel
:
public fvModel
{
// Private data
//- Is this the owner region? +1 is yes, 0 is no, -1 is either "yet to
// be determined" or indicates that this model has no neighbouring
// model (e.g., inter-region porosity)
mutable label owner_;
//- Name of the neighbour region to map
word nbrRegionName_;
//- Name of the corresponding model in the neighbour region
word nbrModelName_;
//- Cached dictionary for delayed construction of nbrModelName
dictionary nbrModelNameDict_;
//- Interpolation method
word interpolationMethod_;
//- Mesh to mesh interpolation object
mutable autoPtr<cellsToCells> interpolationPtr_;
// Private Member Functions
//- Non-virtual read
void readCoeffs(const dictionary& dict);
//- Get the neighbour interRegionModel, or null if there is none
const interRegionModel& nbrModelOrNull() const;
//- Access the interpolation engine
const cellsToCells& interpolation() const;
protected:
// Protected Member Functions
//- Get the neighbour interRegionModel
template<class InterRegionModelType = interRegionModel>
const InterRegionModelType& nbrModel() const;
public:
//- Runtime type information
TypeName("interRegionModel");
// Constructors
//- Construct from dictionary
interRegionModel
(
const word& name,
const word& modelType,
const fvMesh& mesh,
const dictionary& dict
);
//- Destructor
virtual ~interRegionModel();
// Member Functions
// Access
//- Return whether the owner region
inline bool owner() const;
//- Return whether the neighbour region
inline bool neighbour() const;
//- Return const access to the neighbour region name
inline const word& nbrRegionName() const;
//- Return const access to the neighbour region name
inline const word& nbrModelName() const;
//- Return const access to the neighbour mesh
inline const fvMesh& nbrMesh() const;
// Interpolation
//- Interpolate field
template<class Type>
tmp<Field<Type>> interpolate
(
const Field<Type>& field
) const;
//- Interpolate field
template<class Type>
void interpolate
(
const Field<Type>& field,
Field<Type>& result
) const;
// IO
//- Read dictionary
virtual bool read(const dictionary& dict);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace fv
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "interRegionModelI.H"
#ifdef NoRepository
#include "interRegionModelTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|