lookupBase.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2024 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::lookupBase
 
Description
    Base level of Lookup and LookupField classes.
 
SourceFiles
    lookupBase.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef lookupBase_H
#define lookupBase_H
 
#include "dictionary.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                         Class lookupBase Declaration
\*---------------------------------------------------------------------------*/
 
class lookupBase
{
protected:
 
    // Protected Data
 
        //- Key of object
        word name_;
 
 
public:
 
    // Generated Methods
 
        //- No copy assignment
        void operator=(const lookupBase&) = delete;
 
 
    // Constructors
 
        //- Construct from dictionary
        explicit lookupBase(const dictionary& dict);
 
        //- Copy construct
        explicit lookupBase(const lookupBase& rhs);
 
 
    //- Destructor
    virtual ~lookupBase() = default;
 
 
    // Member Functions
 
        //- Write coefficient entries in dictionary format
        virtual void writeEntries(Ostream& os) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //