magTemplates.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) 2012-2022 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 #include "volFields.H"
27 #include "surfaceFields.H"
28 
29 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
30 
31 template<class Type>
32 bool Foam::functionObjects::mag::calcMag()
33 {
34  if (foundObject<VolField<Type>>(fieldName_))
35  {
36  return store
37  (
39  Foam::mag(lookupObject<VolField<Type>>(fieldName_))
40  );
41  }
42  else if (foundObject<SurfaceField<Type>>(fieldName_))
43  {
44  return store
45  (
47  Foam::mag(lookupObject<SurfaceField<Type>>(fieldName_))
48  );
49  }
50  else
51  {
52  return false;
53  }
54 }
55 
56 
57 // ************************************************************************* //
word resultName_
Name of result field.
const word fieldName_
Name of field to process.
const ObjectType & lookupObject(const word &fieldName) const
Lookup object from the objectRegistry.
bool foundObject(const word &fieldName) const
Find field in the objectRegistry.
bool store(const tmp< ObjectType > &tfield)
Store the given field in the objectRegistry.
dimensioned< scalar > mag(const dimensioned< Type > &)
Foam::surfaceFields.