Loading...
Searching...
No Matches
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-------------------------------------------------------------------------------
10License
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\*---------------------------------------------------------------------------*/
28#include "Time.H"
29#include "solverPerformance.H"
30
31// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
32
33template<class Type>
35(
36 const word& name,
38) const
39{
41
43
44 const label timeIndex = this->time().timeIndex();
45
46 if (prevTimeIndex_ != timeIndex)
47 {
48 // Reset solver performance between iterations
49 prevTimeIndex_ = timeIndex;
50 dict.clear();
51 }
52 else
53 {
54 dict.readIfPresent(name, perfs);
55 }
56
57 if (dict.found(name))
58 {
59 perfs.second() = sp;
60 }
61 else
62 {
63 perfs = Pair<SolverPerformance<Type>>(sp, sp);
64 }
65
66 dict.set(name, perfs);
67}
68
69
70template<class Type>
72(
73 const SolverPerformance<Type>& sp
74) const
75{
76 setSolverPerformance(sp.fieldName(), sp);
77}
78
79
80// ************************************************************************* //
const Time & time() const noexcept
Return Time associated with the objectRegistry.
Definition IOobject.C:456
An ordered pair of two objects of type <T> with first() and second() elements.
Definition Pair.H:66
const T & second() const noexcept
Access the second element.
Definition Pair.H:147
SolverPerformance is the class returned by the LduMatrix solver containing performance statistics.
const word & fieldName() const noexcept
Return field name.
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.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
void setSolverPerformance(const word &name, const SolverPerformance< Type > &sp) const
Add/set the solverPerformance entry for the named field.
dictionary & solverPerformanceDict()
Return the dictionary of solver performance data which includes initial and final residuals for conve...
Definition meshState.C:125
A class for handling words, derived from Foam::string.
Definition word.H:66
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition exprTraits.C:127
label timeIndex
dictionary dict