File size: 3,887 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) YEAR 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/>.
Description
Template for use with dynamic code generation of a DimensionedFieldFunction.
- without state
SourceFiles
codedDimensionedFieldFunctionTemplate.C
\*---------------------------------------------------------------------------*/
#ifndef codedDimensionedFieldFunctionTemplate_H
#define codedDimensionedFieldFunctionTemplate_H
#include "DimensionedFieldFunction.H"
#include "DimensionedFvPatchFields.H"
#include "volFields.H"
//{{{ begin codeInclude
${codeInclude}
//}}} end codeInclude
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace DimensionedFieldFunctions
{
/*---------------------------------------------------------------------------*\
A templated DimensionedFieldFunction
\*---------------------------------------------------------------------------*/
class ${typeName}DimensionedFieldFunction${DimensionedFieldTypeName}
:
public DimensionedFieldFunction<${DimensionedFieldType}>
{
typedef typename ${DimensionedFieldType}::Type_ Type;
typedef typename ${DimensionedFieldType}::GeoMesh_ GeoMesh;
typedef typename GeoMesh::Zone Zone;
// Private Data
//- Local reference to the field
${DimensionedFieldType}& field;
public:
// Runtime type information
TypeName("${typeName}");
// Constructors
//- Construct from entry name and dictionary
${typeName}DimensionedFieldFunction${DimensionedFieldTypeName}
(
const dictionary& dict,
${DimensionedFieldType}& field
);
//- Construct a copy for the given field
${typeName}DimensionedFieldFunction${DimensionedFieldTypeName}
(
const
${typeName}DimensionedFieldFunction${DimensionedFieldTypeName}& dff,
${DimensionedFieldType}& field
);
//- Construct and return a clone for the specified field
virtual autoPtr<DimensionedFieldFunction<${DimensionedFieldType}>>
clone(${DimensionedFieldType}& field) const;
//- Destructor
virtual ~${typeName}DimensionedFieldFunction${DimensionedFieldTypeName}();
// Member Functions
//- Evaluate the function and set the field
virtual void evaluate();
//- Update the field if the function has changed
virtual bool update();
//- Write data to dictionary stream
virtual void write(Ostream& os) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace DimensionedFieldFunctions
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|