File size: 5,229 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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
\*---------------------------------------------------------------------------*/
#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
//- 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
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "CodedFunction1I.H"
#ifdef NoRepository
#include "CodedFunction1.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|