codeIncludeEntry.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) 2023-2026 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::functionEntries::codeIncludeEntry
 
Description
    Specify an include file or list of files for \#calc within \#codeBlock
 
    For example if functions from transform.H are used in the \#calc expression
    \verbatim
    angleOfAttack   5; // degs
 
    #codeBlock
    angle           #calc "-degToRad($angleOfAttack)";
 
    #codeInclude    "transform.H"
    liftDir         #calc "transform(Ry($angle), vector(0, 0, 1))";
    dragDir         #calc "transform(Ry($angle), vector(1, 0, 0))";
    #endCodeBlock
    \endverbatim
 
    The usual expansion of environment variables and other constructs
    (eg, the \c ~OpenFOAM/ expansion) is retained.
 
    If multiple include files are required multiple #codeInclude entries can
    be used or more conveniently a list of file names specified, e.g.
    \verbatim
    #codeInclude    ("transform.H" "Field.H")
    \endverbatim
    or formatted in a column if is a larger number of include files required:
    \verbatim
    #codeInclude
    (
        "transform.H"
        "Field.H"
    )
    \endverbatim
 
See also
    Foam::functionEntries::calcEntry
 
SourceFiles
    codeIncludeEntry.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef codeIncludeEntry_H
#define codeIncludeEntry_H
 
#include "functionEntry.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace functionEntries
{
 
/*---------------------------------------------------------------------------*\
                        Class codeIncludeEntry Declaration
\*---------------------------------------------------------------------------*/
 
class codeIncludeEntry
:
    public functionEntry
{
    // Private  data
 
        //- List of file names
        List<fileName> fNames_;
 
 
public:
 
    //- Runtime type information
    FunctionTypeName("#codeInclude");
 
 
    // Constructors
 
        //- Construct from line number, dictionary and Istream
        codeIncludeEntry
        (
            const label lineNumber,
            const dictionary& parentDict,
            Istream& is
        );
 
        //- Copy construct
        codeIncludeEntry(const codeIncludeEntry&) = default;
 
        //- Clone
        virtual autoPtr<entry> clone(const dictionary&) const
        {
            return autoPtr<entry>(new codeIncludeEntry(*this));
        }
 
 
    // Member Functions
 
        //- Execute the functionEntry in a sub-dict context
        virtual bool execute(dictionary& parentDict, Istream&);
 
        //- Return the include file names
        const List<fileName>& fileNames() const
        {
            return fNames_;
        }
 
        //- Add the codeInclude entry to codeDict
        static void addCodeInclude
        (
            const List<fileName>& fileNames,
            const dictionary& contextDict,
            dictionary& codeDict
        );
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const codeIncludeEntry&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace functionEntries
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //