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

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