FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

pointConstraint.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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::pointConstraint
00026 
00027 Description
00028     Accumulates point constraints through successive applications of the
00029     applyConstraint function.
00030  
00031     After all the constraints have been entered the resulting
00032     transformation tensor is returned by the constraintTransformation
00033     function.
00034 
00035 SourceFiles
00036     pointConstraintI.H
00037 
00038 \*---------------------------------------------------------------------------*/
00039 
00040 #ifndef pointConstraint_H
00041 #define pointConstraint_H
00042 
00043 #include <OpenFOAM/label.H>
00044 #include <OpenFOAM/uLabel.H>
00045 #include <OpenFOAM/vector.H>
00046 #include <OpenFOAM/tensor.H>
00047 #include <OpenFOAM/Tuple2.H>
00048 
00049 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00050 
00051 namespace Foam
00052 {
00053 
00054 /*---------------------------------------------------------------------------*\
00055                            Class pointConstraint Declaration
00056 \*---------------------------------------------------------------------------*/
00057 
00058 class pointConstraint
00059 :
00060     public Tuple2<label, vector>
00061 {
00062 
00063 public:
00064 
00065     // Constructors
00066 
00067         //- Construct null
00068         inline pointConstraint();
00069 
00070         //- Construct from Istream
00071         inline pointConstraint(Istream&);
00072 
00073 
00074     // Member Functions
00075 
00076         //- Apply and accumulate the effect of the given constraint direction 
00077         inline void applyConstraint(const vector& cd);
00078 
00079         //- Return the accumulated constraint transformation tensor
00080         inline tensor constraintTransformation() const;
00081 };
00082 
00083 
00084 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00085 
00086 } // End namespace Foam
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 #include "pointConstraintI.H"
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 #endif
00095 
00096 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines