src/errorEstimation/errorEstimate/errorEstimate.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::errorEstimate
  27
  28 Description
  29     Residual error estimation
  30
  31 SourceFiles
  32     errorEstimate.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef errorEstimate_H
  37 #define errorEstimate_H
  38
  39 #include "volFields.H"
  40 #include "surfaceFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                         Class errorEstimate Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class errorEstimate
  53 :
  54     public refCount
  55 {
  56     // Private data
  57
  58         // Reference to GeometricField<Type, fvPatchField, volMesh>
  59         const GeometricField<Type, fvPatchField, volMesh>& psi_;
  60
  61         //- Dimension set
  62         dimensionSet dimensions_;
  63
  64         //- Cell residual pointer
  65         Field<Type> residual_;
  66
  67         //- Normalisation factor
  68         scalarField normFactor_;
  69
  70
  71     // Private Member Functions
  72
  73         //- Return boundary condition types for the error field
  74         wordList errorBCTypes() const;
  75
  76 public:
  77
  78     // Static data members
  79
  80     ClassName("errorEstimate");
  81
  82
  83     // Constructors
  84
  85         //- Construct from components
  86         errorEstimate
  87         (
  88             const GeometricField<Type, fvPatchField, volMesh>& psi,
  89             const dimensionSet& ds,
  90             const Field<Type>& res,
  91             const scalarField& norm
  92         );
  93
  94         //- Construct as copy
  95         errorEstimate(const errorEstimate<Type>&);
  96
  97
  98     // Destructor
  99
 100         ~errorEstimate();
 101
 102
 103     // Member Functions
 104
 105         // Access
 106
 107             //- Return field
 108             const GeometricField<Type, fvPatchField, volMesh>& psi() const
 109             {
 110                 return psi_;
 111             }
 112
 113             //- Return residual dimensions
 114             const dimensionSet& dimensions() const
 115             {
 116                 return dimensions_;
 117             }
 118
 119         // Raw residual (for calculus)
 120
 121             Field<Type>& res()
 122             {
 123                 return residual_;
 124             }
 125
 126             const Field<Type>& res() const
 127             {
 128                 return residual_;
 129             }
 130
 131
 132         // Error Estimate
 133
 134             //- Cell residual (volume intensive)
 135             tmp<GeometricField<Type, fvPatchField, volMesh> > residual() const;
 136
 137             //- Normalisation factor
 138             tmp<volScalarField> normFactor() const;
 139
 140             //- Error estimate
 141             tmp<GeometricField<Type, fvPatchField, volMesh> > error() const;
 142
 143
 144     // Member Operators
 145
 146         void operator=(const errorEstimate<Type>&);
 147         void operator=(const tmp<errorEstimate<Type> >&);
 148
 149         void negate();
 150
 151         void operator+=(const errorEstimate<Type>&);
 152         void operator+=(const tmp<errorEstimate<Type> >&);
 153
 154         void operator-=(const errorEstimate<Type>&);
 155         void operator-=(const tmp<errorEstimate<Type> >&);
 156
 157         void operator+=(const GeometricField<Type,fvPatchField,volMesh>&);
 158         void operator+=(const tmp<GeometricField<Type,fvPatchField,volMesh> >&);
 159
 160         void operator-=(const GeometricField<Type,fvPatchField,volMesh>&);
 161         void operator-=(const tmp<GeometricField<Type,fvPatchField,volMesh> >&);
 162
 163         void operator+=(const dimensioned<Type>&);
 164         void operator-=(const dimensioned<Type>&);
 165
 166         void operator*=(const volScalarField&);
 167         void operator*=(const tmp<volScalarField>&);
 168
 169         void operator*=(const dimensioned<scalar>&);
 170
 171
 172     // Friend Functions
 173
 174     // Friend Operators
 175 };
 176
 177
 178 // * * * * * * * * * * * * * * * Global functions  * * * * * * * * * * * * * //
 179
 180 template<class Type>
 181 void checkMethod
 182 (
 183     const errorEstimate<Type>&,
 184     const errorEstimate<Type>&,
 185     const char*
 186 );
 187
 188 template<class Type>
 189 void checkMethod
 190 (
 191     const errorEstimate<Type>&,
 192     const GeometricField<Type, fvPatchField, volMesh>&,
 193     const char*
 194 );
 195
 196 template<class Type>
 197 void checkMethod
 198 (
 199     const errorEstimate<Type>&,
 200     const dimensioned<Type>&,
 201     const char*
 202 );
 203
 204
 205 // * * * * * * * * * * * * * * * Global operators  * * * * * * * * * * * * * //
 206
 207 template<class Type>
 208 tmp<errorEstimate<Type> > operator-
 209 (
 210     const errorEstimate<Type>&
 211 );
 212
 213 template<class Type>
 214 tmp<errorEstimate<Type> > operator-
 215 (
 216     const tmp<errorEstimate<Type> >&
 217 );
 218
 219 template<class Type>
 220 tmp<errorEstimate<Type> > operator+
 221 (
 222     const errorEstimate<Type>&,
 223     const errorEstimate<Type>&
 224 );
 225
 226 template<class Type>
 227 tmp<errorEstimate<Type> > operator+
 228 (
 229     const tmp<errorEstimate<Type> >&,
 230     const errorEstimate<Type>&
 231 );
 232
 233 template<class Type>
 234 tmp<errorEstimate<Type> > operator+
 235 (
 236     const errorEstimate<Type>&,
 237     const tmp<errorEstimate<Type> >&
 238 );
 239
 240 template<class Type>
 241 tmp<errorEstimate<Type> > operator+
 242 (
 243     const tmp<errorEstimate<Type> >&,
 244     const tmp<errorEstimate<Type> >&
 245 );
 246
 247 template<class Type>
 248 tmp<errorEstimate<Type> > operator-
 249 (
 250     const errorEstimate<Type>&,
 251     const errorEstimate<Type>&
 252 );
 253
 254 template<class Type>
 255 tmp<errorEstimate<Type> > operator-
 256 (
 257     const tmp<errorEstimate<Type> >&,
 258     const errorEstimate<Type>&
 259 );
 260
 261 template<class Type>
 262 tmp<errorEstimate<Type> > operator-
 263 (
 264     const errorEstimate<Type>&,
 265     const tmp<errorEstimate<Type> >&
 266 );
 267
 268 template<class Type>
 269 tmp<errorEstimate<Type> > operator-
 270 (
 271     const tmp<errorEstimate<Type> >&,
 272     const tmp<errorEstimate<Type> >&
 273 );
 274
 275 template<class Type>
 276 tmp<errorEstimate<Type> > operator==
 277 (
 278     const errorEstimate<Type>&,
 279     const errorEstimate<Type>&
 280 );
 281
 282 template<class Type>
 283 tmp<errorEstimate<Type> > operator==
 284 (
 285     const tmp<errorEstimate<Type> >&,
 286     const errorEstimate<Type>&
 287 );
 288
 289 template<class Type>
 290 tmp<errorEstimate<Type> > operator==
 291 (
 292     const errorEstimate<Type>&,
 293     const tmp<errorEstimate<Type> >&
 294 );
 295
 296 template<class Type>
 297 tmp<errorEstimate<Type> > operator==
 298 (
 299     const tmp<errorEstimate<Type> >&,
 300     const tmp<errorEstimate<Type> >&
 301 );
 302
 303 template<class Type>
 304 tmp<errorEstimate<Type> > operator+
 305 (
 306     const errorEstimate<Type>&,
 307     const GeometricField<Type, fvPatchField, volMesh>&
 308 );
 309
 310 template<class Type>
 311 tmp<errorEstimate<Type> > operator+
 312 (
 313     const tmp<errorEstimate<Type> >&,
 314     const GeometricField<Type, fvPatchField, volMesh>&
 315 );
 316
 317 template<class Type>
 318 tmp<errorEstimate<Type> > operator+
 319 (
 320     const errorEstimate<Type>&,
 321     const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 322 );
 323
 324 template<class Type>
 325 tmp<errorEstimate<Type> > operator+
 326 (
 327     const tmp<errorEstimate<Type> >&,
 328     const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 329 );
 330
 331 template<class Type>
 332 tmp<errorEstimate<Type> > operator+
 333 (
 334     const GeometricField<Type, fvPatchField, volMesh>&,
 335     const errorEstimate<Type>&
 336 );
 337
 338 template<class Type>
 339 tmp<errorEstimate<Type> > operator+
 340 (
 341     const GeometricField<Type, fvPatchField, volMesh>&,
 342     const tmp<errorEstimate<Type> >&
 343 );
 344
 345 template<class Type>
 346 tmp<errorEstimate<Type> > operator+
 347 (
 348     const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
 349     const errorEstimate<Type>&
 350 );
 351
 352 template<class Type>
 353 tmp<errorEstimate<Type> > operator+
 354 (
 355     const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
 356     const tmp<errorEstimate<Type> >&
 357 );
 358
 359 template<class Type>
 360 tmp<errorEstimate<Type> > operator-
 361 (
 362     const errorEstimate<Type>&,
 363     const GeometricField<Type, fvPatchField, volMesh>&
 364 );
 365
 366 template<class Type>
 367 tmp<errorEstimate<Type> > operator-
 368 (
 369     const tmp<errorEstimate<Type> >&,
 370     const GeometricField<Type, fvPatchField, volMesh>&
 371 );
 372
 373 template<class Type>
 374 tmp<errorEstimate<Type> > operator-
 375 (
 376     const errorEstimate<Type>&,
 377     const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 378 );
 379
 380 template<class Type>
 381 tmp<errorEstimate<Type> > operator-
 382 (
 383     const tmp<errorEstimate<Type> >&,
 384     const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 385 );
 386
 387 template<class Type>
 388 tmp<errorEstimate<Type> > operator-
 389 (
 390     const GeometricField<Type, fvPatchField, volMesh>&,
 391     const errorEstimate<Type>&
 392 );
 393
 394 template<class Type>
 395 tmp<errorEstimate<Type> > operator-
 396 (
 397     const GeometricField<Type, fvPatchField, volMesh>&,
 398     const tmp<errorEstimate<Type> >&
 399 );
 400
 401 template<class Type>
 402 tmp<errorEstimate<Type> > operator-
 403 (
 404     const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
 405     const errorEstimate<Type>&
 406 );
 407
 408 template<class Type>
 409 tmp<errorEstimate<Type> > operator-
 410 (
 411     const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
 412     const tmp<errorEstimate<Type> >&
 413 );
 414
 415 template<class Type>
 416 tmp<errorEstimate<Type> > operator+
 417 (
 418     const tmp<errorEstimate<Type> >&,
 419     const dimensioned<Type>&
 420 );
 421
 422 template<class Type>
 423 tmp<errorEstimate<Type> > operator+
 424 (
 425     const dimensioned<Type>&,
 426     const tmp<errorEstimate<Type> >&
 427 );
 428
 429 template<class Type>
 430 tmp<errorEstimate<Type> > operator-
 431 (
 432     const tmp<errorEstimate<Type> >&,
 433     const dimensioned<Type>&
 434 );
 435
 436 template<class Type>
 437 tmp<errorEstimate<Type> > operator-
 438 (
 439     const dimensioned<Type>&,
 440     const tmp<errorEstimate<Type> >&
 441 );
 442
 443 template<class Type>
 444 tmp<errorEstimate<Type> > operator==
 445 (
 446     const errorEstimate<Type>&,
 447     const GeometricField<Type, fvPatchField, volMesh>&
 448 );
 449
 450 template<class Type>
 451 tmp<errorEstimate<Type> > operator==
 452 (
 453     const tmp<errorEstimate<Type> >&,
 454     const GeometricField<Type, fvPatchField, volMesh>&
 455 );
 456
 457 template<class Type>
 458 tmp<errorEstimate<Type> > operator==
 459 (
 460     const errorEstimate<Type>&,
 461     const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 462 );
 463
 464 template<class Type>
 465 tmp<errorEstimate<Type> > operator==
 466 (
 467     const tmp<errorEstimate<Type> >&,
 468     const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 469 );
 470
 471 template<class Type>
 472 tmp<errorEstimate<Type> > operator==
 473 (
 474     const errorEstimate<Type>&,
 475     const dimensioned<Type>&
 476 );
 477
 478 template<class Type>
 479 tmp<errorEstimate<Type> > operator==
 480 (
 481     const tmp<errorEstimate<Type> >&,
 482     const dimensioned<Type>&
 483 );
 484
 485
 486 template<class Type>
 487 tmp<errorEstimate<Type> > operator*
 488 (
 489     const volScalarField&,
 490     const errorEstimate<Type>&
 491 );
 492
 493 template<class Type>
 494 tmp<errorEstimate<Type> > operator*
 495 (
 496     const volScalarField&,
 497     const tmp<errorEstimate<Type> >&
 498 );
 499
 500 template<class Type>
 501 tmp<errorEstimate<Type> > operator*
 502 (
 503     const tmp<volScalarField>&,
 504     const errorEstimate<Type>&
 505 );
 506
 507 template<class Type>
 508 tmp<errorEstimate<Type> > operator*
 509 (
 510     const tmp<volScalarField>&,
 511     const tmp<errorEstimate<Type> >&
 512 );
 513
 514
 515 template<class Type>
 516 tmp<errorEstimate<Type> > operator*
 517 (
 518     const dimensioned<scalar>&,
 519     const errorEstimate<Type>&
 520 );
 521
 522 template<class Type>
 523 tmp<errorEstimate<Type> > operator*
 524 (
 525     const dimensioned<scalar>&,
 526     const tmp<errorEstimate<Type> >&
 527 );
 528
 529
 530 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 531
 532 } // End namespace Foam
 533
 534 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 535
 536 #ifdef NoRepository
 537 #   include "errorEstimate.C"
 538 #endif
 539
 540 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 541
 542 #endif
 543
 544 // ************************************************************************* //