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

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