Moving cfMesh into place. Updated contibutors list
[foam-extend-3.2.git] / src / mesh / cfMesh / meshLibrary / utilities / octrees / meshOctree / refinementControls / objectRefinement / boxRefinement.H
blob5a1de77434580b4296bba69b1584429f2a3637ea
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.
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.
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.
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/>.
24 Class
25     boxRefinement
27 Description
28     Checks if a box is contained inside the box object
30 SourceFiles
31     boxRefinement.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef boxRefinement_H
36 #define boxRefinement_H
38 #include "objectRefinement.H"
39 #include "point.H"
40 #include "typeInfo.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                            Class boxRefinement Declaration
49 \*---------------------------------------------------------------------------*/
51 class boxRefinement
53     public objectRefinement
55     // Private data
56         //- centre of the box
57         point centre_;
58     
59         //- length of box sides
60         scalar lengthX_;
61         scalar lengthY_;
62         scalar lengthZ_;
63     
64         //- angles to the global coordinate system
65         //scalar angleX_;
66         //scalar angleY_;
67         //scalar angleZ_;
69 public:
71     //- Runtime type information
72     TypeName("box");
75     // Constructors
77         //- Null construct
78         boxRefinement();
80         //- Construct from name, cell size, centre and sizes
81         boxRefinement
82         (
83             const word& name,
84             const scalar cellSize,
85             const point& centre,
86             const scalar lengthX,
87             const scalar lengthY,
88             const scalar lengthZ
89             //const scalar angleX = 0.,
90             //const scalar angleY = 0.,
91             //const scalar angleZ = 0.
92         );
94         //- Construct from dictionary
95         boxRefinement(const word& name, const dictionary& dict);
96         
97         //- Construct and return a clone
98         virtual autoPtr<objectRefinement> clone
99         (
100             const boxRefinement& sr
101         ) const
102         {
103             return autoPtr<objectRefinement>
104             (
105                 new boxRefinement
106                 (
107                     sr.name(),
108                     sr.cellSize(),
109                     sr.centre_,
110                     sr.lengthX_,
111                     sr.lengthY_,
112                     sr.lengthZ_
113                     //sr.angleX_,
114                     //sr.angleY_,
115                     //sr.angleZ_
116                 )
117             );
118         }
119     
120     // Member Functions
121     
122         //- check if a boundBox intersects or is inside the object
123         bool intersectsObject(const boundBox&) const;
124         
125     //- Return as dictionary of entries
126         dictionary dict(bool ignoreType = false) const;
128       // Write
130         //- Write
131         void write(Ostream&) const;
133         //- Write dictionary
134         void writeDict(Ostream&, bool subDict = true) const;
135         
136     // Member Operators
138         //- assign from dictionary
139         void operator=(const dictionary&);
141     // IOstream Operators
143         Ostream& operator<<(Ostream&) const;
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 } // End namespace Foam
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 #endif
155 // ************************************************************************* //