File size: 7,483 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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 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::DimensionedFunction1
Description
Wrapper around a Function1 which provides evaluation for dimensioned and
geometric fields
SourceFiles
DimensionedFunction1.C
\*---------------------------------------------------------------------------*/
#ifndef DimensionedFunction1_H
#define DimensionedFunction1_H
#include "GeometricField.H"
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class DimensionedFunction1 Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class DimensionedFunction1
{
// Private Data
//- The dimensions of the x-coordinate
const dimensionSet xDimensions_;
//- The dimensions of the value
const dimensionSet valueDimensions_;
//- The function
const autoPtr<Function1<Type>> function_;
// Private Constructors
//- Construct from a name, units and a dictionary
DimensionedFunction1
(
const word& name,
const Function1s::unitSets& units,
const dictionary& dict
);
// Private Member Functions
//- Set a dimensioned field to the value
template
<
class GeoMesh,
template<class> class ResultPrimitiveField,
template<class> class XPrimitiveField
>
void value
(
DimensionedField<scalar, GeoMesh, ResultPrimitiveField>& result,
const DimensionedField<scalar, GeoMesh, XPrimitiveField>& x
) const;
//- Set a dimensioned field to the derivative
template
<
class GeoMesh,
template<class> class ResultPrimitiveField,
template<class> class XPrimitiveField
>
void derivative
(
DimensionedField<scalar, GeoMesh, ResultPrimitiveField>& result,
const DimensionedField<scalar, GeoMesh, XPrimitiveField>& x
) const;
//- Set a geometric field to the value
template
<
class GeoMesh,
template<class> class ResultPrimitiveField,
template<class> class XPrimitiveField
>
void value
(
GeometricField<scalar, GeoMesh, ResultPrimitiveField>& result,
const GeometricField<scalar, GeoMesh, XPrimitiveField>& x
) const;
//- Set a geometric field to the derivative
template
<
class GeoMesh,
template<class> class ResultPrimitiveField,
template<class> class XPrimitiveField
>
void derivative
(
GeometricField<scalar, GeoMesh, ResultPrimitiveField>& result,
const GeometricField<scalar, GeoMesh, XPrimitiveField>& x
) const;
public:
// Selectors
//- Select from dictionary
static autoPtr<DimensionedFunction1<Type>> New
(
const word& name,
const Function1s::unitSets& units,
const dictionary& dict
);
//- Select from dictionary
static autoPtr<DimensionedFunction1<Type>> New
(
const word& name,
const unitSet& xUnits,
const unitSet& valueUnits,
const dictionary& dict
);
// Member Functions
//- Return the value as a field
tmp<Field<Type>> value(const scalarField& x) const;
//- Return the derivative as a field
tmp<Field<Type>> derivative(const scalarField& x) const;
//- Return the value as a dimensioned field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<DimensionedField<Type, GeoMesh>> value
(
const DimensionedField<scalar, GeoMesh, XPrimitiveField>& x
) const;
//- Return the derivative as a dimensioned field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<DimensionedField<Type, GeoMesh>> derivative
(
const DimensionedField<scalar, GeoMesh, XPrimitiveField>& x
) const;
//- Return the value as a dimensioned field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<DimensionedField<Type, GeoMesh>> value
(
const tmp<DimensionedField<scalar, GeoMesh, XPrimitiveField>>& tx
) const;
//- Return the derivative as a dimensioned field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<DimensionedField<Type, GeoMesh>> derivative
(
const tmp<DimensionedField<scalar, GeoMesh, XPrimitiveField>>& tx
) const;
//- Return the value as a geometric field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<GeometricField<Type, GeoMesh>> value
(
const GeometricField<scalar, GeoMesh, XPrimitiveField>& x
) const;
//- Return the derivative as a geometric field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<GeometricField<Type, GeoMesh>> derivative
(
const GeometricField<scalar, GeoMesh, XPrimitiveField>& x
) const;
//- Return the value as a geometric field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<GeometricField<Type, GeoMesh>> value
(
const tmp<GeometricField<scalar, GeoMesh, XPrimitiveField>>& tx
) const;
//- Return the derivative as a geometric field
template<class GeoMesh, template<class> class XPrimitiveField>
tmp<GeometricField<Type, GeoMesh>> derivative
(
const tmp<GeometricField<scalar, GeoMesh, XPrimitiveField>>& tx
) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "DimensionedFunction1.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|