FreeFOAM The Cross-Platform CFD Toolkit
evaluateError.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM 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 OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::evaluateError
26 
27 Description
28  Foam::evaluateError
29 
30 SourceFiles
31  evaluateError.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef evaluateError_H
36 #define evaluateError_H
37 
38 #include <OpenFOAM/labelList.H>
41 
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declaration of classes
49 class refineCell;
50 
51 /*---------------------------------------------------------------------------*\
52  Class evaluateError Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57  // Private data
58 
59  // splitFaces to remove.
60  labelList unsplitFaces_;
61 
62  // cells to refine.
63  List<refineCell> refCells_;
64 
65 
66  // Private Member Functions
67 
68 
69 public:
70 
71  // Constructors
72 
73  //- Construct null
74  evaluateError();
75 
76 
77  //- Construct from error value, error direction. Determine faces to
78  // remove (out of candidate faces) and cells to refine (all cells):
79  //
80  // remove all faces where the (face)error is less than
81  // average - standard deviation
82  // refine all cells where the (cell)error is more than
83  // average + standard deviation. gradTheta is used to determine
84  // direction to refine in.
86  (
87  const volScalarField& cellError,
88  const volVectorField& gradTheta,
89  const surfaceScalarField& faceError,
90  const labelList& candidateFaces
91  );
92 
93 
94  // Member Functions
95 
96  const labelList& unsplitFaces() const
97  {
98  return unsplitFaces_;
99  }
100 
101  const List<refineCell>& refCells() const
102  {
103  return refCells_;
104  }
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************ vim: set sw=4 sts=4 et: ************************ //