File size: 7,974 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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 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::mappedPatchBase
Description
Engine and base class for poly patches which provides interpolative mapping
between two globally conforming poly patches
Example:
\verbatim
// (Settings inherited from mappedPatchBaseBase to identify the
// neighbouring region and patch)
...
// Patch-to-patch mapping method. How the interpolation addressing and
// weights are constructed. Likely to be "matching" if the patches are
// conformal, or "intersection" if they are not. Optional. If omitted,
// then it will be assumed that the patches are conformal, and an
// octree-based method will be used to construct the connections.
method matching; // nearest, intersection, inverseDistance
// Tolerance used to check the patches' global conformance (i.e., the
// conformance of the patches' entire surfaces, not of each pair of
// faces). Optional. Defaults to a small value.
matchTol 1e-4;
\endverbatim
See also
Foam::mappedPatchBaseBase
SourceFiles
mappedPatchBase.C
\*---------------------------------------------------------------------------*/
#ifndef mappedPatchBase_H
#define mappedPatchBase_H
#include "mappedPatchBaseBase.H"
#include "patchToPatch.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class mappedPatchBase Declaration
\*---------------------------------------------------------------------------*/
class mappedPatchBase
:
public mappedPatchBaseBase
{
protected:
// Protected data
//- Are we using the tree mapping method, or a patch-to-patch
// intersection engine? The former is typically faster on small,
// pairs of patches with identical meshes. The latter is better
// parallelised and provides options for connecting patches with
// differing surface meshes.
const bool usingTree_;
//- Distributor (if using tree)
mutable autoPtr<distributionMap> treeMapPtr_;
//- Indices of the neighbouring patch faces who's values
// have to be supplied to the distribution map (if using tree)
mutable labelList treeNbrPatchFaceIndices_;
//- Patch-to-patch intersection engine (if using patch-to-patch)
mutable autoPtr<patchToPatch> patchToPatchPtr_;
//- Default Matching tolerance
static const scalar defaultMatchTol_;
//- Matching tolerance
const scalar matchTol_;
//- Is the mapping engine up to date? Zero if out of date. One if out
// of date (or potentially not out of date) because of motion. Two if
// up to date.
mutable label mappingIsValid_;
//- If the neighbour's mapping engine (if there is one) up to date?
mutable label nbrMappingIsValid_;
// Protected Member Functions
//- Get the face-areas for this patch
virtual tmp<vectorField> patchFaceAreas() const;
//- Get the face-centres for this patch
virtual tmp<pointField> patchFaceCentres() const;
//- Get the local points for this patch
virtual tmp<pointField> patchLocalPoints() const;
//- Get the face-areas for the neighbour patch
tmp<vectorField> nbrPatchFaceAreas() const;
//- Get the face-centres for the neighbour patch
tmp<pointField> nbrPatchFaceCentres() const;
//- Get the local points for the neighbour patch
tmp<pointField> nbrPatchLocalPoints() const;
//- Return whether or not the mapping is valid
bool mappingIsValid() const;
//- Calculate mapping
void calcMapping() const;
//- Clear out data on mesh change
virtual void clearOut() const;
//- Return whether or not the neighbour patch is of mapped type
inline bool nbrPatchIsMapped() const;
//- Get the mapped neighbouring patch
inline const mappedPatchBase& nbrMappedPatch() const;
//- Determine whether the neighbouring patch maps from this patch in
// the same way as this patch maps from its neighbour
inline bool symmetric() const;
public:
//- Runtime type information
TypeName("mappedPatchBase");
// Constructors
//- Construct from patch
mappedPatchBase(const polyPatch&);
//- Construct from components
mappedPatchBase
(
const polyPatch& pp,
const word& nbrRegionName,
const word& nbrPatchName,
const cyclicTransform& transform
);
//- Construct from dictionary
mappedPatchBase
(
const polyPatch& pp,
const dictionary& dict,
const transformType tt
);
//- Construct as copy, resetting patch
mappedPatchBase(const polyPatch&, const mappedPatchBase&);
//- Destructor
virtual ~mappedPatchBase();
// Member Functions
// Casting
//- Cast the given polyPatch to a mappedPatchBase. Handle errors.
static const mappedPatchBase& getMap(const polyPatch& patch);
// Edit
//- Clear out data on mesh change
void clearOut(const bool move);
// Distribute
//- Map/interpolate the neighbour patch field to this patch
template<class Type>
tmp<Field<Type>> fromNeighbour(const Field<Type>& nbrFld) const;
//- Map/interpolate the neighbour patch field to this patch
template<class Type>
tmp<Field<Type>> fromNeighbour
(
const tmp<Field<Type>>& nbrFld
) const;
//- Map/interpolate patch field to the neighbour patch
template<class Type>
tmp<Field<Type>> toNeighbour(const Field<Type>& fld) const;
//- Map/interpolate patch field to the neighbour patch
template<class Type>
tmp<Field<Type>> toNeighbour
(
const tmp<Field<Type>>& fld
) const;
// I/O
//- Write as a dictionary
virtual void write(Ostream&) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "mappedPatchBaseI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "mappedPatchBaseTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|