meshStateTemplates.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 "Time.H"
29 #include "solverPerformance.H"
30 
31 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32 
33 template<class Type>
35 (
36  const word& name,
37  const SolverPerformance<Type>& sp
38 ) const
39 {
41 
43 
44  if (prevTimeIndex_ != this->time().timeIndex())
45  {
46  // Reset solver performance between iterations
47  prevTimeIndex_ = this->time().timeIndex();
48  dict.clear();
49  }
50  else
51  {
52  dict.readIfPresent(name, perfs);
53  }
54 
55  perfs.push_back(sp);
56 
57  dict.set(name, perfs);
58 }
59 
60 
61 template<class Type>
63 (
64  const SolverPerformance<Type>& sp
65 ) const
66 {
67  setSolverPerformance(sp.fieldName(), sp);
68 }
69 
70 
71 // ************************************************************************* //
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:129
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
void push_back(const T &val)
Append an element at the end of the list.
Definition: ListI.H:227
void setSolverPerformance(const word &name, const SolverPerformance< Type > &sp) const
Add/set the solverPerformance entry for the named field.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
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 the current time index.
Definition: TimeStateI.H:43
const word & name() const
Name function is needed to disambiguate those inherited from regIOobject and dictionary.
dictionary & solverPerformanceDict()
Return the dictionary of solver performance data which includes initial and final residuals for conve...
Definition: meshState.C:125
const Time & time() const noexcept
Return Time associated with the objectRegistry.
Definition: IOobject.C:456
void clear()
Clear the dictionary.
Definition: dictionary.C:844