/usr/include/freefoam/finiteVolume/fvPatchField.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 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::fvPatchField
Description
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 types with
specific evaluation proceedures, particularly with respect to specific
fields.
SourceFiles
fvPatchField.C
newFvPatchField.C
\*---------------------------------------------------------------------------*/
#ifndef fvPatchField_H
#define fvPatchField_H
#include <finiteVolume/fvPatch.H>
#include <OpenFOAM/DimensionedField.H>
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
class dictionary;
class fvPatchFieldMapper;
class volMesh;
// Forward declaration of friend functions and operators
template<class Type>
class fvPatchField;
template<class Type>
class fvMatrix;
template<class Type>
Ostream& operator<<(Ostream&, const fvPatchField<Type>&);
/*---------------------------------------------------------------------------*\
Class patch Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class fvPatchField
:
public Field<Type>
{
// Private data
//- Reference to patch
const fvPatch& patch_;
//- Reference to internal field
const DimensionedField<Type, volMesh>& internalField_;
//- Update index used so that updateCoeffs is called only once during
// the construction of the matrix
bool updated_;
//- Optional patch type, used to allow specified boundary conditions
// to be applied to constraint patches by providing the constraint
// patch type as 'patchType'
word patchType_;
public:
typedef fvPatch Patch;
//- Runtime type information
TypeName("fvPatchField");
//- Debug switch to disallow the use of genericFvPatchField
static int disallowGenericFvPatchField;
// Declare run-time constructor selection tables
declareRunTimeSelectionTable
(
tmp,
fvPatchField,
patch,
(
const fvPatch& p,
const DimensionedField<Type, volMesh>& iF
),
(p, iF)
);
declareRunTimeSelectionTable
(
tmp,
fvPatchField,
patchMapper,
(
const fvPatchField<Type>& ptf,
const fvPatch& p,
const DimensionedField<Type, volMesh>& iF,
const fvPatchFieldMapper& m
),
(dynamic_cast<const fvPatchFieldType&>(ptf), p, iF, m)
);
declareRunTimeSelectionTable
(
tmp,
fvPatchField,
dictionary,
(
const fvPatch& p,
const DimensionedField<Type, volMesh>& iF,
const dictionary& dict
),
(p, iF, dict)
);
// Constructors
//- Construct from patch and internal field
fvPatchField
(
const fvPatch&,
const DimensionedField<Type, volMesh>&
);
//- Construct from patch and internal field and patch field
fvPatchField
(
const fvPatch&,
const DimensionedField<Type, volMesh>&,
const Field<Type>&
);
//- Construct from patch, internal field and dictionary
fvPatchField
(
const fvPatch&,
const DimensionedField<Type, volMesh>&,
const dictionary&,
const bool valueRequired=false
);
//- Construct by mapping the given fvPatchField onto a new patch
fvPatchField
(
const fvPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, volMesh>&,
const fvPatchFieldMapper&
);
//- Construct as copy
fvPatchField(const fvPatchField<Type>&);
//- Construct and return a clone
virtual tmp<fvPatchField<Type> > clone() const
{
return tmp<fvPatchField<Type> >(new fvPatchField<Type>(*this));
}
//- Construct as copy setting internal field reference
fvPatchField
(
const fvPatchField<Type>&,
const DimensionedField<Type, volMesh>&
);
//- Construct and return a clone setting internal field reference
virtual tmp<fvPatchField<Type> > clone
(
const DimensionedField<Type, volMesh>& iF
) const
{
return tmp<fvPatchField<Type> >(new fvPatchField<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<fvPatchField<Type> > New
(
const word&,
const fvPatch&,
const DimensionedField<Type, volMesh>&
);
//- Return a pointer to a new patchField created on freestore from
// a given fvPatchField mapped onto a new patch
static tmp<fvPatchField<Type> > New
(
const fvPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, volMesh>&,
const fvPatchFieldMapper&
);
//- Return a pointer to a new patchField created on freestore
// from dictionary
static tmp<fvPatchField<Type> > New
(
const fvPatch&,
const DimensionedField<Type, volMesh>&,
const dictionary&
);
//- Return a pointer to a new calculatedFvPatchField created on
// freestore without setting patchField values
template<class Type2>
static tmp<fvPatchField<Type> > NewCalculatedType
(
const fvPatchField<Type2>&
);
// Destructor
virtual ~fvPatchField<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, volMesh>&
dimensionedInternalField() const
{
return internalField_;
}
//- Return internal field reference
const Field<Type>& internalField() const
{
return internalField_;
}
//- Return the type of the calculated for of fvPatchField
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;
}
//- Return true if the boundary condition has already been updated
bool updated() const
{
return updated_;
}
// Mapping functions
//- Map (and resize as needed) from self given a mapping object
virtual void autoMap
(
const fvPatchFieldMapper&
);
//- Reverse map the given fvPatchField onto this fvPatchField
virtual void rmap
(
const fvPatchField<Type>&,
const labelList&
);
// Evaluation functions
//- Return patch-normal gradient
virtual tmp<Field<Type> > snGrad() const;
//- Update the coefficients associated with the patch field
// Sets Updated to true
virtual void updateCoeffs()
{
updated_ = true;
}
//- Return internal field next to patch as patch field
virtual tmp<Field<Type> > patchInternalField() const;
//- Return patchField on the opposite patch of a coupled patch
virtual tmp<Field<Type> > patchNeighbourField() const
{
notImplemented(type() + "patchNeighbourField()");
return *this;
}
//- Initialise the evaluation of the patch field
virtual void initEvaluate
(
const Pstream::commsTypes commsType=Pstream::blocking
)
{}
//- Evaluate the patch field, sets Updated to false
virtual void evaluate
(
const Pstream::commsTypes commsType=Pstream::blocking
);
//- Return the matrix diagonal coefficients corresponding to the
// evaluation of the value of this patchField with given weights
virtual tmp<Field<Type> > valueInternalCoeffs
(
const tmp<Field<scalar> >&
) const
{
notImplemented
(
type()
+ "::valueInternalCoeffs(const tmp<Field<scalar> >&)"
);
return *this;
}
//- Return the matrix source coefficients corresponding to the
// evaluation of the value of this patchField with given weights
virtual tmp<Field<Type> > valueBoundaryCoeffs
(
const tmp<Field<scalar> >&
) const
{
notImplemented
(
type()
+ "::valueBoundaryCoeffs(const tmp<Field<scalar> >&)"
);
return *this;
}
//- Return the matrix diagonal coefficients corresponding to the
// evaluation of the gradient of this patchField
virtual tmp<Field<Type> > gradientInternalCoeffs() const
{
notImplemented(type() + "::gradientInternalCoeffs()");
return *this;
}
//- Return the matrix source coefficients corresponding to the
// evaluation of the gradient of this patchField
virtual tmp<Field<Type> > gradientBoundaryCoeffs() const
{
notImplemented(type() + "::gradientBoundaryCoeffs()");
return *this;
}
//- Manipulate matrix
virtual void manipulateMatrix(fvMatrix<Type>& matrix);
// I-O
//- Write
virtual void write(Ostream&) const;
//- Helper function to write the keyword and entry only if the
// values are not equal. The value is then output as value2
template<class EntryType>
void writeEntryIfDifferent
(
Ostream& os,
const word& entryName,
const EntryType& value1,
const EntryType& value2
) const;
// Check
//- Check fvPatchField<Type> against given fvPatchField<Type>
void check(const fvPatchField<Type>&) const;
// Member operators
virtual void operator=(const UList<Type>&);
virtual void operator=(const fvPatchField<Type>&);
virtual void operator+=(const fvPatchField<Type>&);
virtual void operator-=(const fvPatchField<Type>&);
virtual void operator*=(const fvPatchField<scalar>&);
virtual void operator/=(const fvPatchField<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 fvPatchField<Type>&);
virtual void operator==(const Field<Type>&);
virtual void operator==(const Type&);
// Ostream operator
friend Ostream& operator<< <Type>(Ostream&, const fvPatchField<Type>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
# include "fvPatchField.C"
# include <finiteVolume/calculatedFvPatchField.H>
#endif
#define makePatchTypeFieldTypeName(type) \
\
defineNamedTemplateTypeNameAndDebug(type, 0);
#define makePatchFieldsTypeName(type) \
\
makePatchTypeFieldTypeName(type##FvPatchScalarField); \
makePatchTypeFieldTypeName(type##FvPatchVectorField); \
makePatchTypeFieldTypeName(type##FvPatchSphericalTensorField); \
makePatchTypeFieldTypeName(type##FvPatchSymmTensorField); \
makePatchTypeFieldTypeName(type##FvPatchTensorField);
#define makePatchTypeField(PatchTypeField, typePatchTypeField) \
\
defineNamedTemplateTypeNameAndDebug(typePatchTypeField, 0); \
\
addToRunTimeSelectionTable \
( \
PatchTypeField, typePatchTypeField, patch \
); \
\
addToRunTimeSelectionTable \
( \
PatchTypeField, \
typePatchTypeField, \
patchMapper \
); \
\
addToRunTimeSelectionTable \
( \
PatchTypeField, typePatchTypeField, dictionary \
);
#define makePatchFields(type) \
\
makePatchTypeField(fvPatchScalarField, type##FvPatchScalarField); \
makePatchTypeField(fvPatchVectorField, type##FvPatchVectorField); \
makePatchTypeField \
( \
fvPatchSphericalTensorField, \
type##FvPatchSphericalTensorField \
); \
makePatchTypeField(fvPatchSymmTensorField, type##FvPatchSymmTensorField); \
makePatchTypeField(fvPatchTensorField, type##FvPatchTensorField);
#define makePatchTypeFieldTypedefs(type) \
\
typedef type##FvPatchField<scalar> type##FvPatchScalarField; \
typedef type##FvPatchField<vector> type##FvPatchVectorField; \
typedef type##FvPatchField<sphericalTensor> \
type##FvPatchSphericalTensorField; \
typedef type##FvPatchField<symmTensor> type##FvPatchSymmTensorField; \
typedef type##FvPatchField<tensor> type##FvPatchTensorField;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************ vim: set sw=4 sts=4 et: ************************ //
|