fieldExprDriverTemplates.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2019-2022 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 template<class Type>
33 (
34  const word& name
35 ) const
36 {
37  bool hasPointData = false;
38 
40 
41  if (hasVariable(name) && variable(name).isType<Type>())
42  {
43  tvar.cref(variable(name));
44  hasPointData = tvar().isPointData();
45  }
46 
47 
48  if (tvar)
49  {
50  const auto& var = tvar.cref();
51  const Field<Type>& vals = var.cref<Type>();
52 
53  const label len = (hasPointData ? this->pointSize() : this->size());
54 
55  if (returnReduceAnd(vals.size() == len))
56  {
57  // Return a copy of the field
58  return tmp<Field<Type>>::New(vals);
59  }
60 
61  if (!var.isUniform())
62  {
64  << "Variable " << name
65  << " is nonuniform and does not fit the size"
66  << ". Using average" << endl;
67  }
68 
69  return tmp<Field<Type>>::New(this->size(), gAverage(vals));
70  }
71 
72  return nullptr;
73 }
74 
75 
76 // ************************************************************************* //
void size(const label n)
Older name for setAddressableSize.
Definition: UList.H:116
virtual bool hasVariable(const word &name) const
True if named variable exists.
Definition: exprDriverI.H:37
virtual label pointSize() const
The point field size for the expression.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tf1, const word &name, const dimensionSet &dimensions, const bool initCopy=false)
Global function forwards to reuseTmpDimensionedField::New.
const T & cref() const
Return const reference to the object or to the contents of a (non-null) managed pointer.
Definition: refPtrI.H:216
A class for managing references or pointers (no reference counting)
Definition: HashPtrTable.H:49
virtual label size() const
The natural field size for the expression.
bool returnReduceAnd(const bool value, const label comm=UPstream::worldComm)
Perform logical (and) MPI Allreduce on a copy. Uses UPstream::reduceAnd.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
Generic templated field type.
Definition: Field.H:62
A class for handling words, derived from Foam::string.
Definition: word.H:63
#define WarningInFunction
Report a warning using Foam::Warning.
Type gAverage(const FieldField< Field, Type > &f)
tmp< Field< Type > > getField(const word &fieldName) const
Return named field (variable) if available.
A class for managing temporary objects.
Definition: HashPtrTable.H:50
virtual exprResult & variable(const word &name)
Non-const access to the named variable (sub-classes only)
Definition: exprDriverI.H:57