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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   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     BlockCoeffComponentNorm
  26
  27 Description
  28     Class for BlockCoeff norm based on a specified component.
  29
  30 Author
  31     Klas Jareteg, 2013-03-07
  32
  33 SourceFiles
  34     BlockCoeffComponentNorm.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef BlockCoeffComponentNorm_H
  39 #define BlockCoeffComponentNorm_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 BlockCoeffComponentNorm Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 template<class Type>
  60 class BlockCoeffComponentNorm
  61 :
  62     public BlockCoeffNorm<Type>
  63 {
  64     // Private data
  65
  66         //- Control data dictionary
  67         dictionary dict_;
  68
  69         //- Component from which the norm is determined
  70         const direction cmpt_;
  71
  72
  73 protected:
  74
  75     // Protected Member Functions
  76
  77         //- Return dictionary
  78         const dictionary& dict() const
  79         {
  80             return dict_;
  81         }
  82
  83
  84 public:
  85
  86     //- Runtime type information
  87     TypeName("componentNorm");
  88
  89
  90     // Constructors
  91
  92         //- Construct from dictionary
  93         BlockCoeffComponentNorm
  94         (
  95             const dictionary& dict
  96         );
  97
  98     // Destructor
  99
 100         virtual ~BlockCoeffComponentNorm()
 101         {}
 102
 103
 104     // Member functions
 105
 106         //- Solve
 107         virtual scalar normalize
 108         (
 109             const BlockCoeff<Type>& a
 110         );
 111
 112         virtual void coeffMag
 113         (
 114             const CoeffField<Type>& a,
 115             Field<scalar>& b
 116         );
 117 };
 118
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 } // End namespace Foam
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 #ifdef NoRepository
 127 #   include "BlockCoeffComponentNorm.C"
 128 #endif
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //