src/VectorN/OpenFOAM/primitives/VectorN.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     VectorN
  27
  28 Description
  29     Templated 2D Vector derived from VectorSpace adding construction from
  30     2 components, element access using x() and y() member functions and
  31     the inner-product (dot-product).
  32
  33 SourceFiles
  34     VectorNI.H
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef VectorN_H
  39 #define VectorN_H
  40
  41 #include "VectorSpace.H"
  42 #include "tensor.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class VectorN Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template <class Cmpt, int length>
  54 class VectorN
  55 :
  56     public VectorSpace<VectorN<Cmpt, length>, Cmpt, length>
  57 {
  58
  59 public:
  60
  61     // Member constants
  62
  63         enum
  64         {
  65             rank = 1 // Rank of VectorN is 1
  66         };
  67
  68
  69     // Static data members
  70
  71         static const char* const typeName;
  72         static const VectorN zero;
  73         static const VectorN one;
  74
  75
  76     // Constructors
  77
  78         //- Construct null
  79         inline VectorN();
  80
  81         //- Construct given VectorSpace
  82         inline VectorN
  83         (
  84             const VectorSpace<VectorN<Cmpt, length>, Cmpt, length>&
  85         );
  86
  87         //- Construct given component value.  Special use only!
  88         explicit inline VectorN(const Cmpt& vx);
  89
  90         //- Construct from Istream
  91         inline VectorN(Istream&);
  92
  93
  94     // Member Functions
  95
  96         //- Return ith component
  97         inline const Cmpt& operator()(const direction i) const;
  98
  99         //- Return access to ith component
 100         inline Cmpt& operator()(const direction i);
 101
 102         //- Componentwise multiply
 103         inline VectorN<Cmpt, length> cmptMultiply
 104         (
 105             const VectorN<Cmpt, length>&
 106         );
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 // Include inline implementations
 117 #include "VectorNI.H"
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 #endif
 122
 123 // ************************************************************************* //