src/dynamicMesh/attachDetach/attachDetach.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::attachDetach
  27
  28 Description
  29     Attach/detach boundary mesh modifier.  This modifier takes a set of
  30     internal faces and converts them into boundary faces and vice versa
  31     based on the given activation switch.
  32
  33     The patch is oriented using the flip map in the face zone.  The
  34     oriented faces are put into the master patch and their mirror
  35     images into the slave.
  36
  37 SourceFiles
  38     attachDetach.C
  39     attachInterface.C
  40     detachInterface.C
  41     attachDetachPointMatchMap.C
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef attachDetach_H
  46 #define attachDetach_H
  47
  48 #include "polyMeshModifier.H"
  49 #include "polyPatchID.H"
  50 #include "ZoneIDs.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58                        Class attachDetach Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class attachDetach
  62 :
  63     public polyMeshModifier
  64 {
  65     // Data types
  66
  67         //- State of the modifier
  68         enum modifierState
  69         {
  70             UNKNOWN,
  71             ATTACHED,
  72             DETACHED
  73         };
  74
  75
  76     // Private data
  77
  78         //- Master face zone ID
  79         faceZoneID faceZoneID_;
  80
  81         //- Master patch ID.  Holds faces with original orientation
  82         polyPatchID masterPatchID_;
  83
  84         //- Slave patch ID.  Holds mirrored faces
  85         polyPatchID slavePatchID_;
  86
  87         //- List of trigger times
  88         scalarField triggerTimes_;
  89
  90         //- Use manual trigger
  91         Switch manualTrigger_;
  92
  93         //- Trigger time index
  94         mutable label triggerIndex_;
  95
  96         //- State of the modifier
  97         mutable modifierState state_;
  98
  99         //- Attach/detach trigger
 100         mutable bool trigger_;
 101
 102
 103         // Private addressing data.  Created on topology change
 104
 105             //- Map of matching points
 106             mutable Map<label>* pointMatchMapPtr_;
 107
 108
 109     // Private Member Functions
 110
 111         //- Disallow default bitwise copy construct
 112         attachDetach(const attachDetach&);
 113
 114         //- Disallow default bitwise assignment
 115         void operator=(const attachDetach&);
 116
 117         //- Check validity of construction data
 118         void checkDefinition();
 119
 120         // Topological changes
 121
 122             //- Attach interface
 123             void attachInterface(polyTopoChange&) const;
 124
 125             //- Detach interface
 126             void detachInterface(polyTopoChange&) const;
 127
 128             //- Calculate point match addressing
 129             void calcPointMatchMap() const;
 130
 131             //- Return point match map
 132             const Map<label>& pointMatchMap() const;
 133
 134             //- Clear addressing
 135             void clearAddressing() const;
 136
 137
 138     // Static data members
 139
 140         //- Relative vertex position tolerance
 141         static const scalar positionDifference_;
 142
 143
 144 public:
 145
 146     //- Runtime type information
 147     TypeName("attachDetach");
 148
 149
 150     // Constructors
 151
 152         //- Construct from components
 153         attachDetach
 154         (
 155             const word& name,
 156             const label index,
 157             const polyTopoChanger& mme,
 158             const word& faceZoneName,
 159             const word& masterPatchName,
 160             const word& slavePatchName,
 161             const scalarField& triggerTimes,
 162             const bool manualTrigger = false
 163         );
 164
 165         //- Construct from dictionary
 166         attachDetach
 167         (
 168             const word& name,
 169             const dictionary& dict,
 170             const label index,
 171             const polyTopoChanger& mesh
 172         );
 173
 174
 175     // Destructor
 176
 177         virtual ~attachDetach();
 178
 179
 180     // Member Functions
 181
 182         //- Return master patch ID
 183         const polyPatchID& masterPatchID() const
 184         {
 185             return masterPatchID_;
 186         }
 187
 188         //- Return slave patch ID
 189         const polyPatchID& slavePatchID() const
 190         {
 191             return slavePatchID_;
 192         }
 193
 194         //- Is the interface attached?
 195         bool attached() const
 196         {
 197             return state_ == ATTACHED;
 198         }
 199
 200         const Switch& manualTrigger() const
 201         {
 202             return manualTrigger_;
 203         }
 204
 205         // Manually set attach.  Use only with manual trigger
 206         bool setAttach() const;
 207
 208         // Manually set detach.  Use only with manual trigger
 209         bool setDetach() const;
 210
 211         //- Check for topology change
 212         virtual bool changeTopology() const;
 213
 214         //- Insert the layer addition/removal instructions
 215         //  into the topological change
 216         virtual void setRefinement(polyTopoChange&) const;
 217
 218         //- Modify motion points to comply with the topological change
 219         virtual void modifyMotionPoints(pointField& motionPoints) const;
 220
 221         //- Force recalculation of locally stored data on topological change
 222         virtual void updateMesh(const mapPolyMesh&);
 223
 224         //- Get reference to trigger times
 225         const scalarField& triggerTimes() const
 226         {
 227             return triggerTimes_;
 228         }
 229
 230
 231         //- Write
 232         virtual void write(Ostream&) const;
 233
 234         //- Write dictionary
 235         virtual void writeDict(Ostream&) const;
 236 };
 237
 238
 239 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 240
 241 } // End namespace Foam
 242
 243 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 244
 245 #endif
 246
 247 // ************************************************************************* //