File size: 4,355 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::DimensionedFieldFunctions::FieldFunction
Description
Field function which looks up another field and uses it as the argument to
evaluate a given Foam::Function1. The user must specify both the name of
the looked-up field and the function1.
Usage
To create a temperature dependent electrical conductivity in the
\c solidElectricalConduction fvModel:
\verbatim
solidElectricalConduction
{
type solidElectricalConduction;
sigma
{
type fieldFunction;
field T;
function
{
type polynomial;
coeffs (7.61e7 -1.38e5);
}
}
}
\endverbatim
SourceFiles
FieldFunction_DimensionedFieldFunction.C
\*---------------------------------------------------------------------------*/
#ifndef FieldFunction_DimensionedFieldFunction_H
#define FieldFunction_DimensionedFieldFunction_H
#include "DimensionedFieldFunction.H"
#include "Function1.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace DimensionedFieldFunctions
{
/*---------------------------------------------------------------------------*\
Class FieldFunction Declaration
\*---------------------------------------------------------------------------*/
template<class DimensionedFieldType>
class FieldFunction
:
public DimensionedFieldFunction<DimensionedFieldType>
{
// Private Data
//- Field name
const word fieldName_;
//- Field Function1 pointer
autoPtr<Foam::Function1<typename DimensionedFieldType::Type_>> funcPtr_;
//- Cached dictionary
autoPtr<dictionary> dictPtr_;
public:
//- Runtime type information
TypeName("fieldFunction");
// Constructors
//- Construct with dictionary to initialise given field
FieldFunction
(
const dictionary& dict,
DimensionedFieldType& field
);
//- Construct a copy for the given field
FieldFunction
(
const FieldFunction& dff,
DimensionedFieldType& field
);
//- Construct and return a clone for the specified field
virtual autoPtr<DimensionedFieldFunction<DimensionedFieldType>>
clone(DimensionedFieldType& field) const;
//- Destructor
virtual ~FieldFunction()
{}
// Member Functions
//- Evaluate the function and set the field
virtual void evaluate();
//- Update the field for the current time
virtual bool update();
//- Write data to dictionary stream
virtual void write(Ostream& os) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace DimensionedFieldFunctions
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "FieldFunction_DimensionedFieldFunction.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|