File size: 4,863 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::FunctionalDimensionedField
Description
DimensionedField with a corresponding run-time selected function
to evaluate and update the field.
See also
Foam::DimensionedField
Foam::DimensionedFieldFunction
Foam::UFunctionalDimensionedField
SourceFiles
FunctionalDimensionedField.C
\*---------------------------------------------------------------------------*/
#ifndef FunctionalDimensionedField_H
#define FunctionalDimensionedField_H
#include "FunctionalDimensionedFieldFwd.H"
#include "DimensionedField.H"
#include "DimensionedFieldFunction.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions
template<class Type, class GeoMesh>
void writeEntry
(
Ostream& os,
const FunctionalDimensionedField<Type, GeoMesh>& udff
);
/*---------------------------------------------------------------------------*\
Class FunctionalDimensionedField Declaration
\*---------------------------------------------------------------------------*/
template<class Type, class GeoMesh>
class FunctionalDimensionedField
:
public DimensionedField<Type, GeoMesh>
{
// Private Data
//- Name of the function entry/sub dictionary
const word funcName_;
//- Optional function pointer
autoPtr<DimensionedFieldFunction<DimensionedField<Type, GeoMesh>>>
funcPtr_;
public:
// Constructors
//- Construct from name, mesh, dimensions, field and dictionary
FunctionalDimensionedField
(
const word& name,
const word& funcName,
const GeoMesh&,
const dimensionSet& dimensions,
const dictionary&
);
//- Construct from name, mesh, dimensions, field, dictionary
// and default value
FunctionalDimensionedField
(
const word& name,
const word& funcName,
const GeoMesh&,
const dimensionSet& dimensions,
const dictionary&,
const Type& defaultValue
);
//- Construct from given FunctionalDimensionedField with new mesh
FunctionalDimensionedField
(
const FunctionalDimensionedField<Type, GeoMesh>&,
const GeoMesh&
);
//- Construct by mapping given FunctionalDimensionedField
FunctionalDimensionedField
(
const FunctionalDimensionedField<Type, GeoMesh>&,
const GeoMesh&,
const fieldMapper&
);
//- Copy constructor
FunctionalDimensionedField
(
const FunctionalDimensionedField<Type, GeoMesh>&
);
// Member Functions
//- Map if mapping direct or evaluate if function defined
void map
(
const DimensionedField<Type, GeoMesh>& df,
const fieldMapper& mapper
);
//- Reset
void reset();
//- Update
bool update();
using regIOobject::write;
//- Write
void write(Ostream&) const;
// Global functions
friend void writeEntry <Type, GeoMesh>
(
Ostream& os,
const FunctionalDimensionedField<Type, GeoMesh>& udff
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "FunctionalDimensionedField.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|