OpenFOAM logo
Open Source CFD Toolkit

fieldToCell.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     fieldToCell
00027 
00028 Description
00029     Select cells based on cell centres inside box.
00030 
00031 SourceFiles
00032     fieldToCell.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef fieldToCell_H
00037 #define fieldToCell_H
00038 
00039 #include "topoSetSource.H"
00040 #include "scalarField.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class fieldToCell Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class fieldToCell
00052 :
00053     public topoSetSource
00054 {
00055 
00056     // Private data
00057 
00058         //- Add usage string
00059         static addToUsageTable usage_;
00060 
00061 
00062         //- Name of volScalarField
00063         word fieldName_;
00064 
00065         //- min to subset field values with
00066         scalar min_;
00067 
00068         //- max ,,
00069         scalar max_;
00070 
00071 
00072     // Private Member Functions
00073 
00074         //- Depending on field values add to or delete from cellSet.
00075         void applyToSet
00076         (
00077             const topoSetSource::setAction action,
00078             const scalarField& field,
00079             topoSet& set
00080         ) const;
00081 
00082 public:
00083 
00084     //- Runtime type information
00085     TypeName("fieldToCell");
00086 
00087     // Constructors
00088 
00089         //- Construct from components
00090         fieldToCell
00091         (
00092             const polyMesh& mesh,
00093             const word& fieldName,
00094             const scalar min,
00095             const scalar max
00096         );
00097 
00098         //- Construct from dictionary
00099         fieldToCell
00100         (
00101             const polyMesh& mesh,
00102             const dictionary& dict
00103         );
00104 
00105         //- Construct from Istream
00106         fieldToCell
00107         (
00108             const polyMesh& mesh,
00109             Istream&
00110         );
00111 
00112 
00113     // Destructor
00114 
00115         virtual ~fieldToCell();
00116 
00117 
00118     // Member Functions
00119 
00120         virtual void applyToSet(const topoSetSource::setAction action, topoSet&)
00121          const;
00122 
00123 };
00124 
00125 
00126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00127 
00128 } // End namespace Foam
00129 
00130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00131 
00132 #endif
00133 
00134 // ************************************************************************* //
For further information go to www.openfoam.org