src/OpenFOAM/fields/pointPatchFields/basic/fixedValue/fixedValuePointPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::fixedValuePointPatchField
  27
  28 Description
  29     A FixedValue boundary condition for pointField.
  30
  31 SourceFiles
  32     fixedValuePointPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef fixedValuePointPatchField_H
  37 #define fixedValuePointPatchField_H
  38
  39 #include "valuePointPatchField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                   Class fixedValuePointPatchField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class fixedValuePointPatchField
  52 :
  53     public valuePointPatchField<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("fixedValue");
  60
  61
  62     // Constructors
  63
  64         //- Construct from patch and internal field
  65         fixedValuePointPatchField
  66         (
  67             const pointPatch&,
  68             const DimensionedField<Type, pointMesh>&
  69         );
  70
  71         //- Construct from patch, internal field and dictionary
  72         fixedValuePointPatchField
  73         (
  74             const pointPatch&,
  75             const DimensionedField<Type, pointMesh>&,
  76             const dictionary&,
  77             const bool valueRequired=true
  78         );
  79
  80         //- Construct by mapping given patchField<Type> onto a new patch
  81         fixedValuePointPatchField
  82         (
  83             const fixedValuePointPatchField<Type>&,
  84             const pointPatch&,
  85             const DimensionedField<Type, pointMesh>&,
  86             const pointPatchFieldMapper&
  87         );
  88
  89         //- Construct and return a clone
  90         virtual autoPtr<pointPatchField<Type> > clone() const
  91         {
  92             return autoPtr<pointPatchField<Type> >
  93             (
  94                 new fixedValuePointPatchField<Type>
  95                 (
  96                     *this
  97                 )
  98             );
  99         }
 100
 101         //- Construct as copy setting internal field reference
 102         fixedValuePointPatchField
 103         (
 104             const fixedValuePointPatchField<Type>&,
 105             const DimensionedField<Type, pointMesh>&
 106         );
 107
 108         //- Construct and return a clone setting internal field reference
 109         virtual autoPtr<pointPatchField<Type> > clone
 110         (
 111             const DimensionedField<Type, pointMesh>& iF
 112         ) const
 113         {
 114             return autoPtr<pointPatchField<Type> >
 115             (
 116                 new fixedValuePointPatchField<Type>
 117                 (
 118                     *this,
 119                     iF
 120                 )
 121             );
 122         }
 123
 124
 125     // Member operators
 126
 127         // Disable assignment operators
 128
 129             virtual void operator=(const Field<Type>&)
 130             {}
 131
 132             virtual void operator=(const Type&)
 133             {}
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #ifdef NoRepository
 144 #    include "fixedValuePointPatchField.C"
 145 #endif
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #endif
 150
 151 // ************************************************************************* //