FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

coupledPointPatchField.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-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 Class
00025     Foam::coupledPointPatchField
00026 
00027 Description
00028     A Coupled boundary condition for pointField
00029 
00030 SourceFiles
00031     coupledPointPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef coupledPointPatchField_H
00036 #define coupledPointPatchField_H
00037 
00038 #include <OpenFOAM/pointPatchField.H>
00039 #include <OpenFOAM/coupledPointPatch.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                   Class coupledPointPatchField Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 template<class Type>
00051 class coupledPointPatchField
00052 :
00053     public pointPatchField<Type>
00054 {
00055 
00056 public:
00057 
00058     //- Runtime type information
00059     TypeName(coupledPointPatch::typeName_());
00060 
00061 
00062     // Constructors
00063 
00064         //- Construct from patch and internal field
00065         coupledPointPatchField
00066         (
00067             const pointPatch&,
00068             const DimensionedField<Type, pointMesh>&
00069         );
00070 
00071         //- Construct from patch, internal field and dictionary
00072         coupledPointPatchField
00073         (
00074             const pointPatch&,
00075             const DimensionedField<Type, pointMesh>&,
00076             const dictionary& dict
00077         );
00078 
00079         //- Construct by mapping given patchField<Type> onto a new patch
00080         coupledPointPatchField
00081         (
00082             const coupledPointPatchField<Type>&,
00083             const pointPatch&,
00084             const DimensionedField<Type, pointMesh>&,
00085             const pointPatchFieldMapper&
00086         );
00087 
00088         //- Construct and return a clone
00089         virtual autoPtr<pointPatchField<Type> > clone() const = 0;
00090 
00091         //- Construct as copy setting internal field reference
00092         coupledPointPatchField
00093         (
00094             const coupledPointPatchField<Type>&,
00095             const DimensionedField<Type, pointMesh>&
00096         );
00097 
00098         //- Construct and return a clone setting internal field reference
00099         virtual autoPtr<pointPatchField<Type> > clone
00100         (
00101             const DimensionedField<Type, pointMesh>& iF
00102         ) const = 0;
00103 
00104 
00105     // Member functions
00106 
00107         // Access
00108 
00109             //- Return true if this patch field is derived from
00110             //  coupledFvPatchField<Type>.
00111             virtual bool coupled() const
00112             {
00113                 return true;
00114             }
00115 
00116             //- Evaluate the patch field
00117             virtual void evaluate
00118             (
00119                 const Pstream::commsTypes commsType=Pstream::blocking
00120             ) = 0;
00121 
00122             //- Initialise swap of patch point values
00123             virtual void initSwapAdd(Field<Type>&) const
00124             {}
00125 
00126             //- Complete swap of patch point values and add to local values
00127             virtual void swapAdd(Field<Type>&) const = 0;
00128 };
00129 
00130 
00131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00132 
00133 } // End namespace Foam
00134 
00135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00136 
00137 #ifdef NoRepository
00138 #    include <OpenFOAM/coupledPointPatchField.C>
00139 #endif
00140 
00141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00142 
00143 #endif
00144 
00145 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines