divide.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2021 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 // There is some include hell going on with regards to the scalar-divided-by-
27 // sphericalTensor operation. This rather odd include sequence resolves it.
28 
29 #include "Field.H"
31 #include "divide.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 namespace functionObjects
39 {
41  addToRunTimeSelectionTable(functionObject, divide, dictionary);
42 }
43 }
44 
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 template
49 <
50  class A,
51  class B,
52  class R = decltype(std::declval<A>()/std::declval<B>())
53 >
55 {
56  R operator()(const A& a, const B& b)
57  {
58  return a/b;
59  }
60 };
61 
62 
63 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
64 
65 bool Foam::functionObjects::divide::calc()
66 {
67  return calcOp<divideOpAuto>();
68 }
69 
70 
71 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
72 
74 (
75  const word& name,
76  const Time& runTime,
77  const dictionary& dict
78 )
79 :
80  fieldsExpression(name, runTime, dict)
81 {
82  setResultName("divide");
83 }
84 
85 
86 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
87 
89 {}
90 
91 
92 // ************************************************************************* //
void divide(FieldField< Field, Type > &f, const FieldField< Field, Type > &f1, const FieldField< Field, scalar > &f2)
divide(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: divide.C:74
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
addToRunTimeSelectionTable(functionObject, Qdot, dictionary)
const dimensionedScalar b
Wien displacement law constant: default SI units: [m K].
Definition: createFields.H:27
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
Macros for easy insertion into run-time selection tables.
R operator()(const A &a, const B &b)
Definition: divide.C:56
A class for handling words, derived from string.
Definition: word.H:59
Specialisation of FieldField<Field, T> for sphericalTensor.
defineTypeNameAndDebug(Qdot, 0)
#define R(A, B, C, D, E, F, K, M)
virtual ~divide()
Destructor.
Definition: divide.C:88
Namespace for OpenFOAM.