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 InNamespace 00025 Foam 00026 00027 Description 00028 Find the reference cell nearest (in index) to the given cell but which 00029 is not on a cyclic, symmetry or processor patch. 00030 00031 SourceFiles 00032 findRefCell.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef findRefCell_H 00037 #define findRefCell_H 00038 00039 #include <OpenFOAM/label.H> 00040 #include <finiteVolume/volFields.H> 00041 00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00043 00044 namespace Foam 00045 { 00046 00047 //- If the field fieldRef needs referencing find the reference cell nearest 00048 // (in index) to the given cell looked-up for field, but which is not on a 00049 // cyclic, symmetry or processor patch. 00050 void setRefCell 00051 ( 00052 const volScalarField& field, 00053 const volScalarField& fieldRef, 00054 const dictionary& dict, 00055 label& refCelli, 00056 scalar& refValue, 00057 const bool forceReference = false 00058 ); 00059 00060 //- If the field needs referencing find the reference cell nearest 00061 // (in index) to the given cell looked-up for field, but which is not on a 00062 // cyclic, symmetry or processor patch. 00063 void setRefCell 00064 ( 00065 const volScalarField& field, 00066 const dictionary& dict, 00067 label& refCelli, 00068 scalar& refValue, 00069 const bool forceReference = false 00070 ); 00071 00072 //- Return the current value of field in the reference cell 00073 scalar getRefCellValue 00074 ( 00075 const volScalarField& field, 00076 const label refCelli 00077 ); 00078 00079 } 00080 00081 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00082 00083 #endif 00084 00085 // ************************ vim: set sw=4 sts=4 et: ************************ //