/usr/include/freefoam/finiteVolume/fvsPatchField.H is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
\\/ 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::fvsPatchField
Description
An abstract base class with a fat-interface to all derived classes
covering all possible ways in which they might be used.
The first level of derivation is to basic patchFields which cover
zero-gradient, fixed-gradient, fixed-value and mixed conditions.
The next level of derivation covers all the specialised typed with
specific evaluation proceedures, particularly with respect to specific
fields.
SourceFiles
fvsPatchField.C
newFvsPatchField.C
\*---------------------------------------------------------------------------*/
#ifndef fvsPatchField_H
#define fvsPatchField_H
#include <finiteVolume/fvPatch.H>
#include <OpenFOAM/DimensionedField.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
class dictionary;
class fvPatchFieldMapper;
class surfaceMesh;
// Forward declaration of friend functions and operators
template<class Type>
class fvsPatchField;
template<class Type>
Ostream& operator<<(Ostream&, const fvsPatchField<Type>&);
/*---------------------------------------------------------------------------*\
Class patch Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class fvsPatchField
:
public Field<Type>
{
// Private data
//- Reference to patch
const fvPatch& patch_;
//- Reference to internal field
const DimensionedField<Type, surfaceMesh>& internalField_;
public:
typedef fvPatch Patch;
//- Runtime type information
TypeName("fvsPatchField");
//- Debug switch to disallow the use of
static int disallowDefaultFvsPatchField;
// Declare run-time constructor selection tables
declareRunTimeSelectionTable
(
tmp,
fvsPatchField,
patch,
(
const fvPatch& p,
const DimensionedField<Type, surfaceMesh>& iF
),
(p, iF)
);
declareRunTimeSelectionTable
(
tmp,
fvsPatchField,
patchMapper,
(
const fvsPatchField<Type>& ptf,
const fvPatch& p,
const DimensionedField<Type, surfaceMesh>& iF,
const fvPatchFieldMapper& m
),
(dynamic_cast<const fvsPatchFieldType&>(ptf), p, iF, m)
);
declareRunTimeSelectionTable
(
tmp,
fvsPatchField,
dictionary,
(
const fvPatch& p,
const DimensionedField<Type, surfaceMesh>& iF,
const dictionary& dict
),
(p, iF, dict)
);
// Constructors
//- Construct from patch and internal field
fvsPatchField
(
const fvPatch&,
const DimensionedField<Type, surfaceMesh>&
);
//- Construct from patch and internal field and patch field
fvsPatchField
(
const fvPatch&,
const DimensionedField<Type, surfaceMesh>&,
const Field<Type>&
);
//- Construct from patch, internal field and dictionary
fvsPatchField
(
const fvPatch&,
const DimensionedField<Type, surfaceMesh>&,
const dictionary&
);
//- Construct by mapping the given fvsPatchField onto a new patch
fvsPatchField
(
const fvsPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, surfaceMesh>&,
const fvPatchFieldMapper&
);
//- Construct as copy
fvsPatchField(const fvsPatchField<Type>&);
//- Construct and return a clone
virtual tmp<fvsPatchField<Type> > clone() const
{
return tmp<fvsPatchField<Type> >(new fvsPatchField<Type>(*this));
}
//- Construct as copy setting internal field reference
fvsPatchField
(
const fvsPatchField<Type>&,
const DimensionedField<Type, surfaceMesh>&
);
//- Construct and return a clone setting internal field reference
virtual tmp<fvsPatchField<Type> > clone
(
const DimensionedField<Type, surfaceMesh>& iF
) const
{
return tmp<fvsPatchField<Type> >
(
new fvsPatchField<Type>(*this, iF)
);
}
// Selectors
//- Return a pointer to a new patchField created on freestore given
// patch and internal field
// (does not set the patch field values)
static tmp<fvsPatchField<Type> > New
(
const word&,
const fvPatch&,
const DimensionedField<Type, surfaceMesh>&
);
//- Return a pointer to a new patchField created on freestore from
// a given fvsPatchField mapped onto a new patch
static tmp<fvsPatchField<Type> > New
(
const fvsPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, surfaceMesh>&,
const fvPatchFieldMapper&
);
//- Return a pointer to a new patchField created on freestore
// from dictionary
static tmp<fvsPatchField<Type> > New
(
const fvPatch&,
const DimensionedField<Type, surfaceMesh>&,
const dictionary&
);
//- Return a pointer to a new calculatedFvsPatchField created on
// freestore without setting patchField values
template<class Type2>
static tmp<fvsPatchField<Type> > NewCalculatedType
(
const fvsPatchField<Type2>&
);
// Destructor
virtual ~fvsPatchField<Type>()
{}
// Member functions
// Access
//- Return local objectRegistry
const objectRegistry& db() const;
//- Return patch
const fvPatch& patch() const
{
return patch_;
}
//- Return dimensioned internal field reference
const DimensionedField<Type, surfaceMesh>&
dimensionedInternalField() const
{
return internalField_;
}
//- Return internal field reference
const Field<Type>& internalField() const
{
return internalField_;
}
//- Return the type of the calculated for of fvsPatchField
static const word& calculatedType();
//- Return true if this patch field fixes a value.
// Needed to check if a level has to be specified while solving
// Poissons equations.
virtual bool fixesValue() const
{
return false;
}
//- Return true if this patch field is coupled
virtual bool coupled() const
{
return false;
}
// Mapping functions
//- Map (and resize as needed) from self given a mapping object
virtual void autoMap
(
const fvPatchFieldMapper&
);
//- Reverse map the given fvsPatchField onto this fvsPatchField
virtual void rmap
(
const fvsPatchField<Type>&,
const labelList&
);
//- Write
virtual void write(Ostream&) const;
// Check
//- Check fvsPatchField<Type> against given fvsPatchField<Type>
void check(const fvsPatchField<Type>&) const;
// Member operators
virtual void operator=(const UList<Type>&);
virtual void operator=(const fvsPatchField<Type>&);
virtual void operator+=(const fvsPatchField<Type>&);
virtual void operator-=(const fvsPatchField<Type>&);
virtual void operator*=(const fvsPatchField<scalar>&);
virtual void operator/=(const fvsPatchField<scalar>&);
virtual void operator+=(const Field<Type>&);
virtual void operator-=(const Field<Type>&);
virtual void operator*=(const Field<scalar>&);
virtual void operator/=(const Field<scalar>&);
virtual void operator=(const Type&);
virtual void operator+=(const Type&);
virtual void operator-=(const Type&);
virtual void operator*=(const scalar);
virtual void operator/=(const scalar);
// Force an assignment irrespective of form of patch
virtual void operator==(const fvsPatchField<Type>&);
virtual void operator==(const Field<Type>&);
virtual void operator==(const Type&);
// Ostream operator
friend Ostream& operator<< <Type>(Ostream&, const fvsPatchField<Type>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
# include "fvsPatchField.C"
# include <finiteVolume/calculatedFvsPatchField.H>
#endif
#define makeFvsPatchTypeFieldTypeName(type) \
\
defineNamedTemplateTypeNameAndDebug(type, 0);
#define makeFvsPatchFieldsTypeName(type) \
\
makeFvsPatchTypeFieldTypeName(type##FvsPatchScalarField); \
makeFvsPatchTypeFieldTypeName(type##FvsPatchVectorField); \
makeFvsPatchTypeFieldTypeName(type##FvsPatchSphericalTensorField); \
makeFvsPatchTypeFieldTypeName(type##FvsPatchSymmTensorField); \
makeFvsPatchTypeFieldTypeName(type##FvsPatchTensorField);
#define makeFvsPatchTypeField(PatchTypeField, typePatchTypeField) \
\
defineNamedTemplateTypeNameAndDebug(typePatchTypeField, 0); \
\
addToRunTimeSelectionTable \
( \
PatchTypeField, typePatchTypeField, patch \
); \
\
addToRunTimeSelectionTable \
( \
PatchTypeField, \
typePatchTypeField, \
patchMapper \
); \
\
addToRunTimeSelectionTable \
( \
PatchTypeField, typePatchTypeField, dictionary \
);
#define makeFvsPatchFields(type) \
\
makeFvsPatchTypeField(fvsPatchScalarField, type##FvsPatchScalarField); \
makeFvsPatchTypeField(fvsPatchVectorField, type##FvsPatchVectorField); \
makeFvsPatchTypeField \
( \
fvsPatchSphericalTensorField, \
type##FvsPatchSphericalTensorField \
); \
makeFvsPatchTypeField(fvsPatchSymmTensorField, type##FvsPatchSymmTensorField); \
makeFvsPatchTypeField(fvsPatchTensorField, type##FvsPatchTensorField);
#define makeFvsPatchTypeFieldTypedefs(type) \
\
typedef type##FvsPatchField<scalar> type##FvsPatchScalarField; \
typedef type##FvsPatchField<vector> type##FvsPatchVectorField; \
typedef type##FvsPatchField<sphericalTensor> \
type##FvsPatchSphericalTensorField; \
typedef type##FvsPatchField<symmTensor> type##FvsPatchSymmTensorField; \
typedef type##FvsPatchField<tensor> type##FvsPatchTensorField;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|