components.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 | Copyright (C) 2016 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  return processed;
53 }
54 
55 
56 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
57 
59 (
60  const word& name,
61  const Time& runTime,
62  const dictionary& dict
63 )
64 :
65  fieldExpression(name, runTime, dict)
66 {
67  read(dict);
68 }
69 
70 
71 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
72 
74 {}
75 
76 
77 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
78 
80 {
81  bool written = true;
82 
83  forAll(resultNames_, i)
84  {
85  written = written && writeObject(resultNames_[i]);
86  }
87 
88  return written;
89 }
90 
91 
93 {
94  bool cleared = true;
95 
96  forAll(resultNames_, i)
97  {
98  cleared = cleared && clearObject(resultNames_[i]);
99  }
100 
101  return cleared;
102 }
103 
104 
105 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:428
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
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.
bool read(const char *, int32_t &)
Definition: int32IO.C:85
A class for handling words, derived from string.
Definition: word.H:59
virtual bool write()
Write the component fields.
Definition: components.C:79
components(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: components.C:59
virtual ~components()
Destructor.
Definition: components.C:73
defineTypeNameAndDebug(fvMeshFunctionObject, 0)
virtual bool clear()
Clear the component fields from the objectRegistry.
Definition: components.C:92
addToRunTimeSelectionTable(functionObject, add, dictionary)
Namespace for OpenFOAM.