File size: 8,877 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 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::GeometricBoundaryField
Description
Generic GeometricBoundaryField class.
SourceFiles
GeometricBoundaryField.C
\*---------------------------------------------------------------------------*/
#ifndef GeometricBoundaryField_H
#define GeometricBoundaryField_H
#include "dimensionedTypes.H"
#include "DimensionedField.H"
#include "PtrField.H"
#include "lduInterfaceFieldPtrsList.H"
#include "LduInterfaceFieldPtrsList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class dictionary;
/*---------------------------------------------------------------------------*\
Class GeometricBoundaryField Declaration
\*---------------------------------------------------------------------------*/
template<class Type, class GeoMesh, template<class> class PrimitiveField>
class GeometricBoundaryField
:
public PtrField<typename GeoMesh::template PatchField<Type>>
{
public:
// Public Types
//- Type of boundary mesh on which this boundary is instantiated
using BoundaryMesh = typename GeoMesh::BoundaryMesh;
//- Type of the internal field from which this GeometricField is derived
using Internal = DimensionedField<Type, GeoMesh, PrimitiveField>;
//- Type of the patch field of which the Boundary is composed
using PatchField = typename GeoMesh::template PatchField<Type>;
//- Type of the boundary field
using BoundaryField = PtrField<PatchField>;
private:
// Private Data
//- Reference to BoundaryMesh for which this field is defined
const BoundaryMesh& bmesh_;
public:
//- Declare friendship with other geometric boundary fields
template<class Type2, class GeoMesh2, template<class> class PrimitiveField2>
friend class GeometricBoundaryField;
// Constructors
//- Construct from a BoundaryMesh
GeometricBoundaryField(const BoundaryMesh&);
//- Construct from a BoundaryMesh,
// reference to the internal field
// and a patch field type
GeometricBoundaryField
(
const BoundaryMesh&,
const Internal&,
const word&
);
//- Construct from a BoundaryMesh,
// reference to the internal field
// and a wordList of patch field types and optionally
// the actual patch types (to override constraint patches)
GeometricBoundaryField
(
const BoundaryMesh&,
const Internal&,
const wordList& wantedPatchTypes,
const wordList& actualPatchTypes = wordList()
);
//- Construct from a BoundaryMesh,
// reference to the internal field
// and a PtrField<PatchField>
GeometricBoundaryField
(
const BoundaryMesh&,
const Internal&,
const PtrField<PatchField>&
);
//- Construct as copy setting the reference to the internal field
GeometricBoundaryField(const Internal&, const GeometricBoundaryField&);
//- Construct as copy setting the reference to the internal field
template<template<class> class PrimitiveField2>
GeometricBoundaryField
(
const Internal& field,
const GeometricBoundaryField<Type, GeoMesh, PrimitiveField2>& btf
);
//- Construct from a BoundaryMesh,
// reference to the internal field
// and a boundary field expression
template<class Expression, class = EnableIfExpressionable<Expression>>
GeometricBoundaryField
(
const BoundaryMesh&,
const Internal&,
const Expression&
);
//- Copy constructor deleted
// as it would not set the internalField reference correctly
GeometricBoundaryField(const GeometricBoundaryField&) = delete;
//- Move constructor deleted
// as it would not set the internalField reference correctly
GeometricBoundaryField(GeometricBoundaryField&&) = delete;
//- Construct from dictionary
GeometricBoundaryField
(
const BoundaryMesh&,
const Internal&,
const dictionary&
);
// Member Functions
//- Read the boundary field
void readField(const Internal& field, const dictionary& dict);
//- Update the boundary condition coefficients
void updateCoeffs();
//- Evaluate boundary conditions
void evaluate();
//- Return a list of the patch field types
wordList types() const;
//- Return const-reference to the boundary field
const BoundaryField& boundaryField() const
{
return *this;
}
//- Return BoundaryField of the cell values neighbouring
// the boundary
tmp<GeometricBoundaryField> boundaryInternalField() const;
//- Return BoundaryField of the values on the other side of couples
PtrList<Field<Type>> coupledNeighbourField() const;
//- Return BoundaryField with the values on the other side of couples
tmp<GeometricBoundaryField> boundaryNeighbourField() const;
//- Return a list of pointers for each patch field with only those
// pointing to interfaces being set
LduInterfaceFieldPtrsList<Type> interfaces() const;
//- Return a list of pointers for each patch field with only those
// pointing to interfaces being set
lduInterfaceFieldPtrsList scalarInterfaces() const;
//- Reset the boundary field contents to the given field
// Used for mesh to mesh mapping
void reset(const GeometricBoundaryField&);
//- Write boundary field as dictionary entry
void writeEntry(const word& keyword, Ostream& os) const;
// Member Operators
//- Inherit PtrField assignment operators
using PtrField<PatchField>::operator=;
//- Inherit PtrField assignment addition operators
using PtrField<PatchField>::operator+=;
//- Inherit PtrField assignment subtractions operators
using PtrField<PatchField>::operator-=;
//- Assignment operator
void operator=(const GeometricBoundaryField&);
//- Move assignment operator
void operator=(GeometricBoundaryField&&);
//- Forced assignment to
// BoundaryField<Type, GeoMesh::template PatchField, BoundaryMesh>
void operator==(const GeometricBoundaryField&);
//- Forced assignment to PtrField<GeoMesh::template PatchField<Type>>
void operator==(const PtrField<PatchField>&);
//- Forced assignment to PtrField expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator==(const Expression&);
//- Forced assignment to PtrField<OtherPatchField<Type>>
template<template<class> class OtherPatchField>
void operator==(const PtrField<OtherPatchField<Type>>&);
//- Forced assignment to Type
void operator==(const Type&);
};
template<class Type, class GeoMesh, template<class> class PrimitiveField>
Ostream& operator<<
(
Ostream&,
const GeometricBoundaryField<Type, GeoMesh, PrimitiveField>&
);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "GeometricBoundaryField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|