FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::fieldToCell
00026 
00027 Description
00028     A topoSetSource to select cells based on field values.
00029 
00030 SourceFiles
00031     fieldToCell.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef fieldToCell_H
00036 #define fieldToCell_H
00037 
00038 #include <meshTools/topoSetSource.H>
00039 #include <OpenFOAM/scalarField.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class fieldToCell Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class fieldToCell
00051 :
00052     public topoSetSource
00053 {
00054 
00055     // Private data
00056 
00057         //- Add usage string
00058         static addToUsageTable usage_;
00059 
00060 
00061         //- Name of volScalarField
00062         word fieldName_;
00063 
00064         //- min to subset field values with
00065         scalar min_;
00066 
00067         //- max ,,
00068         scalar max_;
00069 
00070 
00071     // Private Member Functions
00072 
00073         //- Depending on field values add to or delete from cellSet.
00074         void applyToSet
00075         (
00076             const topoSetSource::setAction action,
00077             const scalarField& field,
00078             topoSet& set
00079         ) const;
00080 
00081 public:
00082 
00083     //- Runtime type information
00084     TypeName("fieldToCell");
00085 
00086     // Constructors
00087 
00088         //- Construct from components
00089         fieldToCell
00090         (
00091             const polyMesh& mesh,
00092             const word& fieldName,
00093             const scalar min,
00094             const scalar max
00095         );
00096 
00097         //- Construct from dictionary
00098         fieldToCell
00099         (
00100             const polyMesh& mesh,
00101             const dictionary& dict
00102         );
00103 
00104         //- Construct from Istream
00105         fieldToCell
00106         (
00107             const polyMesh& mesh,
00108             Istream&
00109         );
00110 
00111 
00112     // Destructor
00113 
00114         virtual ~fieldToCell();
00115 
00116 
00117     // Member Functions
00118 
00119         virtual void applyToSet
00120         (
00121             const topoSetSource::setAction action,
00122             topoSet&
00123         ) const;
00124 
00125 };
00126 
00127 
00128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00129 
00130 } // End namespace Foam
00131 
00132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00133 
00134 #endif
00135 
00136 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines