applications/utilities/mesh/manipulation/createBaffles/SetPatchFields.H

   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 Global
  25     Foam::SetPatchFields
  26
  27 Description
  28     Helper routine to initialise a patch field to a constant value
  29
  30 SourceFiles
  31     SetPatchFields.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef SetPatchFields_H
  36 #define SetPatchFields_H
  37
  38 #include "PtrList.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 //- Helper routine to read fields
  46 template<class GeoField>
  47 void SetPatchFields
  48 (
  49     PtrList<GeoField>& fields,
  50     const label patchI,
  51     const typename GeoField::value_type& initVal
  52 );
  53
  54 } // End namespace Foam
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 #ifdef NoRepository
  59 #   include "SetPatchFields.C"
  60 #endif
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 #endif
  65
  66 // ************************************************************************* //