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 {
41  dictionary& dict = const_cast<dictionary&>(solverPerformanceDict());
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  // Append to list
57  perfs.setSize(perfs.size()+1, sp);
58 
59  dict.set(name, perfs);
60 }
61 
62 
63 template<class Type>
65 (
66  const SolverPerformance<Type>& sp
67 ) const
68 {
69  setSolverPerformance(sp.fieldName(), sp);
70 }
71 
72 
73 // ************************************************************************* //
Foam::data::setSolverPerformance
void setSolverPerformance(const word &name, const SolverPerformance< Type > &sp) const
Add/set the solverPerformance entry for the named field.
Definition: dataTemplates.C:36
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::SolverPerformance::fieldName
const word & fieldName() const noexcept
Return field name.
Definition: SolverPerformance.H:163
Foam::List::setSize
void setSize(const label n)
Alias for resize()
Definition: List.H:222
solverPerformance.H
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Time.H
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: BitOps.H:63
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
data.H
Foam::SolverPerformance
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics.
Definition: SolverPerformance.H:52