CodedFunction1.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) 2020-2024 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::Function1s::Coded
 
Description
    Constructs a dynamically compiled Function1.
 
Usage
    Example of a cosine bell shaped pulse inlet:
    \verbatim
    inlet
    {
        type            uniformFixedValue;
        uniformValue    coded;
 
        name            pulse;
 
        codeInclude
        #{
            #include "mathematicalConstants.H"
        #};
 
        code
        #{
            return vector
            (
                0.5*(1 - cos(constant::mathematical::twoPi*min(x/0.3, 1))),
                0,
                0
            );
        #};
    }
    \endverbatim
 
See also
    Foam::dynamicCode
    Foam::functionEntries::codeStream
 
SourceFiles
    CodedFunction1I.H
    CodedFunction1.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef CodedFunction1_H
#define CodedFunction1_H
 
#include "Function1.H"
#include "codedBase.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace Function1s
{
 
/*---------------------------------------------------------------------------*\
                            Class Coded Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class Coded
:
    public Function1<Type>,
    public codedBase
{
    // Private Data
 
        //- The dynamically generated Function1 pointer
        mutable autoPtr<Function1<Type>> redirectFunction1Ptr_;
 
        //- Cache of the unit conversions
        const unitConversions units_;
 
 
    // Private Member Functions
 
        //- Get the keywords associated with source code
        virtual wordList codeKeys() const;
 
        //- Get the name of the dictionary variables in the source code
        virtual wordList codeDictVars() const;
 
        //- Adapt the context for the current object
        virtual void prepare(dynamicCode&, const dynamicCodeContext&) const;
 
        //- Clear the ptr to the redirected object
        virtual void clearRedirect() const;
 
        //- Compile, link and return the now coded Function1
        autoPtr<Function1<Type>> compileNew();
 
 
public:
 
    // Runtime type information
    TypeName("coded");
 
 
    // Constructors
 
        //- Construct from name and dictionary
        Coded
        (
            const word& name,
            const Function1s::unitConversions& units,
            const dictionary& dict
        );
 
        //- Copy constructor
        Coded(const Coded<Type>& cf1);
 
        //- Construct and return a clone
        virtual tmp<Function1<Type>> clone() const;
 
 
    //- Destructor
    virtual ~Coded();
 
 
    // Member Functions
 
        //- Return value as a function of a scalar
        virtual inline Type value(const scalar x) const;
 
        //- Return value as a function of a scalar field
        virtual tmp<Field<Type>> value(const scalarField& x) const;
 
        //- Integrate between two scalars
        virtual Type integral(const scalar x1, const scalar x2) const;
 
        //- Integrate between two scalar fields
        virtual tmp<Field<Type>> integral
        (
            const scalarField& x1,
            const scalarField& x2
        ) const;
 
        //- Write data to dictionary stream
        virtual void write(Ostream& os, const unitConversions& units) const;
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const Coded<Type>&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Function1s
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "CodedFunction1I.H"
 
#ifdef NoRepository
    #include "CodedFunction1.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //