OpenFOAM logo
Open Source CFD Toolkit

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-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     CoupledPointPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     CoupledPointPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef CoupledPointPatchField_H
00036 #define CoupledPointPatchField_H
00037 
00038 #include "PointPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                   Class CoupledPointPatchField Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<template<class> class PatchField, class PointPatch, class Type>
00050 class CoupledPointPatchField
00051 :
00052     public PatchField<Type>
00053 {
00054 
00055 public:
00056 
00057     // Constructors
00058 
00059         //- Construct from patch and internal field
00060         CoupledPointPatchField
00061         (
00062             const PointPatch&,
00063             const Field<Type>&
00064         );
00065 
00066         //- Construct by mapping given patchField<Type> onto a new patch
00067         CoupledPointPatchField
00068         (
00069             const CoupledPointPatchField<PatchField, PointPatch, Type>&,
00070             const PointPatch&,
00071             const Field<Type>&,
00072             const PointPatchFieldMapper&
00073         );
00074 
00075         //- Construct and return a clone
00076         virtual autoPtr<PatchField<Type> > clone() const = 0;
00077 
00078         //- Construct as copy setting internal field reference
00079         CoupledPointPatchField
00080         (
00081             const CoupledPointPatchField<PatchField, PointPatch, Type>&,
00082             const Field<Type>&
00083         );
00084 
00085         //- Construct and return a clone setting internal field reference
00086         virtual autoPtr<PatchField<Type> > clone
00087         (
00088             const Field<Type>& iF
00089         ) const = 0;
00090 
00091 
00092     // Member functions
00093 
00094         // Access
00095 
00096             //- Return true if this patch field is derived from
00097             //  CoupledPointPatchField<PatchField, PointPatch, Type>.
00098             virtual bool coupled() const
00099             {
00100                 return true;
00101             }
00102 
00103             //- Evaluate the patch field
00104             virtual void evaluate() = 0;
00105 
00106             //- Add field to internal field
00107             virtual void addField(Field<Type>&) const = 0;
00108 };
00109 
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 } // End namespace Foam
00114 
00115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00116 
00117 #ifdef NoRepository
00118 #    include "CoupledPointPatchField.C"
00119 #endif
00120 
00121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00122 
00123 #endif
00124 
00125 // ************************************************************************* //
For further information go to www.openfoam.org