src/mesh/cfMesh/utilities/anisotropicMeshing/coordinateModification/coordinateModification.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     coordinateModification
  26
  27 Description
  28     Base class for modifiers of point coordinates.
  29
  30 SourceFiles
  31     coordinateModification.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef coordinateModification_H
  36 #define coordinateModification_H
  37
  38 #include "word.H"
  39 #include "point.H"
  40 #include "dictionary.H"
  41 #include "PtrList.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declarations
  49 class boundBox;
  50 class plane;
  51
  52 /*---------------------------------------------------------------------------*\
  53                    Class coordinateModification Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class coordinateModification
  57 {
  58     // Private data
  59
  60         //- Modification name
  61         word name_;
  62
  63 public:
  64
  65     // Runtime type information
  66         TypeName("coordinateModification");
  67
  68
  69     // Constructors
  70
  71         //- Null construct
  72         coordinateModification();
  73
  74         //- Construct from dictionary
  75         coordinateModification(const word& name, const dictionary&);
  76
  77     // Declare run-time constructor selection table
  78
  79         declareRunTimeSelectionTable
  80         (
  81             autoPtr,
  82             coordinateModification,
  83             dictionary,
  84             (
  85                 const word& name,
  86                 const dictionary& dict
  87             ),
  88             (name, dict)
  89         );
  90
  91
  92     // Selectors
  93
  94         //- Select constructed from dictionary
  95         static autoPtr<coordinateModification> New
  96         (
  97             const word& name,
  98             const dictionary& dict
  99         );
 100
 101     // Destructor
 102
 103         virtual ~coordinateModification();
 104
 105
 106     // Member Functions
 107
 108         //- return the origin point of the modification object
 109         virtual point origin() const = 0;
 110
 111         //- translate the object for backward transformation
 112         virtual void translateAndModifyObject(const vector&) = 0;
 113
 114         //- calculate the displacement vector for this modification
 115         virtual vector displacement(const point&) const = 0;
 116
 117         //- calculate the displacement vector for the backward modification
 118         virtual vector backwardDisplacement(const point&) const = 0;
 119
 120         //- can this modification object be combined with other ones
 121         virtual bool combiningPossible() const = 0;
 122
 123         //- return that "bounding planes" of the scaling region for
 124         //- the given object
 125         virtual void boundingPlanes(PtrList<plane>&) const = 0;
 126
 127
 128       // Access
 129
 130         //- Return name
 131         const word& name() const
 132         {
 133             return name_;
 134         }
 135
 136         //- set the name
 137         void setName(const word& name)
 138         {
 139             name_ = name;
 140         }
 141
 142         //- Return as dictionary of entries
 143         virtual dictionary dict(bool ignoreType = false) const = 0;
 144
 145       // Write
 146
 147         //- Write
 148         virtual void write(Ostream&) const = 0;
 149
 150         //- Write dictionary
 151         virtual void writeDict(Ostream&, bool subDict = true) const = 0;
 152
 153     // Member Operators
 154
 155         //- assign from dictionary
 156         virtual void operator=(const dictionary&) = 0;
 157
 158     // IOstream Operators
 159
 160         friend Ostream& operator<<(Ostream&, const coordinateModification&);
 161 };
 162
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 } // End namespace Foam
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #endif
 171
 172 // ************************************************************************* //