OpenFOAM logo
Open Source CFD Toolkit

cyclicLduCoupledInterface.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     cyclicLduCoupledInterface
00027 
00028 Description
00029     This class contains the generic elements of a cyclic interface
00030 
00031 SourceFiles
00032     cyclicLduCoupledInterface.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef cyclicLduCoupledInterface_H
00037 #define cyclicLduCoupledInterface_H
00038 
00039 #include "lduCoupledInterface.H"
00040 #include "tensorField.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                   Class cyclicLduCoupledInterface Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class cyclicLduCoupledInterface
00052 :
00053     virtual public lduCoupledInterface
00054 {
00055 
00056 public:
00057 
00058     //- Runtime type information
00059     TypeName("cyclicLduCoupledInterface");
00060 
00061     // Constructors
00062 
00063     // Destructor
00064 
00065         virtual ~cyclicLduCoupledInterface();
00066 
00067 
00068     // Member Functions
00069 
00070         // Access
00071 
00072             //- Is the transform required
00073             virtual bool doTransform() const = 0;
00074 
00075             //- Return face transformation tensor
00076             virtual const tensorField& forwardT() const = 0;
00077 
00078             //- Return neighbour-cell transformation tensor
00079             virtual const tensorField& reverseT() const = 0;
00080 
00081             //- Return rank of component for transform
00082             virtual int rank() const = 0;
00083 
00084         //- Transform given patch internal field
00085         void transformCyclicCoupleField
00086         (
00087             scalarField& psiInternal,
00088             const direction cmpt
00089         ) const;
00090 
00091 };
00092 
00093 
00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00095 
00096 } // End namespace Foam
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 #endif
00101 
00102 // ************************************************************************* //
For further information go to www.openfoam.org