tetherPotentialList.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2020 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::tetherPotentialList
 
Description
 
SourceFiles
    tetherPotentialList.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef tetherPotentialList_H
#define tetherPotentialList_H
 
#include "ListOps.H"
#include "PtrList.H"
#include "word.H"
#include "tetherPotential.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                     Class tetherPotentialList Declaration
\*---------------------------------------------------------------------------*/
 
class tetherPotentialList
:
    public PtrList<tetherPotential>
{
    // Private Data
 
        List<label> idMap_;
 
 
    // Private Member Functions
 
        inline label tetherPotentialIndex
        (
            const label a
        ) const;
 
        void readTetherPotentialDict
        (
            const List<word>& siteIdList,
            const dictionary& tetherPotentialDict,
            const List<word>& tetherSiteIdList
        );
 
 
public:
 
    // Constructors
 
        tetherPotentialList();
 
        //- Construct from siteIdList and potential dictionaries
        tetherPotentialList
        (
            const List<word>& siteIdList,
            const dictionary& tetherPotentialDict,
            const List<word>& tetherSiteIdList
        );
 
        //- Disallow default bitwise assignment
        void operator=(const tetherPotentialList&) = delete;
 
 
    //- Destructor
    ~tetherPotentialList();
 
 
    // Member Functions
 
        void buildPotentials
        (
            const List<word>& siteIdList,
            const dictionary& tetherPotentialDict,
            const List<word>& tetherSiteIdList
        );
 
        // Access
 
            inline const List<word>& idMap() const;
 
            const tetherPotential& tetherPotentialFunction(const label a) const;
 
            vector force(const label a, const vector rIT) const;
 
            scalar energy (const label a, const vector rIT) const;
 
 
    // Member Operators
 
        //- Disallow default bitwise copy construction
        tetherPotentialList(const tetherPotentialList&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "tetherPotentialListI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //