Loading...
Searching...
No Matches
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-------------------------------------------------------------------------------
10License
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"
31// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32
33namespace Foam
34{
35namespace 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 if (fieldNames_.size() < 2)
56 {
58 << "At least two field names are required, but only "
59 << fieldNames_.size() << " provided." << nl
61 }
62}
63
64
66{
67 bool processed = false;
68
69 Log << type() << ' ' << name() << " execute:" << nl;
70
71 forAll(fieldNames_, i)
72 {
73 processed = false;
74
75 if (i == 0)
76 {
77 initialiseResult<scalar>(fieldNames_[i]);
78 initialiseResult<vector>(fieldNames_[i]);
79 initialiseResult<sphericalTensor>(fieldNames_[i]);
80 initialiseResult<symmTensor>(fieldNames_[i]);
81 initialiseResult<tensor>(fieldNames_[i]);
82 }
83 else
84 {
85 multiplyResult<scalar>(fieldNames_[i], processed);
86 multiplyResult<vector>(fieldNames_[i], processed);
87 multiplyResult<sphericalTensor>(fieldNames_[i], processed);
88 multiplyResult<symmTensor>(fieldNames_[i], processed);
89 multiplyResult<tensor>(fieldNames_[i], processed);
90 }
91 }
92
93 return processed;
94}
95
96
97// ************************************************************************* //
#define Log
Definition PDRblock.C:28
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition Time.H:75
void size(const label n)
Older name for setAddressableSize.
Definition UList.H:118
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
Abstract base-class for Time/database function objects.
wordList fieldNames_
Names of fields to process.
void setResultName(const word &typeName, const wordList &defaultArg=wordList::null())
Set the result name.
virtual bool calc()=0
Calculate expression.
Multiplies a given list of (at least two or more) fields and outputs the result into a new field.
Definition multiply.H:137
friend class fieldsExpression
Grant fieldsExpression access to private and protected members.
Definition multiply.H:186
multiply(const word &name, const Time &runTime, const dictionary &dict)
Construct from name, Time and dictionary.
Definition multiply.C:38
A class for handling words, derived from Foam::string.
Definition word.H:66
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition className.H:142
engineTime & runTime
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition error.H:629
auto & name
Function objects are OpenFOAM utilities to ease workflow configurations and enhance workflows.
Namespace for OpenFOAM.
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition POSIX.C:801
IOerror FatalIOError
Error stream (stdout output on all processes), with additional 'FOAM FATAL IO ERROR' header text and ...
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition exprTraits.C:127
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition errorManip.H:125
constexpr char nl
The newline '\n' character (0x0a).
Definition Ostream.H:50
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition stdFoam.H:299