OpenFOAM logo
Open Source CFD Toolkit

GeometricFieldI.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 Description
00026     generic Geometric Type field class
00027 
00028 \*---------------------------------------------------------------------------*/
00029 
00030 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00031 
00032 namespace Foam
00033 {
00034 
00035 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
00036 
00037 // Return reference to mesh
00038 template<class Type, template<class> class PatchField, class GeoMesh>
00039 inline const typename GeometricField<Type, PatchField, GeoMesh>::Mesh&
00040 GeometricField<Type, PatchField, GeoMesh>::mesh() const
00041 {
00042     return mesh_;
00043 }
00044 
00045 
00046 // Return dimensions
00047 template<class Type, template<class> class PatchField, class GeoMesh>
00048 inline dimensionSet&
00049 GeometricField<Type, PatchField, GeoMesh>::dimensions()
00050 {
00051     return dimensions_;
00052 }
00053 
00054 // Return dimensions
00055 template<class Type, template<class> class PatchField, class GeoMesh>
00056 inline const dimensionSet&
00057 GeometricField<Type, PatchField, GeoMesh>::dimensions() const
00058 {
00059     return dimensions_;
00060 }
00061 
00062 // Return internal field
00063 template<class Type, template<class> class PatchField, class GeoMesh>
00064 inline const Field<Type>&
00065 GeometricField<Type, PatchField, GeoMesh>::internalField() const
00066 {
00067     return *this;
00068 }
00069 
00070 // Return reference to GeometricBoundaryField for const field
00071 template<class Type, template<class> class PatchField, class GeoMesh>
00072 inline const typename GeometricField<Type, PatchField, GeoMesh>::
00073 GeometricBoundaryField&
00074 GeometricField<Type, PatchField, GeoMesh>::boundaryField() const
00075 {
00076     return boundaryField_;
00077 }
00078 
00079 
00080 // Return reference to GeometricBoundaryField for const field
00081 template<class Type, template<class> class PatchField, class GeoMesh>
00082 inline label GeometricField<Type, PatchField, GeoMesh>::timeIndex() const
00083 {
00084     return timeIndex_;
00085 }
00086 
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 } // End namespace Foam
00091 
00092 // ************************************************************************* //
For further information go to www.openfoam.org