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 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 isPointVal = false;
38  bool isUniformVal = false;
39 
40  tmp<Field<Type>> tfield;
41 
42  if (hasVariable(name) && variable(name).isType<Type>())
43  {
44  const expressions::exprResult& var = variable(name);
45 
46  isPointVal = var.isPointValue();
47  isUniformVal = var.isUniform();
48 
49  tfield = var.cref<Type>().clone();
50  }
51 
52  if (tfield.valid())
53  {
54  const label fldLen = tfield().size();
55  const label len = (isPointVal ? this->pointSize() : this->size());
56 
57  if (returnReduce((fldLen == len), andOp<bool>()))
58  {
59  return tfield;
60  }
61 
62  if (!isUniformVal)
63  {
65  << "Variable " << name
66  << " does not fit the size and is not a uniform value." << nl
67  << "Using average value" << endl;
68  }
69 
70  return tmp<Field<Type>>::New(this->size(), gAverage(tfield));
71  }
72 
73  return tfield;
74 }
75 
76 
77 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::returnReduce
T returnReduce(const T &Value, const BinaryOp &bop, const int tag=Pstream::msgType(), const label comm=UPstream::worldComm)
Definition: PstreamReduceOps.H:94
Foam::expressions::fieldExpr::parseDriver::getField
tmp< Field< Type > > getField(const word &fieldName) const
Return named field (variable) if available.
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::gAverage
Type gAverage(const FieldField< Field, Type > &f)
Definition: FieldFieldFunctions.C:604
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:337
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:62
Foam::expressions::exprResult
A polymorphic field/result from evaluating an expression.
Definition: exprResult.H:128
Foam::name
word name(const complex &c)
Return string representation of complex.
Definition: complex.C:76
Foam::andOp
Definition: ops.H:233
Foam::expressions::exprResult::isUniform
bool isUniform() const
True if single, uniform value.
Definition: exprResultI.H:265
Foam::expressions::exprResult::cref
const Field< Type > & cref() const
Return const reference to the field.
Foam::New
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh >> &tdf1, const word &name, const dimensionSet &dimensions)
Global function forwards to reuseTmpDimensionedField::New.
Definition: DimensionedFieldReuseFunctions.H:105
Foam::nl
constexpr char nl
Definition: Ostream.H:372
Foam::expressions::exprResult::isPointValue
bool isPointValue(const bool isPointVal=true) const
True if representing point values, or test if same as isPointVal.
Definition: exprResultI.H:257
Foam::tmp::valid
bool valid() const noexcept
Definition: tmpI.H:206
WarningInFunction
#define WarningInFunction
Report a warning using Foam::Warning.
Definition: messageStream.H:294