src/mesh/cfMesh/meshLibrary/utilities/octrees/meshOctree/refinementControls/objectRefinement/sphereRefinement.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     sphereRefinement
  26
  27 Description
  28     Mark objects contained in a sphere
  29
  30 SourceFiles
  31     sphereRefinement.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef sphereRefinement_H
  36 #define sphereRefinement_H
  37
  38 #include "objectRefinement.H"
  39 #include "point.H"
  40 #include "typeInfo.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class sphereRefinement Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class sphereRefinement
  52 :
  53     public objectRefinement
  54 {
  55     // Private data
  56         //- centre of the sphere
  57         point centre_;
  58
  59         //- radius of the sphere
  60         scalar radius_;
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("sphere");
  66
  67
  68     // Constructors
  69
  70         //- Null construct
  71         sphereRefinement();
  72
  73         //- Construct from name, cell size, centre and radius
  74         sphereRefinement
  75         (
  76             const word& name,
  77             const scalar cellSize,
  78             const point& centre,
  79             const scalar radius
  80         );
  81
  82         //- Construct from dictionary
  83         sphereRefinement(const word& name, const dictionary& dict);
  84
  85         //- Construct and return a clone
  86         virtual autoPtr<objectRefinement> clone
  87         (
  88             const sphereRefinement& sr
  89         ) const
  90         {
  91             return autoPtr<objectRefinement>
  92             (
  93                 new sphereRefinement
  94                 (
  95                     sr.name(),
  96                     sr.cellSize(),
  97                     sr.centre_,
  98                     sr.radius_
  99                 )
 100             );
 101         }
 102
 103     // Member Functions
 104
 105         //- check if a boundBox intersects or is inside the object
 106         bool intersectsObject(const boundBox&) const;
 107
 108     //- Return as dictionary of entries
 109         dictionary dict(bool ignoreType = false) const;
 110
 111       // Write
 112
 113         //- Write
 114         void write(Ostream&) const;
 115
 116         //- Write dictionary
 117         void writeDict(Ostream&, bool subDict = true) const;
 118
 119     // Member Operators
 120
 121         //- assign from dictionary
 122         void operator=(const dictionary&);
 123
 124     // IOstream Operators
 125
 126         Ostream& operator<<(Ostream&) const;
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //