OpenFOAM logo
Open Source CFD Toolkit

calculatedFaPatchField.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     calculatedFaPatchField
00027 
00028 Description
00029 
00030 SourceFiles
00031     calculatedFaPatchField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef calculatedFaPatchField_H
00036 #define calculatedFaPatchField_H
00037 
00038 #include "faPatchField.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                       Class calculatedFaPatch Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class Type>
00050 class calculatedFaPatchField
00051 :
00052     public faPatchField<Type>
00053 {
00054 
00055 public:
00056 
00057     //- Runtime type information
00058     TypeName("calculated");
00059 
00060 
00061     // Constructors
00062 
00063         //- Construct from patch and internal field
00064         calculatedFaPatchField
00065         (
00066             const faPatch&,
00067             const Field<Type>&
00068         );
00069 
00070         //- Construct from patch, internal field and dictionary
00071         calculatedFaPatchField
00072         (
00073             const faPatch&,
00074             const Field<Type>&,
00075             const dictionary&
00076         );
00077 
00078         //- Construct by mapping given patchField<Type> onto a new patch
00079         calculatedFaPatchField
00080         (
00081             const calculatedFaPatchField<Type>&,
00082             const faPatch&,
00083             const Field<Type>&,
00084             const faPatchFieldMapper&
00085         );
00086 
00087         //- Construct and return a clone
00088         virtual tmp<faPatchField<Type> > clone() const
00089         {
00090             return tmp<faPatchField<Type> >
00091             (
00092                 new calculatedFaPatchField<Type>(*this)
00093             );
00094         }
00095 
00096         //- Construct as copy setting internal field reference
00097         calculatedFaPatchField
00098         (
00099             const calculatedFaPatchField<Type>&,
00100             const Field<Type>&
00101         );
00102 
00103         //- Construct and return a clone setting internal field reference
00104         virtual tmp<faPatchField<Type> > clone(const Field<Type>& iF) const
00105         {
00106             return tmp<faPatchField<Type> >
00107             (
00108                 new calculatedFaPatchField<Type>(*this, iF)
00109             );
00110         }
00111 
00112 
00113     // Member functions
00114 
00115         // Access
00116 
00117             //- Return true if this patch field fixes a value.
00118             //  Needed to check if a level has to be specified while solving
00119             //  Poissons equations.
00120             virtual bool fixesValue() const
00121             {
00122                 return true;
00123             }
00124 
00125 
00126         // Evaluation functions
00127 
00128             //- Return the matrix diagonal coefficients corresponding to the
00129             //  evaluation of the value of this patchField with given weights
00130             virtual tmp<Field<Type> > valueInternalCoeffs
00131             (
00132                 const tmp<scalarField>&
00133             ) const
00134             {
00135                 FatalErrorIn
00136                 (
00137                     "calculatedFaPatchField<Type>::"
00138                     "valueInternalCoeffs(const tmp<scalarField>&) const"
00139                 )   << "valueInternalCoeffs cannot be called for a "
00140                     << "calculatedFaPatchField.  You are probably trying to "
00141                     << "solve for a field with calculated boundary conditions."
00142                     << abort(FatalError);
00143                 return *this;
00144             }
00145 
00146             //- Return the matrix source coefficients corresponding to the
00147             //  evaluation of the value of this patchField with given weights
00148             virtual tmp<Field<Type> > valueBoundaryCoeffs
00149             (
00150                 const tmp<scalarField>&
00151             ) const
00152             {
00153                 FatalErrorIn
00154                 (
00155                     "calculatedFaPatchField<Type>::"
00156                     "valueBoundaryCoeffs(const tmp<scalarField>&) const"
00157                 )   << "valueBoundaryCoeffs cannot be called for a "
00158                     << "calculatedFaPatchField.  You are probably trying to "
00159                     << "solve for a field with calculated boundary conditions."
00160                     << abort(FatalError);
00161                 return *this;
00162             }
00163 
00164             //- Return the matrix diagonal coefficients corresponding to the
00165             //  evaluation of the gradient of this patchField
00166             tmp<Field<Type> > gradientInternalCoeffs() const
00167             {
00168                 FatalErrorIn
00169                 (
00170                     "calculatedFaPatchField<Type>::"
00171                     "gradientInternalCoeffs() const"
00172                 )   << "gradientInternalCoeffs cannot be called for a "
00173                     << "calculatedFaPatchField.  You are probably trying to "
00174                     << "solve for a field with calculated boundary conditions."
00175                     << abort(FatalError);
00176                 return *this;
00177             }
00178 
00179             //- Return the matrix source coefficients corresponding to the
00180             //  evaluation of the gradient of this patchField
00181             tmp<Field<Type> > gradientBoundaryCoeffs() const
00182             {
00183                 FatalErrorIn
00184                 (
00185                     "calculatedFaPatchField<Type>::"
00186                     "gradientBoundaryCoeffs() const"
00187                 )   << "gradientBoundaryCoeffs cannot be called for a "
00188                     << "calculatedFaPatchField.  You are probably trying to "
00189                     << "solve for a field with calculated boundary conditions."
00190                     << abort(FatalError);
00191                 return *this;
00192             }
00193 
00194 
00195         //- Write
00196         virtual void write(Ostream&) const;
00197 };
00198 
00199 
00200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00201 
00202 } // End namespace Foam
00203 
00204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00205 
00206 #ifdef NoRepository
00207 #   include "calculatedFaPatchField.C"
00208 #endif
00209 
00210 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00211 
00212 #endif
00213 
00214 // ************************************************************************* //
For further information go to www.openfoam.org