File size: 12,703 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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::Field
Description
Generic templated field type.
SourceFiles
Field.C
FieldExpression.C
\*---------------------------------------------------------------------------*/
#ifndef Field_H
#define Field_H
#include "tmp.H"
#include "direction.H"
#include "VectorSpace.H"
#include "scalarList.H"
#include "labelList.H"
#include "expressionExpressionable.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template<class Type>
class Field;
//- Pre-declare related SubField type
template<class Type>
class SubField;
template<class Type>
void writeEntry(Ostream& os, const Field<Type>&);
class unitSet;
class dictionary;
//- Field types
template<class Type>
struct FieldTraits
{
//- Primitive element type
using pType = Type;
//- Primitive element component type
using pCmptType = typename pTraits<Type>::cmptType;
//- Element component type (pCmptType)
using cmptType = pCmptType;
};
//- Field<Field> types
template<class Type>
struct FieldTraits<Field<Type>>
{
//- Primitive element type
using pType = Type;
//- Primitive element component type
using pCmptType = typename pTraits<Type>::cmptType;
//- Element component type (Field of pCmptType)
using cmptType = Field<pCmptType>;
};
/*---------------------------------------------------------------------------*\
Class Field Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Field
:
public tmp<Field<Type>>::refCount,
public List<Type>
{
// Private Member Functions
//- Return reference to copy of this field if mapF is the same field
// otherwise return mapF
const UList<Type>& copySelf
(
const UList<Type>& mapF,
tmp<Field<Type>>& tmapFcpy
) const;
public:
// Public Types
//- Primitive type
using pType = typename FieldTraits<Type>::pType;
//- Primitive component type
using pCmptType = typename FieldTraits<Type>::pCmptType;
//- Component type
using cmptType = typename FieldTraits<Type>::cmptType;
//- Component Field type
using cmptField = Field<cmptType>;
//- subField type
using subField = SubField<Type>;
// Static Data Members
static const char* const typeName;
// Static Member Functions
//- Return a null field
inline static const Field<Type>& null()
{
return NullObjectRef<Field<Type>>();
}
// Constructors
//- Construct null
// Used for temporary fields which are initialised after construction
Field();
//- Construct given size
// Used for temporary fields which are initialised after construction
explicit Field(const label);
//- Construct given size and initial value
Field(const label, const Type&);
//- Construct given size and initialised to zero
Field(const label, const zero);
//- Copy constructor of a UList\<Type\>
explicit Field(const UList<Type>&);
//- Mover constructor transferring the List contents
explicit Field(List<Type>&&);
//- Copy constructor of a UIndirectList\<Type\>
explicit Field(const UIndirectList<Type>&);
//- Copy constructor
Field(const Field<Type>&);
//- Copy constructor or reuse as specified.
Field(Field<Type>&, bool reuse);
//- Move constructor transferring the Field contents
Field(Field<Type>&&);
//- Copy constructor of tmp<Field>
Field(const tmp<Field<Type>>&);
//- Construct by 1 to 1 mapping from the given field
Field
(
const UList<Type>& mapF,
const labelUList& mapAddressing
);
//- Construct by 1 to 1 mapping from the given tmp field
Field
(
const tmp<Field<Type>>& tmapF,
const labelUList& mapAddressing
);
//- Construct by interpolative mapping from the given field
Field
(
const UList<Type>& mapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- Construct by interpolative mapping from the given tmp field
Field
(
const tmp<Field<Type>>& tmapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- Construct from Istream
Field(Istream&);
//- Construct from a dictionary entry
Field(const word& keyword, const dictionary&, const label size);
//- Construct from a dictionary entry with unit conversion
Field
(
const word& keyword,
const unitSet&,
const dictionary&,
const label size
);
//- Construct from an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
Field(const Expression& e);
//- Clone
tmp<Field<Type>> clone() const;
static tmp<Field<Type>> New
(
const tmp<Field<Type>>& tf1,
const bool initRet = true
);
// Member Functions
//- 1 to 1 map from the given field
void map
(
const UList<Type>& mapF,
const labelUList& mapAddressing
);
//- 1 to 1 map from the given tmp field
void map
(
const tmp<Field<Type>>& tmapF,
const labelUList& mapAddressing
);
//- Interpolative map from the given field
void map
(
const UList<Type>& mapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- Interpolative map from the given tmp field
void map
(
const tmp<Field<Type>>& tmapF,
const labelListList& mapAddressing,
const scalarListList& weights
);
//- 1 to 1 reverse-map from the given field
void rmap
(
const UList<Type>& mapF,
const labelUList& mapAddressing
);
//- 1 to 1 reverse-map from the given tmp field
void rmap
(
const tmp<Field<Type>>& tmapF,
const labelUList& mapAddressing
);
//- Interpolative reverse map from the given field
void rmap
(
const UList<Type>& mapF,
const labelUList& mapAddressing,
const UList<scalar>& weights
);
//- Interpolative reverse map from the given tmp field
void rmap
(
const tmp<Field<Type>>& tmapF,
const labelUList& mapAddressing,
const UList<scalar>& weights
);
//- Reset the field values to the given field
// Equivalent to operator=
void reset(const Field<Type>&);
//- Reset the field values to the given field
// Equivalent to operator=
void reset(const UList<Type>&);
//- Negate this field
void negate();
//- Return a component field expression of the field
inline auto component(const direction& d) const;
//- Replace a component field of the field
void replace(const direction, const UList<cmptType>&);
//- Replace a component field of the field
void replace(const direction, const tmp<Field<cmptType>>&);
//- Replace a component field of the field from an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void replace(const direction, const Expression&);
//- Replace a component field of the field
void replace(const direction, const cmptType&);
template<class VSForm>
VSForm block(const label start) const;
//- Return the field transpose expression
// (only defined for second rank tensors)
inline auto T() const;
//- Bound the field to the given lower bound
void boundLower(const Type& lower);
//- Bound the field to the given upper bound
void boundUpper(const Type& upper);
//- Bound the field within the given lower and upper bounds
void bound(const Type& lower, const Type& upper);
//- Append an element at the end of the Field
void append(const Type& t);
//- Append a Field at the end of the Field
void append(const Field<Type>& f);
//- Append a Field at the end of the Field
void append(const tmp<Field<Type>>& tf);
//- Append a Field evaluated from an expression at the end of this Field
template<class Expression, class = EnableIfExpressionable<Expression>>
void append(const Expression& e);
// Member Operators
void operator=(const Field<Type>&);
void operator=(Field<Type>&&);
void operator=(const UList<Type>&);
void operator=(List<Type>&&);
void operator=(const tmp<Field<Type>>&);
void operator=(const pType&);
void operator=(const zero);
template<class Form, class Cmpt, direction nCmpt>
void operator=(const VectorSpace<Form,Cmpt,nCmpt>&);
//- Assign to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator=(const Expression& e);
void operator+=(const UList<Type>&);
void operator+=(const Field<Type>&);
void operator+=(const tmp<Field<Type>>&);
void operator+=(const pType&);
//- Assign-add to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator+=(const Expression& e);
void operator-=(const UList<Type>&);
void operator-=(const Field<Type>&);
void operator-=(const tmp<Field<Type>>&);
void operator-=(const pType&);
//- Assign-subtract to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator-=(const Expression& e);
void operator*=(const UList<cmptType>&);
void operator*=(const Field<cmptType>&);
void operator*=(const tmp<Field<cmptType>>&);
void operator*=(const pCmptType&);
//- Assign-multiply to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator*=(const Expression& e);
void operator/=(const UList<cmptType>&);
void operator/=(const Field<cmptType>&);
void operator/=(const tmp<Field<cmptType>>&);
void operator/=(const pCmptType&);
//- Assign-divide to an expression
template<class Expression, class = EnableIfExpressionable<Expression>>
void operator/=(const Expression& e);
};
template<class Type>
Ostream& operator<<(Ostream&, const Field<Type>&);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "FieldExpression.H"
#include "scalarField.H"
#ifdef NoRepository
#include "Field.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|