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

potentialI.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) 2008-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 \*---------------------------------------------------------------------------*/
00025 
00026 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
00027 
00028 inline Foam::label Foam::potential::nIds() const
00029 {
00030     return idList_.size();
00031 }
00032 
00033 
00034 inline const Foam::List<Foam::word>& Foam::potential::idList() const
00035 {
00036     return idList_;
00037 }
00038 
00039 
00040 inline const Foam::List<Foam::word>& Foam::potential::siteIdList() const
00041 {
00042     return siteIdList_;
00043 }
00044 
00045 
00046 inline Foam::scalar Foam::potential::potentialEnergyLimit() const
00047 {
00048     return potentialEnergyLimit_;
00049 }
00050 
00051 
00052 inline Foam::label Foam::potential::nPairPotentials() const
00053 {
00054     return pairPotentials_.size();
00055 }
00056 
00057 
00058 inline const Foam::labelList& Foam::potential::removalOrder() const
00059 {
00060     return removalOrder_;
00061 }
00062 
00063 
00064 inline const Foam::pairPotentialList& Foam::potential::pairPotentials() const
00065 {
00066     return pairPotentials_;
00067 }
00068 
00069 
00070 inline const Foam::tetherPotentialList&
00071 Foam::potential::tetherPotentials() const
00072 {
00073     return tetherPotentials_;
00074 }
00075 
00076 
00077 inline const Foam::vector& Foam::potential::gravity() const
00078 {
00079     return gravity_;
00080 }
00081 
00082 
00083 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines