components.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) 2016-2020 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 "components.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace functionObjects
34 {
35  defineTypeNameAndDebug(components, 0);
36  addToRunTimeSelectionTable(functionObject, components, dictionary);
37 }
38 }
39 
40 
41 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
42 
43 bool Foam::functionObjects::components::calc()
44 {
45  bool processed = false;
46 
47  processed = processed || calcComponents<vector>();
48  processed = processed || calcComponents<sphericalTensor>();
49  processed = processed || calcComponents<symmTensor>();
50  processed = processed || calcComponents<tensor>();
51 
52  if (!processed)
53  {
54  cannotFindObject(fieldName_);
55  }
56 
57  return processed;
58 }
59 
60 
61 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
62 
64 (
65  const word& name,
66  const Time& runTime,
67  const dictionary& dict
68 )
69 :
70  fieldExpression(name, runTime, dict, typeName)
71 {}
72 
73 
74 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
75 
77 {}
78 
79 
80 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
81 
83 {
84  bool written = true;
85 
86  forAll(resultNames_, i)
87  {
88  written = written && writeObject(resultNames_[i]);
89  }
90 
91  return written;
92 }
93 
94 
96 {
97  bool cleared = true;
98 
99  forAll(resultNames_, i)
100  {
101  cleared = cleared && clearObject(resultNames_[i]);
102  }
103 
104  return cleared;
105 }
106 
107 
108 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
addToRunTimeSelectionTable(functionObject, Qdot, dictionary)
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Macros for easy insertion into run-time selection tables.
A class for handling words, derived from string.
Definition: word.H:59
virtual bool write()
Write the component fields.
Definition: components.C:82
defineTypeNameAndDebug(Qdot, 0)
components(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: components.C:64
virtual ~components()
Destructor.
Definition: components.C:76
virtual bool clear()
Clear the component fields from the objectRegistry.
Definition: components.C:95
Namespace for OpenFOAM.