OpenFOAM logo
Open Source CFD Toolkit

SphericalTensor.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     SphericalTensor
00027 
00028 Description
00029     Templated 3D SphericalTensor derived from VectorSpace adding construction
00030     from 1 component, element access using xx(), yy() and zz() member functions
00031     and the inner-product (dot-product) and outer-product operators.
00032 
00033 SourceFiles
00034     SphericalTensorI.H
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef SphericalTensor_H
00039 #define SphericalTensor_H
00040 
00041 #include "Tensor.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class SphericalTensor Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 template<class Cmpt>
00053 class SphericalTensor
00054 :
00055     public VectorSpace<SphericalTensor<Cmpt>, Cmpt, 1>
00056 {
00057 
00058 public:
00059 
00060     // Member constants
00061 
00062         enum
00063         {
00064             rank = 2 // Rank of SphericalTensor is 2
00065         };
00066 
00067 
00068     // Static data members
00069 
00070         static const char* const typeName;
00071         static const char* componentNames[];
00072         static const SphericalTensor zero;
00073         static const SphericalTensor one;
00074         static const SphericalTensor I;
00075         static const SphericalTensor oneThirdI;
00076         static const SphericalTensor twoThirdsI;
00077 
00078 
00079     //- Component labeling enumeration
00080     enum components { II };
00081 
00082 
00083     // Constructors
00084 
00085         //- Construct null
00086         inline SphericalTensor();
00087 
00088         //- Construct given VectorSpace
00089         inline SphericalTensor
00090         (
00091             const VectorSpace<SphericalTensor<Cmpt>, Cmpt, 1>&
00092         );
00093 
00094         //- Construct given the component
00095         inline SphericalTensor(const Cmpt& tii);
00096 
00097         //- Construct from Istream
00098         inline SphericalTensor(Istream&);
00099 
00100 
00101     // Member Functions
00102 
00103         // Access
00104 
00105             inline const Cmpt& ii() const;
00106             inline Cmpt& ii();
00107 };
00108 
00109 
00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00111 
00112 } // End namespace Foam
00113 
00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00115 
00116 // Include inline implementations
00117 #include "SphericalTensorI.H"
00118 
00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00120 
00121 #endif
00122 
00123 // ************************************************************************* //
For further information go to www.openfoam.org