File size: 6,754 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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-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::fieldMapper
Description
Abstract base class for field mapping
\*---------------------------------------------------------------------------*/
#ifndef fieldMapper_H
#define fieldMapper_H
#include "Field.H"
#include "fieldTypes.H"
#include "fieldMapperM.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class fieldMapper Declaration
\*---------------------------------------------------------------------------*/
class fieldMapper
{
public:
// Public Classes
//- Class used to lazily evaluate fields
template<class Type>
class FieldFunctor;
//- Class used to lazily evaluate field-generating operators
template<class Type, class FieldOp>
class FieldOpFunctor;
private:
// Private Typedefs
//- Alias for tmp<Field<Type>> if the other argument passed is an
// operator (i.e., not a field). Disambiguates calls that take
// operators from those that take field arguments.
template<class Type, class FieldOp>
using TmpFieldTypeIfFieldOp =
typename std::enable_if
<
!std::is_base_of<Field<Type>, FieldOp>::value,
tmp<Field<Type>>
>::type;
// Private Member Functions
//- Map or assign a field in-place
template<class Type>
void mapOrAssign
(
Field<Type>& f,
const Field<Type>& mapF,
const Type& unmappedVal
) const;
//- Map or assign a field and return the result
template<class Type>
tmp<Field<Type>> mapOrAssign
(
const Field<Type>& mapF,
const Type& unmappedVal
) const;
//- Map or assign a field in-place
template<class Type>
void mapOrAssign
(
Field<Type>& f,
const Field<Type>& mapF,
const FieldFunctor<Type>& unmappedFunc
) const;
//- Map or assign a field and return the result
template<class Type>
tmp<Field<Type>> mapOrAssign
(
const Field<Type>& mapF,
const FieldFunctor<Type>& unmappedFunc
) const;
public:
// Constructors
//- Null constructor
fieldMapper()
{}
//- Destructor
virtual ~fieldMapper()
{}
// Member Functions
//- Is the mapper direct?
virtual bool direct() const
{
return true;
}
// Member Operators
//- Map a field
FOR_ALL_FIELD_TYPES(DEFINE_FIELD_MAPPER_MAP_OPERATOR, = 0);
//- Map a label field
DEFINE_FIELD_MAPPER_MAP_OPERATOR(label, = 0);
//- Map a temporary field
template<class Type>
void operator()(Field<Type>& f, const tmp<Field<Type>>& tmapF) const;
//- Map a temporary field
template<class Type>
tmp<Field<Type>> operator()(const tmp<Field<Type>>& tmapF) const;
//- Map or assign a field
FOR_ALL_FIELD_TYPES(DEFINE_FIELD_MAPPER_MAP_OR_ASSIGN_OPERATOR,);
//- Map or assign a label field
DEFINE_FIELD_MAPPER_MAP_OR_ASSIGN_OPERATOR(label,);
//- Map or assign a field from an operator in-place
template<class Type, class FieldOp>
void operator()
(
Field<Type>& f,
const Field<Type>& mapF,
const FieldOp& unmappedOp
) const;
//- Map or assign a field from an operator and return the result
template<class Type, class FieldOp>
TmpFieldTypeIfFieldOp<Type, FieldOp> operator()
(
const Field<Type>& mapF,
const FieldOp& unmappedOp
) const;
};
/*---------------------------------------------------------------------------*\
Class fieldMapper::FieldFunctor Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class fieldMapper::FieldFunctor
{
public:
// Constructors
//- Construct null
FieldFunctor()
{}
//- Destructor
virtual ~FieldFunctor()
{}
// Member Operators
//- Evaluate the field
virtual tmp<Field<Type>> operator()() const = 0;
};
/*---------------------------------------------------------------------------*\
Class fieldMapper::FieldOpFunctor Declaration
\*---------------------------------------------------------------------------*/
template<class Type, class FieldOp>
class fieldMapper::FieldOpFunctor
:
public FieldFunctor<Type>
{
// Private Data
//- The operator
FieldOp op_;
public:
// Constructors
//- Construct from an operator
FieldOpFunctor(const FieldOp& op)
:
FieldFunctor<Type>(),
op_(op)
{}
//- Destructor
virtual ~FieldOpFunctor()
{}
// Member Operators
//- Evaluate the field
virtual tmp<Field<Type>> operator()() const
{
return op_();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "fieldMapperTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|