File size: 5,462 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2012-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::functionObjects::fieldsExpression
Description
Base class for expressions involving multiple fields
See also
Foam::functionObjects::fvMeshFunctionObject
SourceFiles
fieldsExpression.C
fieldsExpressionTemplates.C
\*---------------------------------------------------------------------------*/
#ifndef fieldsExpression_functionObject_H
#define fieldsExpression_functionObject_H
#include "fvMeshFunctionObject.H"
#include "volFieldsFwd.H"
#include "VoidT.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class fieldsExpression Declaration
\*---------------------------------------------------------------------------*/
class fieldsExpression
:
public fvMeshFunctionObject
{
protected:
// Protected Data
//- Names of fields to process
wordList fieldNames_;
//- Name of result fields
word resultName_;
// Protected Member Functions
//- Set the result name
void setResultName
(
const word& functionName,
const wordList& defaultFieldNames = wordList::null()
);
//- Operate on the fields and store the result. Supported overload.
template
<
template<class> class GeoField,
class Op,
class A,
class B,
class = typename Op::template EnableIfDefinedFor<A, B>
>
bool opAndStore(const GeoField<A>& a, const GeoField<B>& b);
//- Operate on the fields and store the result. Not-supported overload.
template<template<class> class GeoField, class Op, class ... Args>
bool opAndStore(const Args& ...);
//- Fold the fields expression up one place
template<template<class> class GeoField, class Op, class A, class B>
bool foldAB(const label i);
//- Fold the fields expression up one place
template<template<class> class GeoField, class Op, class A>
bool foldA(const label i);
//- Fold the fields expression up one place
template<template<class> class GeoField, class Op>
bool fold(const label i);
//- Calculate and store the fields expression for the given geometric
// field type and operation
template<template<class> class GeoField, class Op>
bool calcGeoFieldOp();
//- Calculate and store the fields expression for the given operation
template<class Op>
bool calcOp();
//- Perform calculation on the list of fields and return success
virtual bool calc() = 0;
public:
//- Runtime type information
TypeName("fieldsExpression");
// Constructors
//- Construct from Time and dictionary
fieldsExpression
(
const word& name,
const Time& runTime,
const dictionary& dict,
const wordList& fieldNames = wordList::null(),
const word& resultName = word::null
);
//- Disallow default bitwise copy construction
fieldsExpression(const fieldsExpression&) = delete;
//- Destructor
virtual ~fieldsExpression();
// Member Functions
//- Read the fieldsExpression data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Calculate the result fields
virtual bool execute();
//- Write the result fields
virtual bool write();
//- Clear the result fields from the objectRegistry
virtual bool clear();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fieldsExpression&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "fieldsExpressionTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|