src/mesh/cfMesh/utilities/anisotropicMeshing/coordinateModification/coordinateModifier.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | cfMesh: A library for mesh generation
   4    \\    /   O peration     |
   5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
   6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of cfMesh.
  10
  11     cfMesh 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     cfMesh 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 cfMesh.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     coordinateModifier
  26
  27 Description
  28     Base class for modification of point coordinates
  29     in surface and volume meshes.
  30
  31 SourceFiles
  32     coordinateModifier.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef coordinateModifier_H
  37 #define coordinateModifier_H
  38
  39 #include "objectRegistry.H"
  40 #include "foamTime.H"
  41 #include "word.H"
  42 #include "point.H"
  43 #include "coordinateModificationList.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 // Forward declarations
  51 class boundBox;
  52
  53 /*---------------------------------------------------------------------------*\
  54                    Class coordinateModifier Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class coordinateModifier
  58 {
  59     // Private data
  60
  61         //- Reference to dictionary
  62         const dictionary& modificationDict_;
  63
  64         //- list of coordinate modification objects
  65         coordinateModificationList modifiers_;
  66
  67         //- list of backward coordinate modifiers
  68         coordinateModificationList backwardModifiers_;
  69
  70     // Private member functions
  71         //- check if the comibination of modifiers has a valid inverse
  72         void checkForValidInverse() const;
  73
  74 public:
  75
  76     // Constructors
  77
  78         //- Construct from dictionary
  79         coordinateModifier(const dictionary&);
  80
  81     // Destructor
  82
  83         ~coordinateModifier();
  84
  85
  86     // Member Functions
  87
  88         //- calculate the modified coordinate of the point
  89         point modifiedPoint(const point&) const;
  90
  91         //- calculate the displacement vector for the backward modification
  92         point backwardModifiedPoint(const point&) const;
  93
  94         //- Print modification objects
  95         void printObjects() const;
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //