OpenFOAM logo
Open Source CFD Toolkit

evaluateError.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     evaluateError
00027 
00028 Description
00029 
00030 SourceFiles
00031     evaluateError.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef evaluateError_H
00036 #define evaluateError_H
00037 
00038 #include "labelList.H"
00039 #include "volFieldsFwd.H"
00040 #include "surfaceFieldsFwd.H"
00041 
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 // Class forward declarations
00049 class refineCell;
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class evaluateError Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class evaluateError
00056 {
00057     // Private data
00058 
00059         // splitFaces to remove.
00060         labelList unsplitFaces_;
00061 
00062         // cells to refine.
00063         List<refineCell> refCells_;
00064 
00065 
00066     // Private Member Functions
00067 
00068 
00069 public:
00070 
00071     // Constructors
00072 
00073         //- Construct null
00074         evaluateError();
00075 
00076 
00077         //- Construct from error value, error direction. Determine faces to
00078         //  remove (out of candidate faces) and cells to refine (all cells):
00079         //
00080         //  remove all faces where the (face)error is less than
00081         //     average - standard deviation
00082         //  refine all cells where the (cell)error is more than
00083         //      average + standard deviation. gradTheta is used to determine
00084         //      direction to refine in.
00085         evaluateError
00086         (
00087             const volScalarField& cellError,
00088             const volVectorField& gradTheta,
00089             const surfaceScalarField& faceError,
00090             const labelList& candidateFaces
00091         );
00092 
00093 
00094     // Member Functions
00095 
00096         const labelList& unsplitFaces() const
00097         {
00098             return unsplitFaces_;
00099         }
00100 
00101         const List<refineCell>& refCells() const
00102         {
00103             return refCells_;
00104         }
00105 };
00106 
00107 
00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00109 
00110 } // End namespace Foam
00111 
00112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00113 
00114 #endif
00115 
00116 // ************************************************************************* //
For further information go to www.openfoam.org