multiply.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) 2020 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 #include "multiply.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace functionObjects
36 {
39 }
40 }
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
45 (
46  const word& name,
47  const Time& runTime,
48  const dictionary& dict
49 )
50 :
51  fieldsExpression(name, runTime, dict)
52 {
53  setResultName("multiply");
54 }
55 
56 
57 bool Foam::functionObjects::multiply::calc()
58 {
59  bool processed = false;
60 
61  Log << type() << ' ' << name() << " execute:" << nl;
62 
63  forAll(fieldNames_, i)
64  {
65  processed = false;
66 
67  if (i == 0)
68  {
69  initialiseResult<scalar>(fieldNames_[i]);
70  initialiseResult<vector>(fieldNames_[i]);
71  initialiseResult<sphericalTensor>(fieldNames_[i]);
72  initialiseResult<symmTensor>(fieldNames_[i]);
73  initialiseResult<tensor>(fieldNames_[i]);
74  }
75  else
76  {
77  multiplyResult<scalar>(fieldNames_[i], processed);
78  multiplyResult<vector>(fieldNames_[i], processed);
79  multiplyResult<sphericalTensor>(fieldNames_[i], processed);
80  multiplyResult<symmTensor>(fieldNames_[i], processed);
81  multiplyResult<tensor>(fieldNames_[i], processed);
82  }
83  }
84 
85  return processed;
86 }
87 
88 
89 // ************************************************************************* //
runTime
engineTime & runTime
Definition: createEngineTime.H:13
Log
#define Log
Definition: PDRblock.C:28
Foam::Time
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:63
multiply.H
Foam::functionObject
Abstract base-class for Time/database function objects.
Definition: functionObject.H:329
forAll
#define forAll(list, i)
Definition: stdFoam.H:349
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:119
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Definition: atmBoundaryLayer.C:26
Foam::functionObject::name
const word & name() const noexcept
Definition: functionObject.C:136
Foam::functionObjects::fieldsExpression
Intermediate class for handling field expression function objects (e.g. add, subtract etc....
Definition: fieldsExpression.H:99
Foam::nl
constexpr char nl
Definition: Ostream.H:424
Foam::functionObjects::addToRunTimeSelectionTable
addToRunTimeSelectionTable(functionObject, ObukhovLength, dictionary)
Foam::functionObject::type
virtual const word & type() const =0
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Definition: POSIX.C:717
Foam::functionObjects::fieldsExpression::fieldNames_
wordList fieldNames_
Definition: fieldsExpression.H:108
Foam::functionObjects::defineTypeNameAndDebug
defineTypeNameAndDebug(ObukhovLength, 0)
Foam::functionObjects::fieldsExpression::setResultName
void setResultName(const word &typeName, const wordList &defaultArg=wordList::null())
Definition: fieldsExpression.C:39
Foam::name
word name(const expressions::valueTypeCode typeCode)
Definition: exprTraits.C:52
Foam::functionObjects::multiply::multiply
multiply(const word &name, const Time &runTime, const dictionary &dict)
Definition: multiply.C:38
Foam::multiply
void multiply(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
Foam::functionObjects::multiply
Multiplies a given list of (at least two or more) fields and outputs the result into a new field.
Definition: multiply.H:142