File size: 18,427 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::DimensionedField
Description
Field with dimensions and associated with geometry type GeoMesh which is
used to size the field and a reference to it is maintained.
SourceFiles
DimensionedFieldI.H
DimensionedField.C
DimensionedFieldIO.C
\*---------------------------------------------------------------------------*/
#ifndef DimensionedField_H
#define DimensionedField_H
#include "DimensionedFieldFwd.H"
#include "regIOobject.H"
#include "Field.H"
#include "OldTimeField.H"
#include "dimensionedType.H"
#include "expressionExpressionable.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class DimensionedField Declaration
\*---------------------------------------------------------------------------*/
template<class Type, class GeoMesh, template<class> class PrimitiveField>
class DimensionedField
:
public regIOobject,
public PrimitiveField<Type>,
public OldTimeField<DimensionedField<Type, GeoMesh, PrimitiveField>>
{
public:
// Public Types
//- Value type
using Type_ = Type;
//- Geometric mesh type
using GeoMesh_ = GeoMesh;
//- Base mesh type from which GeoMesh is constructed
using Mesh = typename GeoMesh::Mesh;
//- Type of the field from which this DimensionedField is derived
using FieldType = PrimitiveField<Type>;
//- Type of the field from which this DimensionedField is derived
using Base = PrimitiveField<Type>;
//- Component type of the elements of the field
using cmptType = typename PrimitiveField<Type>::cmptType;
private:
// Private Data
//- Reference to mesh
const GeoMesh& mesh_;
//- Dimension set for this field
dimensionSet dimensions_;
// Private Member Functions
//- Read from file if it is present
bool readIfPresent(const word& fieldDictEntry = "value");
public:
//- Runtime type information
TypeName("DimensionedField");
//- Declare friendship with other dimensioned fields
template<class Type2, class GeoMesh2, template<class> class PrimitiveField2>
friend class DimensionedField;
// Static Member Functions
//- Return a null DimensionedField
inline static const
DimensionedField<Type, GeoMesh, PrimitiveField>& null();
// Constructors
//- Construct from components
DimensionedField
(
const IOobject&,
const GeoMesh& mesh,
const dimensionSet&,
const PrimitiveField<Type>&
);
//- Construct from components
DimensionedField
(
const IOobject&,
const GeoMesh& mesh,
const dimensionSet&,
const tmp<PrimitiveField<Type>>&
);
//- Construct from components
template<class Expression, class = EnableIfExpression<Expression>>
DimensionedField
(
const IOobject&,
const GeoMesh& mesh,
const dimensionSet&,
const Expression& e
);
//- Construct from components
// Used for temporary fields which are initialised after construction
DimensionedField
(
const IOobject&,
const GeoMesh& mesh,
const dimensionSet&,
const bool checkIOFlags
);
//- Construct from components
DimensionedField
(
const IOobject&,
const GeoMesh& mesh,
const dimensioned<Type>&,
const bool checkIOFlags = true
);
//- Construct from dictionary
DimensionedField
(
const IOobject&,
const GeoMesh& mesh,
const dictionary& fieldDict,
const dimensionSet& dims = dimensions::invalid,
const word& fieldDictEntry="value"
);
//- Construct from dictionary constructed from IOobject
DimensionedField
(
const IOobject&,
const GeoMesh& mesh,
const dimensionSet& dims = dimensions::invalid,
const word& fieldDictEntry="value"
);
//- Copy constructor
DimensionedField
(
const DimensionedField<Type, GeoMesh, PrimitiveField>&
);
//- Move constructor
DimensionedField
(
DimensionedField<Type, GeoMesh, PrimitiveField>&&
);
//- Copy constructor
template<template<class> class PrimitiveField2>
explicit DimensionedField
(
const DimensionedField<Type, GeoMesh, PrimitiveField2>&
);
//- Copy constructor or reuse as specified.
template<template<class> class PrimitiveField2>
DimensionedField
(
DimensionedField<Type, GeoMesh, PrimitiveField2>&,
const bool reuse
);
//- Copy constructor of tmp<DimensionedField> deleting argument
DimensionedField
(
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField>>&
);
//- Copy constructor resetting IO parameters
template<template<class> class PrimitiveField2>
DimensionedField
(
const IOobject&,
const DimensionedField<Type, GeoMesh, PrimitiveField2>&,
const bool checkIOFlags = true
);
//- Copy constructor resetting IO parameters and reuse as specified.
template<template<class> class PrimitiveField2>
DimensionedField
(
const IOobject&,
DimensionedField<Type, GeoMesh, PrimitiveField2>&,
const bool reuse,
const bool checkIOFlags = true
);
//- Copy constructor from tmp resetting IO parameters
DimensionedField
(
const IOobject&,
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField>>&,
const bool checkIOFlags = true
);
//- Copy constructor from expression resetting IO parameters
template<class Expression, class = EnableIfExpressionable<Expression>>
DimensionedField
(
const IOobject&,
const Expression& e,
const bool checkIOFlags = true
);
//- Copy constructor resetting name
template<template<class> class PrimitiveField2>
DimensionedField
(
const word& newName,
const DimensionedField<Type, GeoMesh, PrimitiveField2>&
);
//- Copy constructor resetting name and reuse as specified.
template<template<class> class PrimitiveField2>
DimensionedField
(
const word& newName,
DimensionedField<Type, GeoMesh, PrimitiveField2>&,
const bool reuse
);
//- Copy constructor from tmp resetting name
DimensionedField
(
const word& newName,
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField>>&
);
//- Construct from an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
DimensionedField(const Expression& e);
//- Clone
tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> clone() const;
//- Return a temporary field constructed from name, mesh,
// dimensionSet and field
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet&,
const PrimitiveField<Type>&
);
//- Return a temporary field constructed from name, mesh,
// dimensionSet and tmp field
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet&,
const tmp<PrimitiveField<Type>>&
);
//- Return a temporary field constructed from name, mesh,
// dimensionSet and field expression
template<class Expression, class = EnableIfExpressionable<Expression>>
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet&,
const Expression& e
);
//- Return a temporary field constructed from name, mesh
// and dimensionSet
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet&
);
//- Return a temporary field constructed from name, mesh
// and dimensionType providing dimensions and value
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& name,
const GeoMesh& mesh,
const dimensioned<Type>&
);
//- Return a temporary field constructed from name and a field
template<template<class> class PrimitiveField2>
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& newName,
const DimensionedField<Type, GeoMesh, PrimitiveField2>&
);
//- Return renamed temporary field
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& newName,
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField>>&
);
//- Return a temporary field constructed from name, mesh
// and DimensionedField expression
template<class Expression, class = EnableIfExpression<Expression>>
static tmp<DimensionedField<Type, GeoMesh, PrimitiveField>> New
(
const word& name,
const GeoMesh& mesh,
const Expression& e
);
//- Destructor
virtual ~DimensionedField();
// Member Functions
void readField
(
const dictionary& fieldDict,
const word& fieldDictEntry = "value"
);
//- Access the IO
const IOobject& io() const
{
return *this;
}
//- Return mesh
inline const GeoMesh& mesh() const;
//- Return dimensions
inline const dimensionSet& dimensions() const;
//- Return non-const access to dimensions
inline dimensionSet& dimensions();
//- Return a reference to the internal field
PrimitiveField<Type>& primitiveFieldRef();
//- Return a const-reference to the primitive field
inline const PrimitiveField<Type>& primitiveField() const;
//- Transfer the list pointer from the given PrimitiveField
inline virtual void transfer(PrimitiveField<Type>&);
//- Use old-time methods from the base class
USING_OLD_TIME_FIELD(DimensionedField);
//- Return a component field expression of the field
inline auto component(const direction&) const;
//- Replace a component field of the field
template<template<class> class PrimitiveField2>
void replace
(
const direction,
const DimensionedField<cmptType, GeoMesh, PrimitiveField2>&
);
//- Replace a component field of the field
template<template<class> class PrimitiveField2>
void replace
(
const direction,
const tmp<DimensionedField<cmptType, GeoMesh, PrimitiveField2>>&
);
//- Replace a component field of the field from an expression
template<class Expression, class = EnableIfExpression<Expression>>
void replace(const direction, const Expression&);
//- Replace a component field of the field with given value
void replace(const direction, const dimensioned<cmptType>&);
//- Return the field transpose field expression
// (only defined for second rank tensors)
inline auto T() const;
//- Reset the field values to the given field
// Used for mesh to mesh mapping
template<template<class> class PrimitiveField2>
void reset(const DimensionedField<Type, GeoMesh, PrimitiveField2>&);
//- Reset the field values to the given tmp-field
// Used for mesh to mesh mapping
void reset(const tmp<DimensionedField<Type, GeoMesh, PrimitiveField>>&);
//- Reset the field values to the given tmp-field
// Used for mesh to mesh mapping
template<template<class> class PrimitiveField2>
void reset
(
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField2>>&
);
//- Bound the field to the given lower bound
void boundLower(const dimensioned<Type>& lower);
//- Bound the field to the given upper bound
void boundUpper(const dimensioned<Type>& upper);
//- Bound the field within the given lower and upper bounds
void bound
(
const dimensioned<Type>& lower,
const dimensioned<Type>& upper
);
// Write
bool writeData(Ostream&, const word& fieldDictEntry) const;
bool writeData(Ostream&) const;
// Member Operators
void operator=(const DimensionedField<Type, GeoMesh, PrimitiveField>&);
void operator=(DimensionedField<Type, GeoMesh, PrimitiveField>&&);
void operator=
(
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField>>&
);
template<template<class> class PrimitiveField2>
void operator=
(
const DimensionedField<Type, GeoMesh, PrimitiveField2>&
);
template<template<class> class PrimitiveField2>
void operator=
(
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField2>>&
);
//- Assign to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator=(const Expression& e);
void operator=(const dimensioned<Type>&);
void operator=(const zero&);
template<template<class> class PrimitiveField2>
void operator+=
(
const DimensionedField<Type, GeoMesh, PrimitiveField2>&
);
template<template<class> class PrimitiveField2>
void operator+=
(
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField2>>&
);
//- Assign-add to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator+=(const Expression& e);
void operator+=(const dimensioned<Type>&);
template<template<class> class PrimitiveField2>
void operator-=
(
const DimensionedField<Type, GeoMesh, PrimitiveField2>&
);
template<template<class> class PrimitiveField2>
void operator-=
(
const tmp<DimensionedField<Type, GeoMesh, PrimitiveField2>>&
);
//- Assign-subtract to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator-=(const Expression& e);
void operator-=(const dimensioned<Type>&);
template<template<class> class PrimitiveField2>
void operator*=
(
const DimensionedField<scalar, GeoMesh, PrimitiveField2>&
);
template<template<class> class PrimitiveField2>
void operator*=
(
const tmp<DimensionedField<scalar, GeoMesh, PrimitiveField2>>&
);
//- Assign-multiply to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator*=(const Expression& e);
void operator*=(const dimensioned<scalar>&);
template<template<class> class PrimitiveField2>
void operator/=
(
const DimensionedField<scalar, GeoMesh, PrimitiveField2>&
);
template<template<class> class PrimitiveField2>
void operator/=
(
const tmp<DimensionedField<scalar, GeoMesh, PrimitiveField2>>&
);
//- Assign-divide to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator/=(const Expression& e);
void operator/=(const dimensioned<scalar>&);
};
template<class Type, class GeoMesh, template<class> class PrimitiveField>
Ostream& operator<<
(
Ostream&,
const DimensionedField<Type, GeoMesh, PrimitiveField>&
);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "DimensionedFieldI.H"
#include "DimensionedFieldExpression.H"
#ifdef NoRepository
#include "DimensionedField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|