src/foam/primitives/BlockCoeff/BlockCoeffNorm/BlockCoeffMaxNorm/BlockCoeffMaxNorm.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     BlockCoeffMaxNorm
  26
  27 Description
  28     Class for BlockCoeff maximum element magnitude norm.
  29
  30 Author
  31     Klas Jareteg, 2013-03-07
  32
  33 SourceFiles
  34     BlockCoeffMaxNorm.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef BlockCoeffMaxNorm_H
  39 #define BlockCoeffMaxNorm_H
  40
  41 #include "blockCoeffs.H"
  42 #include "blockCoeffNorms.H"
  43 #include "BlockCoeffNorm.H"
  44 #include "CoeffField.H"
  45 #include "runTimeSelectionTables.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 // * * * * * * Forward declaration of template friend fuctions * * * * * * * //
  53
  54
  55 /*---------------------------------------------------------------------------*\
  56                         Class BlockCoeffMaxNorm Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 template<class Type>
  60 class BlockCoeffMaxNorm
  61 :
  62     public BlockCoeffNorm<Type>
  63 {
  64     // Private data
  65
  66         //- Control data dictionary
  67         dictionary dict_;
  68
  69 protected:
  70
  71     // Protected data types
  72
  73
  74     // Protected data
  75
  76
  77     // Protected Member Functions
  78
  79         //- Return dictionary
  80         const dictionary& dict() const
  81         {
  82             return dict_;
  83         }
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("maxNorm");
  89
  90
  91     // Constructors
  92
  93         //- Construct from dictionary
  94         BlockCoeffMaxNorm
  95         (
  96             const dictionary& dict
  97         );
  98
  99     // Destructor
 100
 101         virtual ~BlockCoeffMaxNorm()
 102         {}
 103
 104
 105     // Member functions
 106
 107         //- Solve
 108         virtual scalar normalize
 109         (
 110             const BlockCoeff<Type>& a
 111         );
 112
 113         virtual void coeffMag
 114         (
 115             const CoeffField<Type>& a,
 116             Field<scalar>& b
 117         );
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #ifdef NoRepository
 128 #   include "BlockCoeffMaxNorm.C"
 129 #endif
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //