File size: 26,476 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 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 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::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 procedures, particularly with respect to specific
fields.
SourceFiles
fvPatchField.C
fvPatchFieldNew.C
\*---------------------------------------------------------------------------*/
#ifndef fvPatchField_H
#define fvPatchField_H
#include "fvPatch.H"
#include "DimensionedField.H"
#include "fvPatchFieldMapperFwd.H"
#include "fileNameList.H"
#include "fieldTypes.H"
#include "expressionAssignment.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class objectRegistry;
class dictionary;
class fieldMapper;
class fvMesh;
// Forward declaration of friend functions and operators
template<class Type>
class fvPatchField;
template<class Type>
class calculatedFvPatchField;
template<class Type>
class slicedFvPatchField;
template<class Type>
class fvMatrix;
template<class Type>
Ostream& operator<<(Ostream&, const fvPatchField<Type>&);
/*---------------------------------------------------------------------------*\
Class fvPatchField Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class fvPatchField
:
public Field<Type>
{
// Private Data
//- Optional list of libraries required for this boundary condition
fileNameList libs_;
//- Reference to patch
const fvPatch& patch_;
//- Reference to internal field
const DimensionedField<Type, fvMesh>& internalField_;
//- Update index used so that updateCoeffs is called only once during
// the construction of the matrix
bool updated_;
//- Update index used so that manipulateMatrix is called only once
// during the construction of the matrix
bool manipulatedMatrix_;
public:
// Public Types
//- Declare primitive type
using pType = typename FieldTraits<Type>::pType;
//- Declare component type
using cmptType = typename FieldTraits<Type>::cmptType;
//- Declare component primitive type
using pCmptType = typename FieldTraits<Type>::pCmptType;
//- Declare patch type
using Patch = fvPatch;
//- Declare calculated patch field type
using Calculated = calculatedFvPatchField<Type>;
//- Declare sliced patch field type
using Sliced = slicedFvPatchField<Type>;
//- Declare component Field type
using cmptField = fvPatchField<cmptType>;
//- 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, fvMesh>& iF
),
(p, iF)
);
declareRunTimeSelectionTable
(
tmp,
fvPatchField,
patchMapper,
(
const fvPatchField<Type>& ptf,
const fvPatch& p,
const DimensionedField<Type, fvMesh>& iF,
const fieldMapper& m
),
(dynamic_cast<const fvPatchFieldType&>(ptf), p, iF, m)
);
declareRunTimeSelectionTable
(
tmp,
fvPatchField,
dictionary,
(
const fvPatch& p,
const DimensionedField<Type, fvMesh>& iF,
const dictionary& dict
),
(p, iF, dict)
);
// Constructors
//- Construct from patch and internal field
fvPatchField
(
const fvPatch&,
const DimensionedField<Type, fvMesh>&
);
//- Construct from patch and internal field and patch field
fvPatchField
(
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const Field<Type>&
);
//- Construct from patch, internal field and dictionary
fvPatchField
(
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const dictionary&,
const bool valueRequired=true
);
//- Construct by mapping the given fvPatchField onto a new patch
fvPatchField
(
const fvPatchField<Type>&,
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const fieldMapper&,
const bool mappingRequired=true
);
//- Disallow copy without setting internal field reference
fvPatchField(const fvPatchField<Type>&) = delete;
//- Disallow clone without setting internal field reference
tmp<fvPatchField<Type>> clone() const
{
NotImplemented;
return tmp<fvPatchField<Type>>(nullptr);
}
//- Copy constructor setting internal field reference
fvPatchField
(
const fvPatchField<Type>&,
const DimensionedField<Type, fvMesh>&
);
//- Construct and return a clone setting internal field reference
virtual tmp<fvPatchField<Type>> clone
(
const DimensionedField<Type, fvMesh>& iF
) const
{
return tmp<fvPatchField<Type>>(new fvPatchField<Type>(*this, iF));
}
//- Construct and return a clone onto a new patch
// setting internal field reference
virtual tmp<fvPatchField<Type>> clone
(
const fvPatch& patch,
const DimensionedField<Type, fvMesh>& iF
) const
{
return tmp<fvPatchField<Type>>
(
new fvPatchField<Type>(patch, iF, *this)
);
}
// 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, fvMesh>&
);
//- Return a pointer to a new patchField created on freestore given
// patch and internal field
// (does not set the patch field values).
// Allows override of constraint type
static tmp<fvPatchField<Type>> New
(
const word&,
const word& actualPatchType,
const fvPatch&,
const DimensionedField<Type, fvMesh>&
);
//- 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, fvMesh>&,
const fieldMapper&
);
//- Return a pointer to a new patchField created on freestore
// from dictionary
static tmp<fvPatchField<Type>> New
(
const fvPatch&,
const DimensionedField<Type, fvMesh>&,
const dictionary&
);
//- Destructor
virtual ~fvPatchField()
{}
// Member Functions
// Attributes
//- 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 the value of the patch field
// is altered by assignment (the default)
virtual bool assignable() const
{
return true;
}
//- Return true if this patch field is coupled
virtual bool coupled() const
{
return false;
}
//- Return true if this overrides the underlying constraint type
bool overridesConstraint() const
{
if (type() == patch_.type())
{
return false;
}
typename patchConstructorTable::iterator patchTypeCstrIter
= patchConstructorTablePtr_->find(patch_.type());
return
patchTypeCstrIter
!= patchConstructorTablePtr_->end();
}
// Access
//- Return local objectRegistry
const objectRegistry& db() const;
//- Return time
const Time& time() const;
//- Return patch
const fvPatch& patch() const
{
return patch_;
}
//- Return reference to the base patch field
const Field<Type>& field() const
{
return *this;
}
//- Return dimensioned internal field reference
const DimensionedField<Type, fvMesh>& internalField() const
{
return internalField_;
}
//- Return internal field reference
const Field<Type>& primitiveField() const
{
return internalField_;
}
//- Return true if the boundary condition has already been updated
bool updated() const
{
return updated_;
}
//- Return true if the matrix has already been manipulated
bool manipulatedMatrix() const
{
return manipulatedMatrix_;
}
// Mapping functions
//- Map the given fvPatchField onto this fvPatchField
virtual void map(const fvPatchField<Type>&, const fieldMapper&);
//- Reset the fvPatchField to the given fvPatchField
// Used for mesh to mesh mapping
virtual void reset(const fvPatchField<Type>&);
// Evaluation functions
//- Return patch-normal gradient
virtual tmp<Field<Type>> snGrad() const;
//- Return patch-normal gradient for coupled-patches
// using the deltaCoeffs provided
virtual tmp<Field<Type>> snGrad
(
const scalarField& deltaCoeffs
) const
{
NotImplemented;
return *this;
}
//- Update the coefficients associated with the patch field
// Sets Updated to true
virtual void updateCoeffs();
//- Return internal field next to patch as patch field
virtual tmp<Field<Type>> patchInternalField() const;
//- Return internal field next to patch as patch field
virtual void patchInternalField(Field<Type>&) const;
//- Initialise return of the patchField on the opposite patch of a
// coupled patch
virtual void initPatchNeighbourField
(
const Pstream::commsTypes commsType =
Pstream::commsTypes::blocking
) const
{}
//- Return patchField on the opposite patch of a coupled patch
virtual tmp<Field<Type>> patchNeighbourField
(
const Pstream::commsTypes commsType =
Pstream::commsTypes::blocking
) const
{
NotImplemented;
return *this;
}
//- Initialise the evaluation of the patch field
virtual void initEvaluate
(
const Pstream::commsTypes commsType =
Pstream::commsTypes::blocking
)
{}
//- Evaluate the patch field, sets Updated to false
virtual void evaluate
(
const Pstream::commsTypes commsType =
Pstream::commsTypes::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;
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;
return *this;
}
//- Return the matrix diagonal coefficients corresponding to the
// evaluation of the gradient of this patchField
virtual tmp<Field<Type>> gradientInternalCoeffs() const
{
NotImplemented;
return *this;
}
//- Return the matrix diagonal coefficients corresponding to the
// evaluation of the gradient of this coupled patchField
// using the deltaCoeffs provided
virtual tmp<Field<Type>> gradientInternalCoeffs
(
const scalarField& deltaCoeffs
) const
{
NotImplemented;
return *this;
}
//- Return the matrix source coefficients corresponding to the
// evaluation of the gradient of this patchField
virtual tmp<Field<Type>> gradientBoundaryCoeffs() const
{
NotImplemented;
return *this;
}
//- Return the matrix source coefficients corresponding to the
// evaluation of the gradient of this coupled patchField
// using the deltaCoeffs provided
virtual tmp<Field<Type>> gradientBoundaryCoeffs
(
const scalarField& deltaCoeffs
) const
{
NotImplemented;
return *this;
}
//- Manipulate matrix
virtual void manipulateMatrix(fvMatrix<Type>& matrix);
// I-O
//- Write
virtual void write(Ostream&) 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 Field<Type>&);
virtual void operator=(const fvPatchField<Type>&);
//- Virtual assign to an expression
virtual void operator=(const expression::Assignment<Field<Type>>& a);
//- Templated assign to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator=(const Expression& e);
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&);
//- Virtual force-assign to an expression
virtual void operator==(const expression::Assignment<Field<Type>>&);
//- Templated force-assign
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator==(const Expression& e);
// Ostream operator
friend Ostream& operator<< <Type>(Ostream&, const fvPatchField<Type>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "fvPatchFieldExpression.H"
#ifdef NoRepository
#include "fvPatchField.C"
#include "calculatedFvPatchField.H"
#endif
#define makeFvPatchField(fvPatchTypeField) \
defineNamedTemplateTypeNameAndDebug(fvPatchTypeField, 0); \
template<> \
int fvPatchTypeField::disallowGenericFvPatchField \
( \
debug::debugSwitch("disallowGenericFvPatchField", 0) \
); \
defineTemplateRunTimeSelectionTable(fvPatchTypeField, patch); \
defineTemplateRunTimeSelectionTable(fvPatchTypeField, patchMapper); \
defineTemplateRunTimeSelectionTable(fvPatchTypeField, dictionary);
#define addToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField) \
addToRunTimeSelectionTable \
( \
PatchTypeField, \
typePatchTypeField, \
patchMapper \
); \
addToRunTimeSelectionTable \
( \
PatchTypeField, \
typePatchTypeField, \
dictionary \
);
#define addToNullConstructablePatchFieldRunTimeSelection( \
PatchTypeField, typePatchTypeField) \
\
addToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField) \
\
addToRunTimeSelectionTable \
( \
PatchTypeField, \
typePatchTypeField, \
patch \
);
// Use with caution
#define addRemovableToPatchFieldRunTimeSelection( \
PatchTypeField, typePatchTypeField) \
\
addRemovableToRunTimeSelectionTable \
( \
PatchTypeField, \
typePatchTypeField, \
patchMapper \
); \
addRemovableToRunTimeSelectionTable \
( \
PatchTypeField, \
typePatchTypeField, \
dictionary \
);
// For non-templated patch fields
#define makePatchTypeField(PatchTypeField, typePatchTypeField) \
defineTypeNameAndDebug(typePatchTypeField, 0); \
addToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField)
// For null-constructable non-templated patch fields
#define makeNullConstructablePatchTypeField(PatchTypeField, typePatchTypeField)\
defineTypeNameAndDebug(typePatchTypeField, 0); \
addToNullConstructablePatchFieldRunTimeSelection \
( \
PatchTypeField, \
typePatchTypeField \
)
// For non-templated patch fields - use with caution
#define makeRemovablePatchTypeField(PatchTypeField, typePatchTypeField) \
defineTypeNameAndDebug(typePatchTypeField, 0); \
addRemovableToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField)
// For templated patch fields
#define makeTemplatePatchTypeField(fieldType, type) \
defineNamedTemplateTypeNameAndDebug \
( \
CAT4(type, FvPatch, CAPITALIZE(fieldType), Field), \
0 \
); \
addToPatchFieldRunTimeSelection \
( \
CAT3(fvPatch, CAPITALIZE(fieldType), Field), \
CAT4(type, FvPatch, CAPITALIZE(fieldType), Field) \
)
// For null-constructable templated patch fields
#define makeNullConstructableTemplatePatchTypeField(fieldType, type) \
defineNamedTemplateTypeNameAndDebug \
( \
CAT4(type, FvPatch, CAPITALIZE(fieldType), Field), \
0 \
); \
addToNullConstructablePatchFieldRunTimeSelection \
( \
CAT3(fvPatch, CAPITALIZE(fieldType), Field), \
CAT4(type, FvPatch, CAPITALIZE(fieldType), Field) \
)
#define makePatchFields(type) \
FOR_ALL_FIELD_TYPES(makeTemplatePatchTypeField, type)
#define makeNullConstructablePatchFields(type) \
FOR_ALL_FIELD_TYPES(makeNullConstructableTemplatePatchTypeField, type)
#define makePatchFieldTypeName(fieldType, type) \
defineNamedTemplateTypeNameAndDebug \
( \
CAT4(type, FvPatch, CAPITALIZE(fieldType), Field), \
0 \
);
#define makePatchFieldTypeNames(type) \
FOR_ALL_FIELD_TYPES(makePatchFieldTypeName, type)
#define makePatchTypeFieldTypedef(fieldType, type) \
typedef type##FvPatchField<fieldType> \
CAT4(type, FvPatch, CAPITALIZE(fieldType), Field);
#define makePatchTypeFieldTypedefs(type) \
FOR_ALL_FIELD_TYPES(makePatchTypeFieldTypedef, type)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|