UPtrDictionary.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-2023 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::UPtrDictionary
 
Description
    Template dictionary class which does not manages the storage
    associated with it.
 
    It is derived from DictionaryBase instantiated on a non-memory managed
    form of intrusive doubly-linked list of <T>.
 
SourceFiles
    UPtrDictionary.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef UPtrDictionary_H
#define UPtrDictionary_H
 
#include "DictionaryBase.H"
#include "UDLPtrList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class UPtrDictionary Declaration
\*---------------------------------------------------------------------------*/
 
template<class T>
class UPtrDictionary
:
    public DictionaryBase<UDLPtrList<T>, T>
{
 
public:
 
    // Constructors
 
        //- Construct given initial table size
        UPtrDictionary(const label size = 128);
 
        //- Copy construct
        UPtrDictionary(const UPtrDictionary&);
 
 
    // Member Operators
 
        //- Find and return entry
        const T& operator[](const word& key) const
        {
            return *DictionaryBase<UDLPtrList<T>, T>::operator[](key);
        }
 
        //- Find and return entry
        T& operator[](const word& key)
        {
            return *DictionaryBase<UDLPtrList<T>, T>::operator[](key);
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "UPtrDictionary.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //