| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2020-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::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 | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace Function1s | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class Coded Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| template<class Type> | |
| class Coded | |
| : | |
| public Function1<Type>, | |
| public codedBase | |
| { | |
| // Private Data | |
| //- Keywords associated with source code | |
| static const wordList codeKeys; | |
| //- Name of the dictionary variables in the source code | |
| static const wordList codeDictVars; | |
| // Name of the code options template file | |
| static const word codeOptions; | |
| // Names of the source files to compile | |
| static const wordList compileFiles; | |
| // Names of the source files to copy (header files) | |
| static const wordList copyFiles; | |
| //- Cache of the unit conversions | |
| const unitSets units_; | |
| //- The dynamically generated Function1 pointer | |
| mutable autoPtr<Function1<Type>> redirectFunction1Ptr_; | |
| public: | |
| // Runtime type information | |
| TypeName("coded"); | |
| // Constructors | |
| //- Construct from name and dictionary | |
| Coded | |
| ( | |
| const word& name, | |
| const Function1s::unitSets& 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 the value at a scalar coordinate | |
| virtual inline Type value(const scalar x) const; | |
| //- Return a field of values at given scalar coordinates | |
| virtual tmp<Field<Type>> value(const scalarField& x) const; | |
| //- Return the derivative at a scalar coordinate | |
| virtual Type derivative(const scalar x) const; | |
| //- Return a field of derivatives at given scalar coordinates | |
| virtual tmp<Field<Type>> derivative(const scalarField& x) const; | |
| //- Return the integral between two scalar coordinates | |
| virtual Type integral(const scalar x1, const scalar x2) const; | |
| //- Return a field of integrals given two fields of scalar coordinates | |
| virtual tmp<Field<Type>> integral | |
| ( | |
| const scalarField& x1, | |
| const scalarField& x2 | |
| ) const; | |
| //- Write in dictionary format | |
| virtual void write(Ostream& os, const unitSets& units) const; | |
| // Member Operators | |
| //- Disallow default bitwise assignment | |
| void operator=(const Coded<Type>&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Function1s | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |