findRefCell.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) 2011 OpenFOAM Foundation
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 InNamespace
25  Foam
26 
27 Description
28  Find the reference cell nearest (in index) to the given cell but which
29  is not on a cyclic, symmetry or processor patch.
30 
31 SourceFiles
32  findRefCell.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef findRefCell_H
37 #define findRefCell_H
38 
39 #include "label.H"
40 #include "volFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 //- If the field fieldRef needs referencing find the reference cell nearest
48 // (in index) to the given cell looked-up for field, but which is not on a
49 // cyclic, symmetry or processor patch.
50 void setRefCell
51 (
52  const volScalarField& field,
53  const volScalarField& fieldRef,
54  const dictionary& dict,
55  label& refCelli,
56  scalar& refValue,
57  const bool forceReference = false
58 );
59 
60 //- If the field needs referencing find the reference cell nearest
61 // (in index) to the given cell looked-up for field, but which is not on a
62 // cyclic, symmetry or processor patch.
63 void setRefCell
64 (
65  const volScalarField& field,
66  const dictionary& dict,
67  label& refCelli,
68  scalar& refValue,
69  const bool forceReference = false
70 );
71 
72 //- Return the current value of field in the reference cell
73 scalar getRefCellValue
74 (
75  const volScalarField& field,
76  const label refCelli
77 );
78 
79 }
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 #endif
84 
85 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Namespace for OpenFOAM.
dictionary dict
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:52
void setRefCell(const volScalarField &field, const volScalarField &fieldRef, const dictionary &dict, label &refCelli, scalar &refValue, const bool forceReference=false)
If the field fieldRef needs referencing find the reference cell nearest.
Definition: findRefCell.C:31
scalar getRefCellValue(const volScalarField &field, const label refCelli)
Return the current value of field in the reference cell.
Definition: findRefCell.C:154