OpenFOAM logo
Open Source CFD Toolkit

DiagTensor.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     DiagTensor
00027 
00028 Description
00029     Templated 3D DiagTensor derived from VectorSpace adding construction from
00030     3 components, element access using xx(), yy() and zz() member functions and
00031     the inner-product (dot-product) and outer-product operators.
00032 
00033 SourceFiles
00034     DiagTensorI.H
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef DiagTensor_H
00039 #define DiagTensor_H
00040 
00041 #include "Tensor.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class DiagTensor Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 template <class Cmpt>
00053 class DiagTensor
00054 :
00055     public VectorSpace<DiagTensor<Cmpt>, Cmpt, 3>
00056 {
00057 
00058 public:
00059 
00060     // Member constants
00061 
00062         enum
00063         {
00064             rank = 2 // Rank of DiagTensor is 2
00065         };
00066 
00067 
00068     // Static data members
00069 
00070         static const char* const typeName;
00071         static const char* componentNames[];
00072         static const DiagTensor zero;
00073         static const DiagTensor one;
00074         static const DiagTensor I;
00075 
00076 
00077     //- Component labeling enumeration
00078     enum components { XX, YY, ZZ };
00079 
00080 
00081     // Constructors
00082 
00083         //- Construct null
00084         inline DiagTensor();
00085 
00086         //- Construct given VectorSpace
00087         inline DiagTensor(const VectorSpace<DiagTensor<Cmpt>, Cmpt, 3>&);
00088 
00089         //- Construct given three components
00090         inline DiagTensor(const Cmpt& txx, const Cmpt& tyy, const Cmpt& tzz);
00091 
00092         //- Construct from Istream
00093         inline DiagTensor(Istream&);
00094 
00095 
00096     // Member Functions
00097 
00098         // Access
00099 
00100             inline const Cmpt& xx() const;
00101             inline const Cmpt& yy() const;
00102             inline const Cmpt& zz() const;
00103 
00104             inline Cmpt& xx();
00105             inline Cmpt& yy();
00106             inline Cmpt& zz();
00107 };
00108 
00109 
00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00111 
00112 } // End namespace Foam
00113 
00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00115 
00116 // Include inline implementations
00117 #include "DiagTensorI.H"
00118 
00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00120 
00121 #endif
00122 
00123 // ************************************************************************* //
For further information go to www.openfoam.org