dataTemplates.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) 2015-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 "data.H"
29 #include "Time.H"
30 #include "solverPerformance.H"
31 
32 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
33 
34 template<class Type>
36 (
37  const word& name,
38  const SolverPerformance<Type>& sp
39 ) const
40 {
42 
44 
45  if (prevTimeIndex_ != this->time().timeIndex())
46  {
47  // Reset solver performance between iterations
48  prevTimeIndex_ = this->time().timeIndex();
49  dict.clear();
50  }
51  else
52  {
53  dict.readIfPresent(name, perfs);
54  }
55 
56  perfs.push_back(sp);
57 
58  dict.set(name, perfs);
59 }
60 
61 
62 template<class Type>
64 (
65  const SolverPerformance<Type>& sp
66 ) const
67 {
68  setSolverPerformance(sp.fieldName(), sp);
69 }
70 
71 
72 // ************************************************************************* //
void setSolverPerformance(const word &name, const SolverPerformance< Type > &sp) const
Add/set the solverPerformance entry for the named field.
Definition: dataTemplates.C:29
dictionary dict
const word & fieldName() const noexcept
Return field name.
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:120
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: BitOps.H:56
const dictionary & solverPerformanceDict() const
Return the dictionary of solver performance data which includes initial and final residuals for conve...
Definition: data.C:58
void push_back(const T &val)
Append an element at the end of the list.
Definition: ListI.H:185
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:52
A class for handling words, derived from Foam::string.
Definition: word.H:63
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics...
label timeIndex() const noexcept
Return current time index.
Definition: TimeStateI.H:30
const word & name() const
Name function is needed to disambiguate those inherited from regIOobject and dictionary.
const Time & time() const noexcept
Return Time associated with the objectRegistry.
Definition: IOobject.C:431
void clear()
Clear the dictionary.
Definition: dictionary.C:856