OpenFOAM logo
Open Source CFD Toolkit

FixedValuePointPatchField.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     FixedValuePointPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     FixedValuePointPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef FixedValuePointPatchField_H
00036 #define FixedValuePointPatchField_H
00037 
00038 #include "ValueStoredPointPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                   Class FixedValuePointPatchField Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<template<class> class PatchField, class PointPatch, class Type>
00050 class FixedValuePointPatchField
00051 :
00052     public ValueStoredPointPatchField<PatchField, PointPatch, Type>
00053 {
00054 
00055 public:
00056 
00057     //- Runtime type information
00058     TypeName("fixedValue");
00059 
00060 
00061     // Constructors
00062 
00063         //- Construct from patch and internal field
00064         FixedValuePointPatchField
00065         (
00066             const PointPatch&,
00067             const Field<Type>&
00068         );
00069 
00070         //- Construct from patch and internal field and patch field
00071         FixedValuePointPatchField
00072         (
00073             const PointPatch&,
00074             const Field<Type>&,
00075             const Field<Type>&
00076         );
00077 
00078         //- Construct from patch, internal field and dictionary
00079         FixedValuePointPatchField
00080         (
00081             const PointPatch&,
00082             const Field<Type>&,
00083             const dictionary&
00084         );
00085 
00086         //- Construct by mapping given patchField<Type> onto a new patch
00087         FixedValuePointPatchField
00088         (
00089             const FixedValuePointPatchField<PatchField, PointPatch, Type>&,
00090             const PointPatch&,
00091             const Field<Type>&,
00092             const PointPatchFieldMapper&
00093         );
00094 
00095         //- Construct and return a clone
00096         virtual autoPtr<PatchField<Type> > clone() const
00097         {
00098             return autoPtr<PatchField<Type> >
00099             (
00100                 new FixedValuePointPatchField<PatchField, PointPatch, Type>
00101                 (
00102                     *this
00103                 )
00104             );
00105         }
00106 
00107         //- Construct as copy setting internal field reference
00108         FixedValuePointPatchField
00109         (
00110             const FixedValuePointPatchField<PatchField, PointPatch, Type>&,
00111             const Field<Type>&
00112         );
00113 
00114         //- Construct and return a clone setting internal field reference
00115         virtual autoPtr<PatchField<Type> > clone(const Field<Type>& iF) const
00116         {
00117             return autoPtr<PatchField<Type> >
00118             (
00119                 new FixedValuePointPatchField<PatchField, PointPatch, Type>
00120                 (
00121                     *this,
00122                     iF
00123                 )
00124             );
00125         }
00126 
00127 
00128     // Member functions
00129 
00130         //- Insert boundary value into the internal field
00131         //  Fixed values need to be inserted first. In the second go,
00132         //  there's nothing to do
00133         virtual void initEvaluate(const bool=false)
00134         {
00135             ValueStoredPointPatchField<PatchField, PointPatch, Type>::
00136                 evaluate();
00137         }
00138 
00139         virtual void evaluate()
00140         {}
00141 
00142 
00143     // Member operators
00144 
00145         //- Disable assignment operators
00146         virtual void operator=(const Field<Type>&) {}
00147         virtual void operator=(const Type&) {}
00148 
00149         // Force an assignment irrespective of form of patch
00150 
00151         virtual void operator==
00152         (
00153             const ValueStoredPointPatchField<PatchField, PointPatch, Type>&
00154         );
00155 
00156         virtual void operator==(const Field<Type>&);
00157         virtual void operator==(const Type&);
00158 
00159 };
00160 
00161 
00162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00163 
00164 } // End namespace Foam
00165 
00166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00167 
00168 #ifdef NoRepository
00169 #    include "FixedValuePointPatchField.C"
00170 #endif
00171 
00172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00173 
00174 #endif
00175 
00176 // ************************************************************************* //
For further information go to www.openfoam.org