src/errorEstimation/errorDrivenRefinement/errorDrivenRefinement.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::errorDrivenRefinement
  27
  28 Description
  29     Refines and coarsens based on error estimate.
  30
  31 SourceFiles
  32     errorDrivenRefinement.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef errorDrivenRefinement_H
  37 #define errorDrivenRefinement_H
  38
  39 #include "polyMeshModifier.H"
  40 #include "undoableMeshCutter.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48
  49 /*---------------------------------------------------------------------------*\
  50                        Class errorDrivenRefinement Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class errorDrivenRefinement
  54 :
  55     public polyMeshModifier
  56 {
  57     // Private data
  58
  59         //- Refinement/coarsening engine
  60         mutable undoableMeshCutter refinementEngine_;
  61
  62         //- Name of volVectorField which contains error.
  63         word errorField_;
  64
  65
  66     // Private Member Functions
  67
  68         //- Disallow default bitwise copy construct
  69         errorDrivenRefinement(const errorDrivenRefinement&);
  70
  71         //- Disallow default bitwise assignment
  72         void operator=(const errorDrivenRefinement&);
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("errorDrivenRefinement");
  79
  80
  81     // Constructors
  82
  83         //- Construct from dictionary
  84         errorDrivenRefinement
  85         (
  86             const word& name,
  87             const dictionary& dict,
  88             const label index,
  89             const polyTopoChanger& mme
  90         );
  91
  92
  93     // Destructor
  94
  95         virtual ~errorDrivenRefinement();
  96
  97
  98     // Member Functions
  99
 100         //- Check for topology change
 101         virtual bool changeTopology() const;
 102
 103         //- Insert the layer addition/removal instructions
 104         //  into the topological change
 105         virtual void setRefinement(polyTopoChange&) const;
 106
 107         //- Modify motion points to comply with the topological change
 108         virtual void modifyMotionPoints(pointField& motionPoints) const;
 109
 110         //- Force recalculation of locally stored data on topological change
 111         virtual void updateMesh(const mapPolyMesh&);
 112
 113         //- Write
 114         virtual void write(Ostream&) const;
 115
 116         //- Write dictionary
 117         virtual void writeDict(Ostream&) const;
 118
 119
 120     // Access
 121
 122         //- Underlying mesh modifier
 123         const undoableMeshCutter& refinementEngine() const
 124         {
 125             return refinementEngine_;
 126         }
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //