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

FieldMapper.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::FieldMapper
00026 
00027 Description
00028     Abstract base class to hold the Field mapping addressing and weights.
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef FieldMapper_H
00033 #define FieldMapper_H
00034 
00035 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00036 
00037 namespace Foam
00038 {
00039 
00040 /*---------------------------------------------------------------------------*\
00041                            Class FieldMapper Declaration
00042 \*---------------------------------------------------------------------------*/
00043 
00044 class FieldMapper
00045 {
00046 
00047 public:
00048 
00049     // Constructors
00050 
00051         //- Null constructor
00052         FieldMapper()
00053         {}
00054 
00055 
00056     // Destructor
00057 
00058         virtual ~FieldMapper()
00059         {}
00060 
00061 
00062     // Member Functions
00063 
00064         virtual label size() const = 0;
00065 
00066         virtual bool direct() const = 0;
00067 
00068         virtual const unallocLabelList& directAddressing() const
00069         {
00070             FatalErrorIn("FieldMapper::directAddressing() const")
00071                 << "attempt to access null direct addressing"
00072                 << abort(FatalError);
00073 
00074             return unallocLabelList::null();
00075         }
00076 
00077         virtual const labelListList& addressing() const
00078         {
00079             FatalErrorIn("FieldMapper::addressing() const")
00080                 << "attempt to access null interpolation addressing"
00081                 << abort(FatalError);
00082 
00083             return labelListList::null();
00084         }
00085 
00086         virtual const scalarListList& weights() const
00087         {
00088             FatalErrorIn("FieldMapper::weights() const")
00089                 << "attempt to access null interpolation weights"
00090                 << abort(FatalError);
00091 
00092             return scalarListList::null();
00093         }
00094 
00095 
00096     // Member Operators
00097 
00098         template<class Type>
00099         tmp<Field<Type> > operator()(const Field<Type>& f) const
00100         {
00101             return tmp<Field<Type> >(new Field<Type>(f, *this));
00102         }
00103 };
00104 
00105 
00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00107 
00108 } // End namespace Foam
00109 
00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00111 
00112 #endif
00113 
00114 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines