adaptiveLinear.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) 2012-2015 OpenFOAM Foundation
9 Copyright (C) 2018 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
29#include "adaptiveLinear.H"
31
32// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33
34namespace Foam
35{
36 defineTypeNameAndDebug(adaptiveLinear, 0);
37 addToRunTimeSelectionTable(relaxationModel, adaptiveLinear, dictionary);
38}
39
40// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41
43(
44 const dictionary& relaxationDict,
45 const Time& runTime
46)
47:
48 relaxationModel(typeName, relaxationDict, runTime),
49 relaxationStart_(coeffDict().get<scalar>("relaxationStart")),
50 relaxationEnd_(coeffDict().get<scalar>("relaxationEnd")),
51 lastTimeValue_(runTime_.time().timeOutputValue()),
52 relaxation_(relaxationStart_)
53{}
54
55
56// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
57
59{
60 if (runTime_.time().timeOutputValue() > lastTimeValue_)
61 {
62 scalar currentRelaxation = relaxation_;
63
64 relaxation_ -=
65 (relaxation_ - relaxationEnd_)
66 /(
67 (
70 )
71 /(runTime_.time().timeOutputValue() - lastTimeValue_)
72 + 1
73 );
74
75 lastTimeValue_ = runTime_.time().timeOutputValue();
76
77 return currentRelaxation;
78 }
79
80 return relaxation_;
81}
82
83
84// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
scalar timeOutputValue() const
Return current time value.
Definition: TimeStateI.H:31
virtual dimensionedScalar endTime() const
Return end time.
Definition: Time.C:867
Produces a linear ramp which adapts its gradient to changes in endTime and deltaT to always arrive at...
virtual scalar relaxation()
Return the current relaxation coefficient.
const Type & value() const
Return const reference to value.
const Time & time() const noexcept
Return time registry.
const Time & runTime_
Reference to the conformalVoronoiMesh holding this cvControls object.
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
engineTime & runTime
List< ReturnType > get(const UPtrList< T > &list, const AccessOp &aop)
Namespace for OpenFOAM.