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

processorLduInterfaceField.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::processorLduInterfaceField
00026 
00027 Description
00028     Abstract base class for processor coupled interfaces.
00029 
00030 SourceFiles
00031     processorLduInterfaceField.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef processorLduInterfaceField_H
00036 #define processorLduInterfaceField_H
00037 
00038 #include <OpenFOAM/primitiveFieldsFwd.H>
00039 #include <OpenFOAM/typeInfo.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                   Class processorLduInterfaceField Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class processorLduInterfaceField
00051 {
00052 
00053 public:
00054 
00055     //- Runtime type information
00056     TypeName("processorLduInterfaceField");
00057 
00058 
00059     // Constructors
00060 
00061         //- Construct given coupled patch
00062         processorLduInterfaceField()
00063         {}
00064 
00065 
00066     // Destructor
00067 
00068         virtual ~processorLduInterfaceField();
00069 
00070 
00071     // Member Functions
00072 
00073         // Access
00074 
00075             //- Return processor number
00076             virtual int myProcNo() const = 0;
00077 
00078             //- Return neigbour processor number
00079             virtual int neighbProcNo() const = 0;
00080 
00081             //- Is the transform required
00082             virtual bool doTransform() const = 0;
00083 
00084             //- Return face transformation tensor
00085             virtual const tensorField& forwardT() const = 0;
00086 
00087             //- Return rank of component for transform
00088             virtual int rank() const = 0;
00089 
00090 
00091         //- Transform given patch component field
00092         void transformCoupleField
00093         (
00094             scalarField& f,
00095             const direction cmpt
00096         ) const;
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines