src/OpenFOAM/fields/pointPatchFields/pointPatchField/pointConstraint/pointConstraint.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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     Foam::pointConstraint
  27
  28 Description
  29     Accumulates point constraints through successive applications of the
  30     applyConstraint function.
  31
  32     After all the constraints have been entered the resulting
  33     transformation tensor is returned by the constraintTransformation
  34     function.
  35
  36 SourceFiles
  37     pointConstraintI.H
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef pointConstraint_H
  42 #define pointConstraint_H
  43
  44 #include "label.H"
  45 #include "uLabel.H"
  46 #include "vector.H"
  47 #include "tensor.H"
  48 #include "Tuple2.H"
  49
  50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class pointConstraint Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class pointConstraint
  60 :
  61     public Tuple2<label, vector>
  62 {
  63
  64 public:
  65
  66     // Constructors
  67
  68         //- Construct null
  69         inline pointConstraint();
  70
  71         //- Construct from Istream
  72         inline pointConstraint(Istream&);
  73
  74
  75     // Member Functions
  76
  77         //- Apply and accumulate the effect of the given constraint direction
  78         inline void applyConstraint(const vector& cd);
  79
  80         //- Return the accumulated constraint transformation tensor
  81         inline tensor constraintTransformation() const;
  82 };
  83
  84
  85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  86
  87 } // End namespace Foam
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 #include "pointConstraintI.H"
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #endif
  96
  97 // ************************************************************************* //