OpenFOAM logo
Open Source CFD Toolkit

coordinateRotation.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     coordinateRotation
00027 
00028 Description
00029     Virtual base class for coordinate rotation.  Allows multiple definitions of
00030     rotations of coordinate sytems.
00031 
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef coordinateRotation_H
00036 #define coordinateRotation_H
00037 
00038 #include "vector.H"
00039 #include "tensor.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                        Class coordinateRotation Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class coordinateRotation
00051 {
00052 public:
00053 
00054     // Static data members
00055 
00056         //- Axis
00057         static const vector z;
00058 
00059         //- Direction
00060         static const vector x;
00061 
00062 
00063     // Destructor
00064 
00065         virtual ~coordinateRotation()
00066         {}
00067 
00068 
00069     // Member Functions
00070 
00071         //- Return local-to-global transformation tensor
00072         virtual const tensor& R() const = 0;
00073 
00074         //- Return local axis
00075         vector axis() const
00076         {
00077             return R() & z;
00078         }
00079 
00080         //- Return local direction
00081         vector direction() const
00082         {
00083             return R() & x;
00084         }
00085 };
00086 
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 } // End namespace Foam
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 #endif
00095 
00096 // ************************************************************************* //
For further information go to www.openfoam.org